From 9df0512de5b3ac6c0fcdd073506a323366f7e33c Mon Sep 17 00:00:00 2001 From: AwsSdkPhpAutomation Date: Thu, 4 Jan 2024 19:43:02 +0000 Subject: [PATCH 1/2] Update models for release --- .changes/3.295.6 | 42 ++ CHANGELOG.md | 11 + src/Lightsail/LightsailClient.php | 4 + src/data/config/2014-11-12/api-2.json | 20 +- src/data/config/2014-11-12/api-2.json.php | 2 +- src/data/config/2014-11-12/docs-2.json | 8 +- src/data/config/2014-11-12/docs-2.json.php | 2 +- src/data/docdb/2014-10-31/api-2.json | 4 +- src/data/docdb/2014-10-31/api-2.json.php | 2 +- src/data/docdb/2014-10-31/docs-2.json | 2 + src/data/docdb/2014-10-31/docs-2.json.php | 2 +- src/data/ecs/2014-11-13/api-2.json | 13 +- src/data/ecs/2014-11-13/api-2.json.php | 2 +- src/data/ecs/2014-11-13/docs-2.json | 13 +- src/data/ecs/2014-11-13/docs-2.json.php | 2 +- src/data/es/2015-01-01/api-2.json | 3 +- src/data/es/2015-01-01/api-2.json.php | 2 +- src/data/es/2015-01-01/docs-2.json | 2 +- src/data/es/2015-01-01/docs-2.json.php | 2 +- .../es/2015-01-01/endpoint-rule-set-1.json | 115 +++++- .../2015-01-01/endpoint-rule-set-1.json.php | 2 +- src/data/es/2015-01-01/endpoint-tests-1.json | 6 +- .../es/2015-01-01/endpoint-tests-1.json.php | 2 +- src/data/lightsail/2016-11-28/api-2.json | 156 +++++++- src/data/lightsail/2016-11-28/api-2.json.php | 2 +- src/data/lightsail/2016-11-28/docs-2.json | 364 ++++++++++++------ src/data/lightsail/2016-11-28/docs-2.json.php | 2 +- .../2016-11-28/endpoint-rule-set-1.json | 40 +- .../2016-11-28/endpoint-rule-set-1.json.php | 2 +- src/data/opensearch/2021-01-01/api-2.json | 3 +- src/data/opensearch/2021-01-01/api-2.json.php | 2 +- src/data/opensearch/2021-01-01/docs-2.json | 14 +- .../opensearch/2021-01-01/docs-2.json.php | 2 +- src/data/sagemaker/2017-07-24/api-2.json | 43 ++- src/data/sagemaker/2017-07-24/api-2.json.php | 2 +- src/data/sagemaker/2017-07-24/docs-2.json | 37 ++ src/data/sagemaker/2017-07-24/docs-2.json.php | 2 +- src/data/servicecatalog/2015-12-10/api-2.json | 18 +- .../servicecatalog/2015-12-10/api-2.json.php | 2 +- .../servicecatalog/2015-12-10/docs-2.json | 5 +- .../servicecatalog/2015-12-10/docs-2.json.php | 2 +- 41 files changed, 747 insertions(+), 214 deletions(-) create mode 100644 .changes/3.295.6 diff --git a/.changes/3.295.6 b/.changes/3.295.6 new file mode 100644 index 0000000000..0cf07088a0 --- /dev/null +++ b/.changes/3.295.6 @@ -0,0 +1,42 @@ +[ + { + "type": "api-change", + "category": "DocDB", + "description": "Adding PerformanceInsightsEnabled and PerformanceInsightsKMSKeyId fields to DescribeDBInstances Response." + }, + { + "type": "api-change", + "category": "SageMaker", + "description": "Adding support for provisioned throughput mode for SageMaker Feature Groups" + }, + { + "type": "api-change", + "category": "ECS", + "description": "This release adds support for managed instance draining which facilitates graceful termination of Amazon ECS instances." + }, + { + "type": "api-change", + "category": "ElasticsearchService", + "description": "This release adds support for new or existing Amazon OpenSearch domains to enable TLS 1.3 or TLS 1.2 with perfect forward secrecy cipher suites for domain endpoints." + }, + { + "type": "api-change", + "category": "ServiceCatalog", + "description": "Added Idempotency token support to Service Catalog AssociateServiceActionWithProvisioningArtifact, DisassociateServiceActionFromProvisioningArtifact, DeleteServiceAction API" + }, + { + "type": "api-change", + "category": "ConfigService", + "description": "Updated ResourceType enum with new resource types onboarded by AWS Config in November and December 2023." + }, + { + "type": "api-change", + "category": "Lightsail", + "description": "This release adds support to set up an HTTPS endpoint on an instance." + }, + { + "type": "api-change", + "category": "OpenSearchService", + "description": "This release adds support for new or existing Amazon OpenSearch domains to enable TLS 1.3 or TLS 1.2 with perfect forward secrecy cipher suites for domain endpoints." + } +] diff --git a/CHANGELOG.md b/CHANGELOG.md index 5b3270886c..030b32e2a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # CHANGELOG +## next release + +* `Aws\DocDB` - Adding PerformanceInsightsEnabled and PerformanceInsightsKMSKeyId fields to DescribeDBInstances Response. +* `Aws\SageMaker` - Adding support for provisioned throughput mode for SageMaker Feature Groups +* `Aws\ECS` - This release adds support for managed instance draining which facilitates graceful termination of Amazon ECS instances. +* `Aws\ElasticsearchService` - This release adds support for new or existing Amazon OpenSearch domains to enable TLS 1.3 or TLS 1.2 with perfect forward secrecy cipher suites for domain endpoints. +* `Aws\ServiceCatalog` - Added Idempotency token support to Service Catalog AssociateServiceActionWithProvisioningArtifact, DisassociateServiceActionFromProvisioningArtifact, DeleteServiceAction API +* `Aws\ConfigService` - Updated ResourceType enum with new resource types onboarded by AWS Config in November and December 2023. +* `Aws\Lightsail` - This release adds support to set up an HTTPS endpoint on an instance. +* `Aws\OpenSearchService` - This release adds support for new or existing Amazon OpenSearch domains to enable TLS 1.3 or TLS 1.2 with perfect forward secrecy cipher suites for domain endpoints. + ## 3.295.5 - 2024-01-03 * `Aws\Connect` - Amazon Connect, Contact Lens Evaluation API increase evaluation notes max length to 3072. diff --git a/src/Lightsail/LightsailClient.php b/src/Lightsail/LightsailClient.php index 3f2627cfbf..30e3f31560 100644 --- a/src/Lightsail/LightsailClient.php +++ b/src/Lightsail/LightsailClient.php @@ -251,6 +251,8 @@ * @method \GuzzleHttp\Promise\Promise getRelationalDatabaseSnapshotsAsync(array $args = []) * @method \Aws\Result getRelationalDatabases(array $args = []) * @method \GuzzleHttp\Promise\Promise getRelationalDatabasesAsync(array $args = []) + * @method \Aws\Result getSetupHistory(array $args = []) + * @method \GuzzleHttp\Promise\Promise getSetupHistoryAsync(array $args = []) * @method \Aws\Result getStaticIp(array $args = []) * @method \GuzzleHttp\Promise\Promise getStaticIpAsync(array $args = []) * @method \Aws\Result getStaticIps(array $args = []) @@ -283,6 +285,8 @@ * @method \GuzzleHttp\Promise\Promise setIpAddressTypeAsync(array $args = []) * @method \Aws\Result setResourceAccessForBucket(array $args = []) * @method \GuzzleHttp\Promise\Promise setResourceAccessForBucketAsync(array $args = []) + * @method \Aws\Result setupInstanceHttps(array $args = []) + * @method \GuzzleHttp\Promise\Promise setupInstanceHttpsAsync(array $args = []) * @method \Aws\Result startGUISession(array $args = []) * @method \GuzzleHttp\Promise\Promise startGUISessionAsync(array $args = []) * @method \Aws\Result startInstance(array $args = []) diff --git a/src/data/config/2014-11-12/api-2.json b/src/data/config/2014-11-12/api-2.json index 923197cf03..3ad2dc13ec 100644 --- a/src/data/config/2014-11-12/api-2.json +++ b/src/data/config/2014-11-12/api-2.json @@ -5105,7 +5105,25 @@ "AWS::KafkaConnect::Connector", "AWS::Lambda::CodeSigningConfig", "AWS::NetworkManager::ConnectPeer", - "AWS::ResourceExplorer2::Index" + "AWS::ResourceExplorer2::Index", + "AWS::AppStream::Fleet", + "AWS::Cognito::UserPool", + "AWS::Cognito::UserPoolClient", + "AWS::Cognito::UserPoolGroup", + "AWS::EC2::NetworkInsightsAccessScope", + "AWS::EC2::NetworkInsightsAnalysis", + "AWS::Grafana::Workspace", + "AWS::GroundStation::DataflowEndpointGroup", + "AWS::ImageBuilder::ImageRecipe", + "AWS::KMS::Alias", + "AWS::M2::Environment", + "AWS::QuickSight::DataSource", + "AWS::QuickSight::Template", + "AWS::QuickSight::Theme", + "AWS::RDS::OptionGroup", + "AWS::Redshift::EndpointAccess", + "AWS::Route53Resolver::FirewallRuleGroup", + "AWS::SSM::Document" ] }, "ResourceTypeList":{ diff --git a/src/data/config/2014-11-12/api-2.json.php b/src/data/config/2014-11-12/api-2.json.php index a760ab9283..7607e8b872 100644 --- a/src/data/config/2014-11-12/api-2.json.php +++ b/src/data/config/2014-11-12/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2014-11-12', 'endpointPrefix' => 'config', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'Config Service', 'serviceFullName' => 'AWS Config', 'serviceId' => 'Config Service', 'signatureVersion' => 'v4', 'targetPrefix' => 'StarlingDoveService', 'uid' => 'config-2014-11-12', ], 'operations' => [ 'BatchGetAggregateResourceConfig' => [ 'name' => 'BatchGetAggregateResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchGetAggregateResourceConfigRequest', ], 'output' => [ 'shape' => 'BatchGetAggregateResourceConfigResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'BatchGetResourceConfig' => [ 'name' => 'BatchGetResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchGetResourceConfigRequest', ], 'output' => [ 'shape' => 'BatchGetResourceConfigResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], ], ], 'DeleteAggregationAuthorization' => [ 'name' => 'DeleteAggregationAuthorization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAggregationAuthorizationRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DeleteConfigRule' => [ 'name' => 'DeleteConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConfigRuleRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteConfigurationAggregator' => [ 'name' => 'DeleteConfigurationAggregator', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConfigurationAggregatorRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'DeleteConfigurationRecorder' => [ 'name' => 'DeleteConfigurationRecorder', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConfigurationRecorderRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationRecorderException', ], ], ], 'DeleteConformancePack' => [ 'name' => 'DeleteConformancePack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConformancePackRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConformancePackException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteDeliveryChannel' => [ 'name' => 'DeleteDeliveryChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDeliveryChannelRequest', ], 'errors' => [ [ 'shape' => 'NoSuchDeliveryChannelException', ], [ 'shape' => 'LastDeliveryChannelDeleteFailedException', ], ], ], 'DeleteEvaluationResults' => [ 'name' => 'DeleteEvaluationResults', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEvaluationResultsRequest', ], 'output' => [ 'shape' => 'DeleteEvaluationResultsResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteOrganizationConfigRule' => [ 'name' => 'DeleteOrganizationConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOrganizationConfigRuleRequest', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConfigRuleException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DeleteOrganizationConformancePack' => [ 'name' => 'DeleteOrganizationConformancePack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOrganizationConformancePackRequest', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConformancePackException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DeletePendingAggregationRequest' => [ 'name' => 'DeletePendingAggregationRequest', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePendingAggregationRequestRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DeleteRemediationConfiguration' => [ 'name' => 'DeleteRemediationConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRemediationConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteRemediationConfigurationResponse', ], 'errors' => [ [ 'shape' => 'NoSuchRemediationConfigurationException', ], [ 'shape' => 'RemediationInProgressException', ], [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DeleteRemediationExceptions' => [ 'name' => 'DeleteRemediationExceptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRemediationExceptionsRequest', ], 'output' => [ 'shape' => 'DeleteRemediationExceptionsResponse', ], 'errors' => [ [ 'shape' => 'NoSuchRemediationExceptionException', ], ], ], 'DeleteResourceConfig' => [ 'name' => 'DeleteResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResourceConfigRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'NoRunningConfigurationRecorderException', ], ], ], 'DeleteRetentionConfiguration' => [ 'name' => 'DeleteRetentionConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRetentionConfigurationRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchRetentionConfigurationException', ], ], ], 'DeleteStoredQuery' => [ 'name' => 'DeleteStoredQuery', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStoredQueryRequest', ], 'output' => [ 'shape' => 'DeleteStoredQueryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DeliverConfigSnapshot' => [ 'name' => 'DeliverConfigSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeliverConfigSnapshotRequest', ], 'output' => [ 'shape' => 'DeliverConfigSnapshotResponse', ], 'errors' => [ [ 'shape' => 'NoSuchDeliveryChannelException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], [ 'shape' => 'NoRunningConfigurationRecorderException', ], ], ], 'DescribeAggregateComplianceByConfigRules' => [ 'name' => 'DescribeAggregateComplianceByConfigRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAggregateComplianceByConfigRulesRequest', ], 'output' => [ 'shape' => 'DescribeAggregateComplianceByConfigRulesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'DescribeAggregateComplianceByConformancePacks' => [ 'name' => 'DescribeAggregateComplianceByConformancePacks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAggregateComplianceByConformancePacksRequest', ], 'output' => [ 'shape' => 'DescribeAggregateComplianceByConformancePacksResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'DescribeAggregationAuthorizations' => [ 'name' => 'DescribeAggregationAuthorizations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAggregationAuthorizationsRequest', ], 'output' => [ 'shape' => 'DescribeAggregationAuthorizationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], ], ], 'DescribeComplianceByConfigRule' => [ 'name' => 'DescribeComplianceByConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeComplianceByConfigRuleRequest', ], 'output' => [ 'shape' => 'DescribeComplianceByConfigRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'DescribeComplianceByResource' => [ 'name' => 'DescribeComplianceByResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeComplianceByResourceRequest', ], 'output' => [ 'shape' => 'DescribeComplianceByResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'DescribeConfigRuleEvaluationStatus' => [ 'name' => 'DescribeConfigRuleEvaluationStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigRuleEvaluationStatusRequest', ], 'output' => [ 'shape' => 'DescribeConfigRuleEvaluationStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'DescribeConfigRules' => [ 'name' => 'DescribeConfigRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigRulesRequest', ], 'output' => [ 'shape' => 'DescribeConfigRulesResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeConfigurationAggregatorSourcesStatus' => [ 'name' => 'DescribeConfigurationAggregatorSourcesStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationAggregatorSourcesStatusRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationAggregatorSourcesStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], ], ], 'DescribeConfigurationAggregators' => [ 'name' => 'DescribeConfigurationAggregators', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationAggregatorsRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationAggregatorsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], ], ], 'DescribeConfigurationRecorderStatus' => [ 'name' => 'DescribeConfigurationRecorderStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationRecorderStatusRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationRecorderStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationRecorderException', ], ], ], 'DescribeConfigurationRecorders' => [ 'name' => 'DescribeConfigurationRecorders', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationRecordersRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationRecordersResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationRecorderException', ], ], ], 'DescribeConformancePackCompliance' => [ 'name' => 'DescribeConformancePackCompliance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConformancePackComplianceRequest', ], 'output' => [ 'shape' => 'DescribeConformancePackComplianceResponse', ], 'errors' => [ [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchConfigRuleInConformancePackException', ], [ 'shape' => 'NoSuchConformancePackException', ], ], ], 'DescribeConformancePackStatus' => [ 'name' => 'DescribeConformancePackStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConformancePackStatusRequest', ], 'output' => [ 'shape' => 'DescribeConformancePackStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeConformancePacks' => [ 'name' => 'DescribeConformancePacks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConformancePacksRequest', ], 'output' => [ 'shape' => 'DescribeConformancePacksResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConformancePackException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeDeliveryChannelStatus' => [ 'name' => 'DescribeDeliveryChannelStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeliveryChannelStatusRequest', ], 'output' => [ 'shape' => 'DescribeDeliveryChannelStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchDeliveryChannelException', ], ], ], 'DescribeDeliveryChannels' => [ 'name' => 'DescribeDeliveryChannels', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeliveryChannelsRequest', ], 'output' => [ 'shape' => 'DescribeDeliveryChannelsResponse', ], 'errors' => [ [ 'shape' => 'NoSuchDeliveryChannelException', ], ], ], 'DescribeOrganizationConfigRuleStatuses' => [ 'name' => 'DescribeOrganizationConfigRuleStatuses', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrganizationConfigRuleStatusesRequest', ], 'output' => [ 'shape' => 'DescribeOrganizationConfigRuleStatusesResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConfigRuleException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DescribeOrganizationConfigRules' => [ 'name' => 'DescribeOrganizationConfigRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrganizationConfigRulesRequest', ], 'output' => [ 'shape' => 'DescribeOrganizationConfigRulesResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConfigRuleException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DescribeOrganizationConformancePackStatuses' => [ 'name' => 'DescribeOrganizationConformancePackStatuses', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrganizationConformancePackStatusesRequest', ], 'output' => [ 'shape' => 'DescribeOrganizationConformancePackStatusesResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConformancePackException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DescribeOrganizationConformancePacks' => [ 'name' => 'DescribeOrganizationConformancePacks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrganizationConformancePacksRequest', ], 'output' => [ 'shape' => 'DescribeOrganizationConformancePacksResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConformancePackException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DescribePendingAggregationRequests' => [ 'name' => 'DescribePendingAggregationRequests', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePendingAggregationRequestsRequest', ], 'output' => [ 'shape' => 'DescribePendingAggregationRequestsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], ], ], 'DescribeRemediationConfigurations' => [ 'name' => 'DescribeRemediationConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRemediationConfigurationsRequest', ], 'output' => [ 'shape' => 'DescribeRemediationConfigurationsResponse', ], ], 'DescribeRemediationExceptions' => [ 'name' => 'DescribeRemediationExceptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRemediationExceptionsRequest', ], 'output' => [ 'shape' => 'DescribeRemediationExceptionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeRemediationExecutionStatus' => [ 'name' => 'DescribeRemediationExecutionStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRemediationExecutionStatusRequest', ], 'output' => [ 'shape' => 'DescribeRemediationExecutionStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchRemediationConfigurationException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeRetentionConfigurations' => [ 'name' => 'DescribeRetentionConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRetentionConfigurationsRequest', ], 'output' => [ 'shape' => 'DescribeRetentionConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchRetentionConfigurationException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'GetAggregateComplianceDetailsByConfigRule' => [ 'name' => 'GetAggregateComplianceDetailsByConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAggregateComplianceDetailsByConfigRuleRequest', ], 'output' => [ 'shape' => 'GetAggregateComplianceDetailsByConfigRuleResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'GetAggregateConfigRuleComplianceSummary' => [ 'name' => 'GetAggregateConfigRuleComplianceSummary', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAggregateConfigRuleComplianceSummaryRequest', ], 'output' => [ 'shape' => 'GetAggregateConfigRuleComplianceSummaryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'GetAggregateConformancePackComplianceSummary' => [ 'name' => 'GetAggregateConformancePackComplianceSummary', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAggregateConformancePackComplianceSummaryRequest', ], 'output' => [ 'shape' => 'GetAggregateConformancePackComplianceSummaryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'GetAggregateDiscoveredResourceCounts' => [ 'name' => 'GetAggregateDiscoveredResourceCounts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAggregateDiscoveredResourceCountsRequest', ], 'output' => [ 'shape' => 'GetAggregateDiscoveredResourceCountsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'GetAggregateResourceConfig' => [ 'name' => 'GetAggregateResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAggregateResourceConfigRequest', ], 'output' => [ 'shape' => 'GetAggregateResourceConfigResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], [ 'shape' => 'OversizedConfigurationItemException', ], [ 'shape' => 'ResourceNotDiscoveredException', ], ], ], 'GetComplianceDetailsByConfigRule' => [ 'name' => 'GetComplianceDetailsByConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetComplianceDetailsByConfigRuleRequest', ], 'output' => [ 'shape' => 'GetComplianceDetailsByConfigRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigRuleException', ], ], ], 'GetComplianceDetailsByResource' => [ 'name' => 'GetComplianceDetailsByResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetComplianceDetailsByResourceRequest', ], 'output' => [ 'shape' => 'GetComplianceDetailsByResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], ], ], 'GetComplianceSummaryByConfigRule' => [ 'name' => 'GetComplianceSummaryByConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'output' => [ 'shape' => 'GetComplianceSummaryByConfigRuleResponse', ], ], 'GetComplianceSummaryByResourceType' => [ 'name' => 'GetComplianceSummaryByResourceType', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetComplianceSummaryByResourceTypeRequest', ], 'output' => [ 'shape' => 'GetComplianceSummaryByResourceTypeResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], ], ], 'GetConformancePackComplianceDetails' => [ 'name' => 'GetConformancePackComplianceDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetConformancePackComplianceDetailsRequest', ], 'output' => [ 'shape' => 'GetConformancePackComplianceDetailsResponse', ], 'errors' => [ [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConformancePackException', ], [ 'shape' => 'NoSuchConfigRuleInConformancePackException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'GetConformancePackComplianceSummary' => [ 'name' => 'GetConformancePackComplianceSummary', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetConformancePackComplianceSummaryRequest', ], 'output' => [ 'shape' => 'GetConformancePackComplianceSummaryResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConformancePackException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'GetCustomRulePolicy' => [ 'name' => 'GetCustomRulePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCustomRulePolicyRequest', ], 'output' => [ 'shape' => 'GetCustomRulePolicyResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], ], ], 'GetDiscoveredResourceCounts' => [ 'name' => 'GetDiscoveredResourceCounts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiscoveredResourceCountsRequest', ], 'output' => [ 'shape' => 'GetDiscoveredResourceCountsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'GetOrganizationConfigRuleDetailedStatus' => [ 'name' => 'GetOrganizationConfigRuleDetailedStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOrganizationConfigRuleDetailedStatusRequest', ], 'output' => [ 'shape' => 'GetOrganizationConfigRuleDetailedStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConfigRuleException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'GetOrganizationConformancePackDetailedStatus' => [ 'name' => 'GetOrganizationConformancePackDetailedStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOrganizationConformancePackDetailedStatusRequest', ], 'output' => [ 'shape' => 'GetOrganizationConformancePackDetailedStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConformancePackException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'GetOrganizationCustomRulePolicy' => [ 'name' => 'GetOrganizationCustomRulePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOrganizationCustomRulePolicyRequest', ], 'output' => [ 'shape' => 'GetOrganizationCustomRulePolicyResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConfigRuleException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'GetResourceConfigHistory' => [ 'name' => 'GetResourceConfigHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResourceConfigHistoryRequest', ], 'output' => [ 'shape' => 'GetResourceConfigHistoryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidTimeRangeException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], [ 'shape' => 'ResourceNotDiscoveredException', ], ], ], 'GetResourceEvaluationSummary' => [ 'name' => 'GetResourceEvaluationSummary', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResourceEvaluationSummaryRequest', ], 'output' => [ 'shape' => 'GetResourceEvaluationSummaryResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetStoredQuery' => [ 'name' => 'GetStoredQuery', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStoredQueryRequest', ], 'output' => [ 'shape' => 'GetStoredQueryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAggregateDiscoveredResources' => [ 'name' => 'ListAggregateDiscoveredResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAggregateDiscoveredResourcesRequest', ], 'output' => [ 'shape' => 'ListAggregateDiscoveredResourcesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'ListConformancePackComplianceScores' => [ 'name' => 'ListConformancePackComplianceScores', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListConformancePackComplianceScoresRequest', ], 'output' => [ 'shape' => 'ListConformancePackComplianceScoresResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'ListDiscoveredResources' => [ 'name' => 'ListDiscoveredResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDiscoveredResourcesRequest', ], 'output' => [ 'shape' => 'ListDiscoveredResourcesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], ], ], 'ListResourceEvaluations' => [ 'name' => 'ListResourceEvaluations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceEvaluationsRequest', ], 'output' => [ 'shape' => 'ListResourceEvaluationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidTimeRangeException', ], ], ], 'ListStoredQueries' => [ 'name' => 'ListStoredQueries', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStoredQueriesRequest', ], 'output' => [ 'shape' => 'ListStoredQueriesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'PutAggregationAuthorization' => [ 'name' => 'PutAggregationAuthorization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAggregationAuthorizationRequest', ], 'output' => [ 'shape' => 'PutAggregationAuthorizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], ], ], 'PutConfigRule' => [ 'name' => 'PutConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutConfigRuleRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'MaxNumberOfConfigRulesExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], ], ], 'PutConfigurationAggregator' => [ 'name' => 'PutConfigurationAggregator', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutConfigurationAggregatorRequest', ], 'output' => [ 'shape' => 'PutConfigurationAggregatorResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidRoleException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], [ 'shape' => 'NoAvailableOrganizationException', ], [ 'shape' => 'OrganizationAllFeaturesNotEnabledException', ], ], ], 'PutConfigurationRecorder' => [ 'name' => 'PutConfigurationRecorder', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutConfigurationRecorderRequest', ], 'errors' => [ [ 'shape' => 'MaxNumberOfConfigurationRecordersExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidConfigurationRecorderNameException', ], [ 'shape' => 'InvalidRoleException', ], [ 'shape' => 'InvalidRecordingGroupException', ], ], ], 'PutConformancePack' => [ 'name' => 'PutConformancePack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutConformancePackRequest', ], 'output' => [ 'shape' => 'PutConformancePackResponse', ], 'errors' => [ [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'ConformancePackTemplateValidationException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'MaxNumberOfConformancePacksExceededException', ], ], ], 'PutDeliveryChannel' => [ 'name' => 'PutDeliveryChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutDeliveryChannelRequest', ], 'errors' => [ [ 'shape' => 'MaxNumberOfDeliveryChannelsExceededException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], [ 'shape' => 'InvalidDeliveryChannelNameException', ], [ 'shape' => 'NoSuchBucketException', ], [ 'shape' => 'InvalidS3KeyPrefixException', ], [ 'shape' => 'InvalidS3KmsKeyArnException', ], [ 'shape' => 'InvalidSNSTopicARNException', ], [ 'shape' => 'InsufficientDeliveryPolicyException', ], ], ], 'PutEvaluations' => [ 'name' => 'PutEvaluations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutEvaluationsRequest', ], 'output' => [ 'shape' => 'PutEvaluationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidResultTokenException', ], [ 'shape' => 'NoSuchConfigRuleException', ], ], ], 'PutExternalEvaluation' => [ 'name' => 'PutExternalEvaluation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutExternalEvaluationRequest', ], 'output' => [ 'shape' => 'PutExternalEvaluationResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'PutOrganizationConfigRule' => [ 'name' => 'PutOrganizationConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutOrganizationConfigRuleRequest', ], 'output' => [ 'shape' => 'PutOrganizationConfigRuleResponse', ], 'errors' => [ [ 'shape' => 'MaxNumberOfOrganizationConfigRulesExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], [ 'shape' => 'NoAvailableOrganizationException', ], [ 'shape' => 'OrganizationAllFeaturesNotEnabledException', ], [ 'shape' => 'InsufficientPermissionsException', ], ], ], 'PutOrganizationConformancePack' => [ 'name' => 'PutOrganizationConformancePack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutOrganizationConformancePackRequest', ], 'output' => [ 'shape' => 'PutOrganizationConformancePackResponse', ], 'errors' => [ [ 'shape' => 'MaxNumberOfOrganizationConformancePacksExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'OrganizationConformancePackTemplateValidationException', ], [ 'shape' => 'OrganizationAllFeaturesNotEnabledException', ], [ 'shape' => 'NoAvailableOrganizationException', ], ], ], 'PutRemediationConfigurations' => [ 'name' => 'PutRemediationConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutRemediationConfigurationsRequest', ], 'output' => [ 'shape' => 'PutRemediationConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'PutRemediationExceptions' => [ 'name' => 'PutRemediationExceptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutRemediationExceptionsRequest', ], 'output' => [ 'shape' => 'PutRemediationExceptionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InsufficientPermissionsException', ], ], ], 'PutResourceConfig' => [ 'name' => 'PutResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutResourceConfigRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'NoRunningConfigurationRecorderException', ], [ 'shape' => 'MaxActiveResourcesExceededException', ], ], ], 'PutRetentionConfiguration' => [ 'name' => 'PutRetentionConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutRetentionConfigurationRequest', ], 'output' => [ 'shape' => 'PutRetentionConfigurationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'MaxNumberOfRetentionConfigurationsExceededException', ], ], ], 'PutStoredQuery' => [ 'name' => 'PutStoredQuery', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutStoredQueryRequest', ], 'output' => [ 'shape' => 'PutStoredQueryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'ResourceConcurrentModificationException', ], ], ], 'SelectAggregateResourceConfig' => [ 'name' => 'SelectAggregateResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SelectAggregateResourceConfigRequest', ], 'output' => [ 'shape' => 'SelectAggregateResourceConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidExpressionException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'SelectResourceConfig' => [ 'name' => 'SelectResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SelectResourceConfigRequest', ], 'output' => [ 'shape' => 'SelectResourceConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidExpressionException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'StartConfigRulesEvaluation' => [ 'name' => 'StartConfigRulesEvaluation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartConfigRulesEvaluationRequest', ], 'output' => [ 'shape' => 'StartConfigRulesEvaluationResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'StartConfigurationRecorder' => [ 'name' => 'StartConfigurationRecorder', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartConfigurationRecorderRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationRecorderException', ], [ 'shape' => 'NoAvailableDeliveryChannelException', ], ], ], 'StartRemediationExecution' => [ 'name' => 'StartRemediationExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartRemediationExecutionRequest', ], 'output' => [ 'shape' => 'StartRemediationExecutionResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'NoSuchRemediationConfigurationException', ], ], ], 'StartResourceEvaluation' => [ 'name' => 'StartResourceEvaluation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartResourceEvaluationRequest', ], 'output' => [ 'shape' => 'StartResourceEvaluationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'IdempotentParameterMismatch', ], ], ], 'StopConfigurationRecorder' => [ 'name' => 'StopConfigurationRecorder', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopConfigurationRecorderRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationRecorderException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], ], 'shapes' => [ 'ARN' => [ 'type' => 'string', ], 'AccountAggregationSource' => [ 'type' => 'structure', 'required' => [ 'AccountIds', ], 'members' => [ 'AccountIds' => [ 'shape' => 'AccountAggregationSourceAccountList', ], 'AllAwsRegions' => [ 'shape' => 'Boolean', ], 'AwsRegions' => [ 'shape' => 'AggregatorRegionList', ], ], ], 'AccountAggregationSourceAccountList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], 'min' => 1, ], 'AccountAggregationSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountAggregationSource', ], 'max' => 1, 'min' => 0, ], 'AccountId' => [ 'type' => 'string', 'pattern' => '\\d{12}', ], 'AggregateComplianceByConfigRule' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'Compliance' => [ 'shape' => 'Compliance', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'AggregateComplianceByConfigRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateComplianceByConfigRule', ], ], 'AggregateComplianceByConformancePack' => [ 'type' => 'structure', 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'Compliance' => [ 'shape' => 'AggregateConformancePackCompliance', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'AggregateComplianceByConformancePackList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateComplianceByConformancePack', ], ], 'AggregateComplianceCount' => [ 'type' => 'structure', 'members' => [ 'GroupName' => [ 'shape' => 'StringWithCharLimit256', ], 'ComplianceSummary' => [ 'shape' => 'ComplianceSummary', ], ], ], 'AggregateComplianceCountList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateComplianceCount', ], ], 'AggregateConformancePackCompliance' => [ 'type' => 'structure', 'members' => [ 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], 'CompliantRuleCount' => [ 'shape' => 'Integer', ], 'NonCompliantRuleCount' => [ 'shape' => 'Integer', ], 'TotalRuleCount' => [ 'shape' => 'Integer', ], ], ], 'AggregateConformancePackComplianceCount' => [ 'type' => 'structure', 'members' => [ 'CompliantConformancePackCount' => [ 'shape' => 'Integer', ], 'NonCompliantConformancePackCount' => [ 'shape' => 'Integer', ], ], ], 'AggregateConformancePackComplianceFilters' => [ 'type' => 'structure', 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'AggregateConformancePackComplianceSummary' => [ 'type' => 'structure', 'members' => [ 'ComplianceSummary' => [ 'shape' => 'AggregateConformancePackComplianceCount', ], 'GroupName' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'AggregateConformancePackComplianceSummaryFilters' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'AggregateConformancePackComplianceSummaryGroupKey' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT_ID', 'AWS_REGION', ], ], 'AggregateConformancePackComplianceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateConformancePackComplianceSummary', ], ], 'AggregateEvaluationResult' => [ 'type' => 'structure', 'members' => [ 'EvaluationResultIdentifier' => [ 'shape' => 'EvaluationResultIdentifier', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'ResultRecordedTime' => [ 'shape' => 'Date', ], 'ConfigRuleInvokedTime' => [ 'shape' => 'Date', ], 'Annotation' => [ 'shape' => 'StringWithCharLimit256', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'AggregateEvaluationResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateEvaluationResult', ], ], 'AggregateResourceIdentifier' => [ 'type' => 'structure', 'required' => [ 'SourceAccountId', 'SourceRegion', 'ResourceId', 'ResourceType', ], 'members' => [ 'SourceAccountId' => [ 'shape' => 'AccountId', ], 'SourceRegion' => [ 'shape' => 'AwsRegion', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceName' => [ 'shape' => 'ResourceName', ], ], ], 'AggregatedSourceStatus' => [ 'type' => 'structure', 'members' => [ 'SourceId' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'AggregatedSourceType', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], 'LastUpdateStatus' => [ 'shape' => 'AggregatedSourceStatusType', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], 'LastErrorCode' => [ 'shape' => 'String', ], 'LastErrorMessage' => [ 'shape' => 'String', ], ], ], 'AggregatedSourceStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregatedSourceStatus', ], ], 'AggregatedSourceStatusType' => [ 'type' => 'string', 'enum' => [ 'FAILED', 'SUCCEEDED', 'OUTDATED', ], ], 'AggregatedSourceStatusTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregatedSourceStatusType', ], 'min' => 1, ], 'AggregatedSourceType' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT', 'ORGANIZATION', ], ], 'AggregationAuthorization' => [ 'type' => 'structure', 'members' => [ 'AggregationAuthorizationArn' => [ 'shape' => 'String', ], 'AuthorizedAccountId' => [ 'shape' => 'AccountId', ], 'AuthorizedAwsRegion' => [ 'shape' => 'AwsRegion', ], 'CreationTime' => [ 'shape' => 'Date', ], ], ], 'AggregationAuthorizationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregationAuthorization', ], ], 'AggregatorRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'min' => 1, ], 'AllSupported' => [ 'type' => 'boolean', ], 'AmazonResourceName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'Annotation' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'AutoRemediationAttemptSeconds' => [ 'type' => 'long', 'box' => true, 'max' => 2678000, 'min' => 1, ], 'AutoRemediationAttempts' => [ 'type' => 'integer', 'box' => true, 'max' => 25, 'min' => 1, ], 'AvailabilityZone' => [ 'type' => 'string', ], 'AwsRegion' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'BaseConfigurationItem' => [ 'type' => 'structure', 'members' => [ 'version' => [ 'shape' => 'Version', ], 'accountId' => [ 'shape' => 'AccountId', ], 'configurationItemCaptureTime' => [ 'shape' => 'ConfigurationItemCaptureTime', ], 'configurationItemStatus' => [ 'shape' => 'ConfigurationItemStatus', ], 'configurationStateId' => [ 'shape' => 'ConfigurationStateId', ], 'arn' => [ 'shape' => 'ARN', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'availabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'resourceCreationTime' => [ 'shape' => 'ResourceCreationTime', ], 'configuration' => [ 'shape' => 'Configuration', ], 'supplementaryConfiguration' => [ 'shape' => 'SupplementaryConfiguration', ], 'recordingFrequency' => [ 'shape' => 'RecordingFrequency', ], 'configurationItemDeliveryTime' => [ 'shape' => 'ConfigurationItemDeliveryTime', ], ], ], 'BaseConfigurationItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'BaseConfigurationItem', ], ], 'BaseResourceId' => [ 'type' => 'string', 'max' => 768, 'min' => 1, ], 'BatchGetAggregateResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', 'ResourceIdentifiers', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'ResourceIdentifiers' => [ 'shape' => 'ResourceIdentifiersList', ], ], ], 'BatchGetAggregateResourceConfigResponse' => [ 'type' => 'structure', 'members' => [ 'BaseConfigurationItems' => [ 'shape' => 'BaseConfigurationItems', ], 'UnprocessedResourceIdentifiers' => [ 'shape' => 'UnprocessedResourceIdentifierList', ], ], ], 'BatchGetResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'resourceKeys', ], 'members' => [ 'resourceKeys' => [ 'shape' => 'ResourceKeys', ], ], ], 'BatchGetResourceConfigResponse' => [ 'type' => 'structure', 'members' => [ 'baseConfigurationItems' => [ 'shape' => 'BaseConfigurationItems', ], 'unprocessedResourceKeys' => [ 'shape' => 'ResourceKeys', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'ChannelName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ChronologicalOrder' => [ 'type' => 'string', 'enum' => [ 'Reverse', 'Forward', ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 256, 'min' => 64, ], 'Compliance' => [ 'type' => 'structure', 'members' => [ 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'ComplianceContributorCount' => [ 'shape' => 'ComplianceContributorCount', ], ], ], 'ComplianceByConfigRule' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'StringWithCharLimit64', ], 'Compliance' => [ 'shape' => 'Compliance', ], ], ], 'ComplianceByConfigRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceByConfigRule', ], ], 'ComplianceByResource' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'BaseResourceId', ], 'Compliance' => [ 'shape' => 'Compliance', ], ], ], 'ComplianceByResources' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceByResource', ], ], 'ComplianceContributorCount' => [ 'type' => 'structure', 'members' => [ 'CappedCount' => [ 'shape' => 'Integer', ], 'CapExceeded' => [ 'shape' => 'Boolean', ], ], ], 'ComplianceResourceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit256', ], 'max' => 100, 'min' => 0, ], 'ComplianceScore' => [ 'type' => 'string', ], 'ComplianceSummariesByResourceType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceSummaryByResourceType', ], ], 'ComplianceSummary' => [ 'type' => 'structure', 'members' => [ 'CompliantResourceCount' => [ 'shape' => 'ComplianceContributorCount', ], 'NonCompliantResourceCount' => [ 'shape' => 'ComplianceContributorCount', ], 'ComplianceSummaryTimestamp' => [ 'shape' => 'Date', ], ], ], 'ComplianceSummaryByResourceType' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ComplianceSummary' => [ 'shape' => 'ComplianceSummary', ], ], ], 'ComplianceType' => [ 'type' => 'string', 'enum' => [ 'COMPLIANT', 'NON_COMPLIANT', 'NOT_APPLICABLE', 'INSUFFICIENT_DATA', ], ], 'ComplianceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceType', ], 'max' => 3, 'min' => 0, ], 'ConfigExportDeliveryInfo' => [ 'type' => 'structure', 'members' => [ 'lastStatus' => [ 'shape' => 'DeliveryStatus', ], 'lastErrorCode' => [ 'shape' => 'String', ], 'lastErrorMessage' => [ 'shape' => 'String', ], 'lastAttemptTime' => [ 'shape' => 'Date', ], 'lastSuccessfulTime' => [ 'shape' => 'Date', ], 'nextDeliveryTime' => [ 'shape' => 'Date', ], ], ], 'ConfigRule' => [ 'type' => 'structure', 'required' => [ 'Source', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ConfigRuleArn' => [ 'shape' => 'StringWithCharLimit256', ], 'ConfigRuleId' => [ 'shape' => 'StringWithCharLimit64', ], 'Description' => [ 'shape' => 'EmptiableStringWithCharLimit256', ], 'Scope' => [ 'shape' => 'Scope', ], 'Source' => [ 'shape' => 'Source', ], 'InputParameters' => [ 'shape' => 'StringWithCharLimit1024', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], 'ConfigRuleState' => [ 'shape' => 'ConfigRuleState', ], 'CreatedBy' => [ 'shape' => 'StringWithCharLimit256', ], 'EvaluationModes' => [ 'shape' => 'EvaluationModes', ], ], ], 'ConfigRuleComplianceFilters' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'ConfigRuleComplianceSummaryFilters' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'ConfigRuleComplianceSummaryGroupKey' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT_ID', 'AWS_REGION', ], ], 'ConfigRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ConfigRuleArn' => [ 'shape' => 'String', ], 'ConfigRuleId' => [ 'shape' => 'String', ], 'LastSuccessfulInvocationTime' => [ 'shape' => 'Date', ], 'LastFailedInvocationTime' => [ 'shape' => 'Date', ], 'LastSuccessfulEvaluationTime' => [ 'shape' => 'Date', ], 'LastFailedEvaluationTime' => [ 'shape' => 'Date', ], 'FirstActivatedTime' => [ 'shape' => 'Date', ], 'LastDeactivatedTime' => [ 'shape' => 'Date', ], 'LastErrorCode' => [ 'shape' => 'String', ], 'LastErrorMessage' => [ 'shape' => 'String', ], 'FirstEvaluationStarted' => [ 'shape' => 'Boolean', ], 'LastDebugLogDeliveryStatus' => [ 'shape' => 'String', ], 'LastDebugLogDeliveryStatusReason' => [ 'shape' => 'String', ], 'LastDebugLogDeliveryTime' => [ 'shape' => 'Date', ], ], ], 'ConfigRuleEvaluationStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigRuleEvaluationStatus', ], ], 'ConfigRuleName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ConfigRuleNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigRuleName', ], 'max' => 25, 'min' => 0, ], 'ConfigRuleState' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETING', 'DELETING_RESULTS', 'EVALUATING', ], ], 'ConfigRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigRule', ], ], 'ConfigSnapshotDeliveryProperties' => [ 'type' => 'structure', 'members' => [ 'deliveryFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], ], ], 'ConfigStreamDeliveryInfo' => [ 'type' => 'structure', 'members' => [ 'lastStatus' => [ 'shape' => 'DeliveryStatus', ], 'lastErrorCode' => [ 'shape' => 'String', ], 'lastErrorMessage' => [ 'shape' => 'String', ], 'lastStatusChangeTime' => [ 'shape' => 'Date', ], ], ], 'Configuration' => [ 'type' => 'string', ], 'ConfigurationAggregator' => [ 'type' => 'structure', 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'ConfigurationAggregatorArn' => [ 'shape' => 'ConfigurationAggregatorArn', ], 'AccountAggregationSources' => [ 'shape' => 'AccountAggregationSourceList', ], 'OrganizationAggregationSource' => [ 'shape' => 'OrganizationAggregationSource', ], 'CreationTime' => [ 'shape' => 'Date', ], 'LastUpdatedTime' => [ 'shape' => 'Date', ], 'CreatedBy' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'ConfigurationAggregatorArn' => [ 'type' => 'string', 'pattern' => 'arn:aws[a-z\\-]*:config:[a-z\\-\\d]+:\\d+:config-aggregator/config-aggregator-[a-z\\d]+', ], 'ConfigurationAggregatorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationAggregator', ], ], 'ConfigurationAggregatorName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\w\\-]+', ], 'ConfigurationAggregatorNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationAggregatorName', ], 'max' => 10, 'min' => 0, ], 'ConfigurationItem' => [ 'type' => 'structure', 'members' => [ 'version' => [ 'shape' => 'Version', ], 'accountId' => [ 'shape' => 'AccountId', ], 'configurationItemCaptureTime' => [ 'shape' => 'ConfigurationItemCaptureTime', ], 'configurationItemStatus' => [ 'shape' => 'ConfigurationItemStatus', ], 'configurationStateId' => [ 'shape' => 'ConfigurationStateId', ], 'configurationItemMD5Hash' => [ 'shape' => 'ConfigurationItemMD5Hash', ], 'arn' => [ 'shape' => 'ARN', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'availabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'resourceCreationTime' => [ 'shape' => 'ResourceCreationTime', ], 'tags' => [ 'shape' => 'Tags', ], 'relatedEvents' => [ 'shape' => 'RelatedEventList', ], 'relationships' => [ 'shape' => 'RelationshipList', ], 'configuration' => [ 'shape' => 'Configuration', ], 'supplementaryConfiguration' => [ 'shape' => 'SupplementaryConfiguration', ], 'recordingFrequency' => [ 'shape' => 'RecordingFrequency', ], 'configurationItemDeliveryTime' => [ 'shape' => 'ConfigurationItemDeliveryTime', ], ], ], 'ConfigurationItemCaptureTime' => [ 'type' => 'timestamp', ], 'ConfigurationItemDeliveryTime' => [ 'type' => 'timestamp', ], 'ConfigurationItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationItem', ], ], 'ConfigurationItemMD5Hash' => [ 'type' => 'string', ], 'ConfigurationItemStatus' => [ 'type' => 'string', 'enum' => [ 'OK', 'ResourceDiscovered', 'ResourceNotRecorded', 'ResourceDeleted', 'ResourceDeletedNotRecorded', ], ], 'ConfigurationRecorder' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RecorderName', ], 'roleARN' => [ 'shape' => 'String', ], 'recordingGroup' => [ 'shape' => 'RecordingGroup', ], 'recordingMode' => [ 'shape' => 'RecordingMode', ], ], ], 'ConfigurationRecorderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationRecorder', ], ], 'ConfigurationRecorderNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecorderName', ], ], 'ConfigurationRecorderStatus' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'lastStartTime' => [ 'shape' => 'Date', ], 'lastStopTime' => [ 'shape' => 'Date', ], 'recording' => [ 'shape' => 'Boolean', ], 'lastStatus' => [ 'shape' => 'RecorderStatus', ], 'lastErrorCode' => [ 'shape' => 'String', ], 'lastErrorMessage' => [ 'shape' => 'String', ], 'lastStatusChangeTime' => [ 'shape' => 'Date', ], ], ], 'ConfigurationRecorderStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationRecorderStatus', ], ], 'ConfigurationStateId' => [ 'type' => 'string', ], 'ConformancePackArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'ConformancePackComplianceFilters' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConformancePackConfigRuleNames', ], 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], ], ], 'ConformancePackComplianceResourceIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit256', ], 'max' => 5, 'min' => 0, ], 'ConformancePackComplianceScore' => [ 'type' => 'structure', 'members' => [ 'Score' => [ 'shape' => 'ComplianceScore', ], 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'LastUpdatedTime' => [ 'shape' => 'LastUpdatedTime', ], ], ], 'ConformancePackComplianceScores' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackComplianceScore', ], ], 'ConformancePackComplianceScoresFilters' => [ 'type' => 'structure', 'required' => [ 'ConformancePackNames', ], 'members' => [ 'ConformancePackNames' => [ 'shape' => 'ConformancePackNameFilter', ], ], ], 'ConformancePackComplianceSummary' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', 'ConformancePackComplianceStatus', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ConformancePackComplianceStatus' => [ 'shape' => 'ConformancePackComplianceType', ], ], ], 'ConformancePackComplianceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackComplianceSummary', ], 'max' => 5, 'min' => 1, ], 'ConformancePackComplianceType' => [ 'type' => 'string', 'enum' => [ 'COMPLIANT', 'NON_COMPLIANT', 'INSUFFICIENT_DATA', ], ], 'ConformancePackConfigRuleNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit64', ], 'max' => 10, 'min' => 0, ], 'ConformancePackDetail' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', 'ConformancePackArn', 'ConformancePackId', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ConformancePackArn' => [ 'shape' => 'ConformancePackArn', ], 'ConformancePackId' => [ 'shape' => 'ConformancePackId', ], 'DeliveryS3Bucket' => [ 'shape' => 'DeliveryS3Bucket', ], 'DeliveryS3KeyPrefix' => [ 'shape' => 'DeliveryS3KeyPrefix', ], 'ConformancePackInputParameters' => [ 'shape' => 'ConformancePackInputParameters', ], 'LastUpdateRequestedTime' => [ 'shape' => 'Date', ], 'CreatedBy' => [ 'shape' => 'StringWithCharLimit256', ], 'TemplateSSMDocumentDetails' => [ 'shape' => 'TemplateSSMDocumentDetails', ], ], ], 'ConformancePackDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackDetail', ], 'max' => 25, 'min' => 0, ], 'ConformancePackEvaluationFilters' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConformancePackConfigRuleNames', ], 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceIds' => [ 'shape' => 'ConformancePackComplianceResourceIds', ], ], ], 'ConformancePackEvaluationResult' => [ 'type' => 'structure', 'required' => [ 'ComplianceType', 'EvaluationResultIdentifier', 'ConfigRuleInvokedTime', 'ResultRecordedTime', ], 'members' => [ 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], 'EvaluationResultIdentifier' => [ 'shape' => 'EvaluationResultIdentifier', ], 'ConfigRuleInvokedTime' => [ 'shape' => 'Date', ], 'ResultRecordedTime' => [ 'shape' => 'Date', ], 'Annotation' => [ 'shape' => 'Annotation', ], ], ], 'ConformancePackId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ConformancePackInputParameter' => [ 'type' => 'structure', 'required' => [ 'ParameterName', 'ParameterValue', ], 'members' => [ 'ParameterName' => [ 'shape' => 'ParameterName', ], 'ParameterValue' => [ 'shape' => 'ParameterValue', ], ], ], 'ConformancePackInputParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackInputParameter', ], 'max' => 60, 'min' => 0, ], 'ConformancePackName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z][-a-zA-Z0-9]*', ], 'ConformancePackNameFilter' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackName', ], 'max' => 25, 'min' => 1, ], 'ConformancePackNamesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackName', ], 'max' => 25, 'min' => 0, ], 'ConformancePackNamesToSummarizeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackName', ], 'max' => 5, 'min' => 1, ], 'ConformancePackRuleCompliance' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], 'Controls' => [ 'shape' => 'ControlsList', ], ], ], 'ConformancePackRuleComplianceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackRuleCompliance', ], 'max' => 1000, 'min' => 0, ], 'ConformancePackRuleEvaluationResultsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackEvaluationResult', ], 'max' => 100, 'min' => 0, ], 'ConformancePackState' => [ 'type' => 'string', 'enum' => [ 'CREATE_IN_PROGRESS', 'CREATE_COMPLETE', 'CREATE_FAILED', 'DELETE_IN_PROGRESS', 'DELETE_FAILED', ], ], 'ConformancePackStatusDetail' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', 'ConformancePackId', 'ConformancePackArn', 'ConformancePackState', 'StackArn', 'LastUpdateRequestedTime', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ConformancePackId' => [ 'shape' => 'ConformancePackId', ], 'ConformancePackArn' => [ 'shape' => 'ConformancePackArn', ], 'ConformancePackState' => [ 'shape' => 'ConformancePackState', ], 'StackArn' => [ 'shape' => 'StackArn', ], 'ConformancePackStatusReason' => [ 'shape' => 'ConformancePackStatusReason', ], 'LastUpdateRequestedTime' => [ 'shape' => 'Date', ], 'LastUpdateCompletedTime' => [ 'shape' => 'Date', ], ], ], 'ConformancePackStatusDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackStatusDetail', ], 'max' => 25, 'min' => 0, ], 'ConformancePackStatusReason' => [ 'type' => 'string', 'max' => 2000, 'min' => 0, ], 'ConformancePackTemplateValidationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ControlsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit128', ], 'max' => 20, 'min' => 0, ], 'CosmosPageLimit' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'CustomPolicyDetails' => [ 'type' => 'structure', 'required' => [ 'PolicyRuntime', 'PolicyText', ], 'members' => [ 'PolicyRuntime' => [ 'shape' => 'PolicyRuntime', ], 'PolicyText' => [ 'shape' => 'PolicyText', ], 'EnableDebugLogDelivery' => [ 'shape' => 'Boolean', ], ], ], 'Date' => [ 'type' => 'timestamp', ], 'DebugLogDeliveryAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], 'max' => 1000, 'min' => 0, ], 'DeleteAggregationAuthorizationRequest' => [ 'type' => 'structure', 'required' => [ 'AuthorizedAccountId', 'AuthorizedAwsRegion', ], 'members' => [ 'AuthorizedAccountId' => [ 'shape' => 'AccountId', ], 'AuthorizedAwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'DeleteConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], ], ], 'DeleteConfigurationAggregatorRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], ], ], 'DeleteConfigurationRecorderRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationRecorderName', ], 'members' => [ 'ConfigurationRecorderName' => [ 'shape' => 'RecorderName', ], ], ], 'DeleteConformancePackRequest' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], ], ], 'DeleteDeliveryChannelRequest' => [ 'type' => 'structure', 'required' => [ 'DeliveryChannelName', ], 'members' => [ 'DeliveryChannelName' => [ 'shape' => 'ChannelName', ], ], ], 'DeleteEvaluationResultsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'StringWithCharLimit64', ], ], ], 'DeleteEvaluationResultsResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteOrganizationConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], ], ], 'DeleteOrganizationConformancePackRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConformancePackName', ], 'members' => [ 'OrganizationConformancePackName' => [ 'shape' => 'OrganizationConformancePackName', ], ], ], 'DeletePendingAggregationRequestRequest' => [ 'type' => 'structure', 'required' => [ 'RequesterAccountId', 'RequesterAwsRegion', ], 'members' => [ 'RequesterAccountId' => [ 'shape' => 'AccountId', ], 'RequesterAwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'DeleteRemediationConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceType' => [ 'shape' => 'String', ], ], ], 'DeleteRemediationConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRemediationExceptionsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'ResourceKeys', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceKeys' => [ 'shape' => 'RemediationExceptionResourceKeys', ], ], ], 'DeleteRemediationExceptionsResponse' => [ 'type' => 'structure', 'members' => [ 'FailedBatches' => [ 'shape' => 'FailedDeleteRemediationExceptionsBatches', ], ], ], 'DeleteResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceType', 'ResourceId', ], 'members' => [ 'ResourceType' => [ 'shape' => 'ResourceTypeString', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteRetentionConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'RetentionConfigurationName', ], 'members' => [ 'RetentionConfigurationName' => [ 'shape' => 'RetentionConfigurationName', ], ], ], 'DeleteStoredQueryRequest' => [ 'type' => 'structure', 'required' => [ 'QueryName', ], 'members' => [ 'QueryName' => [ 'shape' => 'QueryName', ], ], ], 'DeleteStoredQueryResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeliverConfigSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'deliveryChannelName', ], 'members' => [ 'deliveryChannelName' => [ 'shape' => 'ChannelName', ], ], ], 'DeliverConfigSnapshotResponse' => [ 'type' => 'structure', 'members' => [ 'configSnapshotId' => [ 'shape' => 'String', ], ], ], 'DeliveryChannel' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ChannelName', ], 's3BucketName' => [ 'shape' => 'String', ], 's3KeyPrefix' => [ 'shape' => 'String', ], 's3KmsKeyArn' => [ 'shape' => 'String', ], 'snsTopicARN' => [ 'shape' => 'String', ], 'configSnapshotDeliveryProperties' => [ 'shape' => 'ConfigSnapshotDeliveryProperties', ], ], ], 'DeliveryChannelList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeliveryChannel', ], ], 'DeliveryChannelNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelName', ], ], 'DeliveryChannelStatus' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'configSnapshotDeliveryInfo' => [ 'shape' => 'ConfigExportDeliveryInfo', ], 'configHistoryDeliveryInfo' => [ 'shape' => 'ConfigExportDeliveryInfo', ], 'configStreamDeliveryInfo' => [ 'shape' => 'ConfigStreamDeliveryInfo', ], ], ], 'DeliveryChannelStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeliveryChannelStatus', ], ], 'DeliveryS3Bucket' => [ 'type' => 'string', 'max' => 63, 'min' => 0, ], 'DeliveryS3KeyPrefix' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'DeliveryStatus' => [ 'type' => 'string', 'enum' => [ 'Success', 'Failure', 'Not_Applicable', ], ], 'DescribeAggregateComplianceByConfigRulesRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Filters' => [ 'shape' => 'ConfigRuleComplianceFilters', ], 'Limit' => [ 'shape' => 'GroupByAPILimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAggregateComplianceByConfigRulesResponse' => [ 'type' => 'structure', 'members' => [ 'AggregateComplianceByConfigRules' => [ 'shape' => 'AggregateComplianceByConfigRuleList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAggregateComplianceByConformancePacksRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Filters' => [ 'shape' => 'AggregateConformancePackComplianceFilters', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAggregateComplianceByConformancePacksResponse' => [ 'type' => 'structure', 'members' => [ 'AggregateComplianceByConformancePacks' => [ 'shape' => 'AggregateComplianceByConformancePackList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAggregationAuthorizationsRequest' => [ 'type' => 'structure', 'members' => [ 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeAggregationAuthorizationsResponse' => [ 'type' => 'structure', 'members' => [ 'AggregationAuthorizations' => [ 'shape' => 'AggregationAuthorizationList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeComplianceByConfigRuleRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConfigRuleNames', ], 'ComplianceTypes' => [ 'shape' => 'ComplianceTypes', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeComplianceByConfigRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ComplianceByConfigRules' => [ 'shape' => 'ComplianceByConfigRules', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeComplianceByResourceRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'BaseResourceId', ], 'ComplianceTypes' => [ 'shape' => 'ComplianceTypes', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeComplianceByResourceResponse' => [ 'type' => 'structure', 'members' => [ 'ComplianceByResources' => [ 'shape' => 'ComplianceByResources', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConfigRuleEvaluationStatusRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConfigRuleNames', ], 'NextToken' => [ 'shape' => 'String', ], 'Limit' => [ 'shape' => 'RuleLimit', ], ], ], 'DescribeConfigRuleEvaluationStatusResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigRulesEvaluationStatus' => [ 'shape' => 'ConfigRuleEvaluationStatusList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeConfigRulesFilters' => [ 'type' => 'structure', 'members' => [ 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], ], ], 'DescribeConfigRulesRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConfigRuleNames', ], 'NextToken' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'DescribeConfigRulesFilters', ], ], ], 'DescribeConfigRulesResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigRules' => [ 'shape' => 'ConfigRules', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeConfigurationAggregatorSourcesStatusRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'UpdateStatus' => [ 'shape' => 'AggregatedSourceStatusTypeList', ], 'NextToken' => [ 'shape' => 'String', ], 'Limit' => [ 'shape' => 'Limit', ], ], ], 'DescribeConfigurationAggregatorSourcesStatusResponse' => [ 'type' => 'structure', 'members' => [ 'AggregatedSourceStatusList' => [ 'shape' => 'AggregatedSourceStatusList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeConfigurationAggregatorsRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigurationAggregatorNames' => [ 'shape' => 'ConfigurationAggregatorNameList', ], 'NextToken' => [ 'shape' => 'String', ], 'Limit' => [ 'shape' => 'Limit', ], ], ], 'DescribeConfigurationAggregatorsResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigurationAggregators' => [ 'shape' => 'ConfigurationAggregatorList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeConfigurationRecorderStatusRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigurationRecorderNames' => [ 'shape' => 'ConfigurationRecorderNameList', ], ], ], 'DescribeConfigurationRecorderStatusResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigurationRecordersStatus' => [ 'shape' => 'ConfigurationRecorderStatusList', ], ], ], 'DescribeConfigurationRecordersRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigurationRecorderNames' => [ 'shape' => 'ConfigurationRecorderNameList', ], ], ], 'DescribeConfigurationRecordersResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigurationRecorders' => [ 'shape' => 'ConfigurationRecorderList', ], ], ], 'DescribeConformancePackComplianceLimit' => [ 'type' => 'integer', 'max' => 1000, 'min' => 0, ], 'DescribeConformancePackComplianceRequest' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'Filters' => [ 'shape' => 'ConformancePackComplianceFilters', ], 'Limit' => [ 'shape' => 'DescribeConformancePackComplianceLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConformancePackComplianceResponse' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', 'ConformancePackRuleComplianceList', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ConformancePackRuleComplianceList' => [ 'shape' => 'ConformancePackRuleComplianceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConformancePackStatusRequest' => [ 'type' => 'structure', 'members' => [ 'ConformancePackNames' => [ 'shape' => 'ConformancePackNamesList', ], 'Limit' => [ 'shape' => 'PageSizeLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConformancePackStatusResponse' => [ 'type' => 'structure', 'members' => [ 'ConformancePackStatusDetails' => [ 'shape' => 'ConformancePackStatusDetailsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConformancePacksRequest' => [ 'type' => 'structure', 'members' => [ 'ConformancePackNames' => [ 'shape' => 'ConformancePackNamesList', ], 'Limit' => [ 'shape' => 'PageSizeLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConformancePacksResponse' => [ 'type' => 'structure', 'members' => [ 'ConformancePackDetails' => [ 'shape' => 'ConformancePackDetailList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeDeliveryChannelStatusRequest' => [ 'type' => 'structure', 'members' => [ 'DeliveryChannelNames' => [ 'shape' => 'DeliveryChannelNameList', ], ], ], 'DescribeDeliveryChannelStatusResponse' => [ 'type' => 'structure', 'members' => [ 'DeliveryChannelsStatus' => [ 'shape' => 'DeliveryChannelStatusList', ], ], ], 'DescribeDeliveryChannelsRequest' => [ 'type' => 'structure', 'members' => [ 'DeliveryChannelNames' => [ 'shape' => 'DeliveryChannelNameList', ], ], ], 'DescribeDeliveryChannelsResponse' => [ 'type' => 'structure', 'members' => [ 'DeliveryChannels' => [ 'shape' => 'DeliveryChannelList', ], ], ], 'DescribeOrganizationConfigRuleStatusesRequest' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRuleNames' => [ 'shape' => 'OrganizationConfigRuleNames', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConfigRuleStatusesResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRuleStatuses' => [ 'shape' => 'OrganizationConfigRuleStatuses', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConfigRulesRequest' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRuleNames' => [ 'shape' => 'OrganizationConfigRuleNames', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConfigRulesResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRules' => [ 'shape' => 'OrganizationConfigRules', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConformancePackStatusesRequest' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePackNames' => [ 'shape' => 'OrganizationConformancePackNames', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConformancePackStatusesResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePackStatuses' => [ 'shape' => 'OrganizationConformancePackStatuses', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConformancePacksRequest' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePackNames' => [ 'shape' => 'OrganizationConformancePackNames', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConformancePacksResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePacks' => [ 'shape' => 'OrganizationConformancePacks', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribePendingAggregationRequestsLimit' => [ 'type' => 'integer', 'max' => 20, 'min' => 0, ], 'DescribePendingAggregationRequestsRequest' => [ 'type' => 'structure', 'members' => [ 'Limit' => [ 'shape' => 'DescribePendingAggregationRequestsLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribePendingAggregationRequestsResponse' => [ 'type' => 'structure', 'members' => [ 'PendingAggregationRequests' => [ 'shape' => 'PendingAggregationRequestList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeRemediationConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleNames', ], 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConfigRuleNames', ], ], ], 'DescribeRemediationConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'RemediationConfigurations' => [ 'shape' => 'RemediationConfigurations', ], ], ], 'DescribeRemediationExceptionsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceKeys' => [ 'shape' => 'RemediationExceptionResourceKeys', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeRemediationExceptionsResponse' => [ 'type' => 'structure', 'members' => [ 'RemediationExceptions' => [ 'shape' => 'RemediationExceptions', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeRemediationExecutionStatusRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceKeys' => [ 'shape' => 'ResourceKeys', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeRemediationExecutionStatusResponse' => [ 'type' => 'structure', 'members' => [ 'RemediationExecutionStatuses' => [ 'shape' => 'RemediationExecutionStatuses', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeRetentionConfigurationsRequest' => [ 'type' => 'structure', 'members' => [ 'RetentionConfigurationNames' => [ 'shape' => 'RetentionConfigurationNameList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRetentionConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'RetentionConfigurations' => [ 'shape' => 'RetentionConfigurationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'DiscoveredResourceIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateResourceIdentifier', ], ], 'EarlierTime' => [ 'type' => 'timestamp', ], 'EmptiableStringWithCharLimit256' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'ErrorMessage' => [ 'type' => 'string', ], 'Evaluation' => [ 'type' => 'structure', 'required' => [ 'ComplianceResourceType', 'ComplianceResourceId', 'ComplianceType', 'OrderingTimestamp', ], 'members' => [ 'ComplianceResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ComplianceResourceId' => [ 'shape' => 'BaseResourceId', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'Annotation' => [ 'shape' => 'StringWithCharLimit256', ], 'OrderingTimestamp' => [ 'shape' => 'OrderingTimestamp', ], ], ], 'EvaluationContext' => [ 'type' => 'structure', 'members' => [ 'EvaluationContextIdentifier' => [ 'shape' => 'EvaluationContextIdentifier', ], ], ], 'EvaluationContextIdentifier' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'EvaluationMode' => [ 'type' => 'string', 'enum' => [ 'DETECTIVE', 'PROACTIVE', ], ], 'EvaluationModeConfiguration' => [ 'type' => 'structure', 'members' => [ 'Mode' => [ 'shape' => 'EvaluationMode', ], ], ], 'EvaluationModes' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationModeConfiguration', ], ], 'EvaluationResult' => [ 'type' => 'structure', 'members' => [ 'EvaluationResultIdentifier' => [ 'shape' => 'EvaluationResultIdentifier', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'ResultRecordedTime' => [ 'shape' => 'Date', ], 'ConfigRuleInvokedTime' => [ 'shape' => 'Date', ], 'Annotation' => [ 'shape' => 'StringWithCharLimit256', ], 'ResultToken' => [ 'shape' => 'String', ], ], ], 'EvaluationResultIdentifier' => [ 'type' => 'structure', 'members' => [ 'EvaluationResultQualifier' => [ 'shape' => 'EvaluationResultQualifier', ], 'OrderingTimestamp' => [ 'shape' => 'Date', ], 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], ], ], 'EvaluationResultQualifier' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'BaseResourceId', ], 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], ], ], 'EvaluationResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationResult', ], ], 'EvaluationStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'ResourceEvaluationStatus', ], 'FailureReason' => [ 'shape' => 'StringWithCharLimit1024', ], ], ], 'EvaluationTimeout' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'Evaluations' => [ 'type' => 'list', 'member' => [ 'shape' => 'Evaluation', ], 'max' => 100, 'min' => 0, ], 'EventSource' => [ 'type' => 'string', 'enum' => [ 'aws.config', ], ], 'ExcludedAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], 'max' => 1000, 'min' => 0, ], 'ExclusionByResourceTypes' => [ 'type' => 'structure', 'members' => [ 'resourceTypes' => [ 'shape' => 'ResourceTypeList', ], ], ], 'ExecutionControls' => [ 'type' => 'structure', 'members' => [ 'SsmControls' => [ 'shape' => 'SsmControls', ], ], ], 'Expression' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, ], 'ExternalEvaluation' => [ 'type' => 'structure', 'required' => [ 'ComplianceResourceType', 'ComplianceResourceId', 'ComplianceType', 'OrderingTimestamp', ], 'members' => [ 'ComplianceResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ComplianceResourceId' => [ 'shape' => 'BaseResourceId', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'Annotation' => [ 'shape' => 'StringWithCharLimit256', ], 'OrderingTimestamp' => [ 'shape' => 'OrderingTimestamp', ], ], ], 'FailedDeleteRemediationExceptionsBatch' => [ 'type' => 'structure', 'members' => [ 'FailureMessage' => [ 'shape' => 'String', ], 'FailedItems' => [ 'shape' => 'RemediationExceptionResourceKeys', ], ], ], 'FailedDeleteRemediationExceptionsBatches' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedDeleteRemediationExceptionsBatch', ], ], 'FailedRemediationBatch' => [ 'type' => 'structure', 'members' => [ 'FailureMessage' => [ 'shape' => 'String', ], 'FailedItems' => [ 'shape' => 'RemediationConfigurations', ], ], ], 'FailedRemediationBatches' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedRemediationBatch', ], ], 'FailedRemediationExceptionBatch' => [ 'type' => 'structure', 'members' => [ 'FailureMessage' => [ 'shape' => 'String', ], 'FailedItems' => [ 'shape' => 'RemediationExceptions', ], ], ], 'FailedRemediationExceptionBatches' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedRemediationExceptionBatch', ], ], 'FieldInfo' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'FieldName', ], ], ], 'FieldInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldInfo', ], ], 'FieldName' => [ 'type' => 'string', ], 'GetAggregateComplianceDetailsByConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', 'ConfigRuleName', 'AccountId', 'AwsRegion', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateComplianceDetailsByConfigRuleResponse' => [ 'type' => 'structure', 'members' => [ 'AggregateEvaluationResults' => [ 'shape' => 'AggregateEvaluationResultList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateConfigRuleComplianceSummaryRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Filters' => [ 'shape' => 'ConfigRuleComplianceSummaryFilters', ], 'GroupByKey' => [ 'shape' => 'ConfigRuleComplianceSummaryGroupKey', ], 'Limit' => [ 'shape' => 'GroupByAPILimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateConfigRuleComplianceSummaryResponse' => [ 'type' => 'structure', 'members' => [ 'GroupByKey' => [ 'shape' => 'StringWithCharLimit256', ], 'AggregateComplianceCounts' => [ 'shape' => 'AggregateComplianceCountList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateConformancePackComplianceSummaryRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Filters' => [ 'shape' => 'AggregateConformancePackComplianceSummaryFilters', ], 'GroupByKey' => [ 'shape' => 'AggregateConformancePackComplianceSummaryGroupKey', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateConformancePackComplianceSummaryResponse' => [ 'type' => 'structure', 'members' => [ 'AggregateConformancePackComplianceSummaries' => [ 'shape' => 'AggregateConformancePackComplianceSummaryList', ], 'GroupByKey' => [ 'shape' => 'StringWithCharLimit256', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateDiscoveredResourceCountsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Filters' => [ 'shape' => 'ResourceCountFilters', ], 'GroupByKey' => [ 'shape' => 'ResourceCountGroupKey', ], 'Limit' => [ 'shape' => 'GroupByAPILimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateDiscoveredResourceCountsResponse' => [ 'type' => 'structure', 'required' => [ 'TotalDiscoveredResources', ], 'members' => [ 'TotalDiscoveredResources' => [ 'shape' => 'Long', ], 'GroupByKey' => [ 'shape' => 'StringWithCharLimit256', ], 'GroupedResourceCounts' => [ 'shape' => 'GroupedResourceCountList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', 'ResourceIdentifier', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'ResourceIdentifier' => [ 'shape' => 'AggregateResourceIdentifier', ], ], ], 'GetAggregateResourceConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigurationItem' => [ 'shape' => 'ConfigurationItem', ], ], ], 'GetComplianceDetailsByConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'StringWithCharLimit64', ], 'ComplianceTypes' => [ 'shape' => 'ComplianceTypes', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetComplianceDetailsByConfigRuleResponse' => [ 'type' => 'structure', 'members' => [ 'EvaluationResults' => [ 'shape' => 'EvaluationResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetComplianceDetailsByResourceRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'BaseResourceId', ], 'ComplianceTypes' => [ 'shape' => 'ComplianceTypes', ], 'NextToken' => [ 'shape' => 'String', ], 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], ], ], 'GetComplianceDetailsByResourceResponse' => [ 'type' => 'structure', 'members' => [ 'EvaluationResults' => [ 'shape' => 'EvaluationResults', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetComplianceSummaryByConfigRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ComplianceSummary' => [ 'shape' => 'ComplianceSummary', ], ], ], 'GetComplianceSummaryByResourceTypeRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceTypes' => [ 'shape' => 'ResourceTypes', ], ], ], 'GetComplianceSummaryByResourceTypeResponse' => [ 'type' => 'structure', 'members' => [ 'ComplianceSummariesByResourceType' => [ 'shape' => 'ComplianceSummariesByResourceType', ], ], ], 'GetConformancePackComplianceDetailsLimit' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'GetConformancePackComplianceDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'Filters' => [ 'shape' => 'ConformancePackEvaluationFilters', ], 'Limit' => [ 'shape' => 'GetConformancePackComplianceDetailsLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetConformancePackComplianceDetailsResponse' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ConformancePackRuleEvaluationResults' => [ 'shape' => 'ConformancePackRuleEvaluationResultsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetConformancePackComplianceSummaryRequest' => [ 'type' => 'structure', 'required' => [ 'ConformancePackNames', ], 'members' => [ 'ConformancePackNames' => [ 'shape' => 'ConformancePackNamesToSummarizeList', ], 'Limit' => [ 'shape' => 'PageSizeLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetConformancePackComplianceSummaryResponse' => [ 'type' => 'structure', 'members' => [ 'ConformancePackComplianceSummaryList' => [ 'shape' => 'ConformancePackComplianceSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetCustomRulePolicyRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], ], ], 'GetCustomRulePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyText' => [ 'shape' => 'PolicyText', ], ], ], 'GetDiscoveredResourceCountsRequest' => [ 'type' => 'structure', 'members' => [ 'resourceTypes' => [ 'shape' => 'ResourceTypes', ], 'limit' => [ 'shape' => 'Limit', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetDiscoveredResourceCountsResponse' => [ 'type' => 'structure', 'members' => [ 'totalDiscoveredResources' => [ 'shape' => 'Long', ], 'resourceCounts' => [ 'shape' => 'ResourceCounts', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetOrganizationConfigRuleDetailedStatusRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], 'Filters' => [ 'shape' => 'StatusDetailFilters', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetOrganizationConfigRuleDetailedStatusResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRuleDetailedStatus' => [ 'shape' => 'OrganizationConfigRuleDetailedStatus', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetOrganizationConformancePackDetailedStatusRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConformancePackName', ], 'members' => [ 'OrganizationConformancePackName' => [ 'shape' => 'OrganizationConformancePackName', ], 'Filters' => [ 'shape' => 'OrganizationResourceDetailedStatusFilters', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetOrganizationConformancePackDetailedStatusResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePackDetailedStatuses' => [ 'shape' => 'OrganizationConformancePackDetailedStatuses', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetOrganizationCustomRulePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], ], ], 'GetOrganizationCustomRulePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyText' => [ 'shape' => 'PolicyText', ], ], ], 'GetResourceConfigHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resourceId', ], 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'laterTime' => [ 'shape' => 'LaterTime', ], 'earlierTime' => [ 'shape' => 'EarlierTime', ], 'chronologicalOrder' => [ 'shape' => 'ChronologicalOrder', ], 'limit' => [ 'shape' => 'Limit', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetResourceConfigHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'configurationItems' => [ 'shape' => 'ConfigurationItemList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetResourceEvaluationSummaryRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceEvaluationId', ], 'members' => [ 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], ], ], 'GetResourceEvaluationSummaryResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], 'EvaluationStatus' => [ 'shape' => 'EvaluationStatus', ], 'EvaluationStartTimestamp' => [ 'shape' => 'Date', ], 'Compliance' => [ 'shape' => 'ComplianceType', ], 'EvaluationContext' => [ 'shape' => 'EvaluationContext', ], 'ResourceDetails' => [ 'shape' => 'ResourceDetails', ], ], ], 'GetStoredQueryRequest' => [ 'type' => 'structure', 'required' => [ 'QueryName', ], 'members' => [ 'QueryName' => [ 'shape' => 'QueryName', ], ], ], 'GetStoredQueryResponse' => [ 'type' => 'structure', 'members' => [ 'StoredQuery' => [ 'shape' => 'StoredQuery', ], ], ], 'GroupByAPILimit' => [ 'type' => 'integer', 'max' => 1000, 'min' => 0, ], 'GroupedResourceCount' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'ResourceCount', ], 'members' => [ 'GroupName' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceCount' => [ 'shape' => 'Long', ], ], ], 'GroupedResourceCountList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupedResourceCount', ], ], 'IdempotentParameterMismatch' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'IncludeGlobalResourceTypes' => [ 'type' => 'boolean', ], 'InsufficientDeliveryPolicyException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InsufficientPermissionsException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Integer' => [ 'type' => 'integer', ], 'InvalidConfigurationRecorderNameException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidDeliveryChannelNameException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidExpressionException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidLimitException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidNextTokenException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidParameterValueException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidRecordingGroupException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidResultTokenException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidRoleException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidS3KeyPrefixException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidS3KmsKeyArnException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidSNSTopicARNException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidTimeRangeException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'LastDeliveryChannelDeleteFailedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'LastUpdatedTime' => [ 'type' => 'timestamp', ], 'LaterTime' => [ 'type' => 'timestamp', ], 'Limit' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ListAggregateDiscoveredResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', 'ResourceType', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'Filters' => [ 'shape' => 'ResourceFilters', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAggregateDiscoveredResourcesResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifiers' => [ 'shape' => 'DiscoveredResourceIdentifierList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListConformancePackComplianceScoresRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ConformancePackComplianceScoresFilters', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'Limit' => [ 'shape' => 'PageSizeLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListConformancePackComplianceScoresResponse' => [ 'type' => 'structure', 'required' => [ 'ConformancePackComplianceScores', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ConformancePackComplianceScores' => [ 'shape' => 'ConformancePackComplianceScores', ], ], ], 'ListDiscoveredResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'resourceType', ], 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceIds' => [ 'shape' => 'ResourceIdList', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'limit' => [ 'shape' => 'Limit', ], 'includeDeletedResources' => [ 'shape' => 'Boolean', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDiscoveredResourcesResponse' => [ 'type' => 'structure', 'members' => [ 'resourceIdentifiers' => [ 'shape' => 'ResourceIdentifierList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceEvaluationsPageItemLimit' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ListResourceEvaluationsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ResourceEvaluationFilters', ], 'Limit' => [ 'shape' => 'ListResourceEvaluationsPageItemLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListResourceEvaluationsResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceEvaluations' => [ 'shape' => 'ResourceEvaluations', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListStoredQueriesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', 'box' => true, ], 'MaxResults' => [ 'shape' => 'Limit', 'box' => true, ], ], ], 'ListStoredQueriesResponse' => [ 'type' => 'structure', 'members' => [ 'StoredQueryMetadata' => [ 'shape' => 'StoredQueryMetadataList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'Long' => [ 'type' => 'long', ], 'MaxActiveResourcesExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfConfigRulesExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfConfigurationRecordersExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfConformancePacksExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfDeliveryChannelsExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfOrganizationConfigRulesExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfOrganizationConformancePacksExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfRetentionConfigurationsExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaximumExecutionFrequency' => [ 'type' => 'string', 'enum' => [ 'One_Hour', 'Three_Hours', 'Six_Hours', 'Twelve_Hours', 'TwentyFour_Hours', ], ], 'MemberAccountRuleStatus' => [ 'type' => 'string', 'enum' => [ 'CREATE_SUCCESSFUL', 'CREATE_IN_PROGRESS', 'CREATE_FAILED', 'DELETE_SUCCESSFUL', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_IN_PROGRESS', 'UPDATE_FAILED', ], ], 'MemberAccountStatus' => [ 'type' => 'structure', 'required' => [ 'AccountId', 'ConfigRuleName', 'MemberAccountRuleStatus', ], 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'ConfigRuleName' => [ 'shape' => 'StringWithCharLimit64', ], 'MemberAccountRuleStatus' => [ 'shape' => 'MemberAccountRuleStatus', ], 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], ], ], 'MessageType' => [ 'type' => 'string', 'enum' => [ 'ConfigurationItemChangeNotification', 'ConfigurationSnapshotDeliveryCompleted', 'ScheduledNotification', 'OversizedConfigurationItemChangeNotification', ], ], 'Name' => [ 'type' => 'string', ], 'NextToken' => [ 'type' => 'string', ], 'NoAvailableConfigurationRecorderException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoAvailableDeliveryChannelException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoAvailableOrganizationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoRunningConfigurationRecorderException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchBucketException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchConfigRuleException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchConfigRuleInConformancePackException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchConfigurationAggregatorException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchConfigurationRecorderException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchConformancePackException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchDeliveryChannelException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchOrganizationConfigRuleException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchOrganizationConformancePackException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchRemediationConfigurationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchRemediationExceptionException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchRetentionConfigurationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OrderingTimestamp' => [ 'type' => 'timestamp', ], 'OrganizationAccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OrganizationAggregationSource' => [ 'type' => 'structure', 'required' => [ 'RoleArn', ], 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'AwsRegions' => [ 'shape' => 'AggregatorRegionList', ], 'AllAwsRegions' => [ 'shape' => 'Boolean', ], ], ], 'OrganizationAllFeaturesNotEnabledException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OrganizationConfigRule' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', 'OrganizationConfigRuleArn', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], 'OrganizationConfigRuleArn' => [ 'shape' => 'StringWithCharLimit256', ], 'OrganizationManagedRuleMetadata' => [ 'shape' => 'OrganizationManagedRuleMetadata', ], 'OrganizationCustomRuleMetadata' => [ 'shape' => 'OrganizationCustomRuleMetadata', ], 'ExcludedAccounts' => [ 'shape' => 'ExcludedAccounts', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], 'OrganizationCustomPolicyRuleMetadata' => [ 'shape' => 'OrganizationCustomPolicyRuleMetadataNoPolicy', ], ], ], 'OrganizationConfigRuleDetailedStatus' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberAccountStatus', ], ], 'OrganizationConfigRuleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*\\S.*', ], 'OrganizationConfigRuleNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit64', ], 'max' => 25, 'min' => 0, ], 'OrganizationConfigRuleStatus' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', 'OrganizationRuleStatus', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], 'OrganizationRuleStatus' => [ 'shape' => 'OrganizationRuleStatus', ], 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], ], ], 'OrganizationConfigRuleStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConfigRuleStatus', ], ], 'OrganizationConfigRuleTriggerType' => [ 'type' => 'string', 'enum' => [ 'ConfigurationItemChangeNotification', 'OversizedConfigurationItemChangeNotification', 'ScheduledNotification', ], ], 'OrganizationConfigRuleTriggerTypeNoSN' => [ 'type' => 'string', 'enum' => [ 'ConfigurationItemChangeNotification', 'OversizedConfigurationItemChangeNotification', ], ], 'OrganizationConfigRuleTriggerTypeNoSNs' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConfigRuleTriggerTypeNoSN', ], ], 'OrganizationConfigRuleTriggerTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConfigRuleTriggerType', ], ], 'OrganizationConfigRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConfigRule', ], ], 'OrganizationConformancePack' => [ 'type' => 'structure', 'required' => [ 'OrganizationConformancePackName', 'OrganizationConformancePackArn', 'LastUpdateTime', ], 'members' => [ 'OrganizationConformancePackName' => [ 'shape' => 'OrganizationConformancePackName', ], 'OrganizationConformancePackArn' => [ 'shape' => 'StringWithCharLimit256', ], 'DeliveryS3Bucket' => [ 'shape' => 'DeliveryS3Bucket', ], 'DeliveryS3KeyPrefix' => [ 'shape' => 'DeliveryS3KeyPrefix', ], 'ConformancePackInputParameters' => [ 'shape' => 'ConformancePackInputParameters', ], 'ExcludedAccounts' => [ 'shape' => 'ExcludedAccounts', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], ], ], 'OrganizationConformancePackDetailedStatus' => [ 'type' => 'structure', 'required' => [ 'AccountId', 'ConformancePackName', 'Status', ], 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'ConformancePackName' => [ 'shape' => 'StringWithCharLimit256', ], 'Status' => [ 'shape' => 'OrganizationResourceDetailedStatus', ], 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], ], ], 'OrganizationConformancePackDetailedStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConformancePackDetailedStatus', ], ], 'OrganizationConformancePackName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z][-a-zA-Z0-9]*', ], 'OrganizationConformancePackNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConformancePackName', ], 'max' => 25, 'min' => 0, ], 'OrganizationConformancePackStatus' => [ 'type' => 'structure', 'required' => [ 'OrganizationConformancePackName', 'Status', ], 'members' => [ 'OrganizationConformancePackName' => [ 'shape' => 'OrganizationConformancePackName', ], 'Status' => [ 'shape' => 'OrganizationResourceStatus', ], 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], ], ], 'OrganizationConformancePackStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConformancePackStatus', ], ], 'OrganizationConformancePackTemplateValidationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OrganizationConformancePacks' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConformancePack', ], ], 'OrganizationCustomPolicyRuleMetadata' => [ 'type' => 'structure', 'required' => [ 'PolicyRuntime', 'PolicyText', ], 'members' => [ 'Description' => [ 'shape' => 'StringWithCharLimit256Min0', ], 'OrganizationConfigRuleTriggerTypes' => [ 'shape' => 'OrganizationConfigRuleTriggerTypeNoSNs', ], 'InputParameters' => [ 'shape' => 'StringWithCharLimit2048', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], 'ResourceTypesScope' => [ 'shape' => 'ResourceTypesScope', ], 'ResourceIdScope' => [ 'shape' => 'StringWithCharLimit768', ], 'TagKeyScope' => [ 'shape' => 'StringWithCharLimit128', ], 'TagValueScope' => [ 'shape' => 'StringWithCharLimit256', ], 'PolicyRuntime' => [ 'shape' => 'PolicyRuntime', ], 'PolicyText' => [ 'shape' => 'PolicyText', ], 'DebugLogDeliveryAccounts' => [ 'shape' => 'DebugLogDeliveryAccounts', ], ], ], 'OrganizationCustomPolicyRuleMetadataNoPolicy' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'StringWithCharLimit256Min0', ], 'OrganizationConfigRuleTriggerTypes' => [ 'shape' => 'OrganizationConfigRuleTriggerTypeNoSNs', ], 'InputParameters' => [ 'shape' => 'StringWithCharLimit2048', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], 'ResourceTypesScope' => [ 'shape' => 'ResourceTypesScope', ], 'ResourceIdScope' => [ 'shape' => 'StringWithCharLimit768', ], 'TagKeyScope' => [ 'shape' => 'StringWithCharLimit128', ], 'TagValueScope' => [ 'shape' => 'StringWithCharLimit256', ], 'PolicyRuntime' => [ 'shape' => 'PolicyRuntime', ], 'DebugLogDeliveryAccounts' => [ 'shape' => 'DebugLogDeliveryAccounts', ], ], ], 'OrganizationCustomRuleMetadata' => [ 'type' => 'structure', 'required' => [ 'LambdaFunctionArn', 'OrganizationConfigRuleTriggerTypes', ], 'members' => [ 'Description' => [ 'shape' => 'StringWithCharLimit256Min0', ], 'LambdaFunctionArn' => [ 'shape' => 'StringWithCharLimit256', ], 'OrganizationConfigRuleTriggerTypes' => [ 'shape' => 'OrganizationConfigRuleTriggerTypes', ], 'InputParameters' => [ 'shape' => 'StringWithCharLimit2048', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], 'ResourceTypesScope' => [ 'shape' => 'ResourceTypesScope', ], 'ResourceIdScope' => [ 'shape' => 'StringWithCharLimit768', ], 'TagKeyScope' => [ 'shape' => 'StringWithCharLimit128', ], 'TagValueScope' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'OrganizationManagedRuleMetadata' => [ 'type' => 'structure', 'required' => [ 'RuleIdentifier', ], 'members' => [ 'Description' => [ 'shape' => 'StringWithCharLimit256Min0', ], 'RuleIdentifier' => [ 'shape' => 'StringWithCharLimit256', ], 'InputParameters' => [ 'shape' => 'StringWithCharLimit2048', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], 'ResourceTypesScope' => [ 'shape' => 'ResourceTypesScope', ], 'ResourceIdScope' => [ 'shape' => 'StringWithCharLimit768', ], 'TagKeyScope' => [ 'shape' => 'StringWithCharLimit128', ], 'TagValueScope' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'OrganizationResourceDetailedStatus' => [ 'type' => 'string', 'enum' => [ 'CREATE_SUCCESSFUL', 'CREATE_IN_PROGRESS', 'CREATE_FAILED', 'DELETE_SUCCESSFUL', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_IN_PROGRESS', 'UPDATE_FAILED', ], ], 'OrganizationResourceDetailedStatusFilters' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'Status' => [ 'shape' => 'OrganizationResourceDetailedStatus', ], ], ], 'OrganizationResourceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATE_SUCCESSFUL', 'CREATE_IN_PROGRESS', 'CREATE_FAILED', 'DELETE_SUCCESSFUL', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_IN_PROGRESS', 'UPDATE_FAILED', ], ], 'OrganizationRuleStatus' => [ 'type' => 'string', 'enum' => [ 'CREATE_SUCCESSFUL', 'CREATE_IN_PROGRESS', 'CREATE_FAILED', 'DELETE_SUCCESSFUL', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_IN_PROGRESS', 'UPDATE_FAILED', ], ], 'OversizedConfigurationItemException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Owner' => [ 'type' => 'string', 'enum' => [ 'CUSTOM_LAMBDA', 'AWS', 'CUSTOM_POLICY', ], ], 'PageSizeLimit' => [ 'type' => 'integer', 'max' => 20, 'min' => 0, ], 'ParameterName' => [ 'type' => 'string', 'max' => 255, 'min' => 0, ], 'ParameterValue' => [ 'type' => 'string', 'max' => 4096, 'min' => 0, ], 'PendingAggregationRequest' => [ 'type' => 'structure', 'members' => [ 'RequesterAccountId' => [ 'shape' => 'AccountId', ], 'RequesterAwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'PendingAggregationRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingAggregationRequest', ], ], 'Percentage' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'PolicyRuntime' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => 'guard\\-2\\.x\\.x', ], 'PolicyText' => [ 'type' => 'string', 'max' => 10000, 'min' => 0, ], 'PutAggregationAuthorizationRequest' => [ 'type' => 'structure', 'required' => [ 'AuthorizedAccountId', 'AuthorizedAwsRegion', ], 'members' => [ 'AuthorizedAccountId' => [ 'shape' => 'AccountId', ], 'AuthorizedAwsRegion' => [ 'shape' => 'AwsRegion', ], 'Tags' => [ 'shape' => 'TagsList', ], ], ], 'PutAggregationAuthorizationResponse' => [ 'type' => 'structure', 'members' => [ 'AggregationAuthorization' => [ 'shape' => 'AggregationAuthorization', ], ], ], 'PutConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRule', ], 'members' => [ 'ConfigRule' => [ 'shape' => 'ConfigRule', ], 'Tags' => [ 'shape' => 'TagsList', ], ], ], 'PutConfigurationAggregatorRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'AccountAggregationSources' => [ 'shape' => 'AccountAggregationSourceList', ], 'OrganizationAggregationSource' => [ 'shape' => 'OrganizationAggregationSource', ], 'Tags' => [ 'shape' => 'TagsList', ], ], ], 'PutConfigurationAggregatorResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigurationAggregator' => [ 'shape' => 'ConfigurationAggregator', ], ], ], 'PutConfigurationRecorderRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationRecorder', ], 'members' => [ 'ConfigurationRecorder' => [ 'shape' => 'ConfigurationRecorder', ], ], ], 'PutConformancePackRequest' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'TemplateS3Uri' => [ 'shape' => 'TemplateS3Uri', ], 'TemplateBody' => [ 'shape' => 'TemplateBody', ], 'DeliveryS3Bucket' => [ 'shape' => 'DeliveryS3Bucket', ], 'DeliveryS3KeyPrefix' => [ 'shape' => 'DeliveryS3KeyPrefix', ], 'ConformancePackInputParameters' => [ 'shape' => 'ConformancePackInputParameters', ], 'TemplateSSMDocumentDetails' => [ 'shape' => 'TemplateSSMDocumentDetails', ], ], ], 'PutConformancePackResponse' => [ 'type' => 'structure', 'members' => [ 'ConformancePackArn' => [ 'shape' => 'ConformancePackArn', ], ], ], 'PutDeliveryChannelRequest' => [ 'type' => 'structure', 'required' => [ 'DeliveryChannel', ], 'members' => [ 'DeliveryChannel' => [ 'shape' => 'DeliveryChannel', ], ], ], 'PutEvaluationsRequest' => [ 'type' => 'structure', 'required' => [ 'ResultToken', ], 'members' => [ 'Evaluations' => [ 'shape' => 'Evaluations', ], 'ResultToken' => [ 'shape' => 'String', ], 'TestMode' => [ 'shape' => 'Boolean', ], ], ], 'PutEvaluationsResponse' => [ 'type' => 'structure', 'members' => [ 'FailedEvaluations' => [ 'shape' => 'Evaluations', ], ], ], 'PutExternalEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'ExternalEvaluation', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ExternalEvaluation' => [ 'shape' => 'ExternalEvaluation', ], ], ], 'PutExternalEvaluationResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutOrganizationConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], 'OrganizationManagedRuleMetadata' => [ 'shape' => 'OrganizationManagedRuleMetadata', ], 'OrganizationCustomRuleMetadata' => [ 'shape' => 'OrganizationCustomRuleMetadata', ], 'ExcludedAccounts' => [ 'shape' => 'ExcludedAccounts', ], 'OrganizationCustomPolicyRuleMetadata' => [ 'shape' => 'OrganizationCustomPolicyRuleMetadata', ], ], ], 'PutOrganizationConfigRuleResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRuleArn' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'PutOrganizationConformancePackRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConformancePackName', ], 'members' => [ 'OrganizationConformancePackName' => [ 'shape' => 'OrganizationConformancePackName', ], 'TemplateS3Uri' => [ 'shape' => 'TemplateS3Uri', ], 'TemplateBody' => [ 'shape' => 'TemplateBody', ], 'DeliveryS3Bucket' => [ 'shape' => 'DeliveryS3Bucket', ], 'DeliveryS3KeyPrefix' => [ 'shape' => 'DeliveryS3KeyPrefix', ], 'ConformancePackInputParameters' => [ 'shape' => 'ConformancePackInputParameters', ], 'ExcludedAccounts' => [ 'shape' => 'ExcludedAccounts', ], ], ], 'PutOrganizationConformancePackResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePackArn' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'PutRemediationConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'RemediationConfigurations', ], 'members' => [ 'RemediationConfigurations' => [ 'shape' => 'RemediationConfigurations', ], ], ], 'PutRemediationConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'FailedBatches' => [ 'shape' => 'FailedRemediationBatches', ], ], ], 'PutRemediationExceptionsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'ResourceKeys', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceKeys' => [ 'shape' => 'RemediationExceptionResourceKeys', ], 'Message' => [ 'shape' => 'StringWithCharLimit1024', ], 'ExpirationTime' => [ 'shape' => 'Date', ], ], ], 'PutRemediationExceptionsResponse' => [ 'type' => 'structure', 'members' => [ 'FailedBatches' => [ 'shape' => 'FailedRemediationExceptionBatches', ], ], ], 'PutResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceType', 'SchemaVersionId', 'ResourceId', 'Configuration', ], 'members' => [ 'ResourceType' => [ 'shape' => 'ResourceTypeString', ], 'SchemaVersionId' => [ 'shape' => 'SchemaVersionId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ResourceName' => [ 'shape' => 'ResourceName', ], 'Configuration' => [ 'shape' => 'Configuration', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'PutRetentionConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'RetentionPeriodInDays', ], 'members' => [ 'RetentionPeriodInDays' => [ 'shape' => 'RetentionPeriodInDays', ], ], ], 'PutRetentionConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'RetentionConfiguration' => [ 'shape' => 'RetentionConfiguration', ], ], ], 'PutStoredQueryRequest' => [ 'type' => 'structure', 'required' => [ 'StoredQuery', ], 'members' => [ 'StoredQuery' => [ 'shape' => 'StoredQuery', ], 'Tags' => [ 'shape' => 'TagsList', ], ], ], 'PutStoredQueryResponse' => [ 'type' => 'structure', 'members' => [ 'QueryArn' => [ 'shape' => 'QueryArn', ], ], ], 'QueryArn' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '^arn:aws[a-z\\-]*:config:[a-z\\-\\d]+:\\d+:stored-query/[a-zA-Z0-9-_]+/query-[a-zA-Z\\d-_/]+$', ], 'QueryDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'QueryExpression' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]*', ], 'QueryId' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^\\S+$', ], 'QueryInfo' => [ 'type' => 'structure', 'members' => [ 'SelectFields' => [ 'shape' => 'FieldInfoList', ], ], ], 'QueryName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-_]+$', ], 'RecorderName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RecorderStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Success', 'Failure', ], ], 'RecordingFrequency' => [ 'type' => 'string', 'enum' => [ 'CONTINUOUS', 'DAILY', ], ], 'RecordingGroup' => [ 'type' => 'structure', 'members' => [ 'allSupported' => [ 'shape' => 'AllSupported', ], 'includeGlobalResourceTypes' => [ 'shape' => 'IncludeGlobalResourceTypes', ], 'resourceTypes' => [ 'shape' => 'ResourceTypeList', ], 'exclusionByResourceTypes' => [ 'shape' => 'ExclusionByResourceTypes', ], 'recordingStrategy' => [ 'shape' => 'RecordingStrategy', ], ], ], 'RecordingMode' => [ 'type' => 'structure', 'required' => [ 'recordingFrequency', ], 'members' => [ 'recordingFrequency' => [ 'shape' => 'RecordingFrequency', ], 'recordingModeOverrides' => [ 'shape' => 'RecordingModeOverrides', ], ], ], 'RecordingModeOverride' => [ 'type' => 'structure', 'required' => [ 'resourceTypes', 'recordingFrequency', ], 'members' => [ 'description' => [ 'shape' => 'Description', ], 'resourceTypes' => [ 'shape' => 'RecordingModeResourceTypesList', ], 'recordingFrequency' => [ 'shape' => 'RecordingFrequency', ], ], ], 'RecordingModeOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordingModeOverride', ], 'max' => 1, 'min' => 0, ], 'RecordingModeResourceTypesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceType', ], ], 'RecordingStrategy' => [ 'type' => 'structure', 'members' => [ 'useOnly' => [ 'shape' => 'RecordingStrategyType', ], ], ], 'RecordingStrategyType' => [ 'type' => 'string', 'enum' => [ 'ALL_SUPPORTED_RESOURCE_TYPES', 'INCLUSION_BY_RESOURCE_TYPES', 'EXCLUSION_BY_RESOURCE_TYPES', ], ], 'ReevaluateConfigRuleNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigRuleName', ], 'max' => 25, 'min' => 1, ], 'RelatedEvent' => [ 'type' => 'string', ], 'RelatedEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelatedEvent', ], ], 'Relationship' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'relationshipName' => [ 'shape' => 'RelationshipName', ], ], ], 'RelationshipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Relationship', ], ], 'RelationshipName' => [ 'type' => 'string', ], 'RemediationConfiguration' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'TargetType', 'TargetId', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'TargetType' => [ 'shape' => 'RemediationTargetType', ], 'TargetId' => [ 'shape' => 'StringWithCharLimit256', ], 'TargetVersion' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'RemediationParameters', ], 'ResourceType' => [ 'shape' => 'String', ], 'Automatic' => [ 'shape' => 'Boolean', ], 'ExecutionControls' => [ 'shape' => 'ExecutionControls', ], 'MaximumAutomaticAttempts' => [ 'shape' => 'AutoRemediationAttempts', ], 'RetryAttemptSeconds' => [ 'shape' => 'AutoRemediationAttemptSeconds', ], 'Arn' => [ 'shape' => 'StringWithCharLimit1024', ], 'CreatedByService' => [ 'shape' => 'StringWithCharLimit1024', ], ], ], 'RemediationConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationConfiguration', ], 'max' => 25, 'min' => 0, ], 'RemediationException' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'ResourceType', 'ResourceId', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'StringWithCharLimit1024', ], 'Message' => [ 'shape' => 'StringWithCharLimit1024', ], 'ExpirationTime' => [ 'shape' => 'Date', ], ], ], 'RemediationExceptionResourceKey' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'StringWithCharLimit1024', ], ], ], 'RemediationExceptionResourceKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationExceptionResourceKey', ], 'max' => 100, 'min' => 1, ], 'RemediationExceptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationException', ], 'max' => 25, 'min' => 0, ], 'RemediationExecutionState' => [ 'type' => 'string', 'enum' => [ 'QUEUED', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', ], ], 'RemediationExecutionStatus' => [ 'type' => 'structure', 'members' => [ 'ResourceKey' => [ 'shape' => 'ResourceKey', ], 'State' => [ 'shape' => 'RemediationExecutionState', ], 'StepDetails' => [ 'shape' => 'RemediationExecutionSteps', ], 'InvocationTime' => [ 'shape' => 'Date', ], 'LastUpdatedTime' => [ 'shape' => 'Date', ], ], ], 'RemediationExecutionStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationExecutionStatus', ], ], 'RemediationExecutionStep' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'RemediationExecutionStepState', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'StartTime' => [ 'shape' => 'Date', ], 'StopTime' => [ 'shape' => 'Date', ], ], ], 'RemediationExecutionStepState' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'PENDING', 'FAILED', ], ], 'RemediationExecutionSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationExecutionStep', ], ], 'RemediationInProgressException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'RemediationParameterValue' => [ 'type' => 'structure', 'members' => [ 'ResourceValue' => [ 'shape' => 'ResourceValue', ], 'StaticValue' => [ 'shape' => 'StaticValue', ], ], ], 'RemediationParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringWithCharLimit256', ], 'value' => [ 'shape' => 'RemediationParameterValue', ], 'max' => 25, 'min' => 0, ], 'RemediationTargetType' => [ 'type' => 'string', 'enum' => [ 'SSM_DOCUMENT', ], ], 'ResourceConcurrentModificationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceConfiguration' => [ 'type' => 'string', 'max' => 51200, 'min' => 1, ], 'ResourceConfigurationSchemaType' => [ 'type' => 'string', 'enum' => [ 'CFN_RESOURCE_SCHEMA', ], ], 'ResourceCount' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'count' => [ 'shape' => 'Long', ], ], ], 'ResourceCountFilters' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'ResourceType', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'Region' => [ 'shape' => 'AwsRegion', ], ], ], 'ResourceCountGroupKey' => [ 'type' => 'string', 'enum' => [ 'RESOURCE_TYPE', 'ACCOUNT_ID', 'AWS_REGION', ], ], 'ResourceCounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceCount', ], ], 'ResourceCreationTime' => [ 'type' => 'timestamp', ], 'ResourceDeletionTime' => [ 'type' => 'timestamp', ], 'ResourceDetails' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'ResourceType', 'ResourceConfiguration', ], 'members' => [ 'ResourceId' => [ 'shape' => 'BaseResourceId', ], 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceConfiguration' => [ 'shape' => 'ResourceConfiguration', ], 'ResourceConfigurationSchemaType' => [ 'shape' => 'ResourceConfigurationSchemaType', ], ], ], 'ResourceEvaluation' => [ 'type' => 'structure', 'members' => [ 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], 'EvaluationStartTimestamp' => [ 'shape' => 'Date', ], ], ], 'ResourceEvaluationFilters' => [ 'type' => 'structure', 'members' => [ 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], 'TimeWindow' => [ 'shape' => 'TimeWindow', ], 'EvaluationContextIdentifier' => [ 'shape' => 'EvaluationContextIdentifier', ], ], ], 'ResourceEvaluationId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'ResourceEvaluationStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', ], ], 'ResourceEvaluations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceEvaluation', ], ], 'ResourceFilters' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ResourceName' => [ 'shape' => 'ResourceName', ], 'Region' => [ 'shape' => 'AwsRegion', ], ], ], 'ResourceId' => [ 'type' => 'string', 'max' => 768, 'min' => 1, ], 'ResourceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceId', ], ], 'ResourceIdentifier' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceDeletionTime' => [ 'shape' => 'ResourceDeletionTime', ], ], ], 'ResourceIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceIdentifier', ], ], 'ResourceIdentifiersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateResourceIdentifier', ], 'max' => 100, 'min' => 1, ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceKey' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resourceId', ], 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], ], ], 'ResourceKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceKey', ], 'max' => 100, 'min' => 1, ], 'ResourceName' => [ 'type' => 'string', ], 'ResourceNotDiscoveredException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'AWS::EC2::CustomerGateway', 'AWS::EC2::EIP', 'AWS::EC2::Host', 'AWS::EC2::Instance', 'AWS::EC2::InternetGateway', 'AWS::EC2::NetworkAcl', 'AWS::EC2::NetworkInterface', 'AWS::EC2::RouteTable', 'AWS::EC2::SecurityGroup', 'AWS::EC2::Subnet', 'AWS::CloudTrail::Trail', 'AWS::EC2::Volume', 'AWS::EC2::VPC', 'AWS::EC2::VPNConnection', 'AWS::EC2::VPNGateway', 'AWS::EC2::RegisteredHAInstance', 'AWS::EC2::NatGateway', 'AWS::EC2::EgressOnlyInternetGateway', 'AWS::EC2::VPCEndpoint', 'AWS::EC2::VPCEndpointService', 'AWS::EC2::FlowLog', 'AWS::EC2::VPCPeeringConnection', 'AWS::Elasticsearch::Domain', 'AWS::IAM::Group', 'AWS::IAM::Policy', 'AWS::IAM::Role', 'AWS::IAM::User', 'AWS::ElasticLoadBalancingV2::LoadBalancer', 'AWS::ACM::Certificate', 'AWS::RDS::DBInstance', 'AWS::RDS::DBSubnetGroup', 'AWS::RDS::DBSecurityGroup', 'AWS::RDS::DBSnapshot', 'AWS::RDS::DBCluster', 'AWS::RDS::DBClusterSnapshot', 'AWS::RDS::EventSubscription', 'AWS::S3::Bucket', 'AWS::S3::AccountPublicAccessBlock', 'AWS::Redshift::Cluster', 'AWS::Redshift::ClusterSnapshot', 'AWS::Redshift::ClusterParameterGroup', 'AWS::Redshift::ClusterSecurityGroup', 'AWS::Redshift::ClusterSubnetGroup', 'AWS::Redshift::EventSubscription', 'AWS::SSM::ManagedInstanceInventory', 'AWS::CloudWatch::Alarm', 'AWS::CloudFormation::Stack', 'AWS::ElasticLoadBalancing::LoadBalancer', 'AWS::AutoScaling::AutoScalingGroup', 'AWS::AutoScaling::LaunchConfiguration', 'AWS::AutoScaling::ScalingPolicy', 'AWS::AutoScaling::ScheduledAction', 'AWS::DynamoDB::Table', 'AWS::CodeBuild::Project', 'AWS::WAF::RateBasedRule', 'AWS::WAF::Rule', 'AWS::WAF::RuleGroup', 'AWS::WAF::WebACL', 'AWS::WAFRegional::RateBasedRule', 'AWS::WAFRegional::Rule', 'AWS::WAFRegional::RuleGroup', 'AWS::WAFRegional::WebACL', 'AWS::CloudFront::Distribution', 'AWS::CloudFront::StreamingDistribution', 'AWS::Lambda::Function', 'AWS::NetworkFirewall::Firewall', 'AWS::NetworkFirewall::FirewallPolicy', 'AWS::NetworkFirewall::RuleGroup', 'AWS::ElasticBeanstalk::Application', 'AWS::ElasticBeanstalk::ApplicationVersion', 'AWS::ElasticBeanstalk::Environment', 'AWS::WAFv2::WebACL', 'AWS::WAFv2::RuleGroup', 'AWS::WAFv2::IPSet', 'AWS::WAFv2::RegexPatternSet', 'AWS::WAFv2::ManagedRuleSet', 'AWS::XRay::EncryptionConfig', 'AWS::SSM::AssociationCompliance', 'AWS::SSM::PatchCompliance', 'AWS::Shield::Protection', 'AWS::ShieldRegional::Protection', 'AWS::Config::ConformancePackCompliance', 'AWS::Config::ResourceCompliance', 'AWS::ApiGateway::Stage', 'AWS::ApiGateway::RestApi', 'AWS::ApiGatewayV2::Stage', 'AWS::ApiGatewayV2::Api', 'AWS::CodePipeline::Pipeline', 'AWS::ServiceCatalog::CloudFormationProvisionedProduct', 'AWS::ServiceCatalog::CloudFormationProduct', 'AWS::ServiceCatalog::Portfolio', 'AWS::SQS::Queue', 'AWS::KMS::Key', 'AWS::QLDB::Ledger', 'AWS::SecretsManager::Secret', 'AWS::SNS::Topic', 'AWS::SSM::FileData', 'AWS::Backup::BackupPlan', 'AWS::Backup::BackupSelection', 'AWS::Backup::BackupVault', 'AWS::Backup::RecoveryPoint', 'AWS::ECR::Repository', 'AWS::ECS::Cluster', 'AWS::ECS::Service', 'AWS::ECS::TaskDefinition', 'AWS::EFS::AccessPoint', 'AWS::EFS::FileSystem', 'AWS::EKS::Cluster', 'AWS::OpenSearch::Domain', 'AWS::EC2::TransitGateway', 'AWS::Kinesis::Stream', 'AWS::Kinesis::StreamConsumer', 'AWS::CodeDeploy::Application', 'AWS::CodeDeploy::DeploymentConfig', 'AWS::CodeDeploy::DeploymentGroup', 'AWS::EC2::LaunchTemplate', 'AWS::ECR::PublicRepository', 'AWS::GuardDuty::Detector', 'AWS::EMR::SecurityConfiguration', 'AWS::SageMaker::CodeRepository', 'AWS::Route53Resolver::ResolverEndpoint', 'AWS::Route53Resolver::ResolverRule', 'AWS::Route53Resolver::ResolverRuleAssociation', 'AWS::DMS::ReplicationSubnetGroup', 'AWS::DMS::EventSubscription', 'AWS::MSK::Cluster', 'AWS::StepFunctions::Activity', 'AWS::WorkSpaces::Workspace', 'AWS::WorkSpaces::ConnectionAlias', 'AWS::SageMaker::Model', 'AWS::ElasticLoadBalancingV2::Listener', 'AWS::StepFunctions::StateMachine', 'AWS::Batch::JobQueue', 'AWS::Batch::ComputeEnvironment', 'AWS::AccessAnalyzer::Analyzer', 'AWS::Athena::WorkGroup', 'AWS::Athena::DataCatalog', 'AWS::Detective::Graph', 'AWS::GlobalAccelerator::Accelerator', 'AWS::GlobalAccelerator::EndpointGroup', 'AWS::GlobalAccelerator::Listener', 'AWS::EC2::TransitGatewayAttachment', 'AWS::EC2::TransitGatewayRouteTable', 'AWS::DMS::Certificate', 'AWS::AppConfig::Application', 'AWS::AppSync::GraphQLApi', 'AWS::DataSync::LocationSMB', 'AWS::DataSync::LocationFSxLustre', 'AWS::DataSync::LocationS3', 'AWS::DataSync::LocationEFS', 'AWS::DataSync::Task', 'AWS::DataSync::LocationNFS', 'AWS::EC2::NetworkInsightsAccessScopeAnalysis', 'AWS::EKS::FargateProfile', 'AWS::Glue::Job', 'AWS::GuardDuty::ThreatIntelSet', 'AWS::GuardDuty::IPSet', 'AWS::SageMaker::Workteam', 'AWS::SageMaker::NotebookInstanceLifecycleConfig', 'AWS::ServiceDiscovery::Service', 'AWS::ServiceDiscovery::PublicDnsNamespace', 'AWS::SES::ContactList', 'AWS::SES::ConfigurationSet', 'AWS::Route53::HostedZone', 'AWS::IoTEvents::Input', 'AWS::IoTEvents::DetectorModel', 'AWS::IoTEvents::AlarmModel', 'AWS::ServiceDiscovery::HttpNamespace', 'AWS::Events::EventBus', 'AWS::ImageBuilder::ContainerRecipe', 'AWS::ImageBuilder::DistributionConfiguration', 'AWS::ImageBuilder::InfrastructureConfiguration', 'AWS::DataSync::LocationObjectStorage', 'AWS::DataSync::LocationHDFS', 'AWS::Glue::Classifier', 'AWS::Route53RecoveryReadiness::Cell', 'AWS::Route53RecoveryReadiness::ReadinessCheck', 'AWS::ECR::RegistryPolicy', 'AWS::Backup::ReportPlan', 'AWS::Lightsail::Certificate', 'AWS::RUM::AppMonitor', 'AWS::Events::Endpoint', 'AWS::SES::ReceiptRuleSet', 'AWS::Events::Archive', 'AWS::Events::ApiDestination', 'AWS::Lightsail::Disk', 'AWS::FIS::ExperimentTemplate', 'AWS::DataSync::LocationFSxWindows', 'AWS::SES::ReceiptFilter', 'AWS::GuardDuty::Filter', 'AWS::SES::Template', 'AWS::AmazonMQ::Broker', 'AWS::AppConfig::Environment', 'AWS::AppConfig::ConfigurationProfile', 'AWS::Cloud9::EnvironmentEC2', 'AWS::EventSchemas::Registry', 'AWS::EventSchemas::RegistryPolicy', 'AWS::EventSchemas::Discoverer', 'AWS::FraudDetector::Label', 'AWS::FraudDetector::EntityType', 'AWS::FraudDetector::Variable', 'AWS::FraudDetector::Outcome', 'AWS::IoT::Authorizer', 'AWS::IoT::SecurityProfile', 'AWS::IoT::RoleAlias', 'AWS::IoT::Dimension', 'AWS::IoTAnalytics::Datastore', 'AWS::Lightsail::Bucket', 'AWS::Lightsail::StaticIp', 'AWS::MediaPackage::PackagingGroup', 'AWS::Route53RecoveryReadiness::RecoveryGroup', 'AWS::ResilienceHub::ResiliencyPolicy', 'AWS::Transfer::Workflow', 'AWS::EKS::IdentityProviderConfig', 'AWS::EKS::Addon', 'AWS::Glue::MLTransform', 'AWS::IoT::Policy', 'AWS::IoT::MitigationAction', 'AWS::IoTTwinMaker::Workspace', 'AWS::IoTTwinMaker::Entity', 'AWS::IoTAnalytics::Dataset', 'AWS::IoTAnalytics::Pipeline', 'AWS::IoTAnalytics::Channel', 'AWS::IoTSiteWise::Dashboard', 'AWS::IoTSiteWise::Project', 'AWS::IoTSiteWise::Portal', 'AWS::IoTSiteWise::AssetModel', 'AWS::IVS::Channel', 'AWS::IVS::RecordingConfiguration', 'AWS::IVS::PlaybackKeyPair', 'AWS::KinesisAnalyticsV2::Application', 'AWS::RDS::GlobalCluster', 'AWS::S3::MultiRegionAccessPoint', 'AWS::DeviceFarm::TestGridProject', 'AWS::Budgets::BudgetsAction', 'AWS::Lex::Bot', 'AWS::CodeGuruReviewer::RepositoryAssociation', 'AWS::IoT::CustomMetric', 'AWS::Route53Resolver::FirewallDomainList', 'AWS::RoboMaker::RobotApplicationVersion', 'AWS::EC2::TrafficMirrorSession', 'AWS::IoTSiteWise::Gateway', 'AWS::Lex::BotAlias', 'AWS::LookoutMetrics::Alert', 'AWS::IoT::AccountAuditConfiguration', 'AWS::EC2::TrafficMirrorTarget', 'AWS::S3::StorageLens', 'AWS::IoT::ScheduledAudit', 'AWS::Events::Connection', 'AWS::EventSchemas::Schema', 'AWS::MediaPackage::PackagingConfiguration', 'AWS::KinesisVideo::SignalingChannel', 'AWS::AppStream::DirectoryConfig', 'AWS::LookoutVision::Project', 'AWS::Route53RecoveryControl::Cluster', 'AWS::Route53RecoveryControl::SafetyRule', 'AWS::Route53RecoveryControl::ControlPanel', 'AWS::Route53RecoveryControl::RoutingControl', 'AWS::Route53RecoveryReadiness::ResourceSet', 'AWS::RoboMaker::SimulationApplication', 'AWS::RoboMaker::RobotApplication', 'AWS::HealthLake::FHIRDatastore', 'AWS::Pinpoint::Segment', 'AWS::Pinpoint::ApplicationSettings', 'AWS::Events::Rule', 'AWS::EC2::DHCPOptions', 'AWS::EC2::NetworkInsightsPath', 'AWS::EC2::TrafficMirrorFilter', 'AWS::EC2::IPAM', 'AWS::IoTTwinMaker::Scene', 'AWS::NetworkManager::TransitGatewayRegistration', 'AWS::CustomerProfiles::Domain', 'AWS::AutoScaling::WarmPool', 'AWS::Connect::PhoneNumber', 'AWS::AppConfig::DeploymentStrategy', 'AWS::AppFlow::Flow', 'AWS::AuditManager::Assessment', 'AWS::CloudWatch::MetricStream', 'AWS::DeviceFarm::InstanceProfile', 'AWS::DeviceFarm::Project', 'AWS::EC2::EC2Fleet', 'AWS::EC2::SubnetRouteTableAssociation', 'AWS::ECR::PullThroughCacheRule', 'AWS::GroundStation::Config', 'AWS::ImageBuilder::ImagePipeline', 'AWS::IoT::FleetMetric', 'AWS::IoTWireless::ServiceProfile', 'AWS::NetworkManager::Device', 'AWS::NetworkManager::GlobalNetwork', 'AWS::NetworkManager::Link', 'AWS::NetworkManager::Site', 'AWS::Panorama::Package', 'AWS::Pinpoint::App', 'AWS::Redshift::ScheduledAction', 'AWS::Route53Resolver::FirewallRuleGroupAssociation', 'AWS::SageMaker::AppImageConfig', 'AWS::SageMaker::Image', 'AWS::ECS::TaskSet', 'AWS::Cassandra::Keyspace', 'AWS::Signer::SigningProfile', 'AWS::Amplify::App', 'AWS::AppMesh::VirtualNode', 'AWS::AppMesh::VirtualService', 'AWS::AppRunner::VpcConnector', 'AWS::AppStream::Application', 'AWS::CodeArtifact::Repository', 'AWS::EC2::PrefixList', 'AWS::EC2::SpotFleet', 'AWS::Evidently::Project', 'AWS::Forecast::Dataset', 'AWS::IAM::SAMLProvider', 'AWS::IAM::ServerCertificate', 'AWS::Pinpoint::Campaign', 'AWS::Pinpoint::InAppTemplate', 'AWS::SageMaker::Domain', 'AWS::Transfer::Agreement', 'AWS::Transfer::Connector', 'AWS::KinesisFirehose::DeliveryStream', 'AWS::Amplify::Branch', 'AWS::AppIntegrations::EventIntegration', 'AWS::AppMesh::Route', 'AWS::Athena::PreparedStatement', 'AWS::EC2::IPAMScope', 'AWS::Evidently::Launch', 'AWS::Forecast::DatasetGroup', 'AWS::GreengrassV2::ComponentVersion', 'AWS::GroundStation::MissionProfile', 'AWS::MediaConnect::FlowEntitlement', 'AWS::MediaConnect::FlowVpcInterface', 'AWS::MediaTailor::PlaybackConfiguration', 'AWS::MSK::Configuration', 'AWS::Personalize::Dataset', 'AWS::Personalize::Schema', 'AWS::Personalize::Solution', 'AWS::Pinpoint::EmailTemplate', 'AWS::Pinpoint::EventStream', 'AWS::ResilienceHub::App', 'AWS::ACMPCA::CertificateAuthority', 'AWS::AppConfig::HostedConfigurationVersion', 'AWS::AppMesh::VirtualGateway', 'AWS::AppMesh::VirtualRouter', 'AWS::AppRunner::Service', 'AWS::CustomerProfiles::ObjectType', 'AWS::DMS::Endpoint', 'AWS::EC2::CapacityReservation', 'AWS::EC2::ClientVpnEndpoint', 'AWS::Kendra::Index', 'AWS::KinesisVideo::Stream', 'AWS::Logs::Destination', 'AWS::Pinpoint::EmailChannel', 'AWS::S3::AccessPoint', 'AWS::NetworkManager::CustomerGatewayAssociation', 'AWS::NetworkManager::LinkAssociation', 'AWS::IoTWireless::MulticastGroup', 'AWS::Personalize::DatasetGroup', 'AWS::IoTTwinMaker::ComponentType', 'AWS::CodeBuild::ReportGroup', 'AWS::SageMaker::FeatureGroup', 'AWS::MSK::BatchScramSecret', 'AWS::AppStream::Stack', 'AWS::IoT::JobTemplate', 'AWS::IoTWireless::FuotaTask', 'AWS::IoT::ProvisioningTemplate', 'AWS::InspectorV2::Filter', 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation', 'AWS::ServiceDiscovery::Instance', 'AWS::Transfer::Certificate', 'AWS::MediaConnect::FlowSource', 'AWS::APS::RuleGroupsNamespace', 'AWS::CodeGuruProfiler::ProfilingGroup', 'AWS::Route53Resolver::ResolverQueryLoggingConfig', 'AWS::Batch::SchedulingPolicy', 'AWS::ACMPCA::CertificateAuthorityActivation', 'AWS::AppMesh::GatewayRoute', 'AWS::AppMesh::Mesh', 'AWS::Connect::Instance', 'AWS::Connect::QuickConnect', 'AWS::EC2::CarrierGateway', 'AWS::EC2::IPAMPool', 'AWS::EC2::TransitGatewayConnect', 'AWS::EC2::TransitGatewayMulticastDomain', 'AWS::ECS::CapacityProvider', 'AWS::IAM::InstanceProfile', 'AWS::IoT::CACertificate', 'AWS::IoTTwinMaker::SyncJob', 'AWS::KafkaConnect::Connector', 'AWS::Lambda::CodeSigningConfig', 'AWS::NetworkManager::ConnectPeer', 'AWS::ResourceExplorer2::Index', ], ], 'ResourceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceType', ], ], 'ResourceTypeString' => [ 'type' => 'string', 'max' => 196, 'min' => 1, ], 'ResourceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit256', ], 'max' => 20, 'min' => 0, ], 'ResourceTypesScope' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit256', ], 'max' => 100, 'min' => 0, ], 'ResourceValue' => [ 'type' => 'structure', 'required' => [ 'Value', ], 'members' => [ 'Value' => [ 'shape' => 'ResourceValueType', ], ], ], 'ResourceValueType' => [ 'type' => 'string', 'enum' => [ 'RESOURCE_ID', ], ], 'Results' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RetentionConfiguration' => [ 'type' => 'structure', 'required' => [ 'Name', 'RetentionPeriodInDays', ], 'members' => [ 'Name' => [ 'shape' => 'RetentionConfigurationName', ], 'RetentionPeriodInDays' => [ 'shape' => 'RetentionPeriodInDays', ], ], ], 'RetentionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RetentionConfiguration', ], ], 'RetentionConfigurationName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\w\\-]+', ], 'RetentionConfigurationNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RetentionConfigurationName', ], 'max' => 1, 'min' => 0, ], 'RetentionPeriodInDays' => [ 'type' => 'integer', 'max' => 2557, 'min' => 30, ], 'RuleLimit' => [ 'type' => 'integer', 'max' => 50, 'min' => 0, ], 'SSMDocumentName' => [ 'type' => 'string', 'pattern' => '^[a-zA-Z0-9_\\-.:/]{3,200}$', ], 'SSMDocumentVersion' => [ 'type' => 'string', 'pattern' => '([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)', ], 'SchemaVersionId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[A-Za-z0-9-]+', ], 'Scope' => [ 'type' => 'structure', 'members' => [ 'ComplianceResourceTypes' => [ 'shape' => 'ComplianceResourceTypes', ], 'TagKey' => [ 'shape' => 'StringWithCharLimit128', ], 'TagValue' => [ 'shape' => 'StringWithCharLimit256', ], 'ComplianceResourceId' => [ 'shape' => 'BaseResourceId', ], ], ], 'SelectAggregateResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'Expression', 'ConfigurationAggregatorName', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Limit' => [ 'shape' => 'Limit', ], 'MaxResults' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SelectAggregateResourceConfigResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'Results', ], 'QueryInfo' => [ 'shape' => 'QueryInfo', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SelectResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'Expression', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SelectResourceConfigResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'Results', ], 'QueryInfo' => [ 'shape' => 'QueryInfo', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SortBy' => [ 'type' => 'string', 'enum' => [ 'SCORE', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'Source' => [ 'type' => 'structure', 'required' => [ 'Owner', ], 'members' => [ 'Owner' => [ 'shape' => 'Owner', ], 'SourceIdentifier' => [ 'shape' => 'StringWithCharLimit256', ], 'SourceDetails' => [ 'shape' => 'SourceDetails', ], 'CustomPolicyDetails' => [ 'shape' => 'CustomPolicyDetails', ], ], ], 'SourceDetail' => [ 'type' => 'structure', 'members' => [ 'EventSource' => [ 'shape' => 'EventSource', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], ], ], 'SourceDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceDetail', ], 'max' => 25, 'min' => 0, ], 'SsmControls' => [ 'type' => 'structure', 'members' => [ 'ConcurrentExecutionRatePercentage' => [ 'shape' => 'Percentage', ], 'ErrorPercentage' => [ 'shape' => 'Percentage', ], ], ], 'StackArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'StartConfigRulesEvaluationRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ReevaluateConfigRuleNames', ], ], ], 'StartConfigRulesEvaluationResponse' => [ 'type' => 'structure', 'members' => [], ], 'StartConfigurationRecorderRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationRecorderName', ], 'members' => [ 'ConfigurationRecorderName' => [ 'shape' => 'RecorderName', ], ], ], 'StartRemediationExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'ResourceKeys', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceKeys' => [ 'shape' => 'ResourceKeys', ], ], ], 'StartRemediationExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'FailureMessage' => [ 'shape' => 'String', ], 'FailedItems' => [ 'shape' => 'ResourceKeys', ], ], ], 'StartResourceEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceDetails', 'EvaluationMode', ], 'members' => [ 'ResourceDetails' => [ 'shape' => 'ResourceDetails', ], 'EvaluationContext' => [ 'shape' => 'EvaluationContext', ], 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], 'EvaluationTimeout' => [ 'shape' => 'EvaluationTimeout', ], 'ClientToken' => [ 'shape' => 'ClientToken', ], ], ], 'StartResourceEvaluationResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], ], ], 'StaticParameterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit256', ], 'max' => 25, 'min' => 0, ], 'StaticValue' => [ 'type' => 'structure', 'required' => [ 'Values', ], 'members' => [ 'Values' => [ 'shape' => 'StaticParameterValues', ], ], ], 'StatusDetailFilters' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'MemberAccountRuleStatus' => [ 'shape' => 'MemberAccountRuleStatus', ], ], ], 'StopConfigurationRecorderRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationRecorderName', ], 'members' => [ 'ConfigurationRecorderName' => [ 'shape' => 'RecorderName', ], ], ], 'StoredQuery' => [ 'type' => 'structure', 'required' => [ 'QueryName', ], 'members' => [ 'QueryId' => [ 'shape' => 'QueryId', 'box' => true, ], 'QueryArn' => [ 'shape' => 'QueryArn', 'box' => true, ], 'QueryName' => [ 'shape' => 'QueryName', ], 'Description' => [ 'shape' => 'QueryDescription', 'box' => true, ], 'Expression' => [ 'shape' => 'QueryExpression', 'box' => true, ], ], ], 'StoredQueryMetadata' => [ 'type' => 'structure', 'required' => [ 'QueryId', 'QueryArn', 'QueryName', ], 'members' => [ 'QueryId' => [ 'shape' => 'QueryId', ], 'QueryArn' => [ 'shape' => 'QueryArn', ], 'QueryName' => [ 'shape' => 'QueryName', ], 'Description' => [ 'shape' => 'QueryDescription', ], ], ], 'StoredQueryMetadataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StoredQueryMetadata', ], ], 'String' => [ 'type' => 'string', ], 'StringWithCharLimit1024' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'StringWithCharLimit128' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'StringWithCharLimit2048' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'StringWithCharLimit256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'StringWithCharLimit256Min0' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'StringWithCharLimit64' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'StringWithCharLimit768' => [ 'type' => 'string', 'max' => 768, 'min' => 1, ], 'SupplementaryConfiguration' => [ 'type' => 'map', 'key' => [ 'shape' => 'SupplementaryConfigurationName', ], 'value' => [ 'shape' => 'SupplementaryConfigurationValue', ], ], 'SupplementaryConfigurationName' => [ 'type' => 'string', ], 'SupplementaryConfigurationValue' => [ 'type' => 'string', ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'Tags' => [ 'type' => 'map', 'key' => [ 'shape' => 'Name', ], 'value' => [ 'shape' => 'Value', ], ], 'TagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TemplateBody' => [ 'type' => 'string', 'max' => 51200, 'min' => 1, ], 'TemplateS3Uri' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => 's3://.*', ], 'TemplateSSMDocumentDetails' => [ 'type' => 'structure', 'required' => [ 'DocumentName', ], 'members' => [ 'DocumentName' => [ 'shape' => 'SSMDocumentName', ], 'DocumentVersion' => [ 'shape' => 'SSMDocumentVersion', ], ], ], 'TimeWindow' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'Date', ], 'EndTime' => [ 'shape' => 'Date', ], ], ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UnprocessedResourceIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateResourceIdentifier', ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Value' => [ 'type' => 'string', ], 'Version' => [ 'type' => 'string', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2014-11-12', 'endpointPrefix' => 'config', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'Config Service', 'serviceFullName' => 'AWS Config', 'serviceId' => 'Config Service', 'signatureVersion' => 'v4', 'targetPrefix' => 'StarlingDoveService', 'uid' => 'config-2014-11-12', ], 'operations' => [ 'BatchGetAggregateResourceConfig' => [ 'name' => 'BatchGetAggregateResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchGetAggregateResourceConfigRequest', ], 'output' => [ 'shape' => 'BatchGetAggregateResourceConfigResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'BatchGetResourceConfig' => [ 'name' => 'BatchGetResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchGetResourceConfigRequest', ], 'output' => [ 'shape' => 'BatchGetResourceConfigResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], ], ], 'DeleteAggregationAuthorization' => [ 'name' => 'DeleteAggregationAuthorization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAggregationAuthorizationRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DeleteConfigRule' => [ 'name' => 'DeleteConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConfigRuleRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteConfigurationAggregator' => [ 'name' => 'DeleteConfigurationAggregator', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConfigurationAggregatorRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'DeleteConfigurationRecorder' => [ 'name' => 'DeleteConfigurationRecorder', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConfigurationRecorderRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationRecorderException', ], ], ], 'DeleteConformancePack' => [ 'name' => 'DeleteConformancePack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConformancePackRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConformancePackException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteDeliveryChannel' => [ 'name' => 'DeleteDeliveryChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDeliveryChannelRequest', ], 'errors' => [ [ 'shape' => 'NoSuchDeliveryChannelException', ], [ 'shape' => 'LastDeliveryChannelDeleteFailedException', ], ], ], 'DeleteEvaluationResults' => [ 'name' => 'DeleteEvaluationResults', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEvaluationResultsRequest', ], 'output' => [ 'shape' => 'DeleteEvaluationResultsResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteOrganizationConfigRule' => [ 'name' => 'DeleteOrganizationConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOrganizationConfigRuleRequest', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConfigRuleException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DeleteOrganizationConformancePack' => [ 'name' => 'DeleteOrganizationConformancePack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOrganizationConformancePackRequest', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConformancePackException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DeletePendingAggregationRequest' => [ 'name' => 'DeletePendingAggregationRequest', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePendingAggregationRequestRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DeleteRemediationConfiguration' => [ 'name' => 'DeleteRemediationConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRemediationConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteRemediationConfigurationResponse', ], 'errors' => [ [ 'shape' => 'NoSuchRemediationConfigurationException', ], [ 'shape' => 'RemediationInProgressException', ], [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DeleteRemediationExceptions' => [ 'name' => 'DeleteRemediationExceptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRemediationExceptionsRequest', ], 'output' => [ 'shape' => 'DeleteRemediationExceptionsResponse', ], 'errors' => [ [ 'shape' => 'NoSuchRemediationExceptionException', ], ], ], 'DeleteResourceConfig' => [ 'name' => 'DeleteResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResourceConfigRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'NoRunningConfigurationRecorderException', ], ], ], 'DeleteRetentionConfiguration' => [ 'name' => 'DeleteRetentionConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRetentionConfigurationRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchRetentionConfigurationException', ], ], ], 'DeleteStoredQuery' => [ 'name' => 'DeleteStoredQuery', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStoredQueryRequest', ], 'output' => [ 'shape' => 'DeleteStoredQueryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DeliverConfigSnapshot' => [ 'name' => 'DeliverConfigSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeliverConfigSnapshotRequest', ], 'output' => [ 'shape' => 'DeliverConfigSnapshotResponse', ], 'errors' => [ [ 'shape' => 'NoSuchDeliveryChannelException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], [ 'shape' => 'NoRunningConfigurationRecorderException', ], ], ], 'DescribeAggregateComplianceByConfigRules' => [ 'name' => 'DescribeAggregateComplianceByConfigRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAggregateComplianceByConfigRulesRequest', ], 'output' => [ 'shape' => 'DescribeAggregateComplianceByConfigRulesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'DescribeAggregateComplianceByConformancePacks' => [ 'name' => 'DescribeAggregateComplianceByConformancePacks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAggregateComplianceByConformancePacksRequest', ], 'output' => [ 'shape' => 'DescribeAggregateComplianceByConformancePacksResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'DescribeAggregationAuthorizations' => [ 'name' => 'DescribeAggregationAuthorizations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAggregationAuthorizationsRequest', ], 'output' => [ 'shape' => 'DescribeAggregationAuthorizationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], ], ], 'DescribeComplianceByConfigRule' => [ 'name' => 'DescribeComplianceByConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeComplianceByConfigRuleRequest', ], 'output' => [ 'shape' => 'DescribeComplianceByConfigRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'DescribeComplianceByResource' => [ 'name' => 'DescribeComplianceByResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeComplianceByResourceRequest', ], 'output' => [ 'shape' => 'DescribeComplianceByResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'DescribeConfigRuleEvaluationStatus' => [ 'name' => 'DescribeConfigRuleEvaluationStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigRuleEvaluationStatusRequest', ], 'output' => [ 'shape' => 'DescribeConfigRuleEvaluationStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'DescribeConfigRules' => [ 'name' => 'DescribeConfigRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigRulesRequest', ], 'output' => [ 'shape' => 'DescribeConfigRulesResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeConfigurationAggregatorSourcesStatus' => [ 'name' => 'DescribeConfigurationAggregatorSourcesStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationAggregatorSourcesStatusRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationAggregatorSourcesStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], ], ], 'DescribeConfigurationAggregators' => [ 'name' => 'DescribeConfigurationAggregators', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationAggregatorsRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationAggregatorsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], ], ], 'DescribeConfigurationRecorderStatus' => [ 'name' => 'DescribeConfigurationRecorderStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationRecorderStatusRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationRecorderStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationRecorderException', ], ], ], 'DescribeConfigurationRecorders' => [ 'name' => 'DescribeConfigurationRecorders', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationRecordersRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationRecordersResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationRecorderException', ], ], ], 'DescribeConformancePackCompliance' => [ 'name' => 'DescribeConformancePackCompliance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConformancePackComplianceRequest', ], 'output' => [ 'shape' => 'DescribeConformancePackComplianceResponse', ], 'errors' => [ [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchConfigRuleInConformancePackException', ], [ 'shape' => 'NoSuchConformancePackException', ], ], ], 'DescribeConformancePackStatus' => [ 'name' => 'DescribeConformancePackStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConformancePackStatusRequest', ], 'output' => [ 'shape' => 'DescribeConformancePackStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeConformancePacks' => [ 'name' => 'DescribeConformancePacks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConformancePacksRequest', ], 'output' => [ 'shape' => 'DescribeConformancePacksResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConformancePackException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeDeliveryChannelStatus' => [ 'name' => 'DescribeDeliveryChannelStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeliveryChannelStatusRequest', ], 'output' => [ 'shape' => 'DescribeDeliveryChannelStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchDeliveryChannelException', ], ], ], 'DescribeDeliveryChannels' => [ 'name' => 'DescribeDeliveryChannels', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeliveryChannelsRequest', ], 'output' => [ 'shape' => 'DescribeDeliveryChannelsResponse', ], 'errors' => [ [ 'shape' => 'NoSuchDeliveryChannelException', ], ], ], 'DescribeOrganizationConfigRuleStatuses' => [ 'name' => 'DescribeOrganizationConfigRuleStatuses', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrganizationConfigRuleStatusesRequest', ], 'output' => [ 'shape' => 'DescribeOrganizationConfigRuleStatusesResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConfigRuleException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DescribeOrganizationConfigRules' => [ 'name' => 'DescribeOrganizationConfigRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrganizationConfigRulesRequest', ], 'output' => [ 'shape' => 'DescribeOrganizationConfigRulesResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConfigRuleException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DescribeOrganizationConformancePackStatuses' => [ 'name' => 'DescribeOrganizationConformancePackStatuses', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrganizationConformancePackStatusesRequest', ], 'output' => [ 'shape' => 'DescribeOrganizationConformancePackStatusesResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConformancePackException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DescribeOrganizationConformancePacks' => [ 'name' => 'DescribeOrganizationConformancePacks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrganizationConformancePacksRequest', ], 'output' => [ 'shape' => 'DescribeOrganizationConformancePacksResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConformancePackException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'DescribePendingAggregationRequests' => [ 'name' => 'DescribePendingAggregationRequests', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePendingAggregationRequestsRequest', ], 'output' => [ 'shape' => 'DescribePendingAggregationRequestsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidLimitException', ], ], ], 'DescribeRemediationConfigurations' => [ 'name' => 'DescribeRemediationConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRemediationConfigurationsRequest', ], 'output' => [ 'shape' => 'DescribeRemediationConfigurationsResponse', ], ], 'DescribeRemediationExceptions' => [ 'name' => 'DescribeRemediationExceptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRemediationExceptionsRequest', ], 'output' => [ 'shape' => 'DescribeRemediationExceptionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeRemediationExecutionStatus' => [ 'name' => 'DescribeRemediationExecutionStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRemediationExecutionStatusRequest', ], 'output' => [ 'shape' => 'DescribeRemediationExecutionStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchRemediationConfigurationException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeRetentionConfigurations' => [ 'name' => 'DescribeRetentionConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRetentionConfigurationsRequest', ], 'output' => [ 'shape' => 'DescribeRetentionConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'NoSuchRetentionConfigurationException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'GetAggregateComplianceDetailsByConfigRule' => [ 'name' => 'GetAggregateComplianceDetailsByConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAggregateComplianceDetailsByConfigRuleRequest', ], 'output' => [ 'shape' => 'GetAggregateComplianceDetailsByConfigRuleResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'GetAggregateConfigRuleComplianceSummary' => [ 'name' => 'GetAggregateConfigRuleComplianceSummary', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAggregateConfigRuleComplianceSummaryRequest', ], 'output' => [ 'shape' => 'GetAggregateConfigRuleComplianceSummaryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'GetAggregateConformancePackComplianceSummary' => [ 'name' => 'GetAggregateConformancePackComplianceSummary', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAggregateConformancePackComplianceSummaryRequest', ], 'output' => [ 'shape' => 'GetAggregateConformancePackComplianceSummaryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'GetAggregateDiscoveredResourceCounts' => [ 'name' => 'GetAggregateDiscoveredResourceCounts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAggregateDiscoveredResourceCountsRequest', ], 'output' => [ 'shape' => 'GetAggregateDiscoveredResourceCountsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'GetAggregateResourceConfig' => [ 'name' => 'GetAggregateResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAggregateResourceConfigRequest', ], 'output' => [ 'shape' => 'GetAggregateResourceConfigResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], [ 'shape' => 'OversizedConfigurationItemException', ], [ 'shape' => 'ResourceNotDiscoveredException', ], ], ], 'GetComplianceDetailsByConfigRule' => [ 'name' => 'GetComplianceDetailsByConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetComplianceDetailsByConfigRuleRequest', ], 'output' => [ 'shape' => 'GetComplianceDetailsByConfigRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigRuleException', ], ], ], 'GetComplianceDetailsByResource' => [ 'name' => 'GetComplianceDetailsByResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetComplianceDetailsByResourceRequest', ], 'output' => [ 'shape' => 'GetComplianceDetailsByResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], ], ], 'GetComplianceSummaryByConfigRule' => [ 'name' => 'GetComplianceSummaryByConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'output' => [ 'shape' => 'GetComplianceSummaryByConfigRuleResponse', ], ], 'GetComplianceSummaryByResourceType' => [ 'name' => 'GetComplianceSummaryByResourceType', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetComplianceSummaryByResourceTypeRequest', ], 'output' => [ 'shape' => 'GetComplianceSummaryByResourceTypeResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], ], ], 'GetConformancePackComplianceDetails' => [ 'name' => 'GetConformancePackComplianceDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetConformancePackComplianceDetailsRequest', ], 'output' => [ 'shape' => 'GetConformancePackComplianceDetailsResponse', ], 'errors' => [ [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConformancePackException', ], [ 'shape' => 'NoSuchConfigRuleInConformancePackException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'GetConformancePackComplianceSummary' => [ 'name' => 'GetConformancePackComplianceSummary', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetConformancePackComplianceSummaryRequest', ], 'output' => [ 'shape' => 'GetConformancePackComplianceSummaryResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConformancePackException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'GetCustomRulePolicy' => [ 'name' => 'GetCustomRulePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCustomRulePolicyRequest', ], 'output' => [ 'shape' => 'GetCustomRulePolicyResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], ], ], 'GetDiscoveredResourceCounts' => [ 'name' => 'GetDiscoveredResourceCounts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiscoveredResourceCountsRequest', ], 'output' => [ 'shape' => 'GetDiscoveredResourceCountsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'GetOrganizationConfigRuleDetailedStatus' => [ 'name' => 'GetOrganizationConfigRuleDetailedStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOrganizationConfigRuleDetailedStatusRequest', ], 'output' => [ 'shape' => 'GetOrganizationConfigRuleDetailedStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConfigRuleException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'GetOrganizationConformancePackDetailedStatus' => [ 'name' => 'GetOrganizationConformancePackDetailedStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOrganizationConformancePackDetailedStatusRequest', ], 'output' => [ 'shape' => 'GetOrganizationConformancePackDetailedStatusResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConformancePackException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'GetOrganizationCustomRulePolicy' => [ 'name' => 'GetOrganizationCustomRulePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOrganizationCustomRulePolicyRequest', ], 'output' => [ 'shape' => 'GetOrganizationCustomRulePolicyResponse', ], 'errors' => [ [ 'shape' => 'NoSuchOrganizationConfigRuleException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], ], ], 'GetResourceConfigHistory' => [ 'name' => 'GetResourceConfigHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResourceConfigHistoryRequest', ], 'output' => [ 'shape' => 'GetResourceConfigHistoryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidTimeRangeException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], [ 'shape' => 'ResourceNotDiscoveredException', ], ], ], 'GetResourceEvaluationSummary' => [ 'name' => 'GetResourceEvaluationSummary', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResourceEvaluationSummaryRequest', ], 'output' => [ 'shape' => 'GetResourceEvaluationSummaryResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetStoredQuery' => [ 'name' => 'GetStoredQuery', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStoredQueryRequest', ], 'output' => [ 'shape' => 'GetStoredQueryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAggregateDiscoveredResources' => [ 'name' => 'ListAggregateDiscoveredResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAggregateDiscoveredResourcesRequest', ], 'output' => [ 'shape' => 'ListAggregateDiscoveredResourcesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], ], ], 'ListConformancePackComplianceScores' => [ 'name' => 'ListConformancePackComplianceScores', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListConformancePackComplianceScoresRequest', ], 'output' => [ 'shape' => 'ListConformancePackComplianceScoresResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'ListDiscoveredResources' => [ 'name' => 'ListDiscoveredResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDiscoveredResourcesRequest', ], 'output' => [ 'shape' => 'ListDiscoveredResourcesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], ], ], 'ListResourceEvaluations' => [ 'name' => 'ListResourceEvaluations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceEvaluationsRequest', ], 'output' => [ 'shape' => 'ListResourceEvaluationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidTimeRangeException', ], ], ], 'ListStoredQueries' => [ 'name' => 'ListStoredQueries', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStoredQueriesRequest', ], 'output' => [ 'shape' => 'ListStoredQueriesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'PutAggregationAuthorization' => [ 'name' => 'PutAggregationAuthorization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAggregationAuthorizationRequest', ], 'output' => [ 'shape' => 'PutAggregationAuthorizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], ], ], 'PutConfigRule' => [ 'name' => 'PutConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutConfigRuleRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'MaxNumberOfConfigRulesExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], ], ], 'PutConfigurationAggregator' => [ 'name' => 'PutConfigurationAggregator', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutConfigurationAggregatorRequest', ], 'output' => [ 'shape' => 'PutConfigurationAggregatorResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidRoleException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], [ 'shape' => 'NoAvailableOrganizationException', ], [ 'shape' => 'OrganizationAllFeaturesNotEnabledException', ], ], ], 'PutConfigurationRecorder' => [ 'name' => 'PutConfigurationRecorder', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutConfigurationRecorderRequest', ], 'errors' => [ [ 'shape' => 'MaxNumberOfConfigurationRecordersExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InvalidConfigurationRecorderNameException', ], [ 'shape' => 'InvalidRoleException', ], [ 'shape' => 'InvalidRecordingGroupException', ], ], ], 'PutConformancePack' => [ 'name' => 'PutConformancePack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutConformancePackRequest', ], 'output' => [ 'shape' => 'PutConformancePackResponse', ], 'errors' => [ [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'ConformancePackTemplateValidationException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'MaxNumberOfConformancePacksExceededException', ], ], ], 'PutDeliveryChannel' => [ 'name' => 'PutDeliveryChannel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutDeliveryChannelRequest', ], 'errors' => [ [ 'shape' => 'MaxNumberOfDeliveryChannelsExceededException', ], [ 'shape' => 'NoAvailableConfigurationRecorderException', ], [ 'shape' => 'InvalidDeliveryChannelNameException', ], [ 'shape' => 'NoSuchBucketException', ], [ 'shape' => 'InvalidS3KeyPrefixException', ], [ 'shape' => 'InvalidS3KmsKeyArnException', ], [ 'shape' => 'InvalidSNSTopicARNException', ], [ 'shape' => 'InsufficientDeliveryPolicyException', ], ], ], 'PutEvaluations' => [ 'name' => 'PutEvaluations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutEvaluationsRequest', ], 'output' => [ 'shape' => 'PutEvaluationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidResultTokenException', ], [ 'shape' => 'NoSuchConfigRuleException', ], ], ], 'PutExternalEvaluation' => [ 'name' => 'PutExternalEvaluation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutExternalEvaluationRequest', ], 'output' => [ 'shape' => 'PutExternalEvaluationResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'PutOrganizationConfigRule' => [ 'name' => 'PutOrganizationConfigRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutOrganizationConfigRuleRequest', ], 'output' => [ 'shape' => 'PutOrganizationConfigRuleResponse', ], 'errors' => [ [ 'shape' => 'MaxNumberOfOrganizationConfigRulesExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], [ 'shape' => 'NoAvailableOrganizationException', ], [ 'shape' => 'OrganizationAllFeaturesNotEnabledException', ], [ 'shape' => 'InsufficientPermissionsException', ], ], ], 'PutOrganizationConformancePack' => [ 'name' => 'PutOrganizationConformancePack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutOrganizationConformancePackRequest', ], 'output' => [ 'shape' => 'PutOrganizationConformancePackResponse', ], 'errors' => [ [ 'shape' => 'MaxNumberOfOrganizationConformancePacksExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'OrganizationAccessDeniedException', ], [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'OrganizationConformancePackTemplateValidationException', ], [ 'shape' => 'OrganizationAllFeaturesNotEnabledException', ], [ 'shape' => 'NoAvailableOrganizationException', ], ], ], 'PutRemediationConfigurations' => [ 'name' => 'PutRemediationConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutRemediationConfigurationsRequest', ], 'output' => [ 'shape' => 'PutRemediationConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'PutRemediationExceptions' => [ 'name' => 'PutRemediationExceptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutRemediationExceptionsRequest', ], 'output' => [ 'shape' => 'PutRemediationExceptionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InsufficientPermissionsException', ], ], ], 'PutResourceConfig' => [ 'name' => 'PutResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutResourceConfigRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'NoRunningConfigurationRecorderException', ], [ 'shape' => 'MaxActiveResourcesExceededException', ], ], ], 'PutRetentionConfiguration' => [ 'name' => 'PutRetentionConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutRetentionConfigurationRequest', ], 'output' => [ 'shape' => 'PutRetentionConfigurationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'MaxNumberOfRetentionConfigurationsExceededException', ], ], ], 'PutStoredQuery' => [ 'name' => 'PutStoredQuery', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutStoredQueryRequest', ], 'output' => [ 'shape' => 'PutStoredQueryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'ResourceConcurrentModificationException', ], ], ], 'SelectAggregateResourceConfig' => [ 'name' => 'SelectAggregateResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SelectAggregateResourceConfigRequest', ], 'output' => [ 'shape' => 'SelectAggregateResourceConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidExpressionException', ], [ 'shape' => 'NoSuchConfigurationAggregatorException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'SelectResourceConfig' => [ 'name' => 'SelectResourceConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SelectResourceConfigRequest', ], 'output' => [ 'shape' => 'SelectResourceConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidExpressionException', ], [ 'shape' => 'InvalidLimitException', ], [ 'shape' => 'InvalidNextTokenException', ], ], ], 'StartConfigRulesEvaluation' => [ 'name' => 'StartConfigRulesEvaluation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartConfigRulesEvaluationRequest', ], 'output' => [ 'shape' => 'StartConfigRulesEvaluationResponse', ], 'errors' => [ [ 'shape' => 'NoSuchConfigRuleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'StartConfigurationRecorder' => [ 'name' => 'StartConfigurationRecorder', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartConfigurationRecorderRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationRecorderException', ], [ 'shape' => 'NoAvailableDeliveryChannelException', ], ], ], 'StartRemediationExecution' => [ 'name' => 'StartRemediationExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartRemediationExecutionRequest', ], 'output' => [ 'shape' => 'StartRemediationExecutionResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InsufficientPermissionsException', ], [ 'shape' => 'NoSuchRemediationConfigurationException', ], ], ], 'StartResourceEvaluation' => [ 'name' => 'StartResourceEvaluation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartResourceEvaluationRequest', ], 'output' => [ 'shape' => 'StartResourceEvaluationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'IdempotentParameterMismatch', ], ], ], 'StopConfigurationRecorder' => [ 'name' => 'StopConfigurationRecorder', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopConfigurationRecorderRequest', ], 'errors' => [ [ 'shape' => 'NoSuchConfigurationRecorderException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], ], 'shapes' => [ 'ARN' => [ 'type' => 'string', ], 'AccountAggregationSource' => [ 'type' => 'structure', 'required' => [ 'AccountIds', ], 'members' => [ 'AccountIds' => [ 'shape' => 'AccountAggregationSourceAccountList', ], 'AllAwsRegions' => [ 'shape' => 'Boolean', ], 'AwsRegions' => [ 'shape' => 'AggregatorRegionList', ], ], ], 'AccountAggregationSourceAccountList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], 'min' => 1, ], 'AccountAggregationSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountAggregationSource', ], 'max' => 1, 'min' => 0, ], 'AccountId' => [ 'type' => 'string', 'pattern' => '\\d{12}', ], 'AggregateComplianceByConfigRule' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'Compliance' => [ 'shape' => 'Compliance', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'AggregateComplianceByConfigRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateComplianceByConfigRule', ], ], 'AggregateComplianceByConformancePack' => [ 'type' => 'structure', 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'Compliance' => [ 'shape' => 'AggregateConformancePackCompliance', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'AggregateComplianceByConformancePackList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateComplianceByConformancePack', ], ], 'AggregateComplianceCount' => [ 'type' => 'structure', 'members' => [ 'GroupName' => [ 'shape' => 'StringWithCharLimit256', ], 'ComplianceSummary' => [ 'shape' => 'ComplianceSummary', ], ], ], 'AggregateComplianceCountList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateComplianceCount', ], ], 'AggregateConformancePackCompliance' => [ 'type' => 'structure', 'members' => [ 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], 'CompliantRuleCount' => [ 'shape' => 'Integer', ], 'NonCompliantRuleCount' => [ 'shape' => 'Integer', ], 'TotalRuleCount' => [ 'shape' => 'Integer', ], ], ], 'AggregateConformancePackComplianceCount' => [ 'type' => 'structure', 'members' => [ 'CompliantConformancePackCount' => [ 'shape' => 'Integer', ], 'NonCompliantConformancePackCount' => [ 'shape' => 'Integer', ], ], ], 'AggregateConformancePackComplianceFilters' => [ 'type' => 'structure', 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'AggregateConformancePackComplianceSummary' => [ 'type' => 'structure', 'members' => [ 'ComplianceSummary' => [ 'shape' => 'AggregateConformancePackComplianceCount', ], 'GroupName' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'AggregateConformancePackComplianceSummaryFilters' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'AggregateConformancePackComplianceSummaryGroupKey' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT_ID', 'AWS_REGION', ], ], 'AggregateConformancePackComplianceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateConformancePackComplianceSummary', ], ], 'AggregateEvaluationResult' => [ 'type' => 'structure', 'members' => [ 'EvaluationResultIdentifier' => [ 'shape' => 'EvaluationResultIdentifier', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'ResultRecordedTime' => [ 'shape' => 'Date', ], 'ConfigRuleInvokedTime' => [ 'shape' => 'Date', ], 'Annotation' => [ 'shape' => 'StringWithCharLimit256', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'AggregateEvaluationResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateEvaluationResult', ], ], 'AggregateResourceIdentifier' => [ 'type' => 'structure', 'required' => [ 'SourceAccountId', 'SourceRegion', 'ResourceId', 'ResourceType', ], 'members' => [ 'SourceAccountId' => [ 'shape' => 'AccountId', ], 'SourceRegion' => [ 'shape' => 'AwsRegion', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceName' => [ 'shape' => 'ResourceName', ], ], ], 'AggregatedSourceStatus' => [ 'type' => 'structure', 'members' => [ 'SourceId' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'AggregatedSourceType', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], 'LastUpdateStatus' => [ 'shape' => 'AggregatedSourceStatusType', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], 'LastErrorCode' => [ 'shape' => 'String', ], 'LastErrorMessage' => [ 'shape' => 'String', ], ], ], 'AggregatedSourceStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregatedSourceStatus', ], ], 'AggregatedSourceStatusType' => [ 'type' => 'string', 'enum' => [ 'FAILED', 'SUCCEEDED', 'OUTDATED', ], ], 'AggregatedSourceStatusTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregatedSourceStatusType', ], 'min' => 1, ], 'AggregatedSourceType' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT', 'ORGANIZATION', ], ], 'AggregationAuthorization' => [ 'type' => 'structure', 'members' => [ 'AggregationAuthorizationArn' => [ 'shape' => 'String', ], 'AuthorizedAccountId' => [ 'shape' => 'AccountId', ], 'AuthorizedAwsRegion' => [ 'shape' => 'AwsRegion', ], 'CreationTime' => [ 'shape' => 'Date', ], ], ], 'AggregationAuthorizationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregationAuthorization', ], ], 'AggregatorRegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'min' => 1, ], 'AllSupported' => [ 'type' => 'boolean', ], 'AmazonResourceName' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'Annotation' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'AutoRemediationAttemptSeconds' => [ 'type' => 'long', 'box' => true, 'max' => 2678000, 'min' => 1, ], 'AutoRemediationAttempts' => [ 'type' => 'integer', 'box' => true, 'max' => 25, 'min' => 1, ], 'AvailabilityZone' => [ 'type' => 'string', ], 'AwsRegion' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'BaseConfigurationItem' => [ 'type' => 'structure', 'members' => [ 'version' => [ 'shape' => 'Version', ], 'accountId' => [ 'shape' => 'AccountId', ], 'configurationItemCaptureTime' => [ 'shape' => 'ConfigurationItemCaptureTime', ], 'configurationItemStatus' => [ 'shape' => 'ConfigurationItemStatus', ], 'configurationStateId' => [ 'shape' => 'ConfigurationStateId', ], 'arn' => [ 'shape' => 'ARN', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'availabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'resourceCreationTime' => [ 'shape' => 'ResourceCreationTime', ], 'configuration' => [ 'shape' => 'Configuration', ], 'supplementaryConfiguration' => [ 'shape' => 'SupplementaryConfiguration', ], 'recordingFrequency' => [ 'shape' => 'RecordingFrequency', ], 'configurationItemDeliveryTime' => [ 'shape' => 'ConfigurationItemDeliveryTime', ], ], ], 'BaseConfigurationItems' => [ 'type' => 'list', 'member' => [ 'shape' => 'BaseConfigurationItem', ], ], 'BaseResourceId' => [ 'type' => 'string', 'max' => 768, 'min' => 1, ], 'BatchGetAggregateResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', 'ResourceIdentifiers', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'ResourceIdentifiers' => [ 'shape' => 'ResourceIdentifiersList', ], ], ], 'BatchGetAggregateResourceConfigResponse' => [ 'type' => 'structure', 'members' => [ 'BaseConfigurationItems' => [ 'shape' => 'BaseConfigurationItems', ], 'UnprocessedResourceIdentifiers' => [ 'shape' => 'UnprocessedResourceIdentifierList', ], ], ], 'BatchGetResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'resourceKeys', ], 'members' => [ 'resourceKeys' => [ 'shape' => 'ResourceKeys', ], ], ], 'BatchGetResourceConfigResponse' => [ 'type' => 'structure', 'members' => [ 'baseConfigurationItems' => [ 'shape' => 'BaseConfigurationItems', ], 'unprocessedResourceKeys' => [ 'shape' => 'ResourceKeys', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'ChannelName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ChronologicalOrder' => [ 'type' => 'string', 'enum' => [ 'Reverse', 'Forward', ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 256, 'min' => 64, ], 'Compliance' => [ 'type' => 'structure', 'members' => [ 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'ComplianceContributorCount' => [ 'shape' => 'ComplianceContributorCount', ], ], ], 'ComplianceByConfigRule' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'StringWithCharLimit64', ], 'Compliance' => [ 'shape' => 'Compliance', ], ], ], 'ComplianceByConfigRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceByConfigRule', ], ], 'ComplianceByResource' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'BaseResourceId', ], 'Compliance' => [ 'shape' => 'Compliance', ], ], ], 'ComplianceByResources' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceByResource', ], ], 'ComplianceContributorCount' => [ 'type' => 'structure', 'members' => [ 'CappedCount' => [ 'shape' => 'Integer', ], 'CapExceeded' => [ 'shape' => 'Boolean', ], ], ], 'ComplianceResourceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit256', ], 'max' => 100, 'min' => 0, ], 'ComplianceScore' => [ 'type' => 'string', ], 'ComplianceSummariesByResourceType' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceSummaryByResourceType', ], ], 'ComplianceSummary' => [ 'type' => 'structure', 'members' => [ 'CompliantResourceCount' => [ 'shape' => 'ComplianceContributorCount', ], 'NonCompliantResourceCount' => [ 'shape' => 'ComplianceContributorCount', ], 'ComplianceSummaryTimestamp' => [ 'shape' => 'Date', ], ], ], 'ComplianceSummaryByResourceType' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ComplianceSummary' => [ 'shape' => 'ComplianceSummary', ], ], ], 'ComplianceType' => [ 'type' => 'string', 'enum' => [ 'COMPLIANT', 'NON_COMPLIANT', 'NOT_APPLICABLE', 'INSUFFICIENT_DATA', ], ], 'ComplianceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ComplianceType', ], 'max' => 3, 'min' => 0, ], 'ConfigExportDeliveryInfo' => [ 'type' => 'structure', 'members' => [ 'lastStatus' => [ 'shape' => 'DeliveryStatus', ], 'lastErrorCode' => [ 'shape' => 'String', ], 'lastErrorMessage' => [ 'shape' => 'String', ], 'lastAttemptTime' => [ 'shape' => 'Date', ], 'lastSuccessfulTime' => [ 'shape' => 'Date', ], 'nextDeliveryTime' => [ 'shape' => 'Date', ], ], ], 'ConfigRule' => [ 'type' => 'structure', 'required' => [ 'Source', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ConfigRuleArn' => [ 'shape' => 'StringWithCharLimit256', ], 'ConfigRuleId' => [ 'shape' => 'StringWithCharLimit64', ], 'Description' => [ 'shape' => 'EmptiableStringWithCharLimit256', ], 'Scope' => [ 'shape' => 'Scope', ], 'Source' => [ 'shape' => 'Source', ], 'InputParameters' => [ 'shape' => 'StringWithCharLimit1024', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], 'ConfigRuleState' => [ 'shape' => 'ConfigRuleState', ], 'CreatedBy' => [ 'shape' => 'StringWithCharLimit256', ], 'EvaluationModes' => [ 'shape' => 'EvaluationModes', ], ], ], 'ConfigRuleComplianceFilters' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'ConfigRuleComplianceSummaryFilters' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'ConfigRuleComplianceSummaryGroupKey' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT_ID', 'AWS_REGION', ], ], 'ConfigRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ConfigRuleArn' => [ 'shape' => 'String', ], 'ConfigRuleId' => [ 'shape' => 'String', ], 'LastSuccessfulInvocationTime' => [ 'shape' => 'Date', ], 'LastFailedInvocationTime' => [ 'shape' => 'Date', ], 'LastSuccessfulEvaluationTime' => [ 'shape' => 'Date', ], 'LastFailedEvaluationTime' => [ 'shape' => 'Date', ], 'FirstActivatedTime' => [ 'shape' => 'Date', ], 'LastDeactivatedTime' => [ 'shape' => 'Date', ], 'LastErrorCode' => [ 'shape' => 'String', ], 'LastErrorMessage' => [ 'shape' => 'String', ], 'FirstEvaluationStarted' => [ 'shape' => 'Boolean', ], 'LastDebugLogDeliveryStatus' => [ 'shape' => 'String', ], 'LastDebugLogDeliveryStatusReason' => [ 'shape' => 'String', ], 'LastDebugLogDeliveryTime' => [ 'shape' => 'Date', ], ], ], 'ConfigRuleEvaluationStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigRuleEvaluationStatus', ], ], 'ConfigRuleName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ConfigRuleNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigRuleName', ], 'max' => 25, 'min' => 0, ], 'ConfigRuleState' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DELETING', 'DELETING_RESULTS', 'EVALUATING', ], ], 'ConfigRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigRule', ], ], 'ConfigSnapshotDeliveryProperties' => [ 'type' => 'structure', 'members' => [ 'deliveryFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], ], ], 'ConfigStreamDeliveryInfo' => [ 'type' => 'structure', 'members' => [ 'lastStatus' => [ 'shape' => 'DeliveryStatus', ], 'lastErrorCode' => [ 'shape' => 'String', ], 'lastErrorMessage' => [ 'shape' => 'String', ], 'lastStatusChangeTime' => [ 'shape' => 'Date', ], ], ], 'Configuration' => [ 'type' => 'string', ], 'ConfigurationAggregator' => [ 'type' => 'structure', 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'ConfigurationAggregatorArn' => [ 'shape' => 'ConfigurationAggregatorArn', ], 'AccountAggregationSources' => [ 'shape' => 'AccountAggregationSourceList', ], 'OrganizationAggregationSource' => [ 'shape' => 'OrganizationAggregationSource', ], 'CreationTime' => [ 'shape' => 'Date', ], 'LastUpdatedTime' => [ 'shape' => 'Date', ], 'CreatedBy' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'ConfigurationAggregatorArn' => [ 'type' => 'string', 'pattern' => 'arn:aws[a-z\\-]*:config:[a-z\\-\\d]+:\\d+:config-aggregator/config-aggregator-[a-z\\d]+', ], 'ConfigurationAggregatorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationAggregator', ], ], 'ConfigurationAggregatorName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\w\\-]+', ], 'ConfigurationAggregatorNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationAggregatorName', ], 'max' => 10, 'min' => 0, ], 'ConfigurationItem' => [ 'type' => 'structure', 'members' => [ 'version' => [ 'shape' => 'Version', ], 'accountId' => [ 'shape' => 'AccountId', ], 'configurationItemCaptureTime' => [ 'shape' => 'ConfigurationItemCaptureTime', ], 'configurationItemStatus' => [ 'shape' => 'ConfigurationItemStatus', ], 'configurationStateId' => [ 'shape' => 'ConfigurationStateId', ], 'configurationItemMD5Hash' => [ 'shape' => 'ConfigurationItemMD5Hash', ], 'arn' => [ 'shape' => 'ARN', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'awsRegion' => [ 'shape' => 'AwsRegion', ], 'availabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'resourceCreationTime' => [ 'shape' => 'ResourceCreationTime', ], 'tags' => [ 'shape' => 'Tags', ], 'relatedEvents' => [ 'shape' => 'RelatedEventList', ], 'relationships' => [ 'shape' => 'RelationshipList', ], 'configuration' => [ 'shape' => 'Configuration', ], 'supplementaryConfiguration' => [ 'shape' => 'SupplementaryConfiguration', ], 'recordingFrequency' => [ 'shape' => 'RecordingFrequency', ], 'configurationItemDeliveryTime' => [ 'shape' => 'ConfigurationItemDeliveryTime', ], ], ], 'ConfigurationItemCaptureTime' => [ 'type' => 'timestamp', ], 'ConfigurationItemDeliveryTime' => [ 'type' => 'timestamp', ], 'ConfigurationItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationItem', ], ], 'ConfigurationItemMD5Hash' => [ 'type' => 'string', ], 'ConfigurationItemStatus' => [ 'type' => 'string', 'enum' => [ 'OK', 'ResourceDiscovered', 'ResourceNotRecorded', 'ResourceDeleted', 'ResourceDeletedNotRecorded', ], ], 'ConfigurationRecorder' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'RecorderName', ], 'roleARN' => [ 'shape' => 'String', ], 'recordingGroup' => [ 'shape' => 'RecordingGroup', ], 'recordingMode' => [ 'shape' => 'RecordingMode', ], ], ], 'ConfigurationRecorderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationRecorder', ], ], 'ConfigurationRecorderNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecorderName', ], ], 'ConfigurationRecorderStatus' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'lastStartTime' => [ 'shape' => 'Date', ], 'lastStopTime' => [ 'shape' => 'Date', ], 'recording' => [ 'shape' => 'Boolean', ], 'lastStatus' => [ 'shape' => 'RecorderStatus', ], 'lastErrorCode' => [ 'shape' => 'String', ], 'lastErrorMessage' => [ 'shape' => 'String', ], 'lastStatusChangeTime' => [ 'shape' => 'Date', ], ], ], 'ConfigurationRecorderStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationRecorderStatus', ], ], 'ConfigurationStateId' => [ 'type' => 'string', ], 'ConformancePackArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'ConformancePackComplianceFilters' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConformancePackConfigRuleNames', ], 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], ], ], 'ConformancePackComplianceResourceIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit256', ], 'max' => 5, 'min' => 0, ], 'ConformancePackComplianceScore' => [ 'type' => 'structure', 'members' => [ 'Score' => [ 'shape' => 'ComplianceScore', ], 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'LastUpdatedTime' => [ 'shape' => 'LastUpdatedTime', ], ], ], 'ConformancePackComplianceScores' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackComplianceScore', ], ], 'ConformancePackComplianceScoresFilters' => [ 'type' => 'structure', 'required' => [ 'ConformancePackNames', ], 'members' => [ 'ConformancePackNames' => [ 'shape' => 'ConformancePackNameFilter', ], ], ], 'ConformancePackComplianceSummary' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', 'ConformancePackComplianceStatus', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ConformancePackComplianceStatus' => [ 'shape' => 'ConformancePackComplianceType', ], ], ], 'ConformancePackComplianceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackComplianceSummary', ], 'max' => 5, 'min' => 1, ], 'ConformancePackComplianceType' => [ 'type' => 'string', 'enum' => [ 'COMPLIANT', 'NON_COMPLIANT', 'INSUFFICIENT_DATA', ], ], 'ConformancePackConfigRuleNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit64', ], 'max' => 10, 'min' => 0, ], 'ConformancePackDetail' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', 'ConformancePackArn', 'ConformancePackId', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ConformancePackArn' => [ 'shape' => 'ConformancePackArn', ], 'ConformancePackId' => [ 'shape' => 'ConformancePackId', ], 'DeliveryS3Bucket' => [ 'shape' => 'DeliveryS3Bucket', ], 'DeliveryS3KeyPrefix' => [ 'shape' => 'DeliveryS3KeyPrefix', ], 'ConformancePackInputParameters' => [ 'shape' => 'ConformancePackInputParameters', ], 'LastUpdateRequestedTime' => [ 'shape' => 'Date', ], 'CreatedBy' => [ 'shape' => 'StringWithCharLimit256', ], 'TemplateSSMDocumentDetails' => [ 'shape' => 'TemplateSSMDocumentDetails', ], ], ], 'ConformancePackDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackDetail', ], 'max' => 25, 'min' => 0, ], 'ConformancePackEvaluationFilters' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConformancePackConfigRuleNames', ], 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceIds' => [ 'shape' => 'ConformancePackComplianceResourceIds', ], ], ], 'ConformancePackEvaluationResult' => [ 'type' => 'structure', 'required' => [ 'ComplianceType', 'EvaluationResultIdentifier', 'ConfigRuleInvokedTime', 'ResultRecordedTime', ], 'members' => [ 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], 'EvaluationResultIdentifier' => [ 'shape' => 'EvaluationResultIdentifier', ], 'ConfigRuleInvokedTime' => [ 'shape' => 'Date', ], 'ResultRecordedTime' => [ 'shape' => 'Date', ], 'Annotation' => [ 'shape' => 'Annotation', ], ], ], 'ConformancePackId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ConformancePackInputParameter' => [ 'type' => 'structure', 'required' => [ 'ParameterName', 'ParameterValue', ], 'members' => [ 'ParameterName' => [ 'shape' => 'ParameterName', ], 'ParameterValue' => [ 'shape' => 'ParameterValue', ], ], ], 'ConformancePackInputParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackInputParameter', ], 'max' => 60, 'min' => 0, ], 'ConformancePackName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z][-a-zA-Z0-9]*', ], 'ConformancePackNameFilter' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackName', ], 'max' => 25, 'min' => 1, ], 'ConformancePackNamesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackName', ], 'max' => 25, 'min' => 0, ], 'ConformancePackNamesToSummarizeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackName', ], 'max' => 5, 'min' => 1, ], 'ConformancePackRuleCompliance' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ComplianceType' => [ 'shape' => 'ConformancePackComplianceType', ], 'Controls' => [ 'shape' => 'ControlsList', ], ], ], 'ConformancePackRuleComplianceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackRuleCompliance', ], 'max' => 1000, 'min' => 0, ], 'ConformancePackRuleEvaluationResultsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackEvaluationResult', ], 'max' => 100, 'min' => 0, ], 'ConformancePackState' => [ 'type' => 'string', 'enum' => [ 'CREATE_IN_PROGRESS', 'CREATE_COMPLETE', 'CREATE_FAILED', 'DELETE_IN_PROGRESS', 'DELETE_FAILED', ], ], 'ConformancePackStatusDetail' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', 'ConformancePackId', 'ConformancePackArn', 'ConformancePackState', 'StackArn', 'LastUpdateRequestedTime', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ConformancePackId' => [ 'shape' => 'ConformancePackId', ], 'ConformancePackArn' => [ 'shape' => 'ConformancePackArn', ], 'ConformancePackState' => [ 'shape' => 'ConformancePackState', ], 'StackArn' => [ 'shape' => 'StackArn', ], 'ConformancePackStatusReason' => [ 'shape' => 'ConformancePackStatusReason', ], 'LastUpdateRequestedTime' => [ 'shape' => 'Date', ], 'LastUpdateCompletedTime' => [ 'shape' => 'Date', ], ], ], 'ConformancePackStatusDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConformancePackStatusDetail', ], 'max' => 25, 'min' => 0, ], 'ConformancePackStatusReason' => [ 'type' => 'string', 'max' => 2000, 'min' => 0, ], 'ConformancePackTemplateValidationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ControlsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit128', ], 'max' => 20, 'min' => 0, ], 'CosmosPageLimit' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'CustomPolicyDetails' => [ 'type' => 'structure', 'required' => [ 'PolicyRuntime', 'PolicyText', ], 'members' => [ 'PolicyRuntime' => [ 'shape' => 'PolicyRuntime', ], 'PolicyText' => [ 'shape' => 'PolicyText', ], 'EnableDebugLogDelivery' => [ 'shape' => 'Boolean', ], ], ], 'Date' => [ 'type' => 'timestamp', ], 'DebugLogDeliveryAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], 'max' => 1000, 'min' => 0, ], 'DeleteAggregationAuthorizationRequest' => [ 'type' => 'structure', 'required' => [ 'AuthorizedAccountId', 'AuthorizedAwsRegion', ], 'members' => [ 'AuthorizedAccountId' => [ 'shape' => 'AccountId', ], 'AuthorizedAwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'DeleteConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], ], ], 'DeleteConfigurationAggregatorRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], ], ], 'DeleteConfigurationRecorderRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationRecorderName', ], 'members' => [ 'ConfigurationRecorderName' => [ 'shape' => 'RecorderName', ], ], ], 'DeleteConformancePackRequest' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], ], ], 'DeleteDeliveryChannelRequest' => [ 'type' => 'structure', 'required' => [ 'DeliveryChannelName', ], 'members' => [ 'DeliveryChannelName' => [ 'shape' => 'ChannelName', ], ], ], 'DeleteEvaluationResultsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'StringWithCharLimit64', ], ], ], 'DeleteEvaluationResultsResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteOrganizationConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], ], ], 'DeleteOrganizationConformancePackRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConformancePackName', ], 'members' => [ 'OrganizationConformancePackName' => [ 'shape' => 'OrganizationConformancePackName', ], ], ], 'DeletePendingAggregationRequestRequest' => [ 'type' => 'structure', 'required' => [ 'RequesterAccountId', 'RequesterAwsRegion', ], 'members' => [ 'RequesterAccountId' => [ 'shape' => 'AccountId', ], 'RequesterAwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'DeleteRemediationConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceType' => [ 'shape' => 'String', ], ], ], 'DeleteRemediationConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRemediationExceptionsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'ResourceKeys', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceKeys' => [ 'shape' => 'RemediationExceptionResourceKeys', ], ], ], 'DeleteRemediationExceptionsResponse' => [ 'type' => 'structure', 'members' => [ 'FailedBatches' => [ 'shape' => 'FailedDeleteRemediationExceptionsBatches', ], ], ], 'DeleteResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceType', 'ResourceId', ], 'members' => [ 'ResourceType' => [ 'shape' => 'ResourceTypeString', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteRetentionConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'RetentionConfigurationName', ], 'members' => [ 'RetentionConfigurationName' => [ 'shape' => 'RetentionConfigurationName', ], ], ], 'DeleteStoredQueryRequest' => [ 'type' => 'structure', 'required' => [ 'QueryName', ], 'members' => [ 'QueryName' => [ 'shape' => 'QueryName', ], ], ], 'DeleteStoredQueryResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeliverConfigSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'deliveryChannelName', ], 'members' => [ 'deliveryChannelName' => [ 'shape' => 'ChannelName', ], ], ], 'DeliverConfigSnapshotResponse' => [ 'type' => 'structure', 'members' => [ 'configSnapshotId' => [ 'shape' => 'String', ], ], ], 'DeliveryChannel' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ChannelName', ], 's3BucketName' => [ 'shape' => 'String', ], 's3KeyPrefix' => [ 'shape' => 'String', ], 's3KmsKeyArn' => [ 'shape' => 'String', ], 'snsTopicARN' => [ 'shape' => 'String', ], 'configSnapshotDeliveryProperties' => [ 'shape' => 'ConfigSnapshotDeliveryProperties', ], ], ], 'DeliveryChannelList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeliveryChannel', ], ], 'DeliveryChannelNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelName', ], ], 'DeliveryChannelStatus' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'configSnapshotDeliveryInfo' => [ 'shape' => 'ConfigExportDeliveryInfo', ], 'configHistoryDeliveryInfo' => [ 'shape' => 'ConfigExportDeliveryInfo', ], 'configStreamDeliveryInfo' => [ 'shape' => 'ConfigStreamDeliveryInfo', ], ], ], 'DeliveryChannelStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeliveryChannelStatus', ], ], 'DeliveryS3Bucket' => [ 'type' => 'string', 'max' => 63, 'min' => 0, ], 'DeliveryS3KeyPrefix' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'DeliveryStatus' => [ 'type' => 'string', 'enum' => [ 'Success', 'Failure', 'Not_Applicable', ], ], 'DescribeAggregateComplianceByConfigRulesRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Filters' => [ 'shape' => 'ConfigRuleComplianceFilters', ], 'Limit' => [ 'shape' => 'GroupByAPILimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAggregateComplianceByConfigRulesResponse' => [ 'type' => 'structure', 'members' => [ 'AggregateComplianceByConfigRules' => [ 'shape' => 'AggregateComplianceByConfigRuleList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAggregateComplianceByConformancePacksRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Filters' => [ 'shape' => 'AggregateConformancePackComplianceFilters', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAggregateComplianceByConformancePacksResponse' => [ 'type' => 'structure', 'members' => [ 'AggregateComplianceByConformancePacks' => [ 'shape' => 'AggregateComplianceByConformancePackList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAggregationAuthorizationsRequest' => [ 'type' => 'structure', 'members' => [ 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeAggregationAuthorizationsResponse' => [ 'type' => 'structure', 'members' => [ 'AggregationAuthorizations' => [ 'shape' => 'AggregationAuthorizationList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeComplianceByConfigRuleRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConfigRuleNames', ], 'ComplianceTypes' => [ 'shape' => 'ComplianceTypes', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeComplianceByConfigRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ComplianceByConfigRules' => [ 'shape' => 'ComplianceByConfigRules', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeComplianceByResourceRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'BaseResourceId', ], 'ComplianceTypes' => [ 'shape' => 'ComplianceTypes', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeComplianceByResourceResponse' => [ 'type' => 'structure', 'members' => [ 'ComplianceByResources' => [ 'shape' => 'ComplianceByResources', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConfigRuleEvaluationStatusRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConfigRuleNames', ], 'NextToken' => [ 'shape' => 'String', ], 'Limit' => [ 'shape' => 'RuleLimit', ], ], ], 'DescribeConfigRuleEvaluationStatusResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigRulesEvaluationStatus' => [ 'shape' => 'ConfigRuleEvaluationStatusList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeConfigRulesFilters' => [ 'type' => 'structure', 'members' => [ 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], ], ], 'DescribeConfigRulesRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConfigRuleNames', ], 'NextToken' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'DescribeConfigRulesFilters', ], ], ], 'DescribeConfigRulesResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigRules' => [ 'shape' => 'ConfigRules', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeConfigurationAggregatorSourcesStatusRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'UpdateStatus' => [ 'shape' => 'AggregatedSourceStatusTypeList', ], 'NextToken' => [ 'shape' => 'String', ], 'Limit' => [ 'shape' => 'Limit', ], ], ], 'DescribeConfigurationAggregatorSourcesStatusResponse' => [ 'type' => 'structure', 'members' => [ 'AggregatedSourceStatusList' => [ 'shape' => 'AggregatedSourceStatusList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeConfigurationAggregatorsRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigurationAggregatorNames' => [ 'shape' => 'ConfigurationAggregatorNameList', ], 'NextToken' => [ 'shape' => 'String', ], 'Limit' => [ 'shape' => 'Limit', ], ], ], 'DescribeConfigurationAggregatorsResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigurationAggregators' => [ 'shape' => 'ConfigurationAggregatorList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeConfigurationRecorderStatusRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigurationRecorderNames' => [ 'shape' => 'ConfigurationRecorderNameList', ], ], ], 'DescribeConfigurationRecorderStatusResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigurationRecordersStatus' => [ 'shape' => 'ConfigurationRecorderStatusList', ], ], ], 'DescribeConfigurationRecordersRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigurationRecorderNames' => [ 'shape' => 'ConfigurationRecorderNameList', ], ], ], 'DescribeConfigurationRecordersResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigurationRecorders' => [ 'shape' => 'ConfigurationRecorderList', ], ], ], 'DescribeConformancePackComplianceLimit' => [ 'type' => 'integer', 'max' => 1000, 'min' => 0, ], 'DescribeConformancePackComplianceRequest' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'Filters' => [ 'shape' => 'ConformancePackComplianceFilters', ], 'Limit' => [ 'shape' => 'DescribeConformancePackComplianceLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConformancePackComplianceResponse' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', 'ConformancePackRuleComplianceList', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ConformancePackRuleComplianceList' => [ 'shape' => 'ConformancePackRuleComplianceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConformancePackStatusRequest' => [ 'type' => 'structure', 'members' => [ 'ConformancePackNames' => [ 'shape' => 'ConformancePackNamesList', ], 'Limit' => [ 'shape' => 'PageSizeLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConformancePackStatusResponse' => [ 'type' => 'structure', 'members' => [ 'ConformancePackStatusDetails' => [ 'shape' => 'ConformancePackStatusDetailsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConformancePacksRequest' => [ 'type' => 'structure', 'members' => [ 'ConformancePackNames' => [ 'shape' => 'ConformancePackNamesList', ], 'Limit' => [ 'shape' => 'PageSizeLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConformancePacksResponse' => [ 'type' => 'structure', 'members' => [ 'ConformancePackDetails' => [ 'shape' => 'ConformancePackDetailList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeDeliveryChannelStatusRequest' => [ 'type' => 'structure', 'members' => [ 'DeliveryChannelNames' => [ 'shape' => 'DeliveryChannelNameList', ], ], ], 'DescribeDeliveryChannelStatusResponse' => [ 'type' => 'structure', 'members' => [ 'DeliveryChannelsStatus' => [ 'shape' => 'DeliveryChannelStatusList', ], ], ], 'DescribeDeliveryChannelsRequest' => [ 'type' => 'structure', 'members' => [ 'DeliveryChannelNames' => [ 'shape' => 'DeliveryChannelNameList', ], ], ], 'DescribeDeliveryChannelsResponse' => [ 'type' => 'structure', 'members' => [ 'DeliveryChannels' => [ 'shape' => 'DeliveryChannelList', ], ], ], 'DescribeOrganizationConfigRuleStatusesRequest' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRuleNames' => [ 'shape' => 'OrganizationConfigRuleNames', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConfigRuleStatusesResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRuleStatuses' => [ 'shape' => 'OrganizationConfigRuleStatuses', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConfigRulesRequest' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRuleNames' => [ 'shape' => 'OrganizationConfigRuleNames', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConfigRulesResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRules' => [ 'shape' => 'OrganizationConfigRules', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConformancePackStatusesRequest' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePackNames' => [ 'shape' => 'OrganizationConformancePackNames', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConformancePackStatusesResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePackStatuses' => [ 'shape' => 'OrganizationConformancePackStatuses', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConformancePacksRequest' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePackNames' => [ 'shape' => 'OrganizationConformancePackNames', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeOrganizationConformancePacksResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePacks' => [ 'shape' => 'OrganizationConformancePacks', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribePendingAggregationRequestsLimit' => [ 'type' => 'integer', 'max' => 20, 'min' => 0, ], 'DescribePendingAggregationRequestsRequest' => [ 'type' => 'structure', 'members' => [ 'Limit' => [ 'shape' => 'DescribePendingAggregationRequestsLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribePendingAggregationRequestsResponse' => [ 'type' => 'structure', 'members' => [ 'PendingAggregationRequests' => [ 'shape' => 'PendingAggregationRequestList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeRemediationConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleNames', ], 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ConfigRuleNames', ], ], ], 'DescribeRemediationConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'RemediationConfigurations' => [ 'shape' => 'RemediationConfigurations', ], ], ], 'DescribeRemediationExceptionsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceKeys' => [ 'shape' => 'RemediationExceptionResourceKeys', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeRemediationExceptionsResponse' => [ 'type' => 'structure', 'members' => [ 'RemediationExceptions' => [ 'shape' => 'RemediationExceptions', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeRemediationExecutionStatusRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceKeys' => [ 'shape' => 'ResourceKeys', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeRemediationExecutionStatusResponse' => [ 'type' => 'structure', 'members' => [ 'RemediationExecutionStatuses' => [ 'shape' => 'RemediationExecutionStatuses', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeRetentionConfigurationsRequest' => [ 'type' => 'structure', 'members' => [ 'RetentionConfigurationNames' => [ 'shape' => 'RetentionConfigurationNameList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeRetentionConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'RetentionConfigurations' => [ 'shape' => 'RetentionConfigurationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'DiscoveredResourceIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateResourceIdentifier', ], ], 'EarlierTime' => [ 'type' => 'timestamp', ], 'EmptiableStringWithCharLimit256' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'ErrorMessage' => [ 'type' => 'string', ], 'Evaluation' => [ 'type' => 'structure', 'required' => [ 'ComplianceResourceType', 'ComplianceResourceId', 'ComplianceType', 'OrderingTimestamp', ], 'members' => [ 'ComplianceResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ComplianceResourceId' => [ 'shape' => 'BaseResourceId', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'Annotation' => [ 'shape' => 'StringWithCharLimit256', ], 'OrderingTimestamp' => [ 'shape' => 'OrderingTimestamp', ], ], ], 'EvaluationContext' => [ 'type' => 'structure', 'members' => [ 'EvaluationContextIdentifier' => [ 'shape' => 'EvaluationContextIdentifier', ], ], ], 'EvaluationContextIdentifier' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'EvaluationMode' => [ 'type' => 'string', 'enum' => [ 'DETECTIVE', 'PROACTIVE', ], ], 'EvaluationModeConfiguration' => [ 'type' => 'structure', 'members' => [ 'Mode' => [ 'shape' => 'EvaluationMode', ], ], ], 'EvaluationModes' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationModeConfiguration', ], ], 'EvaluationResult' => [ 'type' => 'structure', 'members' => [ 'EvaluationResultIdentifier' => [ 'shape' => 'EvaluationResultIdentifier', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'ResultRecordedTime' => [ 'shape' => 'Date', ], 'ConfigRuleInvokedTime' => [ 'shape' => 'Date', ], 'Annotation' => [ 'shape' => 'StringWithCharLimit256', ], 'ResultToken' => [ 'shape' => 'String', ], ], ], 'EvaluationResultIdentifier' => [ 'type' => 'structure', 'members' => [ 'EvaluationResultQualifier' => [ 'shape' => 'EvaluationResultQualifier', ], 'OrderingTimestamp' => [ 'shape' => 'Date', ], 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], ], ], 'EvaluationResultQualifier' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'BaseResourceId', ], 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], ], ], 'EvaluationResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationResult', ], ], 'EvaluationStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'ResourceEvaluationStatus', ], 'FailureReason' => [ 'shape' => 'StringWithCharLimit1024', ], ], ], 'EvaluationTimeout' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'Evaluations' => [ 'type' => 'list', 'member' => [ 'shape' => 'Evaluation', ], 'max' => 100, 'min' => 0, ], 'EventSource' => [ 'type' => 'string', 'enum' => [ 'aws.config', ], ], 'ExcludedAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], 'max' => 1000, 'min' => 0, ], 'ExclusionByResourceTypes' => [ 'type' => 'structure', 'members' => [ 'resourceTypes' => [ 'shape' => 'ResourceTypeList', ], ], ], 'ExecutionControls' => [ 'type' => 'structure', 'members' => [ 'SsmControls' => [ 'shape' => 'SsmControls', ], ], ], 'Expression' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, ], 'ExternalEvaluation' => [ 'type' => 'structure', 'required' => [ 'ComplianceResourceType', 'ComplianceResourceId', 'ComplianceType', 'OrderingTimestamp', ], 'members' => [ 'ComplianceResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ComplianceResourceId' => [ 'shape' => 'BaseResourceId', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'Annotation' => [ 'shape' => 'StringWithCharLimit256', ], 'OrderingTimestamp' => [ 'shape' => 'OrderingTimestamp', ], ], ], 'FailedDeleteRemediationExceptionsBatch' => [ 'type' => 'structure', 'members' => [ 'FailureMessage' => [ 'shape' => 'String', ], 'FailedItems' => [ 'shape' => 'RemediationExceptionResourceKeys', ], ], ], 'FailedDeleteRemediationExceptionsBatches' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedDeleteRemediationExceptionsBatch', ], ], 'FailedRemediationBatch' => [ 'type' => 'structure', 'members' => [ 'FailureMessage' => [ 'shape' => 'String', ], 'FailedItems' => [ 'shape' => 'RemediationConfigurations', ], ], ], 'FailedRemediationBatches' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedRemediationBatch', ], ], 'FailedRemediationExceptionBatch' => [ 'type' => 'structure', 'members' => [ 'FailureMessage' => [ 'shape' => 'String', ], 'FailedItems' => [ 'shape' => 'RemediationExceptions', ], ], ], 'FailedRemediationExceptionBatches' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedRemediationExceptionBatch', ], ], 'FieldInfo' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'FieldName', ], ], ], 'FieldInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldInfo', ], ], 'FieldName' => [ 'type' => 'string', ], 'GetAggregateComplianceDetailsByConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', 'ConfigRuleName', 'AccountId', 'AwsRegion', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'AwsRegion' => [ 'shape' => 'AwsRegion', ], 'ComplianceType' => [ 'shape' => 'ComplianceType', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateComplianceDetailsByConfigRuleResponse' => [ 'type' => 'structure', 'members' => [ 'AggregateEvaluationResults' => [ 'shape' => 'AggregateEvaluationResultList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateConfigRuleComplianceSummaryRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Filters' => [ 'shape' => 'ConfigRuleComplianceSummaryFilters', ], 'GroupByKey' => [ 'shape' => 'ConfigRuleComplianceSummaryGroupKey', ], 'Limit' => [ 'shape' => 'GroupByAPILimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateConfigRuleComplianceSummaryResponse' => [ 'type' => 'structure', 'members' => [ 'GroupByKey' => [ 'shape' => 'StringWithCharLimit256', ], 'AggregateComplianceCounts' => [ 'shape' => 'AggregateComplianceCountList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateConformancePackComplianceSummaryRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Filters' => [ 'shape' => 'AggregateConformancePackComplianceSummaryFilters', ], 'GroupByKey' => [ 'shape' => 'AggregateConformancePackComplianceSummaryGroupKey', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateConformancePackComplianceSummaryResponse' => [ 'type' => 'structure', 'members' => [ 'AggregateConformancePackComplianceSummaries' => [ 'shape' => 'AggregateConformancePackComplianceSummaryList', ], 'GroupByKey' => [ 'shape' => 'StringWithCharLimit256', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateDiscoveredResourceCountsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Filters' => [ 'shape' => 'ResourceCountFilters', ], 'GroupByKey' => [ 'shape' => 'ResourceCountGroupKey', ], 'Limit' => [ 'shape' => 'GroupByAPILimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateDiscoveredResourceCountsResponse' => [ 'type' => 'structure', 'required' => [ 'TotalDiscoveredResources', ], 'members' => [ 'TotalDiscoveredResources' => [ 'shape' => 'Long', ], 'GroupByKey' => [ 'shape' => 'StringWithCharLimit256', ], 'GroupedResourceCounts' => [ 'shape' => 'GroupedResourceCountList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetAggregateResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', 'ResourceIdentifier', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'ResourceIdentifier' => [ 'shape' => 'AggregateResourceIdentifier', ], ], ], 'GetAggregateResourceConfigResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigurationItem' => [ 'shape' => 'ConfigurationItem', ], ], ], 'GetComplianceDetailsByConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'StringWithCharLimit64', ], 'ComplianceTypes' => [ 'shape' => 'ComplianceTypes', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetComplianceDetailsByConfigRuleResponse' => [ 'type' => 'structure', 'members' => [ 'EvaluationResults' => [ 'shape' => 'EvaluationResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetComplianceDetailsByResourceRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'BaseResourceId', ], 'ComplianceTypes' => [ 'shape' => 'ComplianceTypes', ], 'NextToken' => [ 'shape' => 'String', ], 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], ], ], 'GetComplianceDetailsByResourceResponse' => [ 'type' => 'structure', 'members' => [ 'EvaluationResults' => [ 'shape' => 'EvaluationResults', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetComplianceSummaryByConfigRuleResponse' => [ 'type' => 'structure', 'members' => [ 'ComplianceSummary' => [ 'shape' => 'ComplianceSummary', ], ], ], 'GetComplianceSummaryByResourceTypeRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceTypes' => [ 'shape' => 'ResourceTypes', ], ], ], 'GetComplianceSummaryByResourceTypeResponse' => [ 'type' => 'structure', 'members' => [ 'ComplianceSummariesByResourceType' => [ 'shape' => 'ComplianceSummariesByResourceType', ], ], ], 'GetConformancePackComplianceDetailsLimit' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'GetConformancePackComplianceDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'Filters' => [ 'shape' => 'ConformancePackEvaluationFilters', ], 'Limit' => [ 'shape' => 'GetConformancePackComplianceDetailsLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetConformancePackComplianceDetailsResponse' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'ConformancePackRuleEvaluationResults' => [ 'shape' => 'ConformancePackRuleEvaluationResultsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetConformancePackComplianceSummaryRequest' => [ 'type' => 'structure', 'required' => [ 'ConformancePackNames', ], 'members' => [ 'ConformancePackNames' => [ 'shape' => 'ConformancePackNamesToSummarizeList', ], 'Limit' => [ 'shape' => 'PageSizeLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetConformancePackComplianceSummaryResponse' => [ 'type' => 'structure', 'members' => [ 'ConformancePackComplianceSummaryList' => [ 'shape' => 'ConformancePackComplianceSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetCustomRulePolicyRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], ], ], 'GetCustomRulePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyText' => [ 'shape' => 'PolicyText', ], ], ], 'GetDiscoveredResourceCountsRequest' => [ 'type' => 'structure', 'members' => [ 'resourceTypes' => [ 'shape' => 'ResourceTypes', ], 'limit' => [ 'shape' => 'Limit', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetDiscoveredResourceCountsResponse' => [ 'type' => 'structure', 'members' => [ 'totalDiscoveredResources' => [ 'shape' => 'Long', ], 'resourceCounts' => [ 'shape' => 'ResourceCounts', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetOrganizationConfigRuleDetailedStatusRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], 'Filters' => [ 'shape' => 'StatusDetailFilters', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetOrganizationConfigRuleDetailedStatusResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRuleDetailedStatus' => [ 'shape' => 'OrganizationConfigRuleDetailedStatus', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetOrganizationConformancePackDetailedStatusRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConformancePackName', ], 'members' => [ 'OrganizationConformancePackName' => [ 'shape' => 'OrganizationConformancePackName', ], 'Filters' => [ 'shape' => 'OrganizationResourceDetailedStatusFilters', ], 'Limit' => [ 'shape' => 'CosmosPageLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetOrganizationConformancePackDetailedStatusResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePackDetailedStatuses' => [ 'shape' => 'OrganizationConformancePackDetailedStatuses', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetOrganizationCustomRulePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], ], ], 'GetOrganizationCustomRulePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyText' => [ 'shape' => 'PolicyText', ], ], ], 'GetResourceConfigHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resourceId', ], 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'laterTime' => [ 'shape' => 'LaterTime', ], 'earlierTime' => [ 'shape' => 'EarlierTime', ], 'chronologicalOrder' => [ 'shape' => 'ChronologicalOrder', ], 'limit' => [ 'shape' => 'Limit', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetResourceConfigHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'configurationItems' => [ 'shape' => 'ConfigurationItemList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetResourceEvaluationSummaryRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceEvaluationId', ], 'members' => [ 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], ], ], 'GetResourceEvaluationSummaryResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], 'EvaluationStatus' => [ 'shape' => 'EvaluationStatus', ], 'EvaluationStartTimestamp' => [ 'shape' => 'Date', ], 'Compliance' => [ 'shape' => 'ComplianceType', ], 'EvaluationContext' => [ 'shape' => 'EvaluationContext', ], 'ResourceDetails' => [ 'shape' => 'ResourceDetails', ], ], ], 'GetStoredQueryRequest' => [ 'type' => 'structure', 'required' => [ 'QueryName', ], 'members' => [ 'QueryName' => [ 'shape' => 'QueryName', ], ], ], 'GetStoredQueryResponse' => [ 'type' => 'structure', 'members' => [ 'StoredQuery' => [ 'shape' => 'StoredQuery', ], ], ], 'GroupByAPILimit' => [ 'type' => 'integer', 'max' => 1000, 'min' => 0, ], 'GroupedResourceCount' => [ 'type' => 'structure', 'required' => [ 'GroupName', 'ResourceCount', ], 'members' => [ 'GroupName' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceCount' => [ 'shape' => 'Long', ], ], ], 'GroupedResourceCountList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupedResourceCount', ], ], 'IdempotentParameterMismatch' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'IncludeGlobalResourceTypes' => [ 'type' => 'boolean', ], 'InsufficientDeliveryPolicyException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InsufficientPermissionsException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Integer' => [ 'type' => 'integer', ], 'InvalidConfigurationRecorderNameException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidDeliveryChannelNameException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidExpressionException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidLimitException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidNextTokenException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidParameterValueException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidRecordingGroupException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidResultTokenException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidRoleException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidS3KeyPrefixException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidS3KmsKeyArnException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidSNSTopicARNException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidTimeRangeException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'LastDeliveryChannelDeleteFailedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'LastUpdatedTime' => [ 'type' => 'timestamp', ], 'LaterTime' => [ 'type' => 'timestamp', ], 'Limit' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ListAggregateDiscoveredResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', 'ResourceType', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'Filters' => [ 'shape' => 'ResourceFilters', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAggregateDiscoveredResourcesResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifiers' => [ 'shape' => 'DiscoveredResourceIdentifierList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListConformancePackComplianceScoresRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ConformancePackComplianceScoresFilters', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'Limit' => [ 'shape' => 'PageSizeLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListConformancePackComplianceScoresResponse' => [ 'type' => 'structure', 'required' => [ 'ConformancePackComplianceScores', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ConformancePackComplianceScores' => [ 'shape' => 'ConformancePackComplianceScores', ], ], ], 'ListDiscoveredResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'resourceType', ], 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceIds' => [ 'shape' => 'ResourceIdList', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'limit' => [ 'shape' => 'Limit', ], 'includeDeletedResources' => [ 'shape' => 'Boolean', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDiscoveredResourcesResponse' => [ 'type' => 'structure', 'members' => [ 'resourceIdentifiers' => [ 'shape' => 'ResourceIdentifierList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceEvaluationsPageItemLimit' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ListResourceEvaluationsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ResourceEvaluationFilters', ], 'Limit' => [ 'shape' => 'ListResourceEvaluationsPageItemLimit', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListResourceEvaluationsResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceEvaluations' => [ 'shape' => 'ResourceEvaluations', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListStoredQueriesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', 'box' => true, ], 'MaxResults' => [ 'shape' => 'Limit', 'box' => true, ], ], ], 'ListStoredQueriesResponse' => [ 'type' => 'structure', 'members' => [ 'StoredQueryMetadata' => [ 'shape' => 'StoredQueryMetadataList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'Long' => [ 'type' => 'long', ], 'MaxActiveResourcesExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfConfigRulesExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfConfigurationRecordersExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfConformancePacksExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfDeliveryChannelsExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfOrganizationConfigRulesExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfOrganizationConformancePacksExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaxNumberOfRetentionConfigurationsExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MaximumExecutionFrequency' => [ 'type' => 'string', 'enum' => [ 'One_Hour', 'Three_Hours', 'Six_Hours', 'Twelve_Hours', 'TwentyFour_Hours', ], ], 'MemberAccountRuleStatus' => [ 'type' => 'string', 'enum' => [ 'CREATE_SUCCESSFUL', 'CREATE_IN_PROGRESS', 'CREATE_FAILED', 'DELETE_SUCCESSFUL', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_IN_PROGRESS', 'UPDATE_FAILED', ], ], 'MemberAccountStatus' => [ 'type' => 'structure', 'required' => [ 'AccountId', 'ConfigRuleName', 'MemberAccountRuleStatus', ], 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'ConfigRuleName' => [ 'shape' => 'StringWithCharLimit64', ], 'MemberAccountRuleStatus' => [ 'shape' => 'MemberAccountRuleStatus', ], 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], ], ], 'MessageType' => [ 'type' => 'string', 'enum' => [ 'ConfigurationItemChangeNotification', 'ConfigurationSnapshotDeliveryCompleted', 'ScheduledNotification', 'OversizedConfigurationItemChangeNotification', ], ], 'Name' => [ 'type' => 'string', ], 'NextToken' => [ 'type' => 'string', ], 'NoAvailableConfigurationRecorderException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoAvailableDeliveryChannelException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoAvailableOrganizationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoRunningConfigurationRecorderException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchBucketException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchConfigRuleException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchConfigRuleInConformancePackException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchConfigurationAggregatorException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchConfigurationRecorderException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchConformancePackException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchDeliveryChannelException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchOrganizationConfigRuleException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchOrganizationConformancePackException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchRemediationConfigurationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchRemediationExceptionException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NoSuchRetentionConfigurationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OrderingTimestamp' => [ 'type' => 'timestamp', ], 'OrganizationAccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OrganizationAggregationSource' => [ 'type' => 'structure', 'required' => [ 'RoleArn', ], 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'AwsRegions' => [ 'shape' => 'AggregatorRegionList', ], 'AllAwsRegions' => [ 'shape' => 'Boolean', ], ], ], 'OrganizationAllFeaturesNotEnabledException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OrganizationConfigRule' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', 'OrganizationConfigRuleArn', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], 'OrganizationConfigRuleArn' => [ 'shape' => 'StringWithCharLimit256', ], 'OrganizationManagedRuleMetadata' => [ 'shape' => 'OrganizationManagedRuleMetadata', ], 'OrganizationCustomRuleMetadata' => [ 'shape' => 'OrganizationCustomRuleMetadata', ], 'ExcludedAccounts' => [ 'shape' => 'ExcludedAccounts', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], 'OrganizationCustomPolicyRuleMetadata' => [ 'shape' => 'OrganizationCustomPolicyRuleMetadataNoPolicy', ], ], ], 'OrganizationConfigRuleDetailedStatus' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberAccountStatus', ], ], 'OrganizationConfigRuleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*\\S.*', ], 'OrganizationConfigRuleNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit64', ], 'max' => 25, 'min' => 0, ], 'OrganizationConfigRuleStatus' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', 'OrganizationRuleStatus', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], 'OrganizationRuleStatus' => [ 'shape' => 'OrganizationRuleStatus', ], 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], ], ], 'OrganizationConfigRuleStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConfigRuleStatus', ], ], 'OrganizationConfigRuleTriggerType' => [ 'type' => 'string', 'enum' => [ 'ConfigurationItemChangeNotification', 'OversizedConfigurationItemChangeNotification', 'ScheduledNotification', ], ], 'OrganizationConfigRuleTriggerTypeNoSN' => [ 'type' => 'string', 'enum' => [ 'ConfigurationItemChangeNotification', 'OversizedConfigurationItemChangeNotification', ], ], 'OrganizationConfigRuleTriggerTypeNoSNs' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConfigRuleTriggerTypeNoSN', ], ], 'OrganizationConfigRuleTriggerTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConfigRuleTriggerType', ], ], 'OrganizationConfigRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConfigRule', ], ], 'OrganizationConformancePack' => [ 'type' => 'structure', 'required' => [ 'OrganizationConformancePackName', 'OrganizationConformancePackArn', 'LastUpdateTime', ], 'members' => [ 'OrganizationConformancePackName' => [ 'shape' => 'OrganizationConformancePackName', ], 'OrganizationConformancePackArn' => [ 'shape' => 'StringWithCharLimit256', ], 'DeliveryS3Bucket' => [ 'shape' => 'DeliveryS3Bucket', ], 'DeliveryS3KeyPrefix' => [ 'shape' => 'DeliveryS3KeyPrefix', ], 'ConformancePackInputParameters' => [ 'shape' => 'ConformancePackInputParameters', ], 'ExcludedAccounts' => [ 'shape' => 'ExcludedAccounts', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], ], ], 'OrganizationConformancePackDetailedStatus' => [ 'type' => 'structure', 'required' => [ 'AccountId', 'ConformancePackName', 'Status', ], 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'ConformancePackName' => [ 'shape' => 'StringWithCharLimit256', ], 'Status' => [ 'shape' => 'OrganizationResourceDetailedStatus', ], 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], ], ], 'OrganizationConformancePackDetailedStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConformancePackDetailedStatus', ], ], 'OrganizationConformancePackName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z][-a-zA-Z0-9]*', ], 'OrganizationConformancePackNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConformancePackName', ], 'max' => 25, 'min' => 0, ], 'OrganizationConformancePackStatus' => [ 'type' => 'structure', 'required' => [ 'OrganizationConformancePackName', 'Status', ], 'members' => [ 'OrganizationConformancePackName' => [ 'shape' => 'OrganizationConformancePackName', ], 'Status' => [ 'shape' => 'OrganizationResourceStatus', ], 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'LastUpdateTime' => [ 'shape' => 'Date', ], ], ], 'OrganizationConformancePackStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConformancePackStatus', ], ], 'OrganizationConformancePackTemplateValidationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OrganizationConformancePacks' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationConformancePack', ], ], 'OrganizationCustomPolicyRuleMetadata' => [ 'type' => 'structure', 'required' => [ 'PolicyRuntime', 'PolicyText', ], 'members' => [ 'Description' => [ 'shape' => 'StringWithCharLimit256Min0', ], 'OrganizationConfigRuleTriggerTypes' => [ 'shape' => 'OrganizationConfigRuleTriggerTypeNoSNs', ], 'InputParameters' => [ 'shape' => 'StringWithCharLimit2048', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], 'ResourceTypesScope' => [ 'shape' => 'ResourceTypesScope', ], 'ResourceIdScope' => [ 'shape' => 'StringWithCharLimit768', ], 'TagKeyScope' => [ 'shape' => 'StringWithCharLimit128', ], 'TagValueScope' => [ 'shape' => 'StringWithCharLimit256', ], 'PolicyRuntime' => [ 'shape' => 'PolicyRuntime', ], 'PolicyText' => [ 'shape' => 'PolicyText', ], 'DebugLogDeliveryAccounts' => [ 'shape' => 'DebugLogDeliveryAccounts', ], ], ], 'OrganizationCustomPolicyRuleMetadataNoPolicy' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'StringWithCharLimit256Min0', ], 'OrganizationConfigRuleTriggerTypes' => [ 'shape' => 'OrganizationConfigRuleTriggerTypeNoSNs', ], 'InputParameters' => [ 'shape' => 'StringWithCharLimit2048', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], 'ResourceTypesScope' => [ 'shape' => 'ResourceTypesScope', ], 'ResourceIdScope' => [ 'shape' => 'StringWithCharLimit768', ], 'TagKeyScope' => [ 'shape' => 'StringWithCharLimit128', ], 'TagValueScope' => [ 'shape' => 'StringWithCharLimit256', ], 'PolicyRuntime' => [ 'shape' => 'PolicyRuntime', ], 'DebugLogDeliveryAccounts' => [ 'shape' => 'DebugLogDeliveryAccounts', ], ], ], 'OrganizationCustomRuleMetadata' => [ 'type' => 'structure', 'required' => [ 'LambdaFunctionArn', 'OrganizationConfigRuleTriggerTypes', ], 'members' => [ 'Description' => [ 'shape' => 'StringWithCharLimit256Min0', ], 'LambdaFunctionArn' => [ 'shape' => 'StringWithCharLimit256', ], 'OrganizationConfigRuleTriggerTypes' => [ 'shape' => 'OrganizationConfigRuleTriggerTypes', ], 'InputParameters' => [ 'shape' => 'StringWithCharLimit2048', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], 'ResourceTypesScope' => [ 'shape' => 'ResourceTypesScope', ], 'ResourceIdScope' => [ 'shape' => 'StringWithCharLimit768', ], 'TagKeyScope' => [ 'shape' => 'StringWithCharLimit128', ], 'TagValueScope' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'OrganizationManagedRuleMetadata' => [ 'type' => 'structure', 'required' => [ 'RuleIdentifier', ], 'members' => [ 'Description' => [ 'shape' => 'StringWithCharLimit256Min0', ], 'RuleIdentifier' => [ 'shape' => 'StringWithCharLimit256', ], 'InputParameters' => [ 'shape' => 'StringWithCharLimit2048', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], 'ResourceTypesScope' => [ 'shape' => 'ResourceTypesScope', ], 'ResourceIdScope' => [ 'shape' => 'StringWithCharLimit768', ], 'TagKeyScope' => [ 'shape' => 'StringWithCharLimit128', ], 'TagValueScope' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'OrganizationResourceDetailedStatus' => [ 'type' => 'string', 'enum' => [ 'CREATE_SUCCESSFUL', 'CREATE_IN_PROGRESS', 'CREATE_FAILED', 'DELETE_SUCCESSFUL', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_IN_PROGRESS', 'UPDATE_FAILED', ], ], 'OrganizationResourceDetailedStatusFilters' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'Status' => [ 'shape' => 'OrganizationResourceDetailedStatus', ], ], ], 'OrganizationResourceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATE_SUCCESSFUL', 'CREATE_IN_PROGRESS', 'CREATE_FAILED', 'DELETE_SUCCESSFUL', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_IN_PROGRESS', 'UPDATE_FAILED', ], ], 'OrganizationRuleStatus' => [ 'type' => 'string', 'enum' => [ 'CREATE_SUCCESSFUL', 'CREATE_IN_PROGRESS', 'CREATE_FAILED', 'DELETE_SUCCESSFUL', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_SUCCESSFUL', 'UPDATE_IN_PROGRESS', 'UPDATE_FAILED', ], ], 'OversizedConfigurationItemException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Owner' => [ 'type' => 'string', 'enum' => [ 'CUSTOM_LAMBDA', 'AWS', 'CUSTOM_POLICY', ], ], 'PageSizeLimit' => [ 'type' => 'integer', 'max' => 20, 'min' => 0, ], 'ParameterName' => [ 'type' => 'string', 'max' => 255, 'min' => 0, ], 'ParameterValue' => [ 'type' => 'string', 'max' => 4096, 'min' => 0, ], 'PendingAggregationRequest' => [ 'type' => 'structure', 'members' => [ 'RequesterAccountId' => [ 'shape' => 'AccountId', ], 'RequesterAwsRegion' => [ 'shape' => 'AwsRegion', ], ], ], 'PendingAggregationRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingAggregationRequest', ], ], 'Percentage' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'PolicyRuntime' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => 'guard\\-2\\.x\\.x', ], 'PolicyText' => [ 'type' => 'string', 'max' => 10000, 'min' => 0, ], 'PutAggregationAuthorizationRequest' => [ 'type' => 'structure', 'required' => [ 'AuthorizedAccountId', 'AuthorizedAwsRegion', ], 'members' => [ 'AuthorizedAccountId' => [ 'shape' => 'AccountId', ], 'AuthorizedAwsRegion' => [ 'shape' => 'AwsRegion', ], 'Tags' => [ 'shape' => 'TagsList', ], ], ], 'PutAggregationAuthorizationResponse' => [ 'type' => 'structure', 'members' => [ 'AggregationAuthorization' => [ 'shape' => 'AggregationAuthorization', ], ], ], 'PutConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRule', ], 'members' => [ 'ConfigRule' => [ 'shape' => 'ConfigRule', ], 'Tags' => [ 'shape' => 'TagsList', ], ], ], 'PutConfigurationAggregatorRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationAggregatorName', ], 'members' => [ 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'AccountAggregationSources' => [ 'shape' => 'AccountAggregationSourceList', ], 'OrganizationAggregationSource' => [ 'shape' => 'OrganizationAggregationSource', ], 'Tags' => [ 'shape' => 'TagsList', ], ], ], 'PutConfigurationAggregatorResponse' => [ 'type' => 'structure', 'members' => [ 'ConfigurationAggregator' => [ 'shape' => 'ConfigurationAggregator', ], ], ], 'PutConfigurationRecorderRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationRecorder', ], 'members' => [ 'ConfigurationRecorder' => [ 'shape' => 'ConfigurationRecorder', ], ], ], 'PutConformancePackRequest' => [ 'type' => 'structure', 'required' => [ 'ConformancePackName', ], 'members' => [ 'ConformancePackName' => [ 'shape' => 'ConformancePackName', ], 'TemplateS3Uri' => [ 'shape' => 'TemplateS3Uri', ], 'TemplateBody' => [ 'shape' => 'TemplateBody', ], 'DeliveryS3Bucket' => [ 'shape' => 'DeliveryS3Bucket', ], 'DeliveryS3KeyPrefix' => [ 'shape' => 'DeliveryS3KeyPrefix', ], 'ConformancePackInputParameters' => [ 'shape' => 'ConformancePackInputParameters', ], 'TemplateSSMDocumentDetails' => [ 'shape' => 'TemplateSSMDocumentDetails', ], ], ], 'PutConformancePackResponse' => [ 'type' => 'structure', 'members' => [ 'ConformancePackArn' => [ 'shape' => 'ConformancePackArn', ], ], ], 'PutDeliveryChannelRequest' => [ 'type' => 'structure', 'required' => [ 'DeliveryChannel', ], 'members' => [ 'DeliveryChannel' => [ 'shape' => 'DeliveryChannel', ], ], ], 'PutEvaluationsRequest' => [ 'type' => 'structure', 'required' => [ 'ResultToken', ], 'members' => [ 'Evaluations' => [ 'shape' => 'Evaluations', ], 'ResultToken' => [ 'shape' => 'String', ], 'TestMode' => [ 'shape' => 'Boolean', ], ], ], 'PutEvaluationsResponse' => [ 'type' => 'structure', 'members' => [ 'FailedEvaluations' => [ 'shape' => 'Evaluations', ], ], ], 'PutExternalEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'ExternalEvaluation', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ExternalEvaluation' => [ 'shape' => 'ExternalEvaluation', ], ], ], 'PutExternalEvaluationResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutOrganizationConfigRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConfigRuleName', ], 'members' => [ 'OrganizationConfigRuleName' => [ 'shape' => 'OrganizationConfigRuleName', ], 'OrganizationManagedRuleMetadata' => [ 'shape' => 'OrganizationManagedRuleMetadata', ], 'OrganizationCustomRuleMetadata' => [ 'shape' => 'OrganizationCustomRuleMetadata', ], 'ExcludedAccounts' => [ 'shape' => 'ExcludedAccounts', ], 'OrganizationCustomPolicyRuleMetadata' => [ 'shape' => 'OrganizationCustomPolicyRuleMetadata', ], ], ], 'PutOrganizationConfigRuleResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConfigRuleArn' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'PutOrganizationConformancePackRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationConformancePackName', ], 'members' => [ 'OrganizationConformancePackName' => [ 'shape' => 'OrganizationConformancePackName', ], 'TemplateS3Uri' => [ 'shape' => 'TemplateS3Uri', ], 'TemplateBody' => [ 'shape' => 'TemplateBody', ], 'DeliveryS3Bucket' => [ 'shape' => 'DeliveryS3Bucket', ], 'DeliveryS3KeyPrefix' => [ 'shape' => 'DeliveryS3KeyPrefix', ], 'ConformancePackInputParameters' => [ 'shape' => 'ConformancePackInputParameters', ], 'ExcludedAccounts' => [ 'shape' => 'ExcludedAccounts', ], ], ], 'PutOrganizationConformancePackResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationConformancePackArn' => [ 'shape' => 'StringWithCharLimit256', ], ], ], 'PutRemediationConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'RemediationConfigurations', ], 'members' => [ 'RemediationConfigurations' => [ 'shape' => 'RemediationConfigurations', ], ], ], 'PutRemediationConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'FailedBatches' => [ 'shape' => 'FailedRemediationBatches', ], ], ], 'PutRemediationExceptionsRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'ResourceKeys', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceKeys' => [ 'shape' => 'RemediationExceptionResourceKeys', ], 'Message' => [ 'shape' => 'StringWithCharLimit1024', ], 'ExpirationTime' => [ 'shape' => 'Date', ], ], ], 'PutRemediationExceptionsResponse' => [ 'type' => 'structure', 'members' => [ 'FailedBatches' => [ 'shape' => 'FailedRemediationExceptionBatches', ], ], ], 'PutResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceType', 'SchemaVersionId', 'ResourceId', 'Configuration', ], 'members' => [ 'ResourceType' => [ 'shape' => 'ResourceTypeString', ], 'SchemaVersionId' => [ 'shape' => 'SchemaVersionId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ResourceName' => [ 'shape' => 'ResourceName', ], 'Configuration' => [ 'shape' => 'Configuration', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'PutRetentionConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'RetentionPeriodInDays', ], 'members' => [ 'RetentionPeriodInDays' => [ 'shape' => 'RetentionPeriodInDays', ], ], ], 'PutRetentionConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'RetentionConfiguration' => [ 'shape' => 'RetentionConfiguration', ], ], ], 'PutStoredQueryRequest' => [ 'type' => 'structure', 'required' => [ 'StoredQuery', ], 'members' => [ 'StoredQuery' => [ 'shape' => 'StoredQuery', ], 'Tags' => [ 'shape' => 'TagsList', ], ], ], 'PutStoredQueryResponse' => [ 'type' => 'structure', 'members' => [ 'QueryArn' => [ 'shape' => 'QueryArn', ], ], ], 'QueryArn' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '^arn:aws[a-z\\-]*:config:[a-z\\-\\d]+:\\d+:stored-query/[a-zA-Z0-9-_]+/query-[a-zA-Z\\d-_/]+$', ], 'QueryDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'QueryExpression' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]*', ], 'QueryId' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^\\S+$', ], 'QueryInfo' => [ 'type' => 'structure', 'members' => [ 'SelectFields' => [ 'shape' => 'FieldInfoList', ], ], ], 'QueryName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-_]+$', ], 'RecorderName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RecorderStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Success', 'Failure', ], ], 'RecordingFrequency' => [ 'type' => 'string', 'enum' => [ 'CONTINUOUS', 'DAILY', ], ], 'RecordingGroup' => [ 'type' => 'structure', 'members' => [ 'allSupported' => [ 'shape' => 'AllSupported', ], 'includeGlobalResourceTypes' => [ 'shape' => 'IncludeGlobalResourceTypes', ], 'resourceTypes' => [ 'shape' => 'ResourceTypeList', ], 'exclusionByResourceTypes' => [ 'shape' => 'ExclusionByResourceTypes', ], 'recordingStrategy' => [ 'shape' => 'RecordingStrategy', ], ], ], 'RecordingMode' => [ 'type' => 'structure', 'required' => [ 'recordingFrequency', ], 'members' => [ 'recordingFrequency' => [ 'shape' => 'RecordingFrequency', ], 'recordingModeOverrides' => [ 'shape' => 'RecordingModeOverrides', ], ], ], 'RecordingModeOverride' => [ 'type' => 'structure', 'required' => [ 'resourceTypes', 'recordingFrequency', ], 'members' => [ 'description' => [ 'shape' => 'Description', ], 'resourceTypes' => [ 'shape' => 'RecordingModeResourceTypesList', ], 'recordingFrequency' => [ 'shape' => 'RecordingFrequency', ], ], ], 'RecordingModeOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordingModeOverride', ], 'max' => 1, 'min' => 0, ], 'RecordingModeResourceTypesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceType', ], ], 'RecordingStrategy' => [ 'type' => 'structure', 'members' => [ 'useOnly' => [ 'shape' => 'RecordingStrategyType', ], ], ], 'RecordingStrategyType' => [ 'type' => 'string', 'enum' => [ 'ALL_SUPPORTED_RESOURCE_TYPES', 'INCLUSION_BY_RESOURCE_TYPES', 'EXCLUSION_BY_RESOURCE_TYPES', ], ], 'ReevaluateConfigRuleNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigRuleName', ], 'max' => 25, 'min' => 1, ], 'RelatedEvent' => [ 'type' => 'string', ], 'RelatedEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelatedEvent', ], ], 'Relationship' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'relationshipName' => [ 'shape' => 'RelationshipName', ], ], ], 'RelationshipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Relationship', ], ], 'RelationshipName' => [ 'type' => 'string', ], 'RemediationConfiguration' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'TargetType', 'TargetId', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'TargetType' => [ 'shape' => 'RemediationTargetType', ], 'TargetId' => [ 'shape' => 'StringWithCharLimit256', ], 'TargetVersion' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'RemediationParameters', ], 'ResourceType' => [ 'shape' => 'String', ], 'Automatic' => [ 'shape' => 'Boolean', ], 'ExecutionControls' => [ 'shape' => 'ExecutionControls', ], 'MaximumAutomaticAttempts' => [ 'shape' => 'AutoRemediationAttempts', ], 'RetryAttemptSeconds' => [ 'shape' => 'AutoRemediationAttemptSeconds', ], 'Arn' => [ 'shape' => 'StringWithCharLimit1024', ], 'CreatedByService' => [ 'shape' => 'StringWithCharLimit1024', ], ], ], 'RemediationConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationConfiguration', ], 'max' => 25, 'min' => 0, ], 'RemediationException' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'ResourceType', 'ResourceId', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'StringWithCharLimit1024', ], 'Message' => [ 'shape' => 'StringWithCharLimit1024', ], 'ExpirationTime' => [ 'shape' => 'Date', ], ], ], 'RemediationExceptionResourceKey' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceId' => [ 'shape' => 'StringWithCharLimit1024', ], ], ], 'RemediationExceptionResourceKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationExceptionResourceKey', ], 'max' => 100, 'min' => 1, ], 'RemediationExceptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationException', ], 'max' => 25, 'min' => 0, ], 'RemediationExecutionState' => [ 'type' => 'string', 'enum' => [ 'QUEUED', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', ], ], 'RemediationExecutionStatus' => [ 'type' => 'structure', 'members' => [ 'ResourceKey' => [ 'shape' => 'ResourceKey', ], 'State' => [ 'shape' => 'RemediationExecutionState', ], 'StepDetails' => [ 'shape' => 'RemediationExecutionSteps', ], 'InvocationTime' => [ 'shape' => 'Date', ], 'LastUpdatedTime' => [ 'shape' => 'Date', ], ], ], 'RemediationExecutionStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationExecutionStatus', ], ], 'RemediationExecutionStep' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'RemediationExecutionStepState', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'StartTime' => [ 'shape' => 'Date', ], 'StopTime' => [ 'shape' => 'Date', ], ], ], 'RemediationExecutionStepState' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'PENDING', 'FAILED', ], ], 'RemediationExecutionSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemediationExecutionStep', ], ], 'RemediationInProgressException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'RemediationParameterValue' => [ 'type' => 'structure', 'members' => [ 'ResourceValue' => [ 'shape' => 'ResourceValue', ], 'StaticValue' => [ 'shape' => 'StaticValue', ], ], ], 'RemediationParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringWithCharLimit256', ], 'value' => [ 'shape' => 'RemediationParameterValue', ], 'max' => 25, 'min' => 0, ], 'RemediationTargetType' => [ 'type' => 'string', 'enum' => [ 'SSM_DOCUMENT', ], ], 'ResourceConcurrentModificationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceConfiguration' => [ 'type' => 'string', 'max' => 51200, 'min' => 1, ], 'ResourceConfigurationSchemaType' => [ 'type' => 'string', 'enum' => [ 'CFN_RESOURCE_SCHEMA', ], ], 'ResourceCount' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'count' => [ 'shape' => 'Long', ], ], ], 'ResourceCountFilters' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'ResourceType', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'Region' => [ 'shape' => 'AwsRegion', ], ], ], 'ResourceCountGroupKey' => [ 'type' => 'string', 'enum' => [ 'RESOURCE_TYPE', 'ACCOUNT_ID', 'AWS_REGION', ], ], 'ResourceCounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceCount', ], ], 'ResourceCreationTime' => [ 'type' => 'timestamp', ], 'ResourceDeletionTime' => [ 'type' => 'timestamp', ], 'ResourceDetails' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'ResourceType', 'ResourceConfiguration', ], 'members' => [ 'ResourceId' => [ 'shape' => 'BaseResourceId', ], 'ResourceType' => [ 'shape' => 'StringWithCharLimit256', ], 'ResourceConfiguration' => [ 'shape' => 'ResourceConfiguration', ], 'ResourceConfigurationSchemaType' => [ 'shape' => 'ResourceConfigurationSchemaType', ], ], ], 'ResourceEvaluation' => [ 'type' => 'structure', 'members' => [ 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], 'EvaluationStartTimestamp' => [ 'shape' => 'Date', ], ], ], 'ResourceEvaluationFilters' => [ 'type' => 'structure', 'members' => [ 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], 'TimeWindow' => [ 'shape' => 'TimeWindow', ], 'EvaluationContextIdentifier' => [ 'shape' => 'EvaluationContextIdentifier', ], ], ], 'ResourceEvaluationId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'ResourceEvaluationStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', ], ], 'ResourceEvaluations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceEvaluation', ], ], 'ResourceFilters' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'ResourceName' => [ 'shape' => 'ResourceName', ], 'Region' => [ 'shape' => 'AwsRegion', ], ], ], 'ResourceId' => [ 'type' => 'string', 'max' => 768, 'min' => 1, ], 'ResourceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceId', ], ], 'ResourceIdentifier' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceDeletionTime' => [ 'shape' => 'ResourceDeletionTime', ], ], ], 'ResourceIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceIdentifier', ], ], 'ResourceIdentifiersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateResourceIdentifier', ], 'max' => 100, 'min' => 1, ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceKey' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resourceId', ], 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceId' => [ 'shape' => 'ResourceId', ], ], ], 'ResourceKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceKey', ], 'max' => 100, 'min' => 1, ], 'ResourceName' => [ 'type' => 'string', ], 'ResourceNotDiscoveredException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'AWS::EC2::CustomerGateway', 'AWS::EC2::EIP', 'AWS::EC2::Host', 'AWS::EC2::Instance', 'AWS::EC2::InternetGateway', 'AWS::EC2::NetworkAcl', 'AWS::EC2::NetworkInterface', 'AWS::EC2::RouteTable', 'AWS::EC2::SecurityGroup', 'AWS::EC2::Subnet', 'AWS::CloudTrail::Trail', 'AWS::EC2::Volume', 'AWS::EC2::VPC', 'AWS::EC2::VPNConnection', 'AWS::EC2::VPNGateway', 'AWS::EC2::RegisteredHAInstance', 'AWS::EC2::NatGateway', 'AWS::EC2::EgressOnlyInternetGateway', 'AWS::EC2::VPCEndpoint', 'AWS::EC2::VPCEndpointService', 'AWS::EC2::FlowLog', 'AWS::EC2::VPCPeeringConnection', 'AWS::Elasticsearch::Domain', 'AWS::IAM::Group', 'AWS::IAM::Policy', 'AWS::IAM::Role', 'AWS::IAM::User', 'AWS::ElasticLoadBalancingV2::LoadBalancer', 'AWS::ACM::Certificate', 'AWS::RDS::DBInstance', 'AWS::RDS::DBSubnetGroup', 'AWS::RDS::DBSecurityGroup', 'AWS::RDS::DBSnapshot', 'AWS::RDS::DBCluster', 'AWS::RDS::DBClusterSnapshot', 'AWS::RDS::EventSubscription', 'AWS::S3::Bucket', 'AWS::S3::AccountPublicAccessBlock', 'AWS::Redshift::Cluster', 'AWS::Redshift::ClusterSnapshot', 'AWS::Redshift::ClusterParameterGroup', 'AWS::Redshift::ClusterSecurityGroup', 'AWS::Redshift::ClusterSubnetGroup', 'AWS::Redshift::EventSubscription', 'AWS::SSM::ManagedInstanceInventory', 'AWS::CloudWatch::Alarm', 'AWS::CloudFormation::Stack', 'AWS::ElasticLoadBalancing::LoadBalancer', 'AWS::AutoScaling::AutoScalingGroup', 'AWS::AutoScaling::LaunchConfiguration', 'AWS::AutoScaling::ScalingPolicy', 'AWS::AutoScaling::ScheduledAction', 'AWS::DynamoDB::Table', 'AWS::CodeBuild::Project', 'AWS::WAF::RateBasedRule', 'AWS::WAF::Rule', 'AWS::WAF::RuleGroup', 'AWS::WAF::WebACL', 'AWS::WAFRegional::RateBasedRule', 'AWS::WAFRegional::Rule', 'AWS::WAFRegional::RuleGroup', 'AWS::WAFRegional::WebACL', 'AWS::CloudFront::Distribution', 'AWS::CloudFront::StreamingDistribution', 'AWS::Lambda::Function', 'AWS::NetworkFirewall::Firewall', 'AWS::NetworkFirewall::FirewallPolicy', 'AWS::NetworkFirewall::RuleGroup', 'AWS::ElasticBeanstalk::Application', 'AWS::ElasticBeanstalk::ApplicationVersion', 'AWS::ElasticBeanstalk::Environment', 'AWS::WAFv2::WebACL', 'AWS::WAFv2::RuleGroup', 'AWS::WAFv2::IPSet', 'AWS::WAFv2::RegexPatternSet', 'AWS::WAFv2::ManagedRuleSet', 'AWS::XRay::EncryptionConfig', 'AWS::SSM::AssociationCompliance', 'AWS::SSM::PatchCompliance', 'AWS::Shield::Protection', 'AWS::ShieldRegional::Protection', 'AWS::Config::ConformancePackCompliance', 'AWS::Config::ResourceCompliance', 'AWS::ApiGateway::Stage', 'AWS::ApiGateway::RestApi', 'AWS::ApiGatewayV2::Stage', 'AWS::ApiGatewayV2::Api', 'AWS::CodePipeline::Pipeline', 'AWS::ServiceCatalog::CloudFormationProvisionedProduct', 'AWS::ServiceCatalog::CloudFormationProduct', 'AWS::ServiceCatalog::Portfolio', 'AWS::SQS::Queue', 'AWS::KMS::Key', 'AWS::QLDB::Ledger', 'AWS::SecretsManager::Secret', 'AWS::SNS::Topic', 'AWS::SSM::FileData', 'AWS::Backup::BackupPlan', 'AWS::Backup::BackupSelection', 'AWS::Backup::BackupVault', 'AWS::Backup::RecoveryPoint', 'AWS::ECR::Repository', 'AWS::ECS::Cluster', 'AWS::ECS::Service', 'AWS::ECS::TaskDefinition', 'AWS::EFS::AccessPoint', 'AWS::EFS::FileSystem', 'AWS::EKS::Cluster', 'AWS::OpenSearch::Domain', 'AWS::EC2::TransitGateway', 'AWS::Kinesis::Stream', 'AWS::Kinesis::StreamConsumer', 'AWS::CodeDeploy::Application', 'AWS::CodeDeploy::DeploymentConfig', 'AWS::CodeDeploy::DeploymentGroup', 'AWS::EC2::LaunchTemplate', 'AWS::ECR::PublicRepository', 'AWS::GuardDuty::Detector', 'AWS::EMR::SecurityConfiguration', 'AWS::SageMaker::CodeRepository', 'AWS::Route53Resolver::ResolverEndpoint', 'AWS::Route53Resolver::ResolverRule', 'AWS::Route53Resolver::ResolverRuleAssociation', 'AWS::DMS::ReplicationSubnetGroup', 'AWS::DMS::EventSubscription', 'AWS::MSK::Cluster', 'AWS::StepFunctions::Activity', 'AWS::WorkSpaces::Workspace', 'AWS::WorkSpaces::ConnectionAlias', 'AWS::SageMaker::Model', 'AWS::ElasticLoadBalancingV2::Listener', 'AWS::StepFunctions::StateMachine', 'AWS::Batch::JobQueue', 'AWS::Batch::ComputeEnvironment', 'AWS::AccessAnalyzer::Analyzer', 'AWS::Athena::WorkGroup', 'AWS::Athena::DataCatalog', 'AWS::Detective::Graph', 'AWS::GlobalAccelerator::Accelerator', 'AWS::GlobalAccelerator::EndpointGroup', 'AWS::GlobalAccelerator::Listener', 'AWS::EC2::TransitGatewayAttachment', 'AWS::EC2::TransitGatewayRouteTable', 'AWS::DMS::Certificate', 'AWS::AppConfig::Application', 'AWS::AppSync::GraphQLApi', 'AWS::DataSync::LocationSMB', 'AWS::DataSync::LocationFSxLustre', 'AWS::DataSync::LocationS3', 'AWS::DataSync::LocationEFS', 'AWS::DataSync::Task', 'AWS::DataSync::LocationNFS', 'AWS::EC2::NetworkInsightsAccessScopeAnalysis', 'AWS::EKS::FargateProfile', 'AWS::Glue::Job', 'AWS::GuardDuty::ThreatIntelSet', 'AWS::GuardDuty::IPSet', 'AWS::SageMaker::Workteam', 'AWS::SageMaker::NotebookInstanceLifecycleConfig', 'AWS::ServiceDiscovery::Service', 'AWS::ServiceDiscovery::PublicDnsNamespace', 'AWS::SES::ContactList', 'AWS::SES::ConfigurationSet', 'AWS::Route53::HostedZone', 'AWS::IoTEvents::Input', 'AWS::IoTEvents::DetectorModel', 'AWS::IoTEvents::AlarmModel', 'AWS::ServiceDiscovery::HttpNamespace', 'AWS::Events::EventBus', 'AWS::ImageBuilder::ContainerRecipe', 'AWS::ImageBuilder::DistributionConfiguration', 'AWS::ImageBuilder::InfrastructureConfiguration', 'AWS::DataSync::LocationObjectStorage', 'AWS::DataSync::LocationHDFS', 'AWS::Glue::Classifier', 'AWS::Route53RecoveryReadiness::Cell', 'AWS::Route53RecoveryReadiness::ReadinessCheck', 'AWS::ECR::RegistryPolicy', 'AWS::Backup::ReportPlan', 'AWS::Lightsail::Certificate', 'AWS::RUM::AppMonitor', 'AWS::Events::Endpoint', 'AWS::SES::ReceiptRuleSet', 'AWS::Events::Archive', 'AWS::Events::ApiDestination', 'AWS::Lightsail::Disk', 'AWS::FIS::ExperimentTemplate', 'AWS::DataSync::LocationFSxWindows', 'AWS::SES::ReceiptFilter', 'AWS::GuardDuty::Filter', 'AWS::SES::Template', 'AWS::AmazonMQ::Broker', 'AWS::AppConfig::Environment', 'AWS::AppConfig::ConfigurationProfile', 'AWS::Cloud9::EnvironmentEC2', 'AWS::EventSchemas::Registry', 'AWS::EventSchemas::RegistryPolicy', 'AWS::EventSchemas::Discoverer', 'AWS::FraudDetector::Label', 'AWS::FraudDetector::EntityType', 'AWS::FraudDetector::Variable', 'AWS::FraudDetector::Outcome', 'AWS::IoT::Authorizer', 'AWS::IoT::SecurityProfile', 'AWS::IoT::RoleAlias', 'AWS::IoT::Dimension', 'AWS::IoTAnalytics::Datastore', 'AWS::Lightsail::Bucket', 'AWS::Lightsail::StaticIp', 'AWS::MediaPackage::PackagingGroup', 'AWS::Route53RecoveryReadiness::RecoveryGroup', 'AWS::ResilienceHub::ResiliencyPolicy', 'AWS::Transfer::Workflow', 'AWS::EKS::IdentityProviderConfig', 'AWS::EKS::Addon', 'AWS::Glue::MLTransform', 'AWS::IoT::Policy', 'AWS::IoT::MitigationAction', 'AWS::IoTTwinMaker::Workspace', 'AWS::IoTTwinMaker::Entity', 'AWS::IoTAnalytics::Dataset', 'AWS::IoTAnalytics::Pipeline', 'AWS::IoTAnalytics::Channel', 'AWS::IoTSiteWise::Dashboard', 'AWS::IoTSiteWise::Project', 'AWS::IoTSiteWise::Portal', 'AWS::IoTSiteWise::AssetModel', 'AWS::IVS::Channel', 'AWS::IVS::RecordingConfiguration', 'AWS::IVS::PlaybackKeyPair', 'AWS::KinesisAnalyticsV2::Application', 'AWS::RDS::GlobalCluster', 'AWS::S3::MultiRegionAccessPoint', 'AWS::DeviceFarm::TestGridProject', 'AWS::Budgets::BudgetsAction', 'AWS::Lex::Bot', 'AWS::CodeGuruReviewer::RepositoryAssociation', 'AWS::IoT::CustomMetric', 'AWS::Route53Resolver::FirewallDomainList', 'AWS::RoboMaker::RobotApplicationVersion', 'AWS::EC2::TrafficMirrorSession', 'AWS::IoTSiteWise::Gateway', 'AWS::Lex::BotAlias', 'AWS::LookoutMetrics::Alert', 'AWS::IoT::AccountAuditConfiguration', 'AWS::EC2::TrafficMirrorTarget', 'AWS::S3::StorageLens', 'AWS::IoT::ScheduledAudit', 'AWS::Events::Connection', 'AWS::EventSchemas::Schema', 'AWS::MediaPackage::PackagingConfiguration', 'AWS::KinesisVideo::SignalingChannel', 'AWS::AppStream::DirectoryConfig', 'AWS::LookoutVision::Project', 'AWS::Route53RecoveryControl::Cluster', 'AWS::Route53RecoveryControl::SafetyRule', 'AWS::Route53RecoveryControl::ControlPanel', 'AWS::Route53RecoveryControl::RoutingControl', 'AWS::Route53RecoveryReadiness::ResourceSet', 'AWS::RoboMaker::SimulationApplication', 'AWS::RoboMaker::RobotApplication', 'AWS::HealthLake::FHIRDatastore', 'AWS::Pinpoint::Segment', 'AWS::Pinpoint::ApplicationSettings', 'AWS::Events::Rule', 'AWS::EC2::DHCPOptions', 'AWS::EC2::NetworkInsightsPath', 'AWS::EC2::TrafficMirrorFilter', 'AWS::EC2::IPAM', 'AWS::IoTTwinMaker::Scene', 'AWS::NetworkManager::TransitGatewayRegistration', 'AWS::CustomerProfiles::Domain', 'AWS::AutoScaling::WarmPool', 'AWS::Connect::PhoneNumber', 'AWS::AppConfig::DeploymentStrategy', 'AWS::AppFlow::Flow', 'AWS::AuditManager::Assessment', 'AWS::CloudWatch::MetricStream', 'AWS::DeviceFarm::InstanceProfile', 'AWS::DeviceFarm::Project', 'AWS::EC2::EC2Fleet', 'AWS::EC2::SubnetRouteTableAssociation', 'AWS::ECR::PullThroughCacheRule', 'AWS::GroundStation::Config', 'AWS::ImageBuilder::ImagePipeline', 'AWS::IoT::FleetMetric', 'AWS::IoTWireless::ServiceProfile', 'AWS::NetworkManager::Device', 'AWS::NetworkManager::GlobalNetwork', 'AWS::NetworkManager::Link', 'AWS::NetworkManager::Site', 'AWS::Panorama::Package', 'AWS::Pinpoint::App', 'AWS::Redshift::ScheduledAction', 'AWS::Route53Resolver::FirewallRuleGroupAssociation', 'AWS::SageMaker::AppImageConfig', 'AWS::SageMaker::Image', 'AWS::ECS::TaskSet', 'AWS::Cassandra::Keyspace', 'AWS::Signer::SigningProfile', 'AWS::Amplify::App', 'AWS::AppMesh::VirtualNode', 'AWS::AppMesh::VirtualService', 'AWS::AppRunner::VpcConnector', 'AWS::AppStream::Application', 'AWS::CodeArtifact::Repository', 'AWS::EC2::PrefixList', 'AWS::EC2::SpotFleet', 'AWS::Evidently::Project', 'AWS::Forecast::Dataset', 'AWS::IAM::SAMLProvider', 'AWS::IAM::ServerCertificate', 'AWS::Pinpoint::Campaign', 'AWS::Pinpoint::InAppTemplate', 'AWS::SageMaker::Domain', 'AWS::Transfer::Agreement', 'AWS::Transfer::Connector', 'AWS::KinesisFirehose::DeliveryStream', 'AWS::Amplify::Branch', 'AWS::AppIntegrations::EventIntegration', 'AWS::AppMesh::Route', 'AWS::Athena::PreparedStatement', 'AWS::EC2::IPAMScope', 'AWS::Evidently::Launch', 'AWS::Forecast::DatasetGroup', 'AWS::GreengrassV2::ComponentVersion', 'AWS::GroundStation::MissionProfile', 'AWS::MediaConnect::FlowEntitlement', 'AWS::MediaConnect::FlowVpcInterface', 'AWS::MediaTailor::PlaybackConfiguration', 'AWS::MSK::Configuration', 'AWS::Personalize::Dataset', 'AWS::Personalize::Schema', 'AWS::Personalize::Solution', 'AWS::Pinpoint::EmailTemplate', 'AWS::Pinpoint::EventStream', 'AWS::ResilienceHub::App', 'AWS::ACMPCA::CertificateAuthority', 'AWS::AppConfig::HostedConfigurationVersion', 'AWS::AppMesh::VirtualGateway', 'AWS::AppMesh::VirtualRouter', 'AWS::AppRunner::Service', 'AWS::CustomerProfiles::ObjectType', 'AWS::DMS::Endpoint', 'AWS::EC2::CapacityReservation', 'AWS::EC2::ClientVpnEndpoint', 'AWS::Kendra::Index', 'AWS::KinesisVideo::Stream', 'AWS::Logs::Destination', 'AWS::Pinpoint::EmailChannel', 'AWS::S3::AccessPoint', 'AWS::NetworkManager::CustomerGatewayAssociation', 'AWS::NetworkManager::LinkAssociation', 'AWS::IoTWireless::MulticastGroup', 'AWS::Personalize::DatasetGroup', 'AWS::IoTTwinMaker::ComponentType', 'AWS::CodeBuild::ReportGroup', 'AWS::SageMaker::FeatureGroup', 'AWS::MSK::BatchScramSecret', 'AWS::AppStream::Stack', 'AWS::IoT::JobTemplate', 'AWS::IoTWireless::FuotaTask', 'AWS::IoT::ProvisioningTemplate', 'AWS::InspectorV2::Filter', 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation', 'AWS::ServiceDiscovery::Instance', 'AWS::Transfer::Certificate', 'AWS::MediaConnect::FlowSource', 'AWS::APS::RuleGroupsNamespace', 'AWS::CodeGuruProfiler::ProfilingGroup', 'AWS::Route53Resolver::ResolverQueryLoggingConfig', 'AWS::Batch::SchedulingPolicy', 'AWS::ACMPCA::CertificateAuthorityActivation', 'AWS::AppMesh::GatewayRoute', 'AWS::AppMesh::Mesh', 'AWS::Connect::Instance', 'AWS::Connect::QuickConnect', 'AWS::EC2::CarrierGateway', 'AWS::EC2::IPAMPool', 'AWS::EC2::TransitGatewayConnect', 'AWS::EC2::TransitGatewayMulticastDomain', 'AWS::ECS::CapacityProvider', 'AWS::IAM::InstanceProfile', 'AWS::IoT::CACertificate', 'AWS::IoTTwinMaker::SyncJob', 'AWS::KafkaConnect::Connector', 'AWS::Lambda::CodeSigningConfig', 'AWS::NetworkManager::ConnectPeer', 'AWS::ResourceExplorer2::Index', 'AWS::AppStream::Fleet', 'AWS::Cognito::UserPool', 'AWS::Cognito::UserPoolClient', 'AWS::Cognito::UserPoolGroup', 'AWS::EC2::NetworkInsightsAccessScope', 'AWS::EC2::NetworkInsightsAnalysis', 'AWS::Grafana::Workspace', 'AWS::GroundStation::DataflowEndpointGroup', 'AWS::ImageBuilder::ImageRecipe', 'AWS::KMS::Alias', 'AWS::M2::Environment', 'AWS::QuickSight::DataSource', 'AWS::QuickSight::Template', 'AWS::QuickSight::Theme', 'AWS::RDS::OptionGroup', 'AWS::Redshift::EndpointAccess', 'AWS::Route53Resolver::FirewallRuleGroup', 'AWS::SSM::Document', ], ], 'ResourceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceType', ], ], 'ResourceTypeString' => [ 'type' => 'string', 'max' => 196, 'min' => 1, ], 'ResourceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit256', ], 'max' => 20, 'min' => 0, ], 'ResourceTypesScope' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit256', ], 'max' => 100, 'min' => 0, ], 'ResourceValue' => [ 'type' => 'structure', 'required' => [ 'Value', ], 'members' => [ 'Value' => [ 'shape' => 'ResourceValueType', ], ], ], 'ResourceValueType' => [ 'type' => 'string', 'enum' => [ 'RESOURCE_ID', ], ], 'Results' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RetentionConfiguration' => [ 'type' => 'structure', 'required' => [ 'Name', 'RetentionPeriodInDays', ], 'members' => [ 'Name' => [ 'shape' => 'RetentionConfigurationName', ], 'RetentionPeriodInDays' => [ 'shape' => 'RetentionPeriodInDays', ], ], ], 'RetentionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RetentionConfiguration', ], ], 'RetentionConfigurationName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\w\\-]+', ], 'RetentionConfigurationNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RetentionConfigurationName', ], 'max' => 1, 'min' => 0, ], 'RetentionPeriodInDays' => [ 'type' => 'integer', 'max' => 2557, 'min' => 30, ], 'RuleLimit' => [ 'type' => 'integer', 'max' => 50, 'min' => 0, ], 'SSMDocumentName' => [ 'type' => 'string', 'pattern' => '^[a-zA-Z0-9_\\-.:/]{3,200}$', ], 'SSMDocumentVersion' => [ 'type' => 'string', 'pattern' => '([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)', ], 'SchemaVersionId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[A-Za-z0-9-]+', ], 'Scope' => [ 'type' => 'structure', 'members' => [ 'ComplianceResourceTypes' => [ 'shape' => 'ComplianceResourceTypes', ], 'TagKey' => [ 'shape' => 'StringWithCharLimit128', ], 'TagValue' => [ 'shape' => 'StringWithCharLimit256', ], 'ComplianceResourceId' => [ 'shape' => 'BaseResourceId', ], ], ], 'SelectAggregateResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'Expression', 'ConfigurationAggregatorName', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'ConfigurationAggregatorName' => [ 'shape' => 'ConfigurationAggregatorName', ], 'Limit' => [ 'shape' => 'Limit', ], 'MaxResults' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SelectAggregateResourceConfigResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'Results', ], 'QueryInfo' => [ 'shape' => 'QueryInfo', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SelectResourceConfigRequest' => [ 'type' => 'structure', 'required' => [ 'Expression', ], 'members' => [ 'Expression' => [ 'shape' => 'Expression', ], 'Limit' => [ 'shape' => 'Limit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SelectResourceConfigResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'Results', ], 'QueryInfo' => [ 'shape' => 'QueryInfo', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SortBy' => [ 'type' => 'string', 'enum' => [ 'SCORE', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'Source' => [ 'type' => 'structure', 'required' => [ 'Owner', ], 'members' => [ 'Owner' => [ 'shape' => 'Owner', ], 'SourceIdentifier' => [ 'shape' => 'StringWithCharLimit256', ], 'SourceDetails' => [ 'shape' => 'SourceDetails', ], 'CustomPolicyDetails' => [ 'shape' => 'CustomPolicyDetails', ], ], ], 'SourceDetail' => [ 'type' => 'structure', 'members' => [ 'EventSource' => [ 'shape' => 'EventSource', ], 'MessageType' => [ 'shape' => 'MessageType', ], 'MaximumExecutionFrequency' => [ 'shape' => 'MaximumExecutionFrequency', ], ], ], 'SourceDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceDetail', ], 'max' => 25, 'min' => 0, ], 'SsmControls' => [ 'type' => 'structure', 'members' => [ 'ConcurrentExecutionRatePercentage' => [ 'shape' => 'Percentage', ], 'ErrorPercentage' => [ 'shape' => 'Percentage', ], ], ], 'StackArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'StartConfigRulesEvaluationRequest' => [ 'type' => 'structure', 'members' => [ 'ConfigRuleNames' => [ 'shape' => 'ReevaluateConfigRuleNames', ], ], ], 'StartConfigRulesEvaluationResponse' => [ 'type' => 'structure', 'members' => [], ], 'StartConfigurationRecorderRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationRecorderName', ], 'members' => [ 'ConfigurationRecorderName' => [ 'shape' => 'RecorderName', ], ], ], 'StartRemediationExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigRuleName', 'ResourceKeys', ], 'members' => [ 'ConfigRuleName' => [ 'shape' => 'ConfigRuleName', ], 'ResourceKeys' => [ 'shape' => 'ResourceKeys', ], ], ], 'StartRemediationExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'FailureMessage' => [ 'shape' => 'String', ], 'FailedItems' => [ 'shape' => 'ResourceKeys', ], ], ], 'StartResourceEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceDetails', 'EvaluationMode', ], 'members' => [ 'ResourceDetails' => [ 'shape' => 'ResourceDetails', ], 'EvaluationContext' => [ 'shape' => 'EvaluationContext', ], 'EvaluationMode' => [ 'shape' => 'EvaluationMode', ], 'EvaluationTimeout' => [ 'shape' => 'EvaluationTimeout', ], 'ClientToken' => [ 'shape' => 'ClientToken', ], ], ], 'StartResourceEvaluationResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceEvaluationId' => [ 'shape' => 'ResourceEvaluationId', ], ], ], 'StaticParameterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringWithCharLimit256', ], 'max' => 25, 'min' => 0, ], 'StaticValue' => [ 'type' => 'structure', 'required' => [ 'Values', ], 'members' => [ 'Values' => [ 'shape' => 'StaticParameterValues', ], ], ], 'StatusDetailFilters' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'MemberAccountRuleStatus' => [ 'shape' => 'MemberAccountRuleStatus', ], ], ], 'StopConfigurationRecorderRequest' => [ 'type' => 'structure', 'required' => [ 'ConfigurationRecorderName', ], 'members' => [ 'ConfigurationRecorderName' => [ 'shape' => 'RecorderName', ], ], ], 'StoredQuery' => [ 'type' => 'structure', 'required' => [ 'QueryName', ], 'members' => [ 'QueryId' => [ 'shape' => 'QueryId', 'box' => true, ], 'QueryArn' => [ 'shape' => 'QueryArn', 'box' => true, ], 'QueryName' => [ 'shape' => 'QueryName', ], 'Description' => [ 'shape' => 'QueryDescription', 'box' => true, ], 'Expression' => [ 'shape' => 'QueryExpression', 'box' => true, ], ], ], 'StoredQueryMetadata' => [ 'type' => 'structure', 'required' => [ 'QueryId', 'QueryArn', 'QueryName', ], 'members' => [ 'QueryId' => [ 'shape' => 'QueryId', ], 'QueryArn' => [ 'shape' => 'QueryArn', ], 'QueryName' => [ 'shape' => 'QueryName', ], 'Description' => [ 'shape' => 'QueryDescription', ], ], ], 'StoredQueryMetadataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StoredQueryMetadata', ], ], 'String' => [ 'type' => 'string', ], 'StringWithCharLimit1024' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'StringWithCharLimit128' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'StringWithCharLimit2048' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'StringWithCharLimit256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'StringWithCharLimit256Min0' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'StringWithCharLimit64' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'StringWithCharLimit768' => [ 'type' => 'string', 'max' => 768, 'min' => 1, ], 'SupplementaryConfiguration' => [ 'type' => 'map', 'key' => [ 'shape' => 'SupplementaryConfigurationName', ], 'value' => [ 'shape' => 'SupplementaryConfigurationValue', ], ], 'SupplementaryConfigurationName' => [ 'type' => 'string', ], 'SupplementaryConfigurationValue' => [ 'type' => 'string', ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'Tags' => [ 'type' => 'map', 'key' => [ 'shape' => 'Name', ], 'value' => [ 'shape' => 'Value', ], ], 'TagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TemplateBody' => [ 'type' => 'string', 'max' => 51200, 'min' => 1, ], 'TemplateS3Uri' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => 's3://.*', ], 'TemplateSSMDocumentDetails' => [ 'type' => 'structure', 'required' => [ 'DocumentName', ], 'members' => [ 'DocumentName' => [ 'shape' => 'SSMDocumentName', ], 'DocumentVersion' => [ 'shape' => 'SSMDocumentVersion', ], ], ], 'TimeWindow' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'Date', ], 'EndTime' => [ 'shape' => 'Date', ], ], ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UnprocessedResourceIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AggregateResourceIdentifier', ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'AmazonResourceName', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Value' => [ 'type' => 'string', ], 'Version' => [ 'type' => 'string', ], ],]; diff --git a/src/data/config/2014-11-12/docs-2.json b/src/data/config/2014-11-12/docs-2.json index 19ae07a95a..abae35d892 100644 --- a/src/data/config/2014-11-12/docs-2.json +++ b/src/data/config/2014-11-12/docs-2.json @@ -325,7 +325,7 @@ "AutoRemediationAttemptSeconds": { "base": null, "refs": { - "RemediationConfiguration$RetryAttemptSeconds": "

Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

" + "RemediationConfiguration$RetryAttemptSeconds": "

Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If MaximumAutomaticAttempts remediation attempts have been made under RetryAttemptSeconds, a remediation exception will be added to the resource. If you do not select a number, the default is 60 seconds.

For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.

" } }, "AutoRemediationAttempts": { @@ -2806,7 +2806,7 @@ "BaseConfigurationItem$recordingFrequency": "

The recording frequency that Config uses to record configuration changes for the resource.

", "ConfigurationItem$recordingFrequency": "

The recording frequency that Config uses to record configuration changes for the resource.

", "RecordingMode$recordingFrequency": "

The default recording frequency that Config uses to record configuration changes.

Daily recording is not supported for the following resource types:

For the allSupported (ALL_SUPPORTED_RESOURCE_TYPES) recording strategy, these resource types will be set to Continuous recording.

", - "RecordingModeOverride$recordingFrequency": "

The recording frequency that will be applied to all the resource types specified in the override.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

" + "RecordingModeOverride$recordingFrequency": "

The recording frequency that will be applied to all the resource types specified in the override.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

" } }, "RecordingGroup": { @@ -2816,9 +2816,9 @@ } }, "RecordingMode": { - "base": "

Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

", + "base": "

Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

", "refs": { - "ConfigurationRecorder$recordingMode": "

Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

" + "ConfigurationRecorder$recordingMode": "

Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

" } }, "RecordingModeOverride": { diff --git a/src/data/config/2014-11-12/docs-2.json.php b/src/data/config/2014-11-12/docs-2.json.php index 6af2033490..0c0952654e 100644 --- a/src/data/config/2014-11-12/docs-2.json.php +++ b/src/data/config/2014-11-12/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Config

Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see Supported Amazon Web Services resources.

You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see What Is Config in the Config Developer Guide.

', 'operations' => [ 'BatchGetAggregateResourceConfig' => '

Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list.

', 'BatchGetResourceConfig' => '

Returns the BaseConfigurationItem for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list.

', 'DeleteAggregationAuthorization' => '

Deletes the authorization granted to the specified configuration aggregator account in a specified region.

', 'DeleteConfigRule' => '

Deletes the specified Config rule and all of its evaluation results.

Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

You can check the state of a rule by using the DescribeConfigRules request.

', 'DeleteConfigurationAggregator' => '

Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.

', 'DeleteConfigurationRecorder' => '

Deletes the configuration recorder.

After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder.

This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the Config console until you create a new configuration recorder.

', 'DeleteConformancePack' => '

Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.

Config sets the conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.

', 'DeleteDeliveryChannel' => '

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

', 'DeleteEvaluationResults' => '

Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.

', 'DeleteOrganizationConfigRule' => '

Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.

Only a management account and a delegated administrator account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.

Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.

', 'DeleteOrganizationConformancePack' => '

Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.

Only a management account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.

Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.

', 'DeletePendingAggregationRequest' => '

Deletes pending authorization requests for a specified aggregator account in a specified region.

', 'DeleteRemediationConfiguration' => '

Deletes the remediation configuration.

', 'DeleteRemediationExceptions' => '

Deletes one or more remediation exceptions mentioned in the resource keys.

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

', 'DeleteResourceConfig' => '

Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.

', 'DeleteRetentionConfiguration' => '

Deletes the retention configuration.

', 'DeleteStoredQuery' => '

Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.

', 'DeliverConfigSnapshot' => '

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified.

', 'DescribeAggregateComplianceByConfigRules' => '

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

', 'DescribeAggregateComplianceByConformancePacks' => '

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

', 'DescribeAggregationAuthorizations' => '

Returns a list of authorizations granted to various aggregator accounts and regions.

', 'DescribeComplianceByConfigRule' => '

Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.

If Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

', 'DescribeComplianceByResource' => '

Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.

A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

', 'DescribeConfigRuleEvaluationStatus' => '

Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.

', 'DescribeConfigRules' => '

Returns details about your Config rules.

', 'DescribeConfigurationAggregatorSourcesStatus' => '

Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.

', 'DescribeConfigurationAggregators' => '

Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.

', 'DescribeConfigurationRecorderStatus' => '

Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.

>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.

', 'DescribeConfigurationRecorders' => '

Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.

You can specify only one configuration recorder for each Amazon Web Services Region for each account.

', 'DescribeConformancePackCompliance' => '

Returns compliance details for each rule in that conformance pack.

You must provide exact rule names.

', 'DescribeConformancePackStatus' => '

Provides one or more conformance packs deployment status.

If there are no conformance packs then you will see an empty result.

', 'DescribeConformancePacks' => '

Returns a list of one or more conformance packs.

', 'DescribeDeliveryChannelStatus' => '

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

', 'DescribeDeliveryChannels' => '

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

', 'DescribeOrganizationConfigRuleStatuses' => '

Provides organization Config rule deployment status for an organization.

The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.

', 'DescribeOrganizationConfigRules' => '

Returns a list of organization Config rules.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.

For accounts within an organzation

If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won\'t be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.

', 'DescribeOrganizationConformancePackStatuses' => '

Provides organization conformance pack deployment status for an organization.

The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.

', 'DescribeOrganizationConformancePacks' => '

Returns a list of organization conformance packs.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.

For accounts within an organzation

If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won\'t be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.

', 'DescribePendingAggregationRequests' => '

Returns a list of all pending aggregation requests.

', 'DescribeRemediationConfigurations' => '

Returns the details of one or more remediation configurations.

', 'DescribeRemediationExceptions' => '

Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.

', 'DescribeRemediationExecutionStatus' => '

Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.

', 'DescribeRetentionConfigurations' => '

Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.

Currently, Config supports only one retention configuration per region in your account.

', 'GetAggregateComplianceDetailsByConfigRule' => '

Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.

', 'GetAggregateConfigRuleComplianceSummary' => '

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

', 'GetAggregateConformancePackComplianceSummary' => '

Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

', 'GetAggregateDiscoveredResourceCounts' => '

Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.

For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.

', 'GetAggregateResourceConfig' => '

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

', 'GetComplianceDetailsByConfigRule' => '

Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

', 'GetComplianceDetailsByResource' => '

Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.

', 'GetComplianceSummaryByConfigRule' => '

Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

', 'GetComplianceSummaryByResourceType' => '

Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.

', 'GetConformancePackComplianceDetails' => '

Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.

', 'GetConformancePackComplianceSummary' => '

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

', 'GetCustomRulePolicy' => '

Returns the policy definition containing the logic for your Config Custom Policy rule.

', 'GetDiscoveredResourceCounts' => '

Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.

Example

  1. Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.

  2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

  3. Config returns the following:

    • The resource types (EC2 instances, IAM users, and S3 buckets).

    • The number of each resource type (25, 20, and 15).

    • The total number of all resources (60).

The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.

', 'GetOrganizationConfigRuleDetailedStatus' => '

Returns detailed status for each member account within an organization for a given organization Config rule.

', 'GetOrganizationConformancePackDetailedStatus' => '

Returns detailed status for each member account within an organization for a given organization conformance pack.

', 'GetOrganizationCustomRulePolicy' => '

Returns the policy definition containing the logic for your organization Config Custom Policy rule.

', 'GetResourceConfigHistory' => '

For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type. For more information, see Selecting Which Resources Config Records.

Returns a list of ConfigurationItems for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems for the specified retention period.

The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.

', 'GetResourceEvaluationSummary' => '

Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.

To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. For more information, see the Examples section.

', 'GetStoredQuery' => '

Returns the details of a specific stored query.

', 'ListAggregateDiscoveredResources' => '

Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.

For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.

', 'ListConformancePackComplianceScores' => '

Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.

Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA.

', 'ListDiscoveredResources' => '

Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.

You can specify either resource IDs or a resource name, but not both, in the same request.

The response is paginated. By default, Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

', 'ListResourceEvaluations' => '

Returns a list of proactive resource evaluations.

', 'ListStoredQueries' => '

Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.

', 'ListTagsForResource' => '

List the tags for Config resource.

', 'PutAggregationAuthorization' => '

Authorizes the aggregator account and region to collect data from the source account and region.

PutAggregationAuthorization is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

', 'PutConfigRule' => '

Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide.

There are two types of rules: Config Managed Rules and Config Custom Rules. You can use PutConfigRule to create both Config Managed Rules and Config Custom Rules.

Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule\'s identifier for the SourceIdentifier key.

Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.

If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function that the rule invokes to evaluate your resources. When you use PutConfigRule to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. You specify the ARN in the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

For any new Config rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by Config for new rules.

If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.

For more information about developing and using Config rules, see Evaluating Resources with Config Rules in the Config Developer Guide.

PutConfigRule is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

', 'PutConfigurationAggregator' => '

Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.

accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones.

Config should be enabled in source accounts and regions you want to aggregate.

If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.

To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.

PutConfigurationAggregator is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

', 'PutConfigurationRecorder' => '

Creates a new configuration recorder to record configuration changes for specified resource types.

You can also use this action to change the roleARN or the recordingGroup of an existing recorder. For more information, see Managing the Configuration Recorder in the Config Developer Guide.

You can specify only one configuration recorder for each Amazon Web Services Region for each account.

If the configuration recorder does not have the recordingGroup field specified, the default is to record all supported resource types.

', 'PutConformancePack' => '

Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.

This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. The service-linked role is created only when the role does not exist in your account.

You must specify only one of the follow parameters: TemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails.

', 'PutDeliveryChannel' => '

Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic. For more information, see Notifications that Config Sends to an Amazon SNS topic.

Before you can create a delivery channel, you must create a configuration recorder.

You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.

You can have only one delivery channel per region in your account.

', 'PutEvaluations' => '

Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.

', 'PutExternalEvaluation' => '

Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.

', 'PutOrganizationConfigRule' => '

Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide.

Only a management account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.

This API enables organization service access through the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with GetRole action.

To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com.

There are two types of rules: Config Managed Rules and Config Custom Rules. You can use PutOrganizationConfigRule to create both Config Managed Rules and Config Custom Rules.

Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule\'s identifier for the RuleIdentifier key.

Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.

If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function in the management account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function. When you use PutOrganizationConfigRule to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

Make sure to specify one of either OrganizationCustomPolicyRuleMetadata for Custom Policy rules, OrganizationCustomRuleMetadata for Custom Lambda rules, or OrganizationManagedRuleMetadata for managed rules.

', 'PutOrganizationConformancePack' => '

Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.

Only a management account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.

This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.

', 'PutRemediationConfigurations' => '

Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.

If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.

This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.

For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.

However, for automatic remediation configuration, the only valid assumeRole field value is AutomationAssumeRole and you need to provide a value for AutomationAssumeRole to remediate your resources.

', 'PutRemediationExceptions' => '

A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.

Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as NON_COMPLIANT. Once the resource has been evaluated as NON_COMPLIANT, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before a NON_COMPLIANT evaluation result can delete resources before the exception is applied.

Placing an exception can only be performed on resources that are NON_COMPLIANT. If you use this API for COMPLIANT resources or resources that are NOT_APPLICABLE, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see Concepts | Config Rules in the Config Developer Guide.

', 'PutResourceConfig' => '

Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.

The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.

When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.

Write-only schema properites are not recorded as part of the published configuration item.

', 'PutRetentionConfiguration' => '

Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object.

Currently, Config supports only one retention configuration per region in your account.

', 'PutStoredQuery' => '

Saves a new query or updates an existing saved query. The QueryName must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.

PutStoredQuery is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

', 'SelectAggregateResourceConfig' => '

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the Query Components section in the Config Developer Guide.

If you run an aggregation query (i.e., using GROUP BY or using aggregate functions such as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = \'AWS::IAM::Role\' GROUP BY resourceId) and do not specify the MaxResults or the Limit query parameters, the default page size is set to 500.

If you run a non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT * WHERE resourceType = \'AWS::IAM::Role\') and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25.

', 'SelectResourceConfig' => '

Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the Query Components section in the Config Developer Guide.

', 'StartConfigRulesEvaluation' => '

Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources.

You can specify up to 25 Config rules per request.

An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.

You don\'t need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, Config evaluates your resources against the rule automatically.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

', 'StartConfigurationRecorder' => '

Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

You must have created at least one delivery channel to successfully start the configuration recorder.

', 'StartRemediationExecution' => '

Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.

You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.

', 'StartResourceEvaluation' => '

Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.

Ensure you have the cloudformation:DescribeType role setup to validate the resource type schema.

You can find the Resource type schema in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand: aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE.

For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.

', 'StopConfigurationRecorder' => '

Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

', 'TagResource' => '

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. If existing tags are specified, however, then their values will be updated. When a resource is deleted, the tags associated with that resource are deleted as well.

', 'UntagResource' => '

Deletes specified tags from a resource.

', ], 'shapes' => [ 'ARN' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'ConfigurationItem$arn' => '

Amazon Resource Name (ARN) associated with the resource.

', ], ], 'AccountAggregationSource' => [ 'base' => '

A collection of accounts and regions.

', 'refs' => [ 'AccountAggregationSourceList$member' => NULL, ], ], 'AccountAggregationSourceAccountList' => [ 'base' => NULL, 'refs' => [ 'AccountAggregationSource$AccountIds' => '

The 12-digit account ID of the account being aggregated.

', ], ], 'AccountAggregationSourceList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationAggregator$AccountAggregationSources' => '

Provides a list of source accounts and regions to be aggregated.

', 'PutConfigurationAggregatorRequest$AccountAggregationSources' => '

A list of AccountAggregationSource object.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AccountAggregationSourceAccountList$member' => NULL, 'AggregateComplianceByConfigRule$AccountId' => '

The 12-digit account ID of the source account.

', 'AggregateComplianceByConformancePack$AccountId' => '

The 12-digit Amazon Web Services account ID of the source account.

', 'AggregateConformancePackComplianceFilters$AccountId' => '

The 12-digit Amazon Web Services account ID of the source account.

', 'AggregateConformancePackComplianceSummaryFilters$AccountId' => '

The 12-digit Amazon Web Services account ID of the source account.

', 'AggregateEvaluationResult$AccountId' => '

The 12-digit account ID of the source account.

', 'AggregateResourceIdentifier$SourceAccountId' => '

The 12-digit account ID of the source account.

', 'AggregationAuthorization$AuthorizedAccountId' => '

The 12-digit account ID of the account authorized to aggregate data.

', 'BaseConfigurationItem$accountId' => '

The 12-digit Amazon Web Services account ID associated with the resource.

', 'ConfigRuleComplianceFilters$AccountId' => '

The 12-digit account ID of the source account.

', 'ConfigRuleComplianceSummaryFilters$AccountId' => '

The 12-digit account ID of the source account.

', 'ConfigurationItem$accountId' => '

The 12-digit Amazon Web Services account ID associated with the resource.

', 'DebugLogDeliveryAccounts$member' => NULL, 'DeleteAggregationAuthorizationRequest$AuthorizedAccountId' => '

The 12-digit account ID of the account authorized to aggregate data.

', 'DeletePendingAggregationRequestRequest$RequesterAccountId' => '

The 12-digit account ID of the account requesting to aggregate data.

', 'ExcludedAccounts$member' => NULL, 'GetAggregateComplianceDetailsByConfigRuleRequest$AccountId' => '

The 12-digit account ID of the source account.

', 'MemberAccountStatus$AccountId' => '

The 12-digit account ID of a member account.

', 'OrganizationConformancePackDetailedStatus$AccountId' => '

The 12-digit account ID of a member account.

', 'OrganizationResourceDetailedStatusFilters$AccountId' => '

The 12-digit account ID of the member account within an organization.

', 'PendingAggregationRequest$RequesterAccountId' => '

The 12-digit account ID of the account requesting to aggregate data.

', 'PutAggregationAuthorizationRequest$AuthorizedAccountId' => '

The 12-digit account ID of the account authorized to aggregate data.

', 'ResourceCountFilters$AccountId' => '

The 12-digit ID of the account.

', 'ResourceFilters$AccountId' => '

The 12-digit source account ID.

', 'StatusDetailFilters$AccountId' => '

The 12-digit account ID of the member account within an organization.

', ], ], 'AggregateComplianceByConfigRule' => [ 'base' => '

Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.

A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.

', 'refs' => [ 'AggregateComplianceByConfigRuleList$member' => NULL, ], ], 'AggregateComplianceByConfigRuleList' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregateComplianceByConfigRulesResponse$AggregateComplianceByConfigRules' => '

Returns a list of AggregateComplianceByConfigRule object.

', ], ], 'AggregateComplianceByConformancePack' => [ 'base' => '

Provides aggregate compliance of the conformance pack. Indicates whether a conformance pack is compliant based on the name of the conformance pack, account ID, and region.

A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.

', 'refs' => [ 'AggregateComplianceByConformancePackList$member' => NULL, ], ], 'AggregateComplianceByConformancePackList' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregateComplianceByConformancePacksResponse$AggregateComplianceByConformancePacks' => '

Returns the AggregateComplianceByConformancePack object.

', ], ], 'AggregateComplianceCount' => [ 'base' => '

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

', 'refs' => [ 'AggregateComplianceCountList$member' => NULL, ], ], 'AggregateComplianceCountList' => [ 'base' => NULL, 'refs' => [ 'GetAggregateConfigRuleComplianceSummaryResponse$AggregateComplianceCounts' => '

Returns a list of AggregateComplianceCounts object.

', ], ], 'AggregateConformancePackCompliance' => [ 'base' => '

Provides the number of compliant and noncompliant rules within a conformance pack. Also provides the compliance status of the conformance pack and the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.

', 'refs' => [ 'AggregateComplianceByConformancePack$Compliance' => '

The compliance status of the conformance pack.

', ], ], 'AggregateConformancePackComplianceCount' => [ 'base' => '

The number of conformance packs that are compliant and noncompliant.

', 'refs' => [ 'AggregateConformancePackComplianceSummary$ComplianceSummary' => '

Returns an AggregateConformancePackComplianceCount object.

', ], ], 'AggregateConformancePackComplianceFilters' => [ 'base' => '

Filters the conformance packs based on an account ID, region, compliance type, and the name of the conformance pack.

', 'refs' => [ 'DescribeAggregateComplianceByConformancePacksRequest$Filters' => '

Filters the result by AggregateConformancePackComplianceFilters object.

', ], ], 'AggregateConformancePackComplianceSummary' => [ 'base' => '

Provides a summary of compliance based on either account ID or region.

', 'refs' => [ 'AggregateConformancePackComplianceSummaryList$member' => NULL, ], ], 'AggregateConformancePackComplianceSummaryFilters' => [ 'base' => '

Filters the results based on account ID and region.

', 'refs' => [ 'GetAggregateConformancePackComplianceSummaryRequest$Filters' => '

Filters the results based on the AggregateConformancePackComplianceSummaryFilters object.

', ], ], 'AggregateConformancePackComplianceSummaryGroupKey' => [ 'base' => NULL, 'refs' => [ 'GetAggregateConformancePackComplianceSummaryRequest$GroupByKey' => '

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

', ], ], 'AggregateConformancePackComplianceSummaryList' => [ 'base' => NULL, 'refs' => [ 'GetAggregateConformancePackComplianceSummaryResponse$AggregateConformancePackComplianceSummaries' => '

Returns a list of AggregateConformancePackComplianceSummary object.

', ], ], 'AggregateEvaluationResult' => [ 'base' => '

The details of an Config evaluation for an account ID and region in an aggregator. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

', 'refs' => [ 'AggregateEvaluationResultList$member' => NULL, ], ], 'AggregateEvaluationResultList' => [ 'base' => NULL, 'refs' => [ 'GetAggregateComplianceDetailsByConfigRuleResponse$AggregateEvaluationResults' => '

Returns an AggregateEvaluationResults object.

', ], ], 'AggregateResourceIdentifier' => [ 'base' => '

The details that identify a resource that is collected by Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.

', 'refs' => [ 'DiscoveredResourceIdentifierList$member' => NULL, 'GetAggregateResourceConfigRequest$ResourceIdentifier' => '

An object that identifies aggregate resource.

', 'ResourceIdentifiersList$member' => NULL, 'UnprocessedResourceIdentifierList$member' => NULL, ], ], 'AggregatedSourceStatus' => [ 'base' => '

The current sync status between the source and the aggregator account.

', 'refs' => [ 'AggregatedSourceStatusList$member' => NULL, ], ], 'AggregatedSourceStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationAggregatorSourcesStatusResponse$AggregatedSourceStatusList' => '

Returns an AggregatedSourceStatus object.

', ], ], 'AggregatedSourceStatusType' => [ 'base' => NULL, 'refs' => [ 'AggregatedSourceStatus$LastUpdateStatus' => '

Filters the last updated status type.

', 'AggregatedSourceStatusTypeList$member' => NULL, ], ], 'AggregatedSourceStatusTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationAggregatorSourcesStatusRequest$UpdateStatus' => '

Filters the status type.

', ], ], 'AggregatedSourceType' => [ 'base' => NULL, 'refs' => [ 'AggregatedSourceStatus$SourceType' => '

The source account or an organization.

', ], ], 'AggregationAuthorization' => [ 'base' => '

An object that represents the authorizations granted to aggregator accounts and regions.

', 'refs' => [ 'AggregationAuthorizationList$member' => NULL, 'PutAggregationAuthorizationResponse$AggregationAuthorization' => '

Returns an AggregationAuthorization object.

', ], ], 'AggregationAuthorizationList' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregationAuthorizationsResponse$AggregationAuthorizations' => '

Returns a list of authorizations granted to various aggregator accounts and regions.

', ], ], 'AggregatorRegionList' => [ 'base' => NULL, 'refs' => [ 'AccountAggregationSource$AwsRegions' => '

The source regions being aggregated.

', 'OrganizationAggregationSource$AwsRegions' => '

The source regions being aggregated.

', ], ], 'AllSupported' => [ 'base' => NULL, 'refs' => [ 'RecordingGroup$allSupported' => '

Specifies whether Config records configuration changes for all supported resource types, excluding the global IAM resource types.

If you set this field to true, when Config adds support for a new resource type, Config starts recording resources of that type automatically.

If you set this field to true, you cannot enumerate specific resource types to record in the resourceTypes field of RecordingGroup, or to exclude in the resourceTypes field of ExclusionByResourceTypes.

Region availability

Check Resource Coverage by Region Availability to see if a resource type is supported in the Amazon Web Services Region where you set up Config.

', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

', ], ], 'Annotation' => [ 'base' => NULL, 'refs' => [ 'ConformancePackEvaluationResult$Annotation' => '

Supplementary information about how the evaluation determined the compliance.

', ], ], 'AutoRemediationAttemptSeconds' => [ 'base' => NULL, 'refs' => [ 'RemediationConfiguration$RetryAttemptSeconds' => '

Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

', ], ], 'AutoRemediationAttempts' => [ 'base' => NULL, 'refs' => [ 'RemediationConfiguration$MaximumAutomaticAttempts' => '

The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

', ], ], 'AvailabilityZone' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$availabilityZone' => '

The Availability Zone associated with the resource.

', 'ConfigurationItem$availabilityZone' => '

The Availability Zone associated with the resource.

', ], ], 'AwsRegion' => [ 'base' => NULL, 'refs' => [ 'AggregateComplianceByConfigRule$AwsRegion' => '

The source region from where the data is aggregated.

', 'AggregateComplianceByConformancePack$AwsRegion' => '

The source Amazon Web Services Region from where the data is aggregated.

', 'AggregateConformancePackComplianceFilters$AwsRegion' => '

The source Amazon Web Services Region from where the data is aggregated.

', 'AggregateConformancePackComplianceSummaryFilters$AwsRegion' => '

The source Amazon Web Services Region from where the data is aggregated.

', 'AggregateEvaluationResult$AwsRegion' => '

The source region from where the data is aggregated.

', 'AggregateResourceIdentifier$SourceRegion' => '

The source region where data is aggregated.

', 'AggregatedSourceStatus$AwsRegion' => '

The region authorized to collect aggregated data.

', 'AggregationAuthorization$AuthorizedAwsRegion' => '

The region authorized to collect aggregated data.

', 'BaseConfigurationItem$awsRegion' => '

The region where the resource resides.

', 'ConfigRuleComplianceFilters$AwsRegion' => '

The source region where the data is aggregated.

', 'ConfigRuleComplianceSummaryFilters$AwsRegion' => '

The source region where the data is aggregated.

', 'ConfigurationItem$awsRegion' => '

The region where the resource resides.

', 'DeleteAggregationAuthorizationRequest$AuthorizedAwsRegion' => '

The region authorized to collect aggregated data.

', 'DeletePendingAggregationRequestRequest$RequesterAwsRegion' => '

The region requesting to aggregate data.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$AwsRegion' => '

The source region from where the data is aggregated.

', 'PendingAggregationRequest$RequesterAwsRegion' => '

The region requesting to aggregate data.

', 'PutAggregationAuthorizationRequest$AuthorizedAwsRegion' => '

The region authorized to collect aggregated data.

', 'ResourceCountFilters$Region' => '

The region where the account is located.

', 'ResourceFilters$Region' => '

The source region.

', ], ], 'BaseConfigurationItem' => [ 'base' => '

The detailed configurations of a specified resource.

', 'refs' => [ 'BaseConfigurationItems$member' => NULL, ], ], 'BaseConfigurationItems' => [ 'base' => NULL, 'refs' => [ 'BatchGetAggregateResourceConfigResponse$BaseConfigurationItems' => '

A list that contains the current configuration of one or more resources.

', 'BatchGetResourceConfigResponse$baseConfigurationItems' => '

A list that contains the current configuration of one or more resources.

', ], ], 'BaseResourceId' => [ 'base' => NULL, 'refs' => [ 'ComplianceByResource$ResourceId' => '

The ID of the Amazon Web Services resource that was evaluated.

', 'DescribeComplianceByResourceRequest$ResourceId' => '

The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

', 'Evaluation$ComplianceResourceId' => '

The ID of the Amazon Web Services resource that was evaluated.

', 'EvaluationResultQualifier$ResourceId' => '

The ID of the evaluated Amazon Web Services resource.

', 'ExternalEvaluation$ComplianceResourceId' => '

The evaluated compliance resource ID. Config accepts only Amazon Web Services account ID.

', 'GetComplianceDetailsByResourceRequest$ResourceId' => '

The ID of the Amazon Web Services resource for which you want compliance information.

', 'ResourceDetails$ResourceId' => '

A unique resource ID for an evaluation.

', 'Scope$ComplianceResourceId' => '

The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

', ], ], 'BatchGetAggregateResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetAggregateResourceConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetResourceConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AccountAggregationSource$AllAwsRegions' => '

If true, aggregate existing Config regions and future regions.

', 'ComplianceContributorCount$CapExceeded' => '

Indicates whether the maximum count is reached.

', 'ConfigRuleEvaluationStatus$FirstEvaluationStarted' => '

Indicates whether Config has evaluated your resources against the rule at least once.

', 'ConfigurationRecorderStatus$recording' => '

Specifies whether or not the recorder is currently recording.

', 'CustomPolicyDetails$EnableDebugLogDelivery' => '

The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is false.

', 'ListDiscoveredResourcesRequest$includeDeletedResources' => '

Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included.

', 'OrganizationAggregationSource$AllAwsRegions' => '

If true, aggregate existing Config regions and future regions.

', 'PutEvaluationsRequest$TestMode' => '

Use this parameter to specify a test run for PutEvaluations. You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur to your existing evaluations, and evaluation results are not sent to Config.

When TestMode is true, PutEvaluations doesn\'t require a valid value for the ResultToken parameter, but the value cannot be null.

', 'RemediationConfiguration$Automatic' => '

The remediation is triggered automatically.

', ], ], 'ChannelName' => [ 'base' => NULL, 'refs' => [ 'DeleteDeliveryChannelRequest$DeliveryChannelName' => '

The name of the delivery channel to delete.

', 'DeliverConfigSnapshotRequest$deliveryChannelName' => '

The name of the delivery channel through which the snapshot is delivered.

', 'DeliveryChannel$name' => '

The name of the delivery channel. By default, Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

', 'DeliveryChannelNameList$member' => NULL, ], ], 'ChronologicalOrder' => [ 'base' => NULL, 'refs' => [ 'GetResourceConfigHistoryRequest$chronologicalOrder' => '

The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'StartResourceEvaluationRequest$ClientToken' => '

A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

', ], ], 'Compliance' => [ 'base' => '

Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

', 'refs' => [ 'AggregateComplianceByConfigRule$Compliance' => '

Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

', 'ComplianceByConfigRule$Compliance' => '

Indicates whether the Config rule is compliant.

', 'ComplianceByResource$Compliance' => '

Indicates whether the Amazon Web Services resource complies with all of the Config rules that evaluated it.

', ], ], 'ComplianceByConfigRule' => [ 'base' => '

Indicates whether an Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it. A rule is noncompliant if any of these resources do not comply.

', 'refs' => [ 'ComplianceByConfigRules$member' => NULL, ], ], 'ComplianceByConfigRules' => [ 'base' => NULL, 'refs' => [ 'DescribeComplianceByConfigRuleResponse$ComplianceByConfigRules' => '

Indicates whether each of the specified Config rules is compliant.

', ], ], 'ComplianceByResource' => [ 'base' => '

Indicates whether an Amazon Web Services resource that is evaluated according to one or more Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

', 'refs' => [ 'ComplianceByResources$member' => NULL, ], ], 'ComplianceByResources' => [ 'base' => NULL, 'refs' => [ 'DescribeComplianceByResourceResponse$ComplianceByResources' => '

Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.

', ], ], 'ComplianceContributorCount' => [ 'base' => '

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item, up to a maximum number.

', 'refs' => [ 'Compliance$ComplianceContributorCount' => '

The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

', 'ComplianceSummary$CompliantResourceCount' => '

The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

', 'ComplianceSummary$NonCompliantResourceCount' => '

The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

', ], ], 'ComplianceResourceTypes' => [ 'base' => NULL, 'refs' => [ 'Scope$ComplianceResourceTypes' => '

The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

', ], ], 'ComplianceScore' => [ 'base' => NULL, 'refs' => [ 'ConformancePackComplianceScore$Score' => '

Compliance score for the conformance pack. Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA.

', ], ], 'ComplianceSummariesByResourceType' => [ 'base' => NULL, 'refs' => [ 'GetComplianceSummaryByResourceTypeResponse$ComplianceSummariesByResourceType' => '

The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.

', ], ], 'ComplianceSummary' => [ 'base' => '

The number of Config rules or Amazon Web Services resources that are compliant and noncompliant.

', 'refs' => [ 'AggregateComplianceCount$ComplianceSummary' => '

The number of compliant and noncompliant Config rules.

', 'ComplianceSummaryByResourceType$ComplianceSummary' => '

The number of Amazon Web Services resources that are compliant or noncompliant, up to a maximum of 100 for each.

', 'GetComplianceSummaryByConfigRuleResponse$ComplianceSummary' => '

The number of Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.

', ], ], 'ComplianceSummaryByResourceType' => [ 'base' => '

The number of Amazon Web Services resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each.

', 'refs' => [ 'ComplianceSummariesByResourceType$member' => NULL, ], ], 'ComplianceType' => [ 'base' => NULL, 'refs' => [ 'AggregateEvaluationResult$ComplianceType' => '

The resource compliance status.

For the AggregationEvaluationResult data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

', 'Compliance$ComplianceType' => '

Indicates whether an Amazon Web Services resource or Config rule is compliant.

A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.

Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.

For the Compliance data type, Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.

', 'ComplianceTypes$member' => NULL, 'ConfigRuleComplianceFilters$ComplianceType' => '

The rule compliance status.

For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.

', 'Evaluation$ComplianceType' => '

Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

For the Evaluation data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

', 'EvaluationResult$ComplianceType' => '

Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

For the EvaluationResult data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

', 'ExternalEvaluation$ComplianceType' => '

The compliance of the Amazon Web Services resource. The valid values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$ComplianceType' => '

The resource compliance status.

For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

', 'GetResourceEvaluationSummaryResponse$Compliance' => '

The compliance status of the resource evaluation summary.

', ], ], 'ComplianceTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeComplianceByConfigRuleRequest$ComplianceTypes' => '

Filters the results by compliance.

', 'DescribeComplianceByResourceRequest$ComplianceTypes' => '

Filters the results by compliance.

', 'GetComplianceDetailsByConfigRuleRequest$ComplianceTypes' => '

Filters the results by compliance.

INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.

', 'GetComplianceDetailsByResourceRequest$ComplianceTypes' => '

Filters the results by compliance.

INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.

', ], ], 'ConfigExportDeliveryInfo' => [ 'base' => '

Provides status of the delivery of the snapshot or the configuration history to the specified Amazon S3 bucket. Also provides the status of notifications about the Amazon S3 delivery to the specified Amazon SNS topic.

', 'refs' => [ 'DeliveryChannelStatus$configSnapshotDeliveryInfo' => '

A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.

', 'DeliveryChannelStatus$configHistoryDeliveryInfo' => '

A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.

', ], ], 'ConfigRule' => [ 'base' => '

Config rules evaluate the configuration settings of your Amazon Web Services resources. A rule can run when Config detects a configuration change to an Amazon Web Services resource or at a periodic frequency that you choose (for example, every 24 hours). There are two types of rules: Config Managed Rules and Config Custom Rules.

Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules.

Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.

For more information about developing and using Config rules, see Evaluating Resource with Config Rules in the Config Developer Guide.

You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

', 'refs' => [ 'ConfigRules$member' => NULL, 'PutConfigRuleRequest$ConfigRule' => '

The rule that you want to add to your account.

', ], ], 'ConfigRuleComplianceFilters' => [ 'base' => '

Filters the compliance results based on account ID, region, compliance type, and rule name.

', 'refs' => [ 'DescribeAggregateComplianceByConfigRulesRequest$Filters' => '

Filters the results by ConfigRuleComplianceFilters object.

', ], ], 'ConfigRuleComplianceSummaryFilters' => [ 'base' => '

Filters the results based on the account IDs and regions.

', 'refs' => [ 'GetAggregateConfigRuleComplianceSummaryRequest$Filters' => '

Filters the results based on the ConfigRuleComplianceSummaryFilters object.

', ], ], 'ConfigRuleComplianceSummaryGroupKey' => [ 'base' => NULL, 'refs' => [ 'GetAggregateConfigRuleComplianceSummaryRequest$GroupByKey' => '

Groups the result based on ACCOUNT_ID or AWS_REGION.

', ], ], 'ConfigRuleEvaluationStatus' => [ 'base' => '

Status information for your Config Managed rules and Config Custom Policy rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.

This action does not return status information about Config Custom Lambda rules.

', 'refs' => [ 'ConfigRuleEvaluationStatusList$member' => NULL, ], ], 'ConfigRuleEvaluationStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigRuleEvaluationStatusResponse$ConfigRulesEvaluationStatus' => '

Status information about your Config managed rules.

', ], ], 'ConfigRuleName' => [ 'base' => NULL, 'refs' => [ 'AggregateComplianceByConfigRule$ConfigRuleName' => '

The name of the Config rule.

', 'ConfigRule$ConfigRuleName' => '

The name that you assign to the Config rule. The name is required if you are adding a new rule.

', 'ConfigRuleComplianceFilters$ConfigRuleName' => '

The name of the Config rule.

', 'ConfigRuleEvaluationStatus$ConfigRuleName' => '

The name of the Config rule.

', 'ConfigRuleNames$member' => NULL, 'ConformancePackRuleCompliance$ConfigRuleName' => '

Name of the Config rule.

', 'DeleteConfigRuleRequest$ConfigRuleName' => '

The name of the Config rule that you want to delete.

', 'DeleteRemediationConfigurationRequest$ConfigRuleName' => '

The name of the Config rule for which you want to delete remediation configuration.

', 'DeleteRemediationExceptionsRequest$ConfigRuleName' => '

The name of the Config rule for which you want to delete remediation exception configuration.

', 'DescribeRemediationExceptionsRequest$ConfigRuleName' => '

The name of the Config rule.

', 'DescribeRemediationExecutionStatusRequest$ConfigRuleName' => '

A list of Config rule names.

', 'EvaluationResultQualifier$ConfigRuleName' => '

The name of the Config rule that was used in the evaluation.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$ConfigRuleName' => '

The name of the Config rule for which you want compliance information.

', 'GetCustomRulePolicyRequest$ConfigRuleName' => '

The name of your Config Custom Policy rule.

', 'PutExternalEvaluationRequest$ConfigRuleName' => '

The name of the Config rule.

', 'PutRemediationExceptionsRequest$ConfigRuleName' => '

The name of the Config rule for which you want to create remediation exception.

', 'ReevaluateConfigRuleNames$member' => NULL, 'RemediationConfiguration$ConfigRuleName' => '

The name of the Config rule.

', 'RemediationException$ConfigRuleName' => '

The name of the Config rule.

', 'StartRemediationExecutionRequest$ConfigRuleName' => '

The list of names of Config rules that you want to run remediation execution for.

', ], ], 'ConfigRuleNames' => [ 'base' => NULL, 'refs' => [ 'DescribeComplianceByConfigRuleRequest$ConfigRuleNames' => '

Specify one or more Config rule names to filter the results by rule.

', 'DescribeConfigRuleEvaluationStatusRequest$ConfigRuleNames' => '

The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use.

', 'DescribeConfigRulesRequest$ConfigRuleNames' => '

The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

', 'DescribeRemediationConfigurationsRequest$ConfigRuleNames' => '

A list of Config rule names of remediation configurations for which you want details.

', ], ], 'ConfigRuleState' => [ 'base' => NULL, 'refs' => [ 'ConfigRule$ConfigRuleState' => '

Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.

Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.

Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

', ], ], 'ConfigRules' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigRulesResponse$ConfigRules' => '

The details about your Config rules.

', ], ], 'ConfigSnapshotDeliveryProperties' => [ 'base' => '

Provides options for how often Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.

The frequency for a rule that triggers evaluations for your resources when Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:

If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, Config invokes the rule only as often as the deliveryFrequency value.

  1. For example, you want your rule to run evaluations when Config delivers the configuration snapshot.

  2. You specify the MaximumExecutionFrequency value for Six_Hours.

  3. You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours.

  4. Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, Config invokes evaluations for the rule every 24 hours.

You should set the MaximumExecutionFrequency value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action.

To update the deliveryFrequency with which Config delivers your configuration snapshots, use the PutDeliveryChannel action.

', 'refs' => [ 'DeliveryChannel$configSnapshotDeliveryProperties' => '

The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

', ], ], 'ConfigStreamDeliveryInfo' => [ 'base' => '

A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.

', 'refs' => [ 'DeliveryChannelStatus$configStreamDeliveryInfo' => '

A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.

', ], ], 'Configuration' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$configuration' => '

The description of the resource configuration.

', 'ConfigurationItem$configuration' => '

The description of the resource configuration.

', 'PutResourceConfigRequest$Configuration' => '

The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.

The configuration JSON must not exceed 64 KB.

', ], ], 'ConfigurationAggregator' => [ 'base' => '

The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.

', 'refs' => [ 'ConfigurationAggregatorList$member' => NULL, 'PutConfigurationAggregatorResponse$ConfigurationAggregator' => '

Returns a ConfigurationAggregator object.

', ], ], 'ConfigurationAggregatorArn' => [ 'base' => NULL, 'refs' => [ 'ConfigurationAggregator$ConfigurationAggregatorArn' => '

The Amazon Resource Name (ARN) of the aggregator.

', ], ], 'ConfigurationAggregatorList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationAggregatorsResponse$ConfigurationAggregators' => '

Returns a ConfigurationAggregators object.

', ], ], 'ConfigurationAggregatorName' => [ 'base' => NULL, 'refs' => [ 'BatchGetAggregateResourceConfigRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'ConfigurationAggregator$ConfigurationAggregatorName' => '

The name of the aggregator.

', 'ConfigurationAggregatorNameList$member' => NULL, 'DeleteConfigurationAggregatorRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'DescribeAggregateComplianceByConfigRulesRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'DescribeAggregateComplianceByConformancePacksRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'DescribeConfigurationAggregatorSourcesStatusRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'GetAggregateConfigRuleComplianceSummaryRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'GetAggregateConformancePackComplianceSummaryRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'GetAggregateDiscoveredResourceCountsRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'GetAggregateResourceConfigRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'ListAggregateDiscoveredResourcesRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'PutConfigurationAggregatorRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'SelectAggregateResourceConfigRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', ], ], 'ConfigurationAggregatorNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationAggregatorsRequest$ConfigurationAggregatorNames' => '

The name of the configuration aggregators.

', ], ], 'ConfigurationItem' => [ 'base' => '

A list that contains detailed configurations of a specified resource.

', 'refs' => [ 'ConfigurationItemList$member' => NULL, 'GetAggregateResourceConfigResponse$ConfigurationItem' => '

Returns a ConfigurationItem object.

', ], ], 'ConfigurationItemCaptureTime' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$configurationItemCaptureTime' => '

The time when the recording of configuration changes was initiated for the resource.

', 'ConfigurationItem$configurationItemCaptureTime' => '

The time when the recording of configuration changes was initiated for the resource.

', ], ], 'ConfigurationItemDeliveryTime' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$configurationItemDeliveryTime' => '

The time when configuration changes for the resource were delivered.

', 'ConfigurationItem$configurationItemDeliveryTime' => '

The time when configuration changes for the resource were delivered.

', ], ], 'ConfigurationItemList' => [ 'base' => NULL, 'refs' => [ 'GetResourceConfigHistoryResponse$configurationItems' => '

A list that contains the configuration history of one or more resources.

', ], ], 'ConfigurationItemMD5Hash' => [ 'base' => NULL, 'refs' => [ 'ConfigurationItem$configurationItemMD5Hash' => '

Unique MD5 hash that represents the configuration item\'s state.

You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

', ], ], 'ConfigurationItemStatus' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$configurationItemStatus' => '

The configuration item status. Valid values include:

', 'ConfigurationItem$configurationItemStatus' => '

The configuration item status. Valid values include:

', ], ], 'ConfigurationRecorder' => [ 'base' => '

Records configuration changes to your specified resource types. For more information about the configuration recorder, see Managing the Configuration Recorder in the Config Developer Guide.

', 'refs' => [ 'ConfigurationRecorderList$member' => NULL, 'PutConfigurationRecorderRequest$ConfigurationRecorder' => '

An object for the configuration recorder to record configuration changes for specified resource types.

', ], ], 'ConfigurationRecorderList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationRecordersResponse$ConfigurationRecorders' => '

A list that contains the descriptions of the specified configuration recorders.

', ], ], 'ConfigurationRecorderNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationRecorderStatusRequest$ConfigurationRecorderNames' => '

The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.

', 'DescribeConfigurationRecordersRequest$ConfigurationRecorderNames' => '

A list of configuration recorder names.

', ], ], 'ConfigurationRecorderStatus' => [ 'base' => '

The current status of the configuration recorder.

For a detailed status of recording events over time, add your Config events to CloudWatch metrics and use CloudWatch metrics.

', 'refs' => [ 'ConfigurationRecorderStatusList$member' => NULL, ], ], 'ConfigurationRecorderStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationRecorderStatusResponse$ConfigurationRecordersStatus' => '

A list that contains status of the specified recorders.

', ], ], 'ConfigurationStateId' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$configurationStateId' => '

An identifier that indicates the ordering of the configuration items of a resource.

', 'ConfigurationItem$configurationStateId' => '

An identifier that indicates the ordering of the configuration items of a resource.

', ], ], 'ConformancePackArn' => [ 'base' => NULL, 'refs' => [ 'ConformancePackDetail$ConformancePackArn' => '

Amazon Resource Name (ARN) of the conformance pack.

', 'ConformancePackStatusDetail$ConformancePackArn' => '

Amazon Resource Name (ARN) of comformance pack.

', 'PutConformancePackResponse$ConformancePackArn' => '

ARN of the conformance pack.

', ], ], 'ConformancePackComplianceFilters' => [ 'base' => '

Filters the conformance pack by compliance types and Config rule names.

', 'refs' => [ 'DescribeConformancePackComplianceRequest$Filters' => '

A ConformancePackComplianceFilters object.

', ], ], 'ConformancePackComplianceResourceIds' => [ 'base' => NULL, 'refs' => [ 'ConformancePackEvaluationFilters$ResourceIds' => '

Filters the results by resource IDs.

This is valid only when you provide resource type. If there is no resource type, you will see an error.

', ], ], 'ConformancePackComplianceScore' => [ 'base' => '

A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.

', 'refs' => [ 'ConformancePackComplianceScores$member' => NULL, ], ], 'ConformancePackComplianceScores' => [ 'base' => NULL, 'refs' => [ 'ListConformancePackComplianceScoresResponse$ConformancePackComplianceScores' => '

A list of ConformancePackComplianceScore objects.

', ], ], 'ConformancePackComplianceScoresFilters' => [ 'base' => '

A list of filters to apply to the conformance pack compliance score result set.

', 'refs' => [ 'ListConformancePackComplianceScoresRequest$Filters' => '

Filters the results based on the ConformancePackComplianceScoresFilters.

', ], ], 'ConformancePackComplianceSummary' => [ 'base' => '

Summary includes the name and status of the conformance pack.

', 'refs' => [ 'ConformancePackComplianceSummaryList$member' => NULL, ], ], 'ConformancePackComplianceSummaryList' => [ 'base' => NULL, 'refs' => [ 'GetConformancePackComplianceSummaryResponse$ConformancePackComplianceSummaryList' => '

A list of ConformancePackComplianceSummary objects.

', ], ], 'ConformancePackComplianceType' => [ 'base' => NULL, 'refs' => [ 'AggregateConformancePackCompliance$ComplianceType' => '

The compliance status of the conformance pack.

', 'AggregateConformancePackComplianceFilters$ComplianceType' => '

The compliance status of the conformance pack.

', 'ConformancePackComplianceFilters$ComplianceType' => '

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

', 'ConformancePackComplianceSummary$ConformancePackComplianceStatus' => '

The status of the conformance pack.

', 'ConformancePackEvaluationFilters$ComplianceType' => '

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

', 'ConformancePackEvaluationResult$ComplianceType' => '

The compliance type. The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

', 'ConformancePackRuleCompliance$ComplianceType' => '

Compliance of the Config rule.

', ], ], 'ConformancePackConfigRuleNames' => [ 'base' => NULL, 'refs' => [ 'ConformancePackComplianceFilters$ConfigRuleNames' => '

Filters the results by Config rule names.

', 'ConformancePackEvaluationFilters$ConfigRuleNames' => '

Filters the results by Config rule names.

', ], ], 'ConformancePackDetail' => [ 'base' => '

Returns details of a conformance pack. A conformance pack is a collection of Config rules and remediation actions that can be easily deployed in an account and a region.

', 'refs' => [ 'ConformancePackDetailList$member' => NULL, ], ], 'ConformancePackDetailList' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePacksResponse$ConformancePackDetails' => '

Returns a list of ConformancePackDetail objects.

', ], ], 'ConformancePackEvaluationFilters' => [ 'base' => '

Filters a conformance pack by Config rule names, compliance types, Amazon Web Services resource types, and resource IDs.

', 'refs' => [ 'GetConformancePackComplianceDetailsRequest$Filters' => '

A ConformancePackEvaluationFilters object.

', ], ], 'ConformancePackEvaluationResult' => [ 'base' => '

The details of a conformance pack evaluation. Provides Config rule and Amazon Web Services resource type that was evaluated, the compliance of the conformance pack, related time stamps, and supplementary information.

', 'refs' => [ 'ConformancePackRuleEvaluationResultsList$member' => NULL, ], ], 'ConformancePackId' => [ 'base' => NULL, 'refs' => [ 'ConformancePackDetail$ConformancePackId' => '

ID of the conformance pack.

', 'ConformancePackStatusDetail$ConformancePackId' => '

ID of the conformance pack.

', ], ], 'ConformancePackInputParameter' => [ 'base' => '

Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.

', 'refs' => [ 'ConformancePackInputParameters$member' => NULL, ], ], 'ConformancePackInputParameters' => [ 'base' => NULL, 'refs' => [ 'ConformancePackDetail$ConformancePackInputParameters' => '

A list of ConformancePackInputParameter objects.

', 'OrganizationConformancePack$ConformancePackInputParameters' => '

A list of ConformancePackInputParameter objects.

', 'PutConformancePackRequest$ConformancePackInputParameters' => '

A list of ConformancePackInputParameter objects.

', 'PutOrganizationConformancePackRequest$ConformancePackInputParameters' => '

A list of ConformancePackInputParameter objects.

', ], ], 'ConformancePackName' => [ 'base' => NULL, 'refs' => [ 'AggregateComplianceByConformancePack$ConformancePackName' => '

The name of the conformance pack.

', 'AggregateConformancePackComplianceFilters$ConformancePackName' => '

The name of the conformance pack.

', 'ConformancePackComplianceScore$ConformancePackName' => '

The name of the conformance pack.

', 'ConformancePackComplianceSummary$ConformancePackName' => '

The name of the conformance pack name.

', 'ConformancePackDetail$ConformancePackName' => '

Name of the conformance pack.

', 'ConformancePackNameFilter$member' => NULL, 'ConformancePackNamesList$member' => NULL, 'ConformancePackNamesToSummarizeList$member' => NULL, 'ConformancePackStatusDetail$ConformancePackName' => '

Name of the conformance pack.

', 'DeleteConformancePackRequest$ConformancePackName' => '

Name of the conformance pack you want to delete.

', 'DescribeConformancePackComplianceRequest$ConformancePackName' => '

Name of the conformance pack.

', 'DescribeConformancePackComplianceResponse$ConformancePackName' => '

Name of the conformance pack.

', 'GetConformancePackComplianceDetailsRequest$ConformancePackName' => '

Name of the conformance pack.

', 'GetConformancePackComplianceDetailsResponse$ConformancePackName' => '

Name of the conformance pack.

', 'PutConformancePackRequest$ConformancePackName' => '

The unique name of the conformance pack you want to deploy.

', ], ], 'ConformancePackNameFilter' => [ 'base' => NULL, 'refs' => [ 'ConformancePackComplianceScoresFilters$ConformancePackNames' => '

The names of the conformance packs whose compliance scores you want to include in the conformance pack compliance score result set. You can include up to 25 conformance packs in the ConformancePackNames array of strings, each with a character limit of 256 characters for the conformance pack name.

', ], ], 'ConformancePackNamesList' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePackStatusRequest$ConformancePackNames' => '

Comma-separated list of conformance pack names.

', 'DescribeConformancePacksRequest$ConformancePackNames' => '

Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs.

', ], ], 'ConformancePackNamesToSummarizeList' => [ 'base' => NULL, 'refs' => [ 'GetConformancePackComplianceSummaryRequest$ConformancePackNames' => '

Names of conformance packs.

', ], ], 'ConformancePackRuleCompliance' => [ 'base' => '

Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.

', 'refs' => [ 'ConformancePackRuleComplianceList$member' => NULL, ], ], 'ConformancePackRuleComplianceList' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePackComplianceResponse$ConformancePackRuleComplianceList' => '

Returns a list of ConformancePackRuleCompliance objects.

', ], ], 'ConformancePackRuleEvaluationResultsList' => [ 'base' => NULL, 'refs' => [ 'GetConformancePackComplianceDetailsResponse$ConformancePackRuleEvaluationResults' => '

Returns a list of ConformancePackEvaluationResult objects.

', ], ], 'ConformancePackState' => [ 'base' => NULL, 'refs' => [ 'ConformancePackStatusDetail$ConformancePackState' => '

Indicates deployment status of conformance pack.

Config sets the state of the conformance pack to:

', ], ], 'ConformancePackStatusDetail' => [ 'base' => '

Status details of a conformance pack.

', 'refs' => [ 'ConformancePackStatusDetailsList$member' => NULL, ], ], 'ConformancePackStatusDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePackStatusResponse$ConformancePackStatusDetails' => '

A list of ConformancePackStatusDetail objects.

', ], ], 'ConformancePackStatusReason' => [ 'base' => NULL, 'refs' => [ 'ConformancePackStatusDetail$ConformancePackStatusReason' => '

The reason of conformance pack creation failure.

', ], ], 'ConformancePackTemplateValidationException' => [ 'base' => '

You have specified a template that is not valid or supported.

', 'refs' => [], ], 'ControlsList' => [ 'base' => NULL, 'refs' => [ 'ConformancePackRuleCompliance$Controls' => '

Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.

', ], ], 'CosmosPageLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConfigRuleStatusesRequest$Limit' => '

The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

', 'DescribeOrganizationConfigRulesRequest$Limit' => '

The maximum number of organization Config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.

', 'DescribeOrganizationConformancePackStatusesRequest$Limit' => '

The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

', 'DescribeOrganizationConformancePacksRequest$Limit' => '

The maximum number of organization config packs returned on each page. If you do no specify a number, Config uses the default. The default is 100.

', 'GetOrganizationConfigRuleDetailedStatusRequest$Limit' => '

The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not specify a number, Config uses the default. The default is 100.

', 'GetOrganizationConformancePackDetailedStatusRequest$Limit' => '

The maximum number of OrganizationConformancePackDetailedStatuses returned on each page. If you do not specify a number, Config uses the default. The default is 100.

', ], ], 'CustomPolicyDetails' => [ 'base' => '

Provides the runtime system, policy definition, and whether debug logging enabled. You can specify the following CustomPolicyDetails parameter values only for Config Custom Policy rules.

', 'refs' => [ 'Source$CustomPolicyDetails' => '

Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to CUSTOM_POLICY.

', ], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'AggregateEvaluationResult$ResultRecordedTime' => '

The time when Config recorded the aggregate evaluation result.

', 'AggregateEvaluationResult$ConfigRuleInvokedTime' => '

The time when the Config rule evaluated the Amazon Web Services resource.

', 'AggregatedSourceStatus$LastUpdateTime' => '

The time of the last update.

', 'AggregationAuthorization$CreationTime' => '

The time stamp when the aggregation authorization was created.

', 'ComplianceSummary$ComplianceSummaryTimestamp' => '

The time that Config created the compliance summary.

', 'ConfigExportDeliveryInfo$lastAttemptTime' => '

The time of the last attempted delivery.

', 'ConfigExportDeliveryInfo$lastSuccessfulTime' => '

The time of the last successful delivery.

', 'ConfigExportDeliveryInfo$nextDeliveryTime' => '

The time that the next delivery occurs.

', 'ConfigRuleEvaluationStatus$LastSuccessfulInvocationTime' => '

The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.

', 'ConfigRuleEvaluationStatus$LastFailedInvocationTime' => '

The time that Config last failed to invoke the Config rule to evaluate your Amazon Web Services resources.

', 'ConfigRuleEvaluationStatus$LastSuccessfulEvaluationTime' => '

The time that Config last successfully evaluated your Amazon Web Services resources against the rule.

', 'ConfigRuleEvaluationStatus$LastFailedEvaluationTime' => '

The time that Config last failed to evaluate your Amazon Web Services resources against the rule.

', 'ConfigRuleEvaluationStatus$FirstActivatedTime' => '

The time that you first activated the Config rule.

', 'ConfigRuleEvaluationStatus$LastDeactivatedTime' => '

The time that you last turned off the Config rule.

', 'ConfigRuleEvaluationStatus$LastDebugLogDeliveryTime' => '

The time Config last attempted to deliver a debug log for your Config Custom Policy rules.

', 'ConfigStreamDeliveryInfo$lastStatusChangeTime' => '

The time from the last status change.

', 'ConfigurationAggregator$CreationTime' => '

The time stamp when the configuration aggregator was created.

', 'ConfigurationAggregator$LastUpdatedTime' => '

The time of the last update.

', 'ConfigurationRecorderStatus$lastStartTime' => '

The time the recorder was last started.

', 'ConfigurationRecorderStatus$lastStopTime' => '

The time the recorder was last stopped.

', 'ConfigurationRecorderStatus$lastStatusChangeTime' => '

The time of the latest change in status of an recording event processed by the recorder.

', 'ConformancePackDetail$LastUpdateRequestedTime' => '

The last time a conformation pack update was requested.

', 'ConformancePackEvaluationResult$ConfigRuleInvokedTime' => '

The time when Config rule evaluated Amazon Web Services resource.

', 'ConformancePackEvaluationResult$ResultRecordedTime' => '

The time when Config recorded the evaluation result.

', 'ConformancePackStatusDetail$LastUpdateRequestedTime' => '

Last time when conformation pack creation and update was requested.

', 'ConformancePackStatusDetail$LastUpdateCompletedTime' => '

Last time when conformation pack creation and update was successful.

', 'EvaluationResult$ResultRecordedTime' => '

The time when Config recorded the evaluation result.

', 'EvaluationResult$ConfigRuleInvokedTime' => '

The time when the Config rule evaluated the Amazon Web Services resource.

', 'EvaluationResultIdentifier$OrderingTimestamp' => '

The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.

', 'GetResourceEvaluationSummaryResponse$EvaluationStartTimestamp' => '

The start timestamp when Config rule starts evaluating compliance for the provided resource details.

', 'MemberAccountStatus$LastUpdateTime' => '

The timestamp of the last status update.

', 'OrganizationConfigRule$LastUpdateTime' => '

The timestamp of the last update.

', 'OrganizationConfigRuleStatus$LastUpdateTime' => '

The timestamp of the last update.

', 'OrganizationConformancePack$LastUpdateTime' => '

Last time when organization conformation pack was updated.

', 'OrganizationConformancePackDetailedStatus$LastUpdateTime' => '

The timestamp of the last status update.

', 'OrganizationConformancePackStatus$LastUpdateTime' => '

The timestamp of the last update.

', 'PutRemediationExceptionsRequest$ExpirationTime' => '

The exception is automatically deleted after the expiration date.

', 'RemediationException$ExpirationTime' => '

The time when the remediation exception will be deleted.

', 'RemediationExecutionStatus$InvocationTime' => '

Start time when the remediation was executed.

', 'RemediationExecutionStatus$LastUpdatedTime' => '

The time when the remediation execution was last updated.

', 'RemediationExecutionStep$StartTime' => '

The time when the step started.

', 'RemediationExecutionStep$StopTime' => '

The time when the step stopped.

', 'ResourceEvaluation$EvaluationStartTimestamp' => '

The starting time of an execution.

', 'TimeWindow$StartTime' => '

The start time of an execution.

', 'TimeWindow$EndTime' => '

The end time of an execution. The end time must be after the start date.

', ], ], 'DebugLogDeliveryAccounts' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$DebugLogDeliveryAccounts' => '

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$DebugLogDeliveryAccounts' => '

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

', ], ], 'DeleteAggregationAuthorizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConfigRuleRequest' => [ 'base' => '

', 'refs' => [], ], 'DeleteConfigurationAggregatorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConfigurationRecorderRequest' => [ 'base' => '

The request object for the DeleteConfigurationRecorder action.

', 'refs' => [], ], 'DeleteConformancePackRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDeliveryChannelRequest' => [ 'base' => '

The input for the DeleteDeliveryChannel action. The action accepts the following data, in JSON format.

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

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

The output when you delete the evaluation results for the specified Config rule.

', 'refs' => [], ], 'DeleteOrganizationConfigRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOrganizationConformancePackRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePendingAggregationRequestRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRemediationConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRemediationConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRemediationExceptionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRemediationExceptionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetentionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStoredQueryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStoredQueryResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeliverConfigSnapshotRequest' => [ 'base' => '

The input for the DeliverConfigSnapshot action.

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

The output for the DeliverConfigSnapshot action, in JSON format.

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

The channel through which Config delivers notifications and updated configuration states.

', 'refs' => [ 'DeliveryChannelList$member' => NULL, 'PutDeliveryChannelRequest$DeliveryChannel' => '

The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.

', ], ], 'DeliveryChannelList' => [ 'base' => NULL, 'refs' => [ 'DescribeDeliveryChannelsResponse$DeliveryChannels' => '

A list that contains the descriptions of the specified delivery channel.

', ], ], 'DeliveryChannelNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeDeliveryChannelStatusRequest$DeliveryChannelNames' => '

A list of delivery channel names.

', 'DescribeDeliveryChannelsRequest$DeliveryChannelNames' => '

A list of delivery channel names.

', ], ], 'DeliveryChannelStatus' => [ 'base' => '

The status of a specified delivery channel.

Valid values: Success | Failure

', 'refs' => [ 'DeliveryChannelStatusList$member' => NULL, ], ], 'DeliveryChannelStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeDeliveryChannelStatusResponse$DeliveryChannelsStatus' => '

A list that contains the status of a specified delivery channel.

', ], ], 'DeliveryS3Bucket' => [ 'base' => NULL, 'refs' => [ 'ConformancePackDetail$DeliveryS3Bucket' => '

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

', 'OrganizationConformancePack$DeliveryS3Bucket' => '

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

', 'PutConformancePackRequest$DeliveryS3Bucket' => '

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

', 'PutOrganizationConformancePackRequest$DeliveryS3Bucket' => '

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional. If used, it must be prefixed with awsconfigconforms.

', ], ], 'DeliveryS3KeyPrefix' => [ 'base' => NULL, 'refs' => [ 'ConformancePackDetail$DeliveryS3KeyPrefix' => '

The prefix for the Amazon S3 bucket.

This field is optional.

', 'OrganizationConformancePack$DeliveryS3KeyPrefix' => '

Any folder structure you want to add to an Amazon S3 bucket.

This field is optional.

', 'PutConformancePackRequest$DeliveryS3KeyPrefix' => '

The prefix for the Amazon S3 bucket.

This field is optional.

', 'PutOrganizationConformancePackRequest$DeliveryS3KeyPrefix' => '

The prefix for the Amazon S3 bucket.

This field is optional.

', ], ], 'DeliveryStatus' => [ 'base' => NULL, 'refs' => [ 'ConfigExportDeliveryInfo$lastStatus' => '

Status of the last attempted delivery.

', 'ConfigStreamDeliveryInfo$lastStatus' => '

Status of the last attempted delivery.

Note Providing an SNS topic on a DeliveryChannel for Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.

', ], ], 'DescribeAggregateComplianceByConfigRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAggregateComplianceByConfigRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAggregateComplianceByConformancePacksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAggregateComplianceByConformancePacksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAggregationAuthorizationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAggregationAuthorizationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeComplianceByConfigRuleRequest' => [ 'base' => '

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

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

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

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

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

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

Returns a filtered list of Detective or Proactive Config rules. By default, if the filter is not defined, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.

', 'refs' => [ 'DescribeConfigRulesRequest$Filters' => '

Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.

', ], ], 'DescribeConfigRulesRequest' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeConfigurationAggregatorSourcesStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationAggregatorSourcesStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationAggregatorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationAggregatorsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationRecorderStatusRequest' => [ 'base' => '

The input for the DescribeConfigurationRecorderStatus action.

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

The output for the DescribeConfigurationRecorderStatus action, in JSON format.

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

The input for the DescribeConfigurationRecorders action.

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

The output for the DescribeConfigurationRecorders action.

', 'refs' => [], ], 'DescribeConformancePackComplianceLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePackComplianceRequest$Limit' => '

The maximum number of Config rules within a conformance pack are returned on each page.

', ], ], 'DescribeConformancePackComplianceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConformancePackComplianceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConformancePackStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConformancePackStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConformancePacksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConformancePacksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeliveryChannelStatusRequest' => [ 'base' => '

The input for the DeliveryChannelStatus action.

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

The output for the DescribeDeliveryChannelStatus action.

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

The input for the DescribeDeliveryChannels action.

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

The output for the DescribeDeliveryChannels action.

', 'refs' => [], ], 'DescribeOrganizationConfigRuleStatusesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConfigRuleStatusesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConfigRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConfigRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConformancePackStatusesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConformancePackStatusesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConformancePacksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConformancePacksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePendingAggregationRequestsLimit' => [ 'base' => NULL, 'refs' => [ 'DescribePendingAggregationRequestsRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

', ], ], 'DescribePendingAggregationRequestsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePendingAggregationRequestsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationExceptionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationExceptionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationExecutionStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationExecutionStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRetentionConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRetentionConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'RecordingModeOverride$description' => '

A description that you provide for the override.

', ], ], 'DiscoveredResourceIdentifierList' => [ 'base' => NULL, 'refs' => [ 'ListAggregateDiscoveredResourcesResponse$ResourceIdentifiers' => '

Returns a list of ResourceIdentifiers objects.

', ], ], 'EarlierTime' => [ 'base' => NULL, 'refs' => [ 'GetResourceConfigHistoryRequest$earlierTime' => '

The chronologically earliest time in the time range for which the history requested. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.

', ], ], 'EmptiableStringWithCharLimit256' => [ 'base' => NULL, 'refs' => [ 'ConfigRule$Description' => '

The description that you provide for the Config rule.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ResourceConcurrentModificationException$message' => NULL, ], ], 'Evaluation' => [ 'base' => '

Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.

', 'refs' => [ 'Evaluations$member' => NULL, ], ], 'EvaluationContext' => [ 'base' => '

Use EvaluationContext to group independently initiated proactive resource evaluations. For example, CFN Stack. If you want to check just a resource definition, you do not need to provide evaluation context.

', 'refs' => [ 'GetResourceEvaluationSummaryResponse$EvaluationContext' => '

Returns an EvaluationContext object.

', 'StartResourceEvaluationRequest$EvaluationContext' => '

Returns an EvaluationContext object.

', ], ], 'EvaluationContextIdentifier' => [ 'base' => NULL, 'refs' => [ 'EvaluationContext$EvaluationContextIdentifier' => '

A unique EvaluationContextIdentifier ID for an EvaluationContext.

', 'ResourceEvaluationFilters$EvaluationContextIdentifier' => '

Filters evaluations for a given infrastructure deployment. For example: CFN Stack.

', ], ], 'EvaluationMode' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigRulesFilters$EvaluationMode' => '

The mode of an evaluation. The valid values are Detective or Proactive.

', 'EvaluationModeConfiguration$Mode' => '

The mode of an evaluation. The valid values are Detective or Proactive.

', 'EvaluationResultQualifier$EvaluationMode' => '

The mode of an evaluation. The valid values are Detective or Proactive.

', 'GetResourceEvaluationSummaryResponse$EvaluationMode' => '

Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.

', 'ResourceEvaluation$EvaluationMode' => '

The mode of an evaluation. The valid values are Detective or Proactive.

', 'ResourceEvaluationFilters$EvaluationMode' => '

Filters all resource evaluations results based on an evaluation mode. the valid value for this API is Proactive.

', 'StartResourceEvaluationRequest$EvaluationMode' => '

The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE.

', ], ], 'EvaluationModeConfiguration' => [ 'base' => '

The configuration object for Config rule evaluation mode. The supported valid values are Detective or Proactive.

', 'refs' => [ 'EvaluationModes$member' => NULL, ], ], 'EvaluationModes' => [ 'base' => NULL, 'refs' => [ 'ConfigRule$EvaluationModes' => '

The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.

', ], ], 'EvaluationResult' => [ 'base' => '

The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

', 'refs' => [ 'EvaluationResults$member' => NULL, ], ], 'EvaluationResultIdentifier' => [ 'base' => '

Uniquely identifies an evaluation result.

', 'refs' => [ 'AggregateEvaluationResult$EvaluationResultIdentifier' => '

Uniquely identifies the evaluation result.

', 'ConformancePackEvaluationResult$EvaluationResultIdentifier' => NULL, 'EvaluationResult$EvaluationResultIdentifier' => '

Uniquely identifies the evaluation result.

', ], ], 'EvaluationResultQualifier' => [ 'base' => '

Identifies an Config rule that evaluated an Amazon Web Services resource, and provides the type and ID of the resource that the rule evaluated.

', 'refs' => [ 'EvaluationResultIdentifier$EvaluationResultQualifier' => '

Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.

', ], ], 'EvaluationResults' => [ 'base' => NULL, 'refs' => [ 'GetComplianceDetailsByConfigRuleResponse$EvaluationResults' => '

Indicates whether the Amazon Web Services resource complies with the specified Config rule.

', 'GetComplianceDetailsByResourceResponse$EvaluationResults' => '

Indicates whether the specified Amazon Web Services resource complies each Config rule.

', ], ], 'EvaluationStatus' => [ 'base' => '

Returns status details of an evaluation.

', 'refs' => [ 'GetResourceEvaluationSummaryResponse$EvaluationStatus' => '

Returns an EvaluationStatus object.

', ], ], 'EvaluationTimeout' => [ 'base' => NULL, 'refs' => [ 'StartResourceEvaluationRequest$EvaluationTimeout' => '

The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.

', ], ], 'Evaluations' => [ 'base' => NULL, 'refs' => [ 'PutEvaluationsRequest$Evaluations' => '

The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function.

', 'PutEvaluationsResponse$FailedEvaluations' => '

Requests that failed because of a client or server error.

', ], ], 'EventSource' => [ 'base' => NULL, 'refs' => [ 'SourceDetail$EventSource' => '

The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.

', ], ], 'ExcludedAccounts' => [ 'base' => NULL, 'refs' => [ 'OrganizationConfigRule$ExcludedAccounts' => '

A comma-separated list of accounts excluded from organization Config rule.

', 'OrganizationConformancePack$ExcludedAccounts' => '

A comma-separated list of accounts excluded from organization conformance pack.

', 'PutOrganizationConfigRuleRequest$ExcludedAccounts' => '

A comma-separated list of accounts that you want to exclude from an organization Config rule.

', 'PutOrganizationConformancePackRequest$ExcludedAccounts' => '

A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.

', ], ], 'ExclusionByResourceTypes' => [ 'base' => '

Specifies whether the configuration recorder excludes certain resource types from being recorded. Use the resourceTypes field to enter a comma-separated list of resource types you want to exclude from recording.

By default, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.

How to use the exclusion recording strategy

To use this option, you must set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES.

Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded.

Global resource types and the exclusion recording strategy

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

', 'refs' => [ 'RecordingGroup$exclusionByResourceTypes' => '

An object that specifies how Config excludes resource types from being recorded by the configuration recorder.

Required fields

To use this option, you must set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES.

', ], ], 'ExecutionControls' => [ 'base' => '

The controls that Config uses for executing remediations.

', 'refs' => [ 'RemediationConfiguration$ExecutionControls' => '

An ExecutionControls object.

', ], ], 'Expression' => [ 'base' => NULL, 'refs' => [ 'SelectAggregateResourceConfigRequest$Expression' => '

The SQL query SELECT command.

', 'SelectResourceConfigRequest$Expression' => '

The SQL query SELECT command.

', ], ], 'ExternalEvaluation' => [ 'base' => '

Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.

', 'refs' => [ 'PutExternalEvaluationRequest$ExternalEvaluation' => '

An ExternalEvaluation object that provides details about compliance.

', ], ], 'FailedDeleteRemediationExceptionsBatch' => [ 'base' => '

List of each of the failed delete remediation exceptions with specific reasons.

', 'refs' => [ 'FailedDeleteRemediationExceptionsBatches$member' => NULL, ], ], 'FailedDeleteRemediationExceptionsBatches' => [ 'base' => NULL, 'refs' => [ 'DeleteRemediationExceptionsResponse$FailedBatches' => '

Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

', ], ], 'FailedRemediationBatch' => [ 'base' => '

List of each of the failed remediations with specific reasons.

', 'refs' => [ 'FailedRemediationBatches$member' => NULL, ], ], 'FailedRemediationBatches' => [ 'base' => NULL, 'refs' => [ 'PutRemediationConfigurationsResponse$FailedBatches' => '

Returns a list of failed remediation batch objects.

', ], ], 'FailedRemediationExceptionBatch' => [ 'base' => '

List of each of the failed remediation exceptions with specific reasons.

', 'refs' => [ 'FailedRemediationExceptionBatches$member' => NULL, ], ], 'FailedRemediationExceptionBatches' => [ 'base' => NULL, 'refs' => [ 'PutRemediationExceptionsResponse$FailedBatches' => '

Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

', ], ], 'FieldInfo' => [ 'base' => '

Details about the fields such as name of the field.

', 'refs' => [ 'FieldInfoList$member' => NULL, ], ], 'FieldInfoList' => [ 'base' => NULL, 'refs' => [ 'QueryInfo$SelectFields' => '

Returns a FieldInfo object.

', ], ], 'FieldName' => [ 'base' => NULL, 'refs' => [ 'FieldInfo$Name' => '

Name of the field.

', ], ], 'GetAggregateComplianceDetailsByConfigRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateComplianceDetailsByConfigRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateConfigRuleComplianceSummaryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateConfigRuleComplianceSummaryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateConformancePackComplianceSummaryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateConformancePackComplianceSummaryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateDiscoveredResourceCountsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateDiscoveredResourceCountsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateResourceConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetComplianceDetailsByConfigRuleRequest' => [ 'base' => '

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

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

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

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

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

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

', 'refs' => [], ], 'GetConformancePackComplianceDetailsLimit' => [ 'base' => NULL, 'refs' => [ 'GetConformancePackComplianceDetailsRequest$Limit' => '

The maximum number of evaluation results returned on each page. If you do no specify a number, Config uses the default. The default is 100.

', ], ], 'GetConformancePackComplianceDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConformancePackComplianceDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConformancePackComplianceSummaryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConformancePackComplianceSummaryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomRulePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomRulePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDiscoveredResourceCountsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDiscoveredResourceCountsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationConfigRuleDetailedStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationConfigRuleDetailedStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationConformancePackDetailedStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationConformancePackDetailedStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationCustomRulePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationCustomRulePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceConfigHistoryRequest' => [ 'base' => '

The input for the GetResourceConfigHistory action.

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

The output for the GetResourceConfigHistory action.

', 'refs' => [], ], 'GetResourceEvaluationSummaryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceEvaluationSummaryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetStoredQueryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStoredQueryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GroupByAPILimit' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregateComplianceByConfigRulesRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'GetAggregateConfigRuleComplianceSummaryRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

', 'GetAggregateDiscoveredResourceCountsRequest$Limit' => '

The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

', ], ], 'GroupedResourceCount' => [ 'base' => '

The count of resources that are grouped by the group name.

', 'refs' => [ 'GroupedResourceCountList$member' => NULL, ], ], 'GroupedResourceCountList' => [ 'base' => NULL, 'refs' => [ 'GetAggregateDiscoveredResourceCountsResponse$GroupedResourceCounts' => '

Returns a list of GroupedResourceCount objects.

', ], ], 'IdempotentParameterMismatch' => [ 'base' => '

Using the same client token with one or more different parameters. Specify a new client token with the parameter changes and try again.

', 'refs' => [], ], 'IncludeGlobalResourceTypes' => [ 'base' => NULL, 'refs' => [ 'RecordingGroup$includeGlobalResourceTypes' => '

This option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded by Config in Regions where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

Aurora global clusters are recorded in all enabled Regions

The AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if includeGlobalResourceTypes is not set to true. The includeGlobalResourceTypes option is a bundle which only applies to IAM users, groups, roles, and customer managed policies.

If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, use one of the following recording strategies:

  1. Record all current and future resource types with exclusions (EXCLUSION_BY_RESOURCE_TYPES), or

  2. Record specific resource types (INCLUSION_BY_RESOURCE_TYPES).

For more information, see Selecting Which Resources are Recorded in the Config developer guide.

Before you set this field to true, set the allSupported field of RecordingGroup to true. Optionally, you can set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES.

Overriding fields

If you set this field to false but list global IAM resource types in the resourceTypes field of RecordingGroup, Config will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.

If you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the resourceTypes field in addition to setting the includeGlobalResourceTypes field to false.

', ], ], 'InsufficientDeliveryPolicyException' => [ 'base' => '

Your Amazon S3 bucket policy does not permit Config to write to it.

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

Indicates one of the following errors:

', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'AggregateConformancePackCompliance$CompliantRuleCount' => '

The number of compliant Config Rules.

', 'AggregateConformancePackCompliance$NonCompliantRuleCount' => '

The number of noncompliant Config Rules.

', 'AggregateConformancePackCompliance$TotalRuleCount' => '

Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.

', 'AggregateConformancePackComplianceCount$CompliantConformancePackCount' => '

Number of compliant conformance packs.

', 'AggregateConformancePackComplianceCount$NonCompliantConformancePackCount' => '

Number of noncompliant conformance packs.

', 'ComplianceContributorCount$CappedCount' => '

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

', ], ], 'InvalidConfigurationRecorderNameException' => [ 'base' => '

You have provided a name for the configuration recorder that is not valid.

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

The specified delivery channel name is not valid.

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

The syntax of the query is incorrect.

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

The specified limit is outside the allowable range.

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

The specified next token is not valid. Specify the nextToken string that was returned in the previous response to get the next page of results.

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

One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.

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

Indicates one of the following errors:

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

The specified ResultToken is not valid.

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

You have provided a null or empty Amazon Resource Name (ARN) for the IAM role assumed by Config and used by the configuration recorder.

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

The specified Amazon S3 key prefix is not valid.

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

The specified Amazon KMS Key ARN is not valid.

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

The specified Amazon SNS topic does not exist.

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

The specified time range is not valid. The earlier time is not chronologically before the later time.

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

You cannot delete the delivery channel you specified because the configuration recorder is running.

', 'refs' => [], ], 'LastUpdatedTime' => [ 'base' => NULL, 'refs' => [ 'ConformancePackComplianceScore$LastUpdatedTime' => '

The time that the conformance pack compliance score was last updated.

', ], ], 'LaterTime' => [ 'base' => NULL, 'refs' => [ 'GetResourceConfigHistoryRequest$laterTime' => '

The chronologically latest time in the time range for which the history requested. If not specified, current time is taken.

', ], ], 'Limit' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregateComplianceByConformancePacksRequest$Limit' => '

The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'DescribeAggregationAuthorizationsRequest$Limit' => '

The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'DescribeComplianceByResourceRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'DescribeConfigurationAggregatorSourcesStatusRequest$Limit' => '

The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'DescribeConfigurationAggregatorsRequest$Limit' => '

The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'DescribeRemediationExceptionsRequest$Limit' => '

The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default.

', 'DescribeRemediationExecutionStatusRequest$Limit' => '

The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'GetAggregateConformancePackComplianceSummaryRequest$Limit' => '

The maximum number of results returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'GetComplianceDetailsByConfigRuleRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'GetDiscoveredResourceCountsRequest$limit' => '

The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'GetResourceConfigHistoryRequest$limit' => '

The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'ListAggregateDiscoveredResourcesRequest$Limit' => '

The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'ListDiscoveredResourcesRequest$limit' => '

The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'ListStoredQueriesRequest$MaxResults' => '

The maximum number of results to be returned with a single call.

', 'ListTagsForResourceRequest$Limit' => '

The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, Config uses the default.

', 'SelectAggregateResourceConfigRequest$Limit' => '

The maximum number of query results returned on each page.

', 'SelectAggregateResourceConfigRequest$MaxResults' => '

The maximum number of query results returned on each page. Config also allows the Limit request parameter.

', 'SelectResourceConfigRequest$Limit' => '

The maximum number of query results returned on each page.

', ], ], 'LimitExceededException' => [ 'base' => '

For StartConfigRulesEvaluation API, this exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.

For PutConfigurationAggregator API, this exception is thrown if the number of accounts and aggregators exceeds the limit.

', 'refs' => [], ], 'ListAggregateDiscoveredResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAggregateDiscoveredResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListConformancePackComplianceScoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConformancePackComplianceScoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDiscoveredResourcesRequest' => [ 'base' => '

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

', 'refs' => [], ], 'ListResourceEvaluationsPageItemLimit' => [ 'base' => NULL, 'refs' => [ 'ListResourceEvaluationsRequest$Limit' => '

The maximum number of evaluations returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', ], ], 'ListResourceEvaluationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceEvaluationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStoredQueriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStoredQueriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'GetAggregateDiscoveredResourceCountsResponse$TotalDiscoveredResources' => '

The total number of resources that are present in an aggregator with the filters that you provide.

', 'GetDiscoveredResourceCountsResponse$totalDiscoveredResources' => '

The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.

Example

  1. Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.

  2. You make a call to the GetDiscoveredResourceCounts action and specify the resource type, "AWS::EC2::Instances", in the request.

  3. Config returns 25 for totalDiscoveredResources.

', 'GroupedResourceCount$ResourceCount' => '

The number of resources in the group.

', 'ResourceCount$count' => '

The number of resources.

', ], ], 'MaxActiveResourcesExceededException' => [ 'base' => '

You have reached the limit of active custom resource types in your account. There is a limit of 100,000. Delete unused resources using DeleteResourceConfig .

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

Failed to add the Config rule because the account already contains the maximum number of 150 rules. Consider deleting any deactivated rules before you add new rules.

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

You have reached the limit of the number of configuration recorders you can create.

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

You have reached the limit of the number of conformance packs you can create in an account. For more information, see Service Limits in the Config Developer Guide.

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

You have reached the limit of the number of delivery channels you can create.

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

You have reached the limit of the number of organization Config rules you can create. For more information, see see Service Limits in the Config Developer Guide.

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

You have reached the limit of the number of organization conformance packs you can create in an account. For more information, see Service Limits in the Config Developer Guide.

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

Failed to add the retention configuration because a retention configuration with that name already exists.

', 'refs' => [], ], 'MaximumExecutionFrequency' => [ 'base' => NULL, 'refs' => [ 'ConfigRule$MaximumExecutionFrequency' => '

The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

', 'ConfigSnapshotDeliveryProperties$deliveryFrequency' => '

The frequency with which Config delivers configuration snapshots.

', 'OrganizationCustomPolicyRuleMetadata$MaximumExecutionFrequency' => '

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$MaximumExecutionFrequency' => '

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

', 'OrganizationCustomRuleMetadata$MaximumExecutionFrequency' => '

The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

', 'OrganizationManagedRuleMetadata$MaximumExecutionFrequency' => '

The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

', 'SourceDetail$MaximumExecutionFrequency' => '

The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

', ], ], 'MemberAccountRuleStatus' => [ 'base' => NULL, 'refs' => [ 'MemberAccountStatus$MemberAccountRuleStatus' => '

Indicates deployment status for Config rule in the member account. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the management account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

', 'StatusDetailFilters$MemberAccountRuleStatus' => '

Indicates deployment status for Config rule in the member account. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the management account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

', ], ], 'MemberAccountStatus' => [ 'base' => '

Organization Config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.

', 'refs' => [ 'OrganizationConfigRuleDetailedStatus$member' => NULL, ], ], 'MessageType' => [ 'base' => NULL, 'refs' => [ 'SourceDetail$MessageType' => '

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'Tags$key' => NULL, ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregateComplianceByConfigRulesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeAggregateComplianceByConfigRulesResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeAggregateComplianceByConformancePacksRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeAggregateComplianceByConformancePacksResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeComplianceByResourceRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeComplianceByResourceResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'DescribeConformancePackComplianceRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeConformancePackComplianceResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeConformancePackStatusRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeConformancePackStatusResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeConformancePacksRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeConformancePacksResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeRetentionConfigurationsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeRetentionConfigurationsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateComplianceDetailsByConfigRuleResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateConfigRuleComplianceSummaryRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateConfigRuleComplianceSummaryResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateConformancePackComplianceSummaryRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateConformancePackComplianceSummaryResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateDiscoveredResourceCountsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateDiscoveredResourceCountsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetComplianceDetailsByConfigRuleRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetComplianceDetailsByConfigRuleResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'GetConformancePackComplianceDetailsRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'GetConformancePackComplianceDetailsResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'GetConformancePackComplianceSummaryRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetConformancePackComplianceSummaryResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetDiscoveredResourceCountsRequest$nextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetDiscoveredResourceCountsResponse$nextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'GetResourceConfigHistoryRequest$nextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetResourceConfigHistoryResponse$nextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'ListAggregateDiscoveredResourcesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListAggregateDiscoveredResourcesResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListConformancePackComplianceScoresRequest$NextToken' => '

The nextToken string in a prior request that you can use to get the paginated response for the next set of conformance pack compliance scores.

', 'ListConformancePackComplianceScoresResponse$NextToken' => '

The nextToken string that you can use to get the next page of results in a paginated response.

', 'ListDiscoveredResourcesRequest$nextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListDiscoveredResourcesResponse$nextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'ListTagsForResourceRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListTagsForResourceResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'SelectAggregateResourceConfigRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'SelectAggregateResourceConfigResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'SelectResourceConfigRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'SelectResourceConfigResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', ], ], 'NoAvailableConfigurationRecorderException' => [ 'base' => '

There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

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

There is no delivery channel available to record configurations.

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

Organization is no longer available.

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

There is no configuration recorder running.

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

The specified Amazon S3 bucket does not exist.

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

The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

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

Config rule that you passed in the filter does not exist.

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

You have specified a configuration aggregator that does not exist.

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

You have specified a configuration recorder that does not exist.

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

You specified one or more conformance packs that do not exist.

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

You have specified a delivery channel that does not exist.

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

The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

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

Config organization conformance pack that you passed in the filter does not exist.

For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.

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

You specified an Config rule without a remediation configuration.

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

You tried to delete a remediation exception that does not exist.

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

You have specified a retention configuration that does not exist.

', 'refs' => [], ], 'OrderingTimestamp' => [ 'base' => NULL, 'refs' => [ 'Evaluation$OrderingTimestamp' => '

The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

', 'ExternalEvaluation$OrderingTimestamp' => '

The time when the compliance was recorded.

', ], ], 'OrganizationAccessDeniedException' => [ 'base' => '

For PutConfigurationAggregator API, you can see this exception for the following reasons:

For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.

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

This object contains regions to set up the aggregator and an IAM role to retrieve organization details.

', 'refs' => [ 'ConfigurationAggregator$OrganizationAggregationSource' => '

Provides an organization and list of regions to be aggregated.

', 'PutConfigurationAggregatorRequest$OrganizationAggregationSource' => '

An OrganizationAggregationSource object.

', ], ], 'OrganizationAllFeaturesNotEnabledException' => [ 'base' => '

Config resource cannot be created because your organization does not have all features enabled.

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

An organization Config rule that has information about Config rules that Config creates in member accounts.

', 'refs' => [ 'OrganizationConfigRules$member' => NULL, ], ], 'OrganizationConfigRuleDetailedStatus' => [ 'base' => NULL, 'refs' => [ 'GetOrganizationConfigRuleDetailedStatusResponse$OrganizationConfigRuleDetailedStatus' => '

A list of MemberAccountStatus objects.

', ], ], 'OrganizationConfigRuleName' => [ 'base' => NULL, 'refs' => [ 'DeleteOrganizationConfigRuleRequest$OrganizationConfigRuleName' => '

The name of organization Config rule that you want to delete.

', 'GetOrganizationConfigRuleDetailedStatusRequest$OrganizationConfigRuleName' => '

The name of your organization Config rule for which you want status details for member accounts.

', 'GetOrganizationCustomRulePolicyRequest$OrganizationConfigRuleName' => '

The name of your organization Config Custom Policy rule.

', 'OrganizationConfigRule$OrganizationConfigRuleName' => '

The name that you assign to organization Config rule.

', 'OrganizationConfigRuleStatus$OrganizationConfigRuleName' => '

The name that you assign to organization Config rule.

', 'PutOrganizationConfigRuleRequest$OrganizationConfigRuleName' => '

The name that you assign to an organization Config rule.

', ], ], 'OrganizationConfigRuleNames' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConfigRuleStatusesRequest$OrganizationConfigRuleNames' => '

The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.

', 'DescribeOrganizationConfigRulesRequest$OrganizationConfigRuleNames' => '

The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.

', ], ], 'OrganizationConfigRuleStatus' => [ 'base' => '

Returns the status for an organization Config rule in an organization.

', 'refs' => [ 'OrganizationConfigRuleStatuses$member' => NULL, ], ], 'OrganizationConfigRuleStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConfigRuleStatusesResponse$OrganizationConfigRuleStatuses' => '

A list of OrganizationConfigRuleStatus objects.

', ], ], 'OrganizationConfigRuleTriggerType' => [ 'base' => NULL, 'refs' => [ 'OrganizationConfigRuleTriggerTypes$member' => NULL, ], ], 'OrganizationConfigRuleTriggerTypeNoSN' => [ 'base' => NULL, 'refs' => [ 'OrganizationConfigRuleTriggerTypeNoSNs$member' => NULL, ], ], 'OrganizationConfigRuleTriggerTypeNoSNs' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$OrganizationConfigRuleTriggerTypes' => '

The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$OrganizationConfigRuleTriggerTypes' => '

The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered notification types:

', ], ], 'OrganizationConfigRuleTriggerTypes' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomRuleMetadata$OrganizationConfigRuleTriggerTypes' => '

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

', ], ], 'OrganizationConfigRules' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConfigRulesResponse$OrganizationConfigRules' => '

Returns a list of OrganizationConfigRule objects.

', ], ], 'OrganizationConformancePack' => [ 'base' => '

An organization conformance pack that has information about conformance packs that Config creates in member accounts.

', 'refs' => [ 'OrganizationConformancePacks$member' => NULL, ], ], 'OrganizationConformancePackDetailedStatus' => [ 'base' => '

Organization conformance pack creation or deletion status in each member account. This includes the name of the conformance pack, the status, error code and error message when the conformance pack creation or deletion failed.

', 'refs' => [ 'OrganizationConformancePackDetailedStatuses$member' => NULL, ], ], 'OrganizationConformancePackDetailedStatuses' => [ 'base' => NULL, 'refs' => [ 'GetOrganizationConformancePackDetailedStatusResponse$OrganizationConformancePackDetailedStatuses' => '

A list of OrganizationConformancePackDetailedStatus objects.

', ], ], 'OrganizationConformancePackName' => [ 'base' => NULL, 'refs' => [ 'DeleteOrganizationConformancePackRequest$OrganizationConformancePackName' => '

The name of organization conformance pack that you want to delete.

', 'GetOrganizationConformancePackDetailedStatusRequest$OrganizationConformancePackName' => '

The name of organization conformance pack for which you want status details for member accounts.

', 'OrganizationConformancePack$OrganizationConformancePackName' => '

The name you assign to an organization conformance pack.

', 'OrganizationConformancePackNames$member' => NULL, 'OrganizationConformancePackStatus$OrganizationConformancePackName' => '

The name that you assign to organization conformance pack.

', 'PutOrganizationConformancePackRequest$OrganizationConformancePackName' => '

Name of the organization conformance pack you want to create.

', ], ], 'OrganizationConformancePackNames' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConformancePackStatusesRequest$OrganizationConformancePackNames' => '

The names of organization conformance packs for which you want status details. If you do not specify any names, Config returns details for all your organization conformance packs.

', 'DescribeOrganizationConformancePacksRequest$OrganizationConformancePackNames' => '

The name that you assign to an organization conformance pack.

', ], ], 'OrganizationConformancePackStatus' => [ 'base' => '

Returns the status for an organization conformance pack in an organization.

', 'refs' => [ 'OrganizationConformancePackStatuses$member' => NULL, ], ], 'OrganizationConformancePackStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConformancePackStatusesResponse$OrganizationConformancePackStatuses' => '

A list of OrganizationConformancePackStatus objects.

', ], ], 'OrganizationConformancePackTemplateValidationException' => [ 'base' => '

You have specified a template that is not valid or supported.

', 'refs' => [], ], 'OrganizationConformancePacks' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConformancePacksResponse$OrganizationConformancePacks' => '

Returns a list of OrganizationConformancePacks objects.

', ], ], 'OrganizationCustomPolicyRuleMetadata' => [ 'base' => '

An object that specifies metadata for your organization\'s Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

', 'refs' => [ 'PutOrganizationConfigRuleRequest$OrganizationCustomPolicyRuleMetadata' => '

An OrganizationCustomPolicyRuleMetadata object. This object specifies metadata for your organization\'s Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

', ], ], 'OrganizationCustomPolicyRuleMetadataNoPolicy' => [ 'base' => '

metadata for your organization Config Custom Policy rule including the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that trigger Config to evaluate Amazon Web Services resources against a rule.

', 'refs' => [ 'OrganizationConfigRule$OrganizationCustomPolicyRuleMetadata' => '

An object that specifies metadata for your organization\'s Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

', ], ], 'OrganizationCustomRuleMetadata' => [ 'base' => '

An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

', 'refs' => [ 'OrganizationConfigRule$OrganizationCustomRuleMetadata' => '

An OrganizationCustomRuleMetadata object.

', 'PutOrganizationConfigRuleRequest$OrganizationCustomRuleMetadata' => '

An OrganizationCustomRuleMetadata object. This object specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

', ], ], 'OrganizationManagedRuleMetadata' => [ 'base' => '

An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

', 'refs' => [ 'OrganizationConfigRule$OrganizationManagedRuleMetadata' => '

An OrganizationManagedRuleMetadata object.

', 'PutOrganizationConfigRuleRequest$OrganizationManagedRuleMetadata' => '

An OrganizationManagedRuleMetadata object. This object specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

', ], ], 'OrganizationResourceDetailedStatus' => [ 'base' => NULL, 'refs' => [ 'OrganizationConformancePackDetailedStatus$Status' => '

Indicates deployment status for conformance pack in a member account. When management account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When management account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the management account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

', 'OrganizationResourceDetailedStatusFilters$Status' => '

Indicates deployment status for conformance pack in a member account. When management account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When management account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the management account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

', ], ], 'OrganizationResourceDetailedStatusFilters' => [ 'base' => '

Status filter object to filter results based on specific member account ID or status type for an organization conformance pack.

', 'refs' => [ 'GetOrganizationConformancePackDetailedStatusRequest$Filters' => '

An OrganizationResourceDetailedStatusFilters object.

', ], ], 'OrganizationResourceStatus' => [ 'base' => NULL, 'refs' => [ 'OrganizationConformancePackStatus$Status' => '

Indicates deployment status of an organization conformance pack. When management account calls PutOrganizationConformancePack for the first time, conformance pack status is created in all the member accounts. When management account calls PutOrganizationConformancePack for the second time, conformance pack status is updated in all the member accounts. Additionally, conformance pack status is updated when one or more member accounts join or leave an organization. Conformance pack status is deleted when the management account deletes OrganizationConformancePack in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

', ], ], 'OrganizationRuleStatus' => [ 'base' => NULL, 'refs' => [ 'OrganizationConfigRuleStatus$OrganizationRuleStatus' => '

Indicates deployment status of an organization Config rule. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the management account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

', ], ], 'OversizedConfigurationItemException' => [ 'base' => '

The configuration item size is outside the allowable range.

', 'refs' => [], ], 'Owner' => [ 'base' => NULL, 'refs' => [ 'Source$Owner' => '

Indicates whether Amazon Web Services or the customer owns and manages the Config rule.

Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see Config Managed Rules in the Config developer guide.

Config Custom Rules are rules that you can develop either with Guard (CUSTOM_POLICY) or Lambda (CUSTOM_LAMBDA). For more information, see Config Custom Rules in the Config developer guide.

', ], ], 'PageSizeLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePackStatusRequest$Limit' => '

The maximum number of conformance packs status returned on each page.

', 'DescribeConformancePacksRequest$Limit' => '

The maximum number of conformance packs returned on each page.

', 'GetConformancePackComplianceSummaryRequest$Limit' => '

The maximum number of conformance packs returned on each page.

', 'ListConformancePackComplianceScoresRequest$Limit' => '

The maximum number of conformance pack compliance scores returned on each page.

', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'ConformancePackInputParameter$ParameterName' => '

One part of a key-value pair.

', ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'ConformancePackInputParameter$ParameterValue' => '

Another part of the key-value pair.

', ], ], 'PendingAggregationRequest' => [ 'base' => '

An object that represents the account ID and region of an aggregator account that is requesting authorization but is not yet authorized.

', 'refs' => [ 'PendingAggregationRequestList$member' => NULL, ], ], 'PendingAggregationRequestList' => [ 'base' => NULL, 'refs' => [ 'DescribePendingAggregationRequestsResponse$PendingAggregationRequests' => '

Returns a PendingAggregationRequests object.

', ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'SsmControls$ConcurrentExecutionRatePercentage' => '

The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.

', 'SsmControls$ErrorPercentage' => '

The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.

', ], ], 'PolicyRuntime' => [ 'base' => NULL, 'refs' => [ 'CustomPolicyDetails$PolicyRuntime' => '

The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

', 'OrganizationCustomPolicyRuleMetadata$PolicyRuntime' => '

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$PolicyRuntime' => '

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

', ], ], 'PolicyText' => [ 'base' => NULL, 'refs' => [ 'CustomPolicyDetails$PolicyText' => '

The policy definition containing the logic for your Config Custom Policy rule.

', 'GetCustomRulePolicyResponse$PolicyText' => '

The policy definition containing the logic for your Config Custom Policy rule.

', 'GetOrganizationCustomRulePolicyResponse$PolicyText' => '

The policy definition containing the logic for your organization Config Custom Policy rule.

', 'OrganizationCustomPolicyRuleMetadata$PolicyText' => '

The policy definition containing the logic for your organization Config Custom Policy rule.

', ], ], 'PutAggregationAuthorizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAggregationAuthorizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutConfigRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutConfigurationAggregatorRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutConfigurationAggregatorResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutConfigurationRecorderRequest' => [ 'base' => '

The input for the PutConfigurationRecorder action.

', 'refs' => [], ], 'PutConformancePackRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutConformancePackResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutDeliveryChannelRequest' => [ 'base' => '

The input for the PutDeliveryChannel action.

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

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

', 'refs' => [], ], 'PutExternalEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutExternalEvaluationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutOrganizationConfigRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutOrganizationConfigRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutOrganizationConformancePackRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutOrganizationConformancePackResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutRemediationConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRemediationConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutRemediationExceptionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRemediationExceptionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRetentionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRetentionConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutStoredQueryRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutStoredQueryResponse' => [ 'base' => NULL, 'refs' => [], ], 'QueryArn' => [ 'base' => NULL, 'refs' => [ 'PutStoredQueryResponse$QueryArn' => '

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

', 'StoredQuery$QueryArn' => '

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

', 'StoredQueryMetadata$QueryArn' => '

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

', ], ], 'QueryDescription' => [ 'base' => NULL, 'refs' => [ 'StoredQuery$Description' => '

A unique description for the query.

', 'StoredQueryMetadata$Description' => '

A unique description for the query.

', ], ], 'QueryExpression' => [ 'base' => NULL, 'refs' => [ 'StoredQuery$Expression' => '

The expression of the query. For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = \'AWS::S3::Bucket\' AND supplementaryConfiguration.BucketVersioningConfiguration.status = \'Off\'.

', ], ], 'QueryId' => [ 'base' => NULL, 'refs' => [ 'StoredQuery$QueryId' => '

The ID of the query.

', 'StoredQueryMetadata$QueryId' => '

The ID of the query.

', ], ], 'QueryInfo' => [ 'base' => '

Details about the query.

', 'refs' => [ 'SelectAggregateResourceConfigResponse$QueryInfo' => NULL, 'SelectResourceConfigResponse$QueryInfo' => '

Returns the QueryInfo object.

', ], ], 'QueryName' => [ 'base' => NULL, 'refs' => [ 'DeleteStoredQueryRequest$QueryName' => '

The name of the query that you want to delete.

', 'GetStoredQueryRequest$QueryName' => '

The name of the query.

', 'StoredQuery$QueryName' => '

The name of the query.

', 'StoredQueryMetadata$QueryName' => '

The name of the query.

', ], ], 'RecorderName' => [ 'base' => NULL, 'refs' => [ 'ConfigurationRecorder$name' => '

The name of the configuration recorder. Config automatically assigns the name of "default" when creating the configuration recorder.

You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name.

', 'ConfigurationRecorderNameList$member' => NULL, 'DeleteConfigurationRecorderRequest$ConfigurationRecorderName' => '

The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action.

', 'StartConfigurationRecorderRequest$ConfigurationRecorderName' => '

The name of the recorder object that records each configuration change made to the resources.

', 'StopConfigurationRecorderRequest$ConfigurationRecorderName' => '

The name of the recorder object that records each configuration change made to the resources.

', ], ], 'RecorderStatus' => [ 'base' => NULL, 'refs' => [ 'ConfigurationRecorderStatus$lastStatus' => '

The status of the latest recording event processed by the recorder.

', ], ], 'RecordingFrequency' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$recordingFrequency' => '

The recording frequency that Config uses to record configuration changes for the resource.

', 'ConfigurationItem$recordingFrequency' => '

The recording frequency that Config uses to record configuration changes for the resource.

', 'RecordingMode$recordingFrequency' => '

The default recording frequency that Config uses to record configuration changes.

Daily recording is not supported for the following resource types:

  • AWS::Config::ResourceCompliance

  • AWS::Config::ConformancePackCompliance

  • AWS::Config::ConfigurationRecorder

For the allSupported (ALL_SUPPORTED_RESOURCE_TYPES) recording strategy, these resource types will be set to Continuous recording.

', 'RecordingModeOverride$recordingFrequency' => '

The recording frequency that will be applied to all the resource types specified in the override.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

', ], ], 'RecordingGroup' => [ 'base' => '

Specifies which resource types Config records for configuration changes. By default, Config records configuration changes for all current and future supported resource types in the Amazon Web Services Region where you have enabled Config, excluding the global IAM resource types: IAM users, groups, roles, and customer managed policies.

In the recording group, you specify whether you want to record all supported current and future supported resource types or to include or exclude specific resources types. For a list of supported resource types, see Supported Resource Types in the Config developer guide.

If you don\'t want Config to record all current and future supported resource types (excluding the global IAM resource types), use one of the following recording strategies:

  1. Record all current and future resource types with exclusions (EXCLUSION_BY_RESOURCE_TYPES), or

  2. Record specific resource types (INCLUSION_BY_RESOURCE_TYPES).

If you use the recording strategy to Record all current and future resource types (ALL_SUPPORTED_RESOURCE_TYPES), you can use the flag includeGlobalResourceTypes to include the global IAM resource types in your recording.

Aurora global clusters are recorded in all enabled Regions

The AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled.

If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, use the EXCLUSION_BY_RESOURCE_TYPES or INCLUSION_BY_RESOURCE_TYPES recording strategy.

', 'refs' => [ 'ConfigurationRecorder$recordingGroup' => '

Specifies which resource types Config records for configuration changes.

High Number of Config Evaluations

You may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.

If you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An ephemeral workload is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.

', ], ], 'RecordingMode' => [ 'base' => '

Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

', 'refs' => [ 'ConfigurationRecorder$recordingMode' => '

Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

', ], ], 'RecordingModeOverride' => [ 'base' => '

An object for you to specify your overrides for the recording mode.

', 'refs' => [ 'RecordingModeOverrides$member' => NULL, ], ], 'RecordingModeOverrides' => [ 'base' => NULL, 'refs' => [ 'RecordingMode$recordingModeOverrides' => '

An array of recordingModeOverride objects for you to specify your overrides for the recording mode. The recordingModeOverride object in the recordingModeOverrides array consists of three fields: a description, the new recordingFrequency, and an array of resourceTypes to override.

', ], ], 'RecordingModeResourceTypesList' => [ 'base' => NULL, 'refs' => [ 'RecordingModeOverride$resourceTypes' => '

A comma-separated list that specifies which resource types Config includes in the override.

Daily recording is not supported for the following resource types:

  • AWS::Config::ResourceCompliance

  • AWS::Config::ConformancePackCompliance

  • AWS::Config::ConfigurationRecorder

', ], ], 'RecordingStrategy' => [ 'base' => '

Specifies the recording strategy of the configuration recorder.

', 'refs' => [ 'RecordingGroup$recordingStrategy' => '

An object that specifies the recording strategy for the configuration recorder.

Required and optional fields

The recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true.

The recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

Overriding fields

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

Global resources types and the resource exclusion recording strategy

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

  • Asia Pacific (Hyderabad)

  • Asia Pacific (Melbourne)

  • Europe (Spain)

  • Europe (Zurich)

  • Israel (Tel Aviv)

  • Middle East (UAE)

', ], ], 'RecordingStrategyType' => [ 'base' => NULL, 'refs' => [ 'RecordingStrategy$useOnly' => '

The recording strategy for the configuration recorder.

Required and optional fields

The recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true.

The recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

Overriding fields

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

Global resource types and the exclusion recording strategy

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

  • Asia Pacific (Hyderabad)

  • Asia Pacific (Melbourne)

  • Europe (Spain)

  • Europe (Zurich)

  • Israel (Tel Aviv)

  • Middle East (UAE)

', ], ], 'ReevaluateConfigRuleNames' => [ 'base' => NULL, 'refs' => [ 'StartConfigRulesEvaluationRequest$ConfigRuleNames' => '

The list of names of Config rules that you want to run evaluations for.

', ], ], 'RelatedEvent' => [ 'base' => NULL, 'refs' => [ 'RelatedEventList$member' => NULL, ], ], 'RelatedEventList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationItem$relatedEvents' => '

A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

', ], ], 'Relationship' => [ 'base' => '

The relationship of the related resource to the main resource.

', 'refs' => [ 'RelationshipList$member' => NULL, ], ], 'RelationshipList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationItem$relationships' => '

A list of related Amazon Web Services resources.

', ], ], 'RelationshipName' => [ 'base' => NULL, 'refs' => [ 'Relationship$relationshipName' => '

The type of relationship with the related resource.

', ], ], 'RemediationConfiguration' => [ 'base' => '

An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

', 'refs' => [ 'RemediationConfigurations$member' => NULL, ], ], 'RemediationConfigurations' => [ 'base' => NULL, 'refs' => [ 'DescribeRemediationConfigurationsResponse$RemediationConfigurations' => '

Returns a remediation configuration object.

', 'FailedRemediationBatch$FailedItems' => '

Returns remediation configurations of the failed items.

', 'PutRemediationConfigurationsRequest$RemediationConfigurations' => '

A list of remediation configuration objects.

', ], ], 'RemediationException' => [ 'base' => '

An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type.

', 'refs' => [ 'RemediationExceptions$member' => NULL, ], ], 'RemediationExceptionResourceKey' => [ 'base' => '

The details that identify a resource within Config, including the resource type and resource ID.

', 'refs' => [ 'RemediationExceptionResourceKeys$member' => NULL, ], ], 'RemediationExceptionResourceKeys' => [ 'base' => NULL, 'refs' => [ 'DeleteRemediationExceptionsRequest$ResourceKeys' => '

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

', 'DescribeRemediationExceptionsRequest$ResourceKeys' => '

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

', 'FailedDeleteRemediationExceptionsBatch$FailedItems' => '

Returns remediation exception resource key object of the failed items.

', 'PutRemediationExceptionsRequest$ResourceKeys' => '

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

', ], ], 'RemediationExceptions' => [ 'base' => NULL, 'refs' => [ 'DescribeRemediationExceptionsResponse$RemediationExceptions' => '

Returns a list of remediation exception objects.

', 'FailedRemediationExceptionBatch$FailedItems' => '

Returns remediation exception resource key object of the failed items.

', ], ], 'RemediationExecutionState' => [ 'base' => NULL, 'refs' => [ 'RemediationExecutionStatus$State' => '

ENUM of the values.

', ], ], 'RemediationExecutionStatus' => [ 'base' => '

Provides details of the current status of the invoked remediation action for that resource.

', 'refs' => [ 'RemediationExecutionStatuses$member' => NULL, ], ], 'RemediationExecutionStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeRemediationExecutionStatusResponse$RemediationExecutionStatuses' => '

Returns a list of remediation execution statuses objects.

', ], ], 'RemediationExecutionStep' => [ 'base' => '

Name of the step from the SSM document.

', 'refs' => [ 'RemediationExecutionSteps$member' => NULL, ], ], 'RemediationExecutionStepState' => [ 'base' => NULL, 'refs' => [ 'RemediationExecutionStep$State' => '

The valid status of the step.

', ], ], 'RemediationExecutionSteps' => [ 'base' => NULL, 'refs' => [ 'RemediationExecutionStatus$StepDetails' => '

Details of every step.

', ], ], 'RemediationInProgressException' => [ 'base' => '

Remediation action is in progress. You can either cancel execution in Amazon Web Services Systems Manager or wait and try again later.

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

The value is either a dynamic (resource) value or a static value. You must select either a dynamic value or a static value.

', 'refs' => [ 'RemediationParameters$value' => NULL, ], ], 'RemediationParameters' => [ 'base' => NULL, 'refs' => [ 'RemediationConfiguration$Parameters' => '

An object of the RemediationParameterValue.

', ], ], 'RemediationTargetType' => [ 'base' => NULL, 'refs' => [ 'RemediationConfiguration$TargetType' => '

The type of the target. Target executes remediation. For example, SSM document.

', ], ], 'ResourceConcurrentModificationException' => [ 'base' => '

Two users are trying to modify the same query at the same time. Wait for a moment and try again.

', 'refs' => [], ], 'ResourceConfiguration' => [ 'base' => NULL, 'refs' => [ 'ResourceDetails$ResourceConfiguration' => '

The resource definition to be evaluated as per the resource configuration schema type.

', ], ], 'ResourceConfigurationSchemaType' => [ 'base' => NULL, 'refs' => [ 'ResourceDetails$ResourceConfigurationSchemaType' => '

The schema type of the resource configuration.

You can find the Resource type schema, or CFN_RESOURCE_SCHEMA, in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand: aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE.

For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.

', ], ], 'ResourceCount' => [ 'base' => '

An object that contains the resource type and the number of resources.

', 'refs' => [ 'ResourceCounts$member' => NULL, ], ], 'ResourceCountFilters' => [ 'base' => '

Filters the resource count based on account ID, region, and resource type.

', 'refs' => [ 'GetAggregateDiscoveredResourceCountsRequest$Filters' => '

Filters the results based on the ResourceCountFilters object.

', ], ], 'ResourceCountGroupKey' => [ 'base' => NULL, 'refs' => [ 'GetAggregateDiscoveredResourceCountsRequest$GroupByKey' => '

The key to group the resource counts.

', ], ], 'ResourceCounts' => [ 'base' => NULL, 'refs' => [ 'GetDiscoveredResourceCountsResponse$resourceCounts' => '

The list of ResourceCount objects. Each object is listed in descending order by the number of resources.

', ], ], 'ResourceCreationTime' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$resourceCreationTime' => '

The time stamp when the resource was created.

', 'ConfigurationItem$resourceCreationTime' => '

The time stamp when the resource was created.

', ], ], 'ResourceDeletionTime' => [ 'base' => NULL, 'refs' => [ 'ResourceIdentifier$resourceDeletionTime' => '

The time that the resource was deleted.

', ], ], 'ResourceDetails' => [ 'base' => '

Returns information about the resource being evaluated.

', 'refs' => [ 'GetResourceEvaluationSummaryResponse$ResourceDetails' => '

Returns a ResourceDetails object.

', 'StartResourceEvaluationRequest$ResourceDetails' => '

Returns a ResourceDetails object.

', ], ], 'ResourceEvaluation' => [ 'base' => '

Returns details of a resource evaluation.

', 'refs' => [ 'ResourceEvaluations$member' => NULL, ], ], 'ResourceEvaluationFilters' => [ 'base' => '

Returns details of a resource evaluation based on the selected filter.

', 'refs' => [ 'ListResourceEvaluationsRequest$Filters' => '

Returns a ResourceEvaluationFilters object.

', ], ], 'ResourceEvaluationId' => [ 'base' => NULL, 'refs' => [ 'EvaluationResultIdentifier$ResourceEvaluationId' => '

A Unique ID for an evaluation result.

', 'GetComplianceDetailsByResourceRequest$ResourceEvaluationId' => '

The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.

You need to only provide either a ResourceEvaluationID or a ResourceID and ResourceType.

', 'GetResourceEvaluationSummaryRequest$ResourceEvaluationId' => '

The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

', 'GetResourceEvaluationSummaryResponse$ResourceEvaluationId' => '

The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

', 'ResourceEvaluation$ResourceEvaluationId' => '

The ResourceEvaluationId of a evaluation.

', 'StartResourceEvaluationResponse$ResourceEvaluationId' => '

A unique ResourceEvaluationId that is associated with a single execution.

', ], ], 'ResourceEvaluationStatus' => [ 'base' => NULL, 'refs' => [ 'EvaluationStatus$Status' => '

The status of an execution. The valid values are In_Progress, Succeeded or Failed.

', ], ], 'ResourceEvaluations' => [ 'base' => NULL, 'refs' => [ 'ListResourceEvaluationsResponse$ResourceEvaluations' => '

Returns a ResourceEvaluations object.

', ], ], 'ResourceFilters' => [ 'base' => '

Filters the results by resource account ID, region, resource ID, and resource name.

', 'refs' => [ 'ListAggregateDiscoveredResourcesRequest$Filters' => '

Filters the results based on the ResourceFilters object.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AggregateResourceIdentifier$ResourceId' => '

The ID of the Amazon Web Services resource.

', 'BaseConfigurationItem$resourceId' => '

The ID of the resource (for example., sg-xxxxxx).

', 'ConfigurationItem$resourceId' => '

The ID of the resource (for example, sg-xxxxxx).

', 'DeleteResourceConfigRequest$ResourceId' => '

Unique identifier of the resource.

', 'GetResourceConfigHistoryRequest$resourceId' => '

The ID of the resource (for example., sg-xxxxxx).

', 'PutResourceConfigRequest$ResourceId' => '

Unique identifier of the resource.

', 'Relationship$resourceId' => '

The ID of the related resource (for example, sg-xxxxxx).

', 'ResourceFilters$ResourceId' => '

The ID of the resource.

', 'ResourceIdList$member' => NULL, 'ResourceIdentifier$resourceId' => '

The ID of the resource (for example, sg-xxxxxx).

', 'ResourceKey$resourceId' => '

The ID of the resource (for example., sg-xxxxxx).

', ], ], 'ResourceIdList' => [ 'base' => NULL, 'refs' => [ 'ListDiscoveredResourcesRequest$resourceIds' => '

The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered. You can list a minimum of 1 resourceID and a maximum of 20 resourceIds.

', ], ], 'ResourceIdentifier' => [ 'base' => '

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

', 'refs' => [ 'ResourceIdentifierList$member' => NULL, ], ], 'ResourceIdentifierList' => [ 'base' => NULL, 'refs' => [ 'ListDiscoveredResourcesResponse$resourceIdentifiers' => '

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

', ], ], 'ResourceIdentifiersList' => [ 'base' => NULL, 'refs' => [ 'BatchGetAggregateResourceConfigRequest$ResourceIdentifiers' => '

A list of aggregate ResourceIdentifiers objects.

', ], ], 'ResourceInUseException' => [ 'base' => '

You see this exception in the following cases:

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

The details that identify a resource within Config, including the resource type and resource ID.

', 'refs' => [ 'RemediationExecutionStatus$ResourceKey' => NULL, 'ResourceKeys$member' => NULL, ], ], 'ResourceKeys' => [ 'base' => NULL, 'refs' => [ 'BatchGetResourceConfigRequest$resourceKeys' => '

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

', 'BatchGetResourceConfigResponse$unprocessedResourceKeys' => '

A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys list.

', 'DescribeRemediationExecutionStatusRequest$ResourceKeys' => '

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

', 'StartRemediationExecutionRequest$ResourceKeys' => '

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

', 'StartRemediationExecutionResponse$FailedItems' => '

For resources that have failed to start execution, the API returns a resource key object.

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'AggregateResourceIdentifier$ResourceName' => '

The name of the Amazon Web Services resource.

', 'BaseConfigurationItem$resourceName' => '

The custom name of the resource, if available.

', 'ConfigurationItem$resourceName' => '

The custom name of the resource, if available.

', 'ListDiscoveredResourcesRequest$resourceName' => '

The custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.

', 'PutResourceConfigRequest$ResourceName' => '

Name of the resource.

', 'Relationship$resourceName' => '

The custom name of the related resource, if available.

', 'ResourceFilters$ResourceName' => '

The name of the resource.

', 'ResourceIdentifier$resourceName' => '

The custom name of the resource (if available).

', ], ], 'ResourceNotDiscoveredException' => [ 'base' => '

You have specified a resource that is either unknown or has not been discovered.

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

You have specified a resource that does not exist.

', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'AggregateResourceIdentifier$ResourceType' => '

The type of the Amazon Web Services resource.

', 'BaseConfigurationItem$resourceType' => '

The type of Amazon Web Services resource.

', 'ConfigurationItem$resourceType' => '

The type of Amazon Web Services resource.

', 'GetResourceConfigHistoryRequest$resourceType' => '

The resource type.

', 'ListAggregateDiscoveredResourcesRequest$ResourceType' => '

The type of resources that you want Config to list in the response.

', 'ListDiscoveredResourcesRequest$resourceType' => '

The type of resources that you want Config to list in the response.

', 'RecordingModeResourceTypesList$member' => NULL, 'Relationship$resourceType' => '

The resource type of the related resource.

', 'ResourceCount$resourceType' => '

The resource type (for example, "AWS::EC2::Instance").

', 'ResourceCountFilters$ResourceType' => '

The type of the Amazon Web Services resource.

', 'ResourceIdentifier$resourceType' => '

The type of resource.

', 'ResourceKey$resourceType' => '

The resource type.

', 'ResourceTypeList$member' => NULL, ], ], 'ResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'ExclusionByResourceTypes$resourceTypes' => '

A comma-separated list of resource types to exclude from recording by the configuration recorder.

', 'RecordingGroup$resourceTypes' => '

A comma-separated list that specifies which resource types Config records.

For a list of valid resourceTypes values, see the Resource Type Value column in Supported Amazon Web Services resource Types in the Config developer guide.

Required and optional fields

Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.

To record all configuration changes, set the allSupported field of RecordingGroup to true, and either omit this field or don\'t specify any resource types in this field. If you set the allSupported field to false and specify values for resourceTypes, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

Region availability

Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.

', ], ], 'ResourceTypeString' => [ 'base' => NULL, 'refs' => [ 'DeleteResourceConfigRequest$ResourceType' => '

The type of the resource.

', 'PutResourceConfigRequest$ResourceType' => '

The type of the resource. The custom resource type must be registered with CloudFormation.

You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.

', ], ], 'ResourceTypes' => [ 'base' => NULL, 'refs' => [ 'GetComplianceSummaryByResourceTypeRequest$ResourceTypes' => '

Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.

For this request, you can specify an Amazon Web Services resource type such as AWS::EC2::Instance. You can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

', 'GetDiscoveredResourceCountsRequest$resourceTypes' => '

The comma-separated list that specifies the resource types that you want Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User").

If a value for resourceTypes is not specified, Config returns all resource types that Config is recording in the region for your account.

If the configuration recorder is turned off, Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.

', ], ], 'ResourceTypesScope' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$ResourceTypesScope' => '

The type of the Amazon Web Services resource that was evaluated.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$ResourceTypesScope' => '

The type of the Amazon Web Services resource that was evaluated.

', 'OrganizationCustomRuleMetadata$ResourceTypesScope' => '

The type of the Amazon Web Services resource that was evaluated.

', 'OrganizationManagedRuleMetadata$ResourceTypesScope' => '

The type of the Amazon Web Services resource that was evaluated.

', ], ], 'ResourceValue' => [ 'base' => '

The dynamic value of the resource.

', 'refs' => [ 'RemediationParameterValue$ResourceValue' => '

The value is dynamic and changes at run-time.

', ], ], 'ResourceValueType' => [ 'base' => NULL, 'refs' => [ 'ResourceValue$Value' => '

The value is a resource ID.

', ], ], 'Results' => [ 'base' => NULL, 'refs' => [ 'SelectAggregateResourceConfigResponse$Results' => '

Returns the results for the SQL query.

', 'SelectResourceConfigResponse$Results' => '

Returns the results for the SQL query.

', ], ], 'RetentionConfiguration' => [ 'base' => '

An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in Config.

', 'refs' => [ 'PutRetentionConfigurationResponse$RetentionConfiguration' => '

Returns a retention configuration object.

', 'RetentionConfigurationList$member' => NULL, ], ], 'RetentionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'DescribeRetentionConfigurationsResponse$RetentionConfigurations' => '

Returns a retention configuration object.

', ], ], 'RetentionConfigurationName' => [ 'base' => NULL, 'refs' => [ 'DeleteRetentionConfigurationRequest$RetentionConfigurationName' => '

The name of the retention configuration to delete.

', 'RetentionConfiguration$Name' => '

The name of the retention configuration object.

', 'RetentionConfigurationNameList$member' => NULL, ], ], 'RetentionConfigurationNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeRetentionConfigurationsRequest$RetentionConfigurationNames' => '

A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.

Currently, Config supports only one retention configuration per region in your account.

', ], ], 'RetentionPeriodInDays' => [ 'base' => NULL, 'refs' => [ 'PutRetentionConfigurationRequest$RetentionPeriodInDays' => '

Number of days Config stores your historical information.

Currently, only applicable to the configuration item history.

', 'RetentionConfiguration$RetentionPeriodInDays' => '

Number of days Config stores your historical information.

Currently, only applicable to the configuration item history.

', ], ], 'RuleLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigRuleEvaluationStatusRequest$Limit' => '

The number of rule evaluation results that you want returned.

This parameter is required if the rule limit for your account is more than the default of 150 rules.

For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.

', ], ], 'SSMDocumentName' => [ 'base' => NULL, 'refs' => [ 'TemplateSSMDocumentDetails$DocumentName' => '

The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.

', ], ], 'SSMDocumentVersion' => [ 'base' => NULL, 'refs' => [ 'TemplateSSMDocumentDetails$DocumentVersion' => '

The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.

This field is optional.

', ], ], 'SchemaVersionId' => [ 'base' => NULL, 'refs' => [ 'PutResourceConfigRequest$SchemaVersionId' => '

Version of the schema registered for the ResourceType in CloudFormation.

', ], ], 'Scope' => [ 'base' => '

Defines which resources trigger an evaluation for an Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

', 'refs' => [ 'ConfigRule$Scope' => '

Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

The scope can be empty.

', ], ], 'SelectAggregateResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'SelectAggregateResourceConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'SelectResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'SelectResourceConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'SortBy' => [ 'base' => NULL, 'refs' => [ 'ListConformancePackComplianceScoresRequest$SortBy' => '

Sorts your conformance pack compliance scores in either ascending or descending order, depending on SortOrder.

By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Enter SCORE, to sort conformance pack compliance scores by the numerical value of the compliance score.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListConformancePackComplianceScoresRequest$SortOrder' => '

Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.

By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Conformance pack compliance scores are sorted in reverse alphabetical order if you enter DESCENDING.

You can sort conformance pack compliance scores by the numerical value of the compliance score by entering SCORE in the SortBy action. When compliance scores are sorted by SCORE, conformance packs with a compliance score of INSUFFICIENT_DATA will be last when sorting by ascending order and first when sorting by descending order.

', ], ], 'Source' => [ 'base' => '

Provides the CustomPolicyDetails, the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your Amazon Web Services resources.

', 'refs' => [ 'ConfigRule$Source' => '

Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.

', ], ], 'SourceDetail' => [ 'base' => '

Provides the source and the message types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.

', 'refs' => [ 'SourceDetails$member' => NULL, ], ], 'SourceDetails' => [ 'base' => NULL, 'refs' => [ 'Source$SourceDetails' => '

Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

If the owner is set to CUSTOM_POLICY, the only acceptable values for the Config rule trigger message type are ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification.

', ], ], 'SsmControls' => [ 'base' => '

Amazon Web Services Systems Manager (SSM) specific remediation controls.

', 'refs' => [ 'ExecutionControls$SsmControls' => '

A SsmControls object.

', ], ], 'StackArn' => [ 'base' => NULL, 'refs' => [ 'ConformancePackStatusDetail$StackArn' => '

Amazon Resource Name (ARN) of CloudFormation stack.

', ], ], 'StartConfigRulesEvaluationRequest' => [ 'base' => '

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

The output when you start the evaluation for the specified Config rule.

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

The input for the StartConfigurationRecorder action.

', 'refs' => [], ], 'StartRemediationExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRemediationExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartResourceEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartResourceEvaluationResponse' => [ 'base' => NULL, 'refs' => [], ], 'StaticParameterValues' => [ 'base' => NULL, 'refs' => [ 'StaticValue$Values' => '

A list of values. For example, the ARN of the assumed role.

', ], ], 'StaticValue' => [ 'base' => '

The static value of the resource.

', 'refs' => [ 'RemediationParameterValue$StaticValue' => '

The value is static and does not change at run-time.

', ], ], 'StatusDetailFilters' => [ 'base' => '

Status filter object to filter results based on specific member account ID or status type for an organization Config rule.

', 'refs' => [ 'GetOrganizationConfigRuleDetailedStatusRequest$Filters' => '

A StatusDetailFilters object.

', ], ], 'StopConfigurationRecorderRequest' => [ 'base' => '

The input for the StopConfigurationRecorder action.

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

Provides the details of a stored query.

', 'refs' => [ 'GetStoredQueryResponse$StoredQuery' => '

Returns a StoredQuery object.

', 'PutStoredQueryRequest$StoredQuery' => '

A list of StoredQuery objects. The mandatory fields are QueryName and Expression.

When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional.

', ], ], 'StoredQueryMetadata' => [ 'base' => '

Returns details of a specific query.

', 'refs' => [ 'StoredQueryMetadataList$member' => NULL, ], ], 'StoredQueryMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListStoredQueriesResponse$StoredQueryMetadata' => '

A list of StoredQueryMetadata objects.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AggregatedSourceStatus$SourceId' => '

The source account ID or an organization.

', 'AggregatedSourceStatus$LastErrorCode' => '

The error code that Config returned when the source account aggregation last failed.

', 'AggregatedSourceStatus$LastErrorMessage' => '

The message indicating that the source account aggregation failed due to an error.

', 'AggregationAuthorization$AggregationAuthorizationArn' => '

The Amazon Resource Name (ARN) of the aggregation object.

', 'AggregatorRegionList$member' => NULL, 'ConfigExportDeliveryInfo$lastErrorCode' => '

The error code from the last attempted delivery.

', 'ConfigExportDeliveryInfo$lastErrorMessage' => '

The error message from the last attempted delivery.

', 'ConfigRuleEvaluationStatus$ConfigRuleArn' => '

The Amazon Resource Name (ARN) of the Config rule.

', 'ConfigRuleEvaluationStatus$ConfigRuleId' => '

The ID of the Config rule.

', 'ConfigRuleEvaluationStatus$LastErrorCode' => '

The error code that Config returned when the rule last failed.

', 'ConfigRuleEvaluationStatus$LastErrorMessage' => '

The error message that Config returned when the rule last failed.

', 'ConfigRuleEvaluationStatus$LastDebugLogDeliveryStatus' => '

The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either Successful or Failed.

', 'ConfigRuleEvaluationStatus$LastDebugLogDeliveryStatusReason' => '

The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.

', 'ConfigStreamDeliveryInfo$lastErrorCode' => '

The error code from the last attempted delivery.

', 'ConfigStreamDeliveryInfo$lastErrorMessage' => '

The error message from the last attempted delivery.

', 'ConfigurationRecorder$roleARN' => '

Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.

While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.

Pre-existing Config role

If you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected.

For example, if Control Tower has an IAM role that allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see Identity and Access Management for Config in the Config Developer Guide.

', 'ConfigurationRecorderStatus$name' => '

The name of the configuration recorder.

', 'ConfigurationRecorderStatus$lastErrorCode' => '

The latest error code from when the recorder last failed.

', 'ConfigurationRecorderStatus$lastErrorMessage' => '

The latest error message from when the recorder last failed.

', 'DeleteRemediationConfigurationRequest$ResourceType' => '

The type of a resource.

', 'DeliverConfigSnapshotResponse$configSnapshotId' => '

The ID of the snapshot that is being created.

', 'DeliveryChannel$s3BucketName' => '

The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.

', 'DeliveryChannel$s3KeyPrefix' => '

The prefix for the specified Amazon S3 bucket.

', 'DeliveryChannel$s3KmsKeyArn' => '

The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.

', 'DeliveryChannel$snsTopicARN' => '

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.

', 'DeliveryChannelStatus$name' => '

The name of the delivery channel.

', 'DescribeAggregationAuthorizationsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeAggregationAuthorizationsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeComplianceByConfigRuleRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeComplianceByConfigRuleResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'DescribeConfigRuleEvaluationStatusRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeConfigRuleEvaluationStatusResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'DescribeConfigRulesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeConfigRulesResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'DescribeConfigurationAggregatorSourcesStatusRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeConfigurationAggregatorSourcesStatusResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeConfigurationAggregatorsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeConfigurationAggregatorsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConfigRuleStatusesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConfigRuleStatusesResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConfigRulesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConfigRulesResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConformancePackStatusesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConformancePackStatusesResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConformancePacksRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConformancePacksResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribePendingAggregationRequestsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribePendingAggregationRequestsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeRemediationExceptionsRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeRemediationExceptionsResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeRemediationExecutionStatusRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeRemediationExecutionStatusResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'EvaluationResult$ResultToken' => '

An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.

', 'FailedDeleteRemediationExceptionsBatch$FailureMessage' => '

Returns a failure message for delete remediation exception. For example, Config creates an exception due to an internal error.

', 'FailedRemediationBatch$FailureMessage' => '

Returns a failure message. For example, the resource is already compliant.

', 'FailedRemediationExceptionBatch$FailureMessage' => '

Returns a failure message. For example, the auto-remediation has failed.

', 'GetComplianceDetailsByResourceRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetComplianceDetailsByResourceResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'GetOrganizationConfigRuleDetailedStatusRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetOrganizationConfigRuleDetailedStatusResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetOrganizationConformancePackDetailedStatusRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetOrganizationConformancePackDetailedStatusResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'IdempotentParameterMismatch$message' => NULL, 'ListResourceEvaluationsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListResourceEvaluationsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListStoredQueriesRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'ListStoredQueriesResponse$NextToken' => '

If the previous paginated request didn\'t return all of the remaining results, the response object\'s NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s NextToken parameter. If there are no remaining results, the previous response object\'s NextToken parameter is set to null.

', 'MemberAccountStatus$ErrorCode' => '

An error code that is returned when Config rule creation or deletion failed in the member account.

', 'MemberAccountStatus$ErrorMessage' => '

An error message indicating that Config rule account creation or deletion has failed due to an error in the member account.

', 'OrganizationAggregationSource$RoleArn' => '

ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.

', 'OrganizationConfigRuleStatus$ErrorCode' => '

An error code that is returned when organization Config rule creation or deletion has failed.

', 'OrganizationConfigRuleStatus$ErrorMessage' => '

An error message indicating that organization Config rule creation or deletion failed due to an error.

', 'OrganizationConformancePackDetailedStatus$ErrorCode' => '

An error code that is returned when conformance pack creation or deletion failed in the member account.

', 'OrganizationConformancePackDetailedStatus$ErrorMessage' => '

An error message indicating that conformance pack account creation or deletion has failed due to an error in the member account.

', 'OrganizationConformancePackStatus$ErrorCode' => '

An error code that is returned when organization conformance pack creation or deletion has failed in a member account.

', 'OrganizationConformancePackStatus$ErrorMessage' => '

An error message indicating that organization conformance pack creation or deletion failed due to an error.

', 'PutEvaluationsRequest$ResultToken' => '

An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.

', 'RemediationConfiguration$TargetVersion' => '

Version of the target. For example, version of the SSM document.

If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.

', 'RemediationConfiguration$ResourceType' => '

The type of a resource.

', 'RemediationExecutionStep$Name' => '

The details of the step.

', 'RemediationExecutionStep$ErrorMessage' => '

An error message if the step was interrupted during execution.

', 'Results$member' => NULL, 'StartRemediationExecutionResponse$FailureMessage' => '

Returns a failure message. For example, the resource is already compliant.

', ], ], 'StringWithCharLimit1024' => [ 'base' => NULL, 'refs' => [ 'ConfigRule$InputParameters' => '

A string, in JSON format, that is passed to the Config rule Lambda function.

', 'EvaluationStatus$FailureReason' => '

An explanation for failed execution status.

', 'PutRemediationExceptionsRequest$Message' => '

The message contains an explanation of the exception.

', 'RemediationConfiguration$Arn' => '

Amazon Resource Name (ARN) of remediation configuration.

', 'RemediationConfiguration$CreatedByService' => '

Name of the service that owns the service-linked rule, if applicable.

', 'RemediationException$ResourceId' => '

The ID of the resource (for example., sg-xxxxxx).

', 'RemediationException$Message' => '

An explanation of an remediation exception.

', 'RemediationExceptionResourceKey$ResourceId' => '

The ID of the resource (for example., sg-xxxxxx).

', ], ], 'StringWithCharLimit128' => [ 'base' => NULL, 'refs' => [ 'ControlsList$member' => NULL, 'OrganizationCustomPolicyRuleMetadata$TagKeyScope' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$TagKeyScope' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

', 'OrganizationCustomRuleMetadata$TagKeyScope' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

', 'OrganizationManagedRuleMetadata$TagKeyScope' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

', 'Scope$TagKey' => '

The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

', ], ], 'StringWithCharLimit2048' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$InputParameters' => '

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$InputParameters' => '

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

', 'OrganizationCustomRuleMetadata$InputParameters' => '

A string, in JSON format, that is passed to your organization Config rule Lambda function.

', 'OrganizationManagedRuleMetadata$InputParameters' => '

A string, in JSON format, that is passed to your organization Config rule Lambda function.

', ], ], 'StringWithCharLimit256' => [ 'base' => NULL, 'refs' => [ 'AggregateComplianceCount$GroupName' => '

The 12-digit account ID or region based on the GroupByKey value.

', 'AggregateConformancePackComplianceSummary$GroupName' => '

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

', 'AggregateEvaluationResult$Annotation' => '

Supplementary information about how the agrregate evaluation determined the compliance.

', 'ComplianceByResource$ResourceType' => '

The type of the Amazon Web Services resource that was evaluated.

', 'ComplianceResourceTypes$member' => NULL, 'ComplianceSummaryByResourceType$ResourceType' => '

The type of Amazon Web Services resource.

', 'ConfigRule$ConfigRuleArn' => '

The Amazon Resource Name (ARN) of the Config rule.

', 'ConfigRule$CreatedBy' => '

Service principal name of the service that created the rule.

The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.

', 'ConfigurationAggregator$CreatedBy' => '

Amazon Web Services service that created the configuration aggregator.

', 'ConformancePackComplianceResourceIds$member' => NULL, 'ConformancePackDetail$CreatedBy' => '

The Amazon Web Services service that created the conformance pack.

', 'ConformancePackEvaluationFilters$ResourceType' => '

Filters the results by the resource type (for example, "AWS::EC2::Instance").

', 'DescribeComplianceByResourceRequest$ResourceType' => '

The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

', 'Evaluation$ComplianceResourceType' => '

The type of Amazon Web Services resource that was evaluated.

', 'Evaluation$Annotation' => '

Supplementary information about how the evaluation determined the compliance.

', 'EvaluationResult$Annotation' => '

Supplementary information about how the evaluation determined the compliance.

', 'EvaluationResultQualifier$ResourceType' => '

The type of Amazon Web Services resource that was evaluated.

', 'ExternalEvaluation$ComplianceResourceType' => '

The evaluated compliance resource type. Config accepts AWS::::Account resource type.

', 'ExternalEvaluation$Annotation' => '

Supplementary information about the reason of compliance. For example, this task was completed on a specific date.

', 'GetAggregateConfigRuleComplianceSummaryResponse$GroupByKey' => '

Groups the result based on ACCOUNT_ID or AWS_REGION.

', 'GetAggregateConformancePackComplianceSummaryResponse$GroupByKey' => '

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

', 'GetAggregateDiscoveredResourceCountsResponse$GroupByKey' => '

The key passed into the request object. If GroupByKey is not provided, the result will be empty.

', 'GetComplianceDetailsByResourceRequest$ResourceType' => '

The type of the Amazon Web Services resource for which you want compliance information.

', 'GroupedResourceCount$GroupName' => '

The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the region was chosen as GroupByKey.

', 'OrganizationConfigRule$OrganizationConfigRuleArn' => '

Amazon Resource Name (ARN) of organization Config rule.

', 'OrganizationConformancePack$OrganizationConformancePackArn' => '

Amazon Resource Name (ARN) of organization conformance pack.

', 'OrganizationConformancePackDetailedStatus$ConformancePackName' => '

The name of conformance pack deployed in the member account.

', 'OrganizationCustomPolicyRuleMetadata$TagValueScope' => '

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$TagValueScope' => '

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', 'OrganizationCustomRuleMetadata$LambdaFunctionArn' => '

The lambda function ARN.

', 'OrganizationCustomRuleMetadata$TagValueScope' => '

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', 'OrganizationManagedRuleMetadata$RuleIdentifier' => '

For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

', 'OrganizationManagedRuleMetadata$TagValueScope' => '

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', 'PutOrganizationConfigRuleResponse$OrganizationConfigRuleArn' => '

The Amazon Resource Name (ARN) of an organization Config rule.

', 'PutOrganizationConformancePackResponse$OrganizationConformancePackArn' => '

ARN of the organization conformance pack.

', 'RemediationConfiguration$TargetId' => '

Target ID is the name of the SSM document.

', 'RemediationException$ResourceType' => '

The type of a resource.

', 'RemediationExceptionResourceKey$ResourceType' => '

The type of a resource.

', 'RemediationParameters$key' => NULL, 'ResourceDetails$ResourceType' => '

The type of resource being evaluated.

', 'ResourceTypes$member' => NULL, 'ResourceTypesScope$member' => NULL, 'Scope$TagValue' => '

The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

', 'Source$SourceIdentifier' => '

For Config Managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see List of Config Managed Rules.

For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule\'s Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name.

For Config Custom Policy rules, this field will be ignored.

', 'StaticParameterValues$member' => NULL, ], ], 'StringWithCharLimit256Min0' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$Description' => '

The description that you provide for your organization Config Custom Policy rule.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$Description' => '

The description that you provide for your organization Config Custom Policy rule.

', 'OrganizationCustomRuleMetadata$Description' => '

The description that you provide for your organization Config rule.

', 'OrganizationManagedRuleMetadata$Description' => '

The description that you provide for your organization Config rule.

', ], ], 'StringWithCharLimit64' => [ 'base' => NULL, 'refs' => [ 'ComplianceByConfigRule$ConfigRuleName' => '

The name of the Config rule.

', 'ConfigRule$ConfigRuleId' => '

The ID of the Config rule.

', 'ConformancePackConfigRuleNames$member' => NULL, 'DeleteEvaluationResultsRequest$ConfigRuleName' => '

The name of the Config rule for which you want to delete the evaluation results.

', 'GetComplianceDetailsByConfigRuleRequest$ConfigRuleName' => '

The name of the Config rule for which you want compliance information.

', 'MemberAccountStatus$ConfigRuleName' => '

The name of Config rule deployed in the member account.

', 'OrganizationConfigRuleNames$member' => NULL, ], ], 'StringWithCharLimit768' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$ResourceIdScope' => '

The ID of the Amazon Web Services resource that was evaluated.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$ResourceIdScope' => '

The ID of the Amazon Web Services resource that was evaluated.

', 'OrganizationCustomRuleMetadata$ResourceIdScope' => '

The ID of the Amazon Web Services resource that was evaluated.

', 'OrganizationManagedRuleMetadata$ResourceIdScope' => '

The ID of the Amazon Web Services resource that was evaluated.

', ], ], 'SupplementaryConfiguration' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$supplementaryConfiguration' => '

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

', 'ConfigurationItem$supplementaryConfiguration' => '

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

', ], ], 'SupplementaryConfigurationName' => [ 'base' => NULL, 'refs' => [ 'SupplementaryConfiguration$key' => NULL, ], ], 'SupplementaryConfigurationValue' => [ 'base' => NULL, 'refs' => [ 'SupplementaryConfiguration$value' => NULL, ], ], 'Tag' => [ 'base' => '

The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

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

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

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

The keys of the tags to be removed.

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

The tags for the resource.

', 'TagResourceRequest$Tags' => '

An array of tag object.

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

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'ConfigurationItem$tags' => '

A mapping of key value tags associated with the resource.

', 'PutResourceConfigRequest$Tags' => '

Tags associated with the resource.

This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for PutResourceConfig are tags that you supply for the configuration items of your custom resources.

', ], ], 'TagsList' => [ 'base' => NULL, 'refs' => [ 'PutAggregationAuthorizationRequest$Tags' => '

An array of tag object.

', 'PutConfigRuleRequest$Tags' => '

An array of tag object.

', 'PutConfigurationAggregatorRequest$Tags' => '

An array of tag object.

', 'PutStoredQueryRequest$Tags' => '

A list of Tags object.

', ], ], 'TemplateBody' => [ 'base' => NULL, 'refs' => [ 'PutConformancePackRequest$TemplateBody' => '

A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.

You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

', 'PutOrganizationConformancePackRequest$TemplateBody' => '

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

', ], ], 'TemplateS3Uri' => [ 'base' => NULL, 'refs' => [ 'PutConformancePackRequest$TemplateS3Uri' => '

The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.

You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.

', 'PutOrganizationConformancePackRequest$TemplateS3Uri' => '

Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).

You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.

', ], ], 'TemplateSSMDocumentDetails' => [ 'base' => '

This API allows you to create a conformance pack template with an Amazon Web Services Systems Manager document (SSM document). To deploy a conformance pack using an SSM document, first create an SSM document with conformance pack content, and then provide the DocumentName in the PutConformancePack API. You can also provide the DocumentVersion.

The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.

', 'refs' => [ 'ConformancePackDetail$TemplateSSMDocumentDetails' => '

An object that contains the name or Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

', 'PutConformancePackRequest$TemplateSSMDocumentDetails' => '

An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

', ], ], 'TimeWindow' => [ 'base' => '

Filters evaluation results based on start and end times.

', 'refs' => [ 'ResourceEvaluationFilters$TimeWindow' => '

Returns a TimeWindow object.

', ], ], 'TooManyTagsException' => [ 'base' => '

You have reached the limit of the number of tags you can use. For more information, see Service Limits in the Config Developer Guide.

', 'refs' => [], ], 'UnprocessedResourceIdentifierList' => [ 'base' => NULL, 'refs' => [ 'BatchGetAggregateResourceConfigResponse$UnprocessedResourceIdentifiers' => '

A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

The requested action is not valid.

For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

', 'refs' => [], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'Tags$value' => NULL, ], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$version' => '

The version number of the resource configuration.

', 'ConfigurationItem$version' => '

The version number of the resource configuration.

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

Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see Supported Amazon Web Services resources.

You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see What Is Config in the Config Developer Guide.

', 'operations' => [ 'BatchGetAggregateResourceConfig' => '

Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list.

  • The API does not return results for deleted resources.

  • The API does not return tags and relationships.

', 'BatchGetResourceConfig' => '

Returns the BaseConfigurationItem for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list.

  • The API does not return results for deleted resources.

  • The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.

', 'DeleteAggregationAuthorization' => '

Deletes the authorization granted to the specified configuration aggregator account in a specified region.

', 'DeleteConfigRule' => '

Deletes the specified Config rule and all of its evaluation results.

Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

You can check the state of a rule by using the DescribeConfigRules request.

', 'DeleteConfigurationAggregator' => '

Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.

', 'DeleteConfigurationRecorder' => '

Deletes the configuration recorder.

After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder.

This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the Config console until you create a new configuration recorder.

', 'DeleteConformancePack' => '

Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.

Config sets the conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.

', 'DeleteDeliveryChannel' => '

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

', 'DeleteEvaluationResults' => '

Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.

', 'DeleteOrganizationConfigRule' => '

Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.

Only a management account and a delegated administrator account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.

Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.

', 'DeleteOrganizationConformancePack' => '

Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.

Only a management account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.

Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.

', 'DeletePendingAggregationRequest' => '

Deletes pending authorization requests for a specified aggregator account in a specified region.

', 'DeleteRemediationConfiguration' => '

Deletes the remediation configuration.

', 'DeleteRemediationExceptions' => '

Deletes one or more remediation exceptions mentioned in the resource keys.

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

', 'DeleteResourceConfig' => '

Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.

', 'DeleteRetentionConfiguration' => '

Deletes the retention configuration.

', 'DeleteStoredQuery' => '

Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.

', 'DeliverConfigSnapshot' => '

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified.

', 'DescribeAggregateComplianceByConfigRules' => '

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

', 'DescribeAggregateComplianceByConformancePacks' => '

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

', 'DescribeAggregationAuthorizations' => '

Returns a list of authorizations granted to various aggregator accounts and regions.

', 'DescribeComplianceByConfigRule' => '

Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.

If Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

', 'DescribeComplianceByResource' => '

Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.

A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

', 'DescribeConfigRuleEvaluationStatus' => '

Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.

', 'DescribeConfigRules' => '

Returns details about your Config rules.

', 'DescribeConfigurationAggregatorSourcesStatus' => '

Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.

', 'DescribeConfigurationAggregators' => '

Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.

', 'DescribeConfigurationRecorderStatus' => '

Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.

>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.

', 'DescribeConfigurationRecorders' => '

Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.

You can specify only one configuration recorder for each Amazon Web Services Region for each account.

', 'DescribeConformancePackCompliance' => '

Returns compliance details for each rule in that conformance pack.

You must provide exact rule names.

', 'DescribeConformancePackStatus' => '

Provides one or more conformance packs deployment status.

If there are no conformance packs then you will see an empty result.

', 'DescribeConformancePacks' => '

Returns a list of one or more conformance packs.

', 'DescribeDeliveryChannelStatus' => '

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

', 'DescribeDeliveryChannels' => '

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

', 'DescribeOrganizationConfigRuleStatuses' => '

Provides organization Config rule deployment status for an organization.

The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.

', 'DescribeOrganizationConfigRules' => '

Returns a list of organization Config rules.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.

For accounts within an organzation

If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won\'t be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.

', 'DescribeOrganizationConformancePackStatuses' => '

Provides organization conformance pack deployment status for an organization.

The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.

', 'DescribeOrganizationConformancePacks' => '

Returns a list of organization conformance packs.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.

For accounts within an organzation

If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won\'t be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.

', 'DescribePendingAggregationRequests' => '

Returns a list of all pending aggregation requests.

', 'DescribeRemediationConfigurations' => '

Returns the details of one or more remediation configurations.

', 'DescribeRemediationExceptions' => '

Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.

', 'DescribeRemediationExecutionStatus' => '

Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.

', 'DescribeRetentionConfigurations' => '

Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.

Currently, Config supports only one retention configuration per region in your account.

', 'GetAggregateComplianceDetailsByConfigRule' => '

Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.

', 'GetAggregateConfigRuleComplianceSummary' => '

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

', 'GetAggregateConformancePackComplianceSummary' => '

Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

', 'GetAggregateDiscoveredResourceCounts' => '

Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.

For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.

', 'GetAggregateResourceConfig' => '

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

', 'GetComplianceDetailsByConfigRule' => '

Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

', 'GetComplianceDetailsByResource' => '

Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.

', 'GetComplianceSummaryByConfigRule' => '

Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

', 'GetComplianceSummaryByResourceType' => '

Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.

', 'GetConformancePackComplianceDetails' => '

Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.

', 'GetConformancePackComplianceSummary' => '

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

', 'GetCustomRulePolicy' => '

Returns the policy definition containing the logic for your Config Custom Policy rule.

', 'GetDiscoveredResourceCounts' => '

Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.

Example

  1. Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.

  2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

  3. Config returns the following:

    • The resource types (EC2 instances, IAM users, and S3 buckets).

    • The number of each resource type (25, 20, and 15).

    • The total number of all resources (60).

The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

  • You are a new Config customer.

  • You just enabled resource recording.

It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.

', 'GetOrganizationConfigRuleDetailedStatus' => '

Returns detailed status for each member account within an organization for a given organization Config rule.

', 'GetOrganizationConformancePackDetailedStatus' => '

Returns detailed status for each member account within an organization for a given organization conformance pack.

', 'GetOrganizationCustomRulePolicy' => '

Returns the policy definition containing the logic for your organization Config Custom Policy rule.

', 'GetResourceConfigHistory' => '

For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type. For more information, see Selecting Which Resources Config Records.

Returns a list of ConfigurationItems for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems for the specified retention period.

The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.

', 'GetResourceEvaluationSummary' => '

Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.

To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. For more information, see the Examples section.

', 'GetStoredQuery' => '

Returns the details of a specific stored query.

', 'ListAggregateDiscoveredResources' => '

Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.

For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.

', 'ListConformancePackComplianceScores' => '

Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.

Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA.

', 'ListDiscoveredResources' => '

Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.

You can specify either resource IDs or a resource name, but not both, in the same request.

The response is paginated. By default, Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

', 'ListResourceEvaluations' => '

Returns a list of proactive resource evaluations.

', 'ListStoredQueries' => '

Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.

', 'ListTagsForResource' => '

List the tags for Config resource.

', 'PutAggregationAuthorization' => '

Authorizes the aggregator account and region to collect data from the source account and region.

PutAggregationAuthorization is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

', 'PutConfigRule' => '

Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide.

There are two types of rules: Config Managed Rules and Config Custom Rules. You can use PutConfigRule to create both Config Managed Rules and Config Custom Rules.

Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule\'s identifier for the SourceIdentifier key.

Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.

If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function that the rule invokes to evaluate your resources. When you use PutConfigRule to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. You specify the ARN in the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

For any new Config rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by Config for new rules.

If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.

For more information about developing and using Config rules, see Evaluating Resources with Config Rules in the Config Developer Guide.

PutConfigRule is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

', 'PutConfigurationAggregator' => '

Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.

accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones.

Config should be enabled in source accounts and regions you want to aggregate.

If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.

To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.

PutConfigurationAggregator is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

', 'PutConfigurationRecorder' => '

Creates a new configuration recorder to record configuration changes for specified resource types.

You can also use this action to change the roleARN or the recordingGroup of an existing recorder. For more information, see Managing the Configuration Recorder in the Config Developer Guide.

You can specify only one configuration recorder for each Amazon Web Services Region for each account.

If the configuration recorder does not have the recordingGroup field specified, the default is to record all supported resource types.

', 'PutConformancePack' => '

Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.

This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. The service-linked role is created only when the role does not exist in your account.

You must specify only one of the follow parameters: TemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails.

', 'PutDeliveryChannel' => '

Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic. For more information, see Notifications that Config Sends to an Amazon SNS topic.

Before you can create a delivery channel, you must create a configuration recorder.

You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.

You can have only one delivery channel per region in your account.

', 'PutEvaluations' => '

Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.

', 'PutExternalEvaluation' => '

Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.

', 'PutOrganizationConfigRule' => '

Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide.

Only a management account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.

This API enables organization service access through the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with GetRole action.

To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com.

There are two types of rules: Config Managed Rules and Config Custom Rules. You can use PutOrganizationConfigRule to create both Config Managed Rules and Config Custom Rules.

Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule\'s identifier for the RuleIdentifier key.

Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.

If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function in the management account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function. When you use PutOrganizationConfigRule to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

Make sure to specify one of either OrganizationCustomPolicyRuleMetadata for Custom Policy rules, OrganizationCustomRuleMetadata for Custom Lambda rules, or OrganizationManagedRuleMetadata for managed rules.

', 'PutOrganizationConformancePack' => '

Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.

Only a management account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.

This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.

', 'PutRemediationConfigurations' => '

Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.

If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.

This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.

For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.

However, for automatic remediation configuration, the only valid assumeRole field value is AutomationAssumeRole and you need to provide a value for AutomationAssumeRole to remediate your resources.

', 'PutRemediationExceptions' => '

A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.

Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as NON_COMPLIANT. Once the resource has been evaluated as NON_COMPLIANT, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before a NON_COMPLIANT evaluation result can delete resources before the exception is applied.

Placing an exception can only be performed on resources that are NON_COMPLIANT. If you use this API for COMPLIANT resources or resources that are NOT_APPLICABLE, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see Concepts | Config Rules in the Config Developer Guide.

', 'PutResourceConfig' => '

Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.

The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.

When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.

Write-only schema properites are not recorded as part of the published configuration item.

', 'PutRetentionConfiguration' => '

Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object.

Currently, Config supports only one retention configuration per region in your account.

', 'PutStoredQuery' => '

Saves a new query or updates an existing saved query. The QueryName must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.

PutStoredQuery is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

', 'SelectAggregateResourceConfig' => '

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the Query Components section in the Config Developer Guide.

If you run an aggregation query (i.e., using GROUP BY or using aggregate functions such as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = \'AWS::IAM::Role\' GROUP BY resourceId) and do not specify the MaxResults or the Limit query parameters, the default page size is set to 500.

If you run a non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT * WHERE resourceType = \'AWS::IAM::Role\') and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25.

', 'SelectResourceConfig' => '

Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the Query Components section in the Config Developer Guide.

', 'StartConfigRulesEvaluation' => '

Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources.

You can specify up to 25 Config rules per request.

An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.

You don\'t need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, Config evaluates your resources against the rule automatically.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

', 'StartConfigurationRecorder' => '

Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

You must have created at least one delivery channel to successfully start the configuration recorder.

', 'StartRemediationExecution' => '

Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.

You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.

', 'StartResourceEvaluation' => '

Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.

Ensure you have the cloudformation:DescribeType role setup to validate the resource type schema.

You can find the Resource type schema in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand: aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE.

For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.

', 'StopConfigurationRecorder' => '

Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

', 'TagResource' => '

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. If existing tags are specified, however, then their values will be updated. When a resource is deleted, the tags associated with that resource are deleted as well.

', 'UntagResource' => '

Deletes specified tags from a resource.

', ], 'shapes' => [ 'ARN' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$arn' => '

The Amazon Resource Name (ARN) of the resource.

', 'ConfigurationItem$arn' => '

Amazon Resource Name (ARN) associated with the resource.

', ], ], 'AccountAggregationSource' => [ 'base' => '

A collection of accounts and regions.

', 'refs' => [ 'AccountAggregationSourceList$member' => NULL, ], ], 'AccountAggregationSourceAccountList' => [ 'base' => NULL, 'refs' => [ 'AccountAggregationSource$AccountIds' => '

The 12-digit account ID of the account being aggregated.

', ], ], 'AccountAggregationSourceList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationAggregator$AccountAggregationSources' => '

Provides a list of source accounts and regions to be aggregated.

', 'PutConfigurationAggregatorRequest$AccountAggregationSources' => '

A list of AccountAggregationSource object.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AccountAggregationSourceAccountList$member' => NULL, 'AggregateComplianceByConfigRule$AccountId' => '

The 12-digit account ID of the source account.

', 'AggregateComplianceByConformancePack$AccountId' => '

The 12-digit Amazon Web Services account ID of the source account.

', 'AggregateConformancePackComplianceFilters$AccountId' => '

The 12-digit Amazon Web Services account ID of the source account.

', 'AggregateConformancePackComplianceSummaryFilters$AccountId' => '

The 12-digit Amazon Web Services account ID of the source account.

', 'AggregateEvaluationResult$AccountId' => '

The 12-digit account ID of the source account.

', 'AggregateResourceIdentifier$SourceAccountId' => '

The 12-digit account ID of the source account.

', 'AggregationAuthorization$AuthorizedAccountId' => '

The 12-digit account ID of the account authorized to aggregate data.

', 'BaseConfigurationItem$accountId' => '

The 12-digit Amazon Web Services account ID associated with the resource.

', 'ConfigRuleComplianceFilters$AccountId' => '

The 12-digit account ID of the source account.

', 'ConfigRuleComplianceSummaryFilters$AccountId' => '

The 12-digit account ID of the source account.

', 'ConfigurationItem$accountId' => '

The 12-digit Amazon Web Services account ID associated with the resource.

', 'DebugLogDeliveryAccounts$member' => NULL, 'DeleteAggregationAuthorizationRequest$AuthorizedAccountId' => '

The 12-digit account ID of the account authorized to aggregate data.

', 'DeletePendingAggregationRequestRequest$RequesterAccountId' => '

The 12-digit account ID of the account requesting to aggregate data.

', 'ExcludedAccounts$member' => NULL, 'GetAggregateComplianceDetailsByConfigRuleRequest$AccountId' => '

The 12-digit account ID of the source account.

', 'MemberAccountStatus$AccountId' => '

The 12-digit account ID of a member account.

', 'OrganizationConformancePackDetailedStatus$AccountId' => '

The 12-digit account ID of a member account.

', 'OrganizationResourceDetailedStatusFilters$AccountId' => '

The 12-digit account ID of the member account within an organization.

', 'PendingAggregationRequest$RequesterAccountId' => '

The 12-digit account ID of the account requesting to aggregate data.

', 'PutAggregationAuthorizationRequest$AuthorizedAccountId' => '

The 12-digit account ID of the account authorized to aggregate data.

', 'ResourceCountFilters$AccountId' => '

The 12-digit ID of the account.

', 'ResourceFilters$AccountId' => '

The 12-digit source account ID.

', 'StatusDetailFilters$AccountId' => '

The 12-digit account ID of the member account within an organization.

', ], ], 'AggregateComplianceByConfigRule' => [ 'base' => '

Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.

A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.

', 'refs' => [ 'AggregateComplianceByConfigRuleList$member' => NULL, ], ], 'AggregateComplianceByConfigRuleList' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregateComplianceByConfigRulesResponse$AggregateComplianceByConfigRules' => '

Returns a list of AggregateComplianceByConfigRule object.

', ], ], 'AggregateComplianceByConformancePack' => [ 'base' => '

Provides aggregate compliance of the conformance pack. Indicates whether a conformance pack is compliant based on the name of the conformance pack, account ID, and region.

A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.

', 'refs' => [ 'AggregateComplianceByConformancePackList$member' => NULL, ], ], 'AggregateComplianceByConformancePackList' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregateComplianceByConformancePacksResponse$AggregateComplianceByConformancePacks' => '

Returns the AggregateComplianceByConformancePack object.

', ], ], 'AggregateComplianceCount' => [ 'base' => '

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

', 'refs' => [ 'AggregateComplianceCountList$member' => NULL, ], ], 'AggregateComplianceCountList' => [ 'base' => NULL, 'refs' => [ 'GetAggregateConfigRuleComplianceSummaryResponse$AggregateComplianceCounts' => '

Returns a list of AggregateComplianceCounts object.

', ], ], 'AggregateConformancePackCompliance' => [ 'base' => '

Provides the number of compliant and noncompliant rules within a conformance pack. Also provides the compliance status of the conformance pack and the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.

', 'refs' => [ 'AggregateComplianceByConformancePack$Compliance' => '

The compliance status of the conformance pack.

', ], ], 'AggregateConformancePackComplianceCount' => [ 'base' => '

The number of conformance packs that are compliant and noncompliant.

', 'refs' => [ 'AggregateConformancePackComplianceSummary$ComplianceSummary' => '

Returns an AggregateConformancePackComplianceCount object.

', ], ], 'AggregateConformancePackComplianceFilters' => [ 'base' => '

Filters the conformance packs based on an account ID, region, compliance type, and the name of the conformance pack.

', 'refs' => [ 'DescribeAggregateComplianceByConformancePacksRequest$Filters' => '

Filters the result by AggregateConformancePackComplianceFilters object.

', ], ], 'AggregateConformancePackComplianceSummary' => [ 'base' => '

Provides a summary of compliance based on either account ID or region.

', 'refs' => [ 'AggregateConformancePackComplianceSummaryList$member' => NULL, ], ], 'AggregateConformancePackComplianceSummaryFilters' => [ 'base' => '

Filters the results based on account ID and region.

', 'refs' => [ 'GetAggregateConformancePackComplianceSummaryRequest$Filters' => '

Filters the results based on the AggregateConformancePackComplianceSummaryFilters object.

', ], ], 'AggregateConformancePackComplianceSummaryGroupKey' => [ 'base' => NULL, 'refs' => [ 'GetAggregateConformancePackComplianceSummaryRequest$GroupByKey' => '

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

', ], ], 'AggregateConformancePackComplianceSummaryList' => [ 'base' => NULL, 'refs' => [ 'GetAggregateConformancePackComplianceSummaryResponse$AggregateConformancePackComplianceSummaries' => '

Returns a list of AggregateConformancePackComplianceSummary object.

', ], ], 'AggregateEvaluationResult' => [ 'base' => '

The details of an Config evaluation for an account ID and region in an aggregator. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

', 'refs' => [ 'AggregateEvaluationResultList$member' => NULL, ], ], 'AggregateEvaluationResultList' => [ 'base' => NULL, 'refs' => [ 'GetAggregateComplianceDetailsByConfigRuleResponse$AggregateEvaluationResults' => '

Returns an AggregateEvaluationResults object.

', ], ], 'AggregateResourceIdentifier' => [ 'base' => '

The details that identify a resource that is collected by Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.

', 'refs' => [ 'DiscoveredResourceIdentifierList$member' => NULL, 'GetAggregateResourceConfigRequest$ResourceIdentifier' => '

An object that identifies aggregate resource.

', 'ResourceIdentifiersList$member' => NULL, 'UnprocessedResourceIdentifierList$member' => NULL, ], ], 'AggregatedSourceStatus' => [ 'base' => '

The current sync status between the source and the aggregator account.

', 'refs' => [ 'AggregatedSourceStatusList$member' => NULL, ], ], 'AggregatedSourceStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationAggregatorSourcesStatusResponse$AggregatedSourceStatusList' => '

Returns an AggregatedSourceStatus object.

', ], ], 'AggregatedSourceStatusType' => [ 'base' => NULL, 'refs' => [ 'AggregatedSourceStatus$LastUpdateStatus' => '

Filters the last updated status type.

', 'AggregatedSourceStatusTypeList$member' => NULL, ], ], 'AggregatedSourceStatusTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationAggregatorSourcesStatusRequest$UpdateStatus' => '

Filters the status type.

', ], ], 'AggregatedSourceType' => [ 'base' => NULL, 'refs' => [ 'AggregatedSourceStatus$SourceType' => '

The source account or an organization.

', ], ], 'AggregationAuthorization' => [ 'base' => '

An object that represents the authorizations granted to aggregator accounts and regions.

', 'refs' => [ 'AggregationAuthorizationList$member' => NULL, 'PutAggregationAuthorizationResponse$AggregationAuthorization' => '

Returns an AggregationAuthorization object.

', ], ], 'AggregationAuthorizationList' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregationAuthorizationsResponse$AggregationAuthorizations' => '

Returns a list of authorizations granted to various aggregator accounts and regions.

', ], ], 'AggregatorRegionList' => [ 'base' => NULL, 'refs' => [ 'AccountAggregationSource$AwsRegions' => '

The source regions being aggregated.

', 'OrganizationAggregationSource$AwsRegions' => '

The source regions being aggregated.

', ], ], 'AllSupported' => [ 'base' => NULL, 'refs' => [ 'RecordingGroup$allSupported' => '

Specifies whether Config records configuration changes for all supported resource types, excluding the global IAM resource types.

If you set this field to true, when Config adds support for a new resource type, Config starts recording resources of that type automatically.

If you set this field to true, you cannot enumerate specific resource types to record in the resourceTypes field of RecordingGroup, or to exclude in the resourceTypes field of ExclusionByResourceTypes.

Region availability

Check Resource Coverage by Region Availability to see if a resource type is supported in the Amazon Web Services Region where you set up Config.

', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

', ], ], 'Annotation' => [ 'base' => NULL, 'refs' => [ 'ConformancePackEvaluationResult$Annotation' => '

Supplementary information about how the evaluation determined the compliance.

', ], ], 'AutoRemediationAttemptSeconds' => [ 'base' => NULL, 'refs' => [ 'RemediationConfiguration$RetryAttemptSeconds' => '

Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If MaximumAutomaticAttempts remediation attempts have been made under RetryAttemptSeconds, a remediation exception will be added to the resource. If you do not select a number, the default is 60 seconds.

For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.

', ], ], 'AutoRemediationAttempts' => [ 'base' => NULL, 'refs' => [ 'RemediationConfiguration$MaximumAutomaticAttempts' => '

The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

', ], ], 'AvailabilityZone' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$availabilityZone' => '

The Availability Zone associated with the resource.

', 'ConfigurationItem$availabilityZone' => '

The Availability Zone associated with the resource.

', ], ], 'AwsRegion' => [ 'base' => NULL, 'refs' => [ 'AggregateComplianceByConfigRule$AwsRegion' => '

The source region from where the data is aggregated.

', 'AggregateComplianceByConformancePack$AwsRegion' => '

The source Amazon Web Services Region from where the data is aggregated.

', 'AggregateConformancePackComplianceFilters$AwsRegion' => '

The source Amazon Web Services Region from where the data is aggregated.

', 'AggregateConformancePackComplianceSummaryFilters$AwsRegion' => '

The source Amazon Web Services Region from where the data is aggregated.

', 'AggregateEvaluationResult$AwsRegion' => '

The source region from where the data is aggregated.

', 'AggregateResourceIdentifier$SourceRegion' => '

The source region where data is aggregated.

', 'AggregatedSourceStatus$AwsRegion' => '

The region authorized to collect aggregated data.

', 'AggregationAuthorization$AuthorizedAwsRegion' => '

The region authorized to collect aggregated data.

', 'BaseConfigurationItem$awsRegion' => '

The region where the resource resides.

', 'ConfigRuleComplianceFilters$AwsRegion' => '

The source region where the data is aggregated.

', 'ConfigRuleComplianceSummaryFilters$AwsRegion' => '

The source region where the data is aggregated.

', 'ConfigurationItem$awsRegion' => '

The region where the resource resides.

', 'DeleteAggregationAuthorizationRequest$AuthorizedAwsRegion' => '

The region authorized to collect aggregated data.

', 'DeletePendingAggregationRequestRequest$RequesterAwsRegion' => '

The region requesting to aggregate data.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$AwsRegion' => '

The source region from where the data is aggregated.

', 'PendingAggregationRequest$RequesterAwsRegion' => '

The region requesting to aggregate data.

', 'PutAggregationAuthorizationRequest$AuthorizedAwsRegion' => '

The region authorized to collect aggregated data.

', 'ResourceCountFilters$Region' => '

The region where the account is located.

', 'ResourceFilters$Region' => '

The source region.

', ], ], 'BaseConfigurationItem' => [ 'base' => '

The detailed configurations of a specified resource.

', 'refs' => [ 'BaseConfigurationItems$member' => NULL, ], ], 'BaseConfigurationItems' => [ 'base' => NULL, 'refs' => [ 'BatchGetAggregateResourceConfigResponse$BaseConfigurationItems' => '

A list that contains the current configuration of one or more resources.

', 'BatchGetResourceConfigResponse$baseConfigurationItems' => '

A list that contains the current configuration of one or more resources.

', ], ], 'BaseResourceId' => [ 'base' => NULL, 'refs' => [ 'ComplianceByResource$ResourceId' => '

The ID of the Amazon Web Services resource that was evaluated.

', 'DescribeComplianceByResourceRequest$ResourceId' => '

The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

', 'Evaluation$ComplianceResourceId' => '

The ID of the Amazon Web Services resource that was evaluated.

', 'EvaluationResultQualifier$ResourceId' => '

The ID of the evaluated Amazon Web Services resource.

', 'ExternalEvaluation$ComplianceResourceId' => '

The evaluated compliance resource ID. Config accepts only Amazon Web Services account ID.

', 'GetComplianceDetailsByResourceRequest$ResourceId' => '

The ID of the Amazon Web Services resource for which you want compliance information.

', 'ResourceDetails$ResourceId' => '

A unique resource ID for an evaluation.

', 'Scope$ComplianceResourceId' => '

The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

', ], ], 'BatchGetAggregateResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetAggregateResourceConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetResourceConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AccountAggregationSource$AllAwsRegions' => '

If true, aggregate existing Config regions and future regions.

', 'ComplianceContributorCount$CapExceeded' => '

Indicates whether the maximum count is reached.

', 'ConfigRuleEvaluationStatus$FirstEvaluationStarted' => '

Indicates whether Config has evaluated your resources against the rule at least once.

', 'ConfigurationRecorderStatus$recording' => '

Specifies whether or not the recorder is currently recording.

', 'CustomPolicyDetails$EnableDebugLogDelivery' => '

The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is false.

', 'ListDiscoveredResourcesRequest$includeDeletedResources' => '

Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included.

', 'OrganizationAggregationSource$AllAwsRegions' => '

If true, aggregate existing Config regions and future regions.

', 'PutEvaluationsRequest$TestMode' => '

Use this parameter to specify a test run for PutEvaluations. You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur to your existing evaluations, and evaluation results are not sent to Config.

When TestMode is true, PutEvaluations doesn\'t require a valid value for the ResultToken parameter, but the value cannot be null.

', 'RemediationConfiguration$Automatic' => '

The remediation is triggered automatically.

', ], ], 'ChannelName' => [ 'base' => NULL, 'refs' => [ 'DeleteDeliveryChannelRequest$DeliveryChannelName' => '

The name of the delivery channel to delete.

', 'DeliverConfigSnapshotRequest$deliveryChannelName' => '

The name of the delivery channel through which the snapshot is delivered.

', 'DeliveryChannel$name' => '

The name of the delivery channel. By default, Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

', 'DeliveryChannelNameList$member' => NULL, ], ], 'ChronologicalOrder' => [ 'base' => NULL, 'refs' => [ 'GetResourceConfigHistoryRequest$chronologicalOrder' => '

The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'StartResourceEvaluationRequest$ClientToken' => '

A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

', ], ], 'Compliance' => [ 'base' => '

Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

', 'refs' => [ 'AggregateComplianceByConfigRule$Compliance' => '

Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

', 'ComplianceByConfigRule$Compliance' => '

Indicates whether the Config rule is compliant.

', 'ComplianceByResource$Compliance' => '

Indicates whether the Amazon Web Services resource complies with all of the Config rules that evaluated it.

', ], ], 'ComplianceByConfigRule' => [ 'base' => '

Indicates whether an Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it. A rule is noncompliant if any of these resources do not comply.

', 'refs' => [ 'ComplianceByConfigRules$member' => NULL, ], ], 'ComplianceByConfigRules' => [ 'base' => NULL, 'refs' => [ 'DescribeComplianceByConfigRuleResponse$ComplianceByConfigRules' => '

Indicates whether each of the specified Config rules is compliant.

', ], ], 'ComplianceByResource' => [ 'base' => '

Indicates whether an Amazon Web Services resource that is evaluated according to one or more Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

', 'refs' => [ 'ComplianceByResources$member' => NULL, ], ], 'ComplianceByResources' => [ 'base' => NULL, 'refs' => [ 'DescribeComplianceByResourceResponse$ComplianceByResources' => '

Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.

', ], ], 'ComplianceContributorCount' => [ 'base' => '

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item, up to a maximum number.

', 'refs' => [ 'Compliance$ComplianceContributorCount' => '

The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

', 'ComplianceSummary$CompliantResourceCount' => '

The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

', 'ComplianceSummary$NonCompliantResourceCount' => '

The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

', ], ], 'ComplianceResourceTypes' => [ 'base' => NULL, 'refs' => [ 'Scope$ComplianceResourceTypes' => '

The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

', ], ], 'ComplianceScore' => [ 'base' => NULL, 'refs' => [ 'ConformancePackComplianceScore$Score' => '

Compliance score for the conformance pack. Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA.

', ], ], 'ComplianceSummariesByResourceType' => [ 'base' => NULL, 'refs' => [ 'GetComplianceSummaryByResourceTypeResponse$ComplianceSummariesByResourceType' => '

The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.

', ], ], 'ComplianceSummary' => [ 'base' => '

The number of Config rules or Amazon Web Services resources that are compliant and noncompliant.

', 'refs' => [ 'AggregateComplianceCount$ComplianceSummary' => '

The number of compliant and noncompliant Config rules.

', 'ComplianceSummaryByResourceType$ComplianceSummary' => '

The number of Amazon Web Services resources that are compliant or noncompliant, up to a maximum of 100 for each.

', 'GetComplianceSummaryByConfigRuleResponse$ComplianceSummary' => '

The number of Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.

', ], ], 'ComplianceSummaryByResourceType' => [ 'base' => '

The number of Amazon Web Services resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each.

', 'refs' => [ 'ComplianceSummariesByResourceType$member' => NULL, ], ], 'ComplianceType' => [ 'base' => NULL, 'refs' => [ 'AggregateEvaluationResult$ComplianceType' => '

The resource compliance status.

For the AggregationEvaluationResult data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

', 'Compliance$ComplianceType' => '

Indicates whether an Amazon Web Services resource or Config rule is compliant.

A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.

Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.

For the Compliance data type, Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.

', 'ComplianceTypes$member' => NULL, 'ConfigRuleComplianceFilters$ComplianceType' => '

The rule compliance status.

For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.

', 'Evaluation$ComplianceType' => '

Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

For the Evaluation data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

', 'EvaluationResult$ComplianceType' => '

Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

For the EvaluationResult data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

', 'ExternalEvaluation$ComplianceType' => '

The compliance of the Amazon Web Services resource. The valid values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$ComplianceType' => '

The resource compliance status.

For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

', 'GetResourceEvaluationSummaryResponse$Compliance' => '

The compliance status of the resource evaluation summary.

', ], ], 'ComplianceTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeComplianceByConfigRuleRequest$ComplianceTypes' => '

Filters the results by compliance.

', 'DescribeComplianceByResourceRequest$ComplianceTypes' => '

Filters the results by compliance.

', 'GetComplianceDetailsByConfigRuleRequest$ComplianceTypes' => '

Filters the results by compliance.

INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.

', 'GetComplianceDetailsByResourceRequest$ComplianceTypes' => '

Filters the results by compliance.

INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.

', ], ], 'ConfigExportDeliveryInfo' => [ 'base' => '

Provides status of the delivery of the snapshot or the configuration history to the specified Amazon S3 bucket. Also provides the status of notifications about the Amazon S3 delivery to the specified Amazon SNS topic.

', 'refs' => [ 'DeliveryChannelStatus$configSnapshotDeliveryInfo' => '

A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.

', 'DeliveryChannelStatus$configHistoryDeliveryInfo' => '

A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.

', ], ], 'ConfigRule' => [ 'base' => '

Config rules evaluate the configuration settings of your Amazon Web Services resources. A rule can run when Config detects a configuration change to an Amazon Web Services resource or at a periodic frequency that you choose (for example, every 24 hours). There are two types of rules: Config Managed Rules and Config Custom Rules.

Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules.

Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.

For more information about developing and using Config rules, see Evaluating Resource with Config Rules in the Config Developer Guide.

You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

', 'refs' => [ 'ConfigRules$member' => NULL, 'PutConfigRuleRequest$ConfigRule' => '

The rule that you want to add to your account.

', ], ], 'ConfigRuleComplianceFilters' => [ 'base' => '

Filters the compliance results based on account ID, region, compliance type, and rule name.

', 'refs' => [ 'DescribeAggregateComplianceByConfigRulesRequest$Filters' => '

Filters the results by ConfigRuleComplianceFilters object.

', ], ], 'ConfigRuleComplianceSummaryFilters' => [ 'base' => '

Filters the results based on the account IDs and regions.

', 'refs' => [ 'GetAggregateConfigRuleComplianceSummaryRequest$Filters' => '

Filters the results based on the ConfigRuleComplianceSummaryFilters object.

', ], ], 'ConfigRuleComplianceSummaryGroupKey' => [ 'base' => NULL, 'refs' => [ 'GetAggregateConfigRuleComplianceSummaryRequest$GroupByKey' => '

Groups the result based on ACCOUNT_ID or AWS_REGION.

', ], ], 'ConfigRuleEvaluationStatus' => [ 'base' => '

Status information for your Config Managed rules and Config Custom Policy rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.

This action does not return status information about Config Custom Lambda rules.

', 'refs' => [ 'ConfigRuleEvaluationStatusList$member' => NULL, ], ], 'ConfigRuleEvaluationStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigRuleEvaluationStatusResponse$ConfigRulesEvaluationStatus' => '

Status information about your Config managed rules.

', ], ], 'ConfigRuleName' => [ 'base' => NULL, 'refs' => [ 'AggregateComplianceByConfigRule$ConfigRuleName' => '

The name of the Config rule.

', 'ConfigRule$ConfigRuleName' => '

The name that you assign to the Config rule. The name is required if you are adding a new rule.

', 'ConfigRuleComplianceFilters$ConfigRuleName' => '

The name of the Config rule.

', 'ConfigRuleEvaluationStatus$ConfigRuleName' => '

The name of the Config rule.

', 'ConfigRuleNames$member' => NULL, 'ConformancePackRuleCompliance$ConfigRuleName' => '

Name of the Config rule.

', 'DeleteConfigRuleRequest$ConfigRuleName' => '

The name of the Config rule that you want to delete.

', 'DeleteRemediationConfigurationRequest$ConfigRuleName' => '

The name of the Config rule for which you want to delete remediation configuration.

', 'DeleteRemediationExceptionsRequest$ConfigRuleName' => '

The name of the Config rule for which you want to delete remediation exception configuration.

', 'DescribeRemediationExceptionsRequest$ConfigRuleName' => '

The name of the Config rule.

', 'DescribeRemediationExecutionStatusRequest$ConfigRuleName' => '

A list of Config rule names.

', 'EvaluationResultQualifier$ConfigRuleName' => '

The name of the Config rule that was used in the evaluation.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$ConfigRuleName' => '

The name of the Config rule for which you want compliance information.

', 'GetCustomRulePolicyRequest$ConfigRuleName' => '

The name of your Config Custom Policy rule.

', 'PutExternalEvaluationRequest$ConfigRuleName' => '

The name of the Config rule.

', 'PutRemediationExceptionsRequest$ConfigRuleName' => '

The name of the Config rule for which you want to create remediation exception.

', 'ReevaluateConfigRuleNames$member' => NULL, 'RemediationConfiguration$ConfigRuleName' => '

The name of the Config rule.

', 'RemediationException$ConfigRuleName' => '

The name of the Config rule.

', 'StartRemediationExecutionRequest$ConfigRuleName' => '

The list of names of Config rules that you want to run remediation execution for.

', ], ], 'ConfigRuleNames' => [ 'base' => NULL, 'refs' => [ 'DescribeComplianceByConfigRuleRequest$ConfigRuleNames' => '

Specify one or more Config rule names to filter the results by rule.

', 'DescribeConfigRuleEvaluationStatusRequest$ConfigRuleNames' => '

The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use.

', 'DescribeConfigRulesRequest$ConfigRuleNames' => '

The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

', 'DescribeRemediationConfigurationsRequest$ConfigRuleNames' => '

A list of Config rule names of remediation configurations for which you want details.

', ], ], 'ConfigRuleState' => [ 'base' => NULL, 'refs' => [ 'ConfigRule$ConfigRuleState' => '

Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.

Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.

Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

', ], ], 'ConfigRules' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigRulesResponse$ConfigRules' => '

The details about your Config rules.

', ], ], 'ConfigSnapshotDeliveryProperties' => [ 'base' => '

Provides options for how often Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.

The frequency for a rule that triggers evaluations for your resources when Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:

If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, Config invokes the rule only as often as the deliveryFrequency value.

  1. For example, you want your rule to run evaluations when Config delivers the configuration snapshot.

  2. You specify the MaximumExecutionFrequency value for Six_Hours.

  3. You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours.

  4. Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, Config invokes evaluations for the rule every 24 hours.

You should set the MaximumExecutionFrequency value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action.

To update the deliveryFrequency with which Config delivers your configuration snapshots, use the PutDeliveryChannel action.

', 'refs' => [ 'DeliveryChannel$configSnapshotDeliveryProperties' => '

The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

', ], ], 'ConfigStreamDeliveryInfo' => [ 'base' => '

A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.

', 'refs' => [ 'DeliveryChannelStatus$configStreamDeliveryInfo' => '

A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.

', ], ], 'Configuration' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$configuration' => '

The description of the resource configuration.

', 'ConfigurationItem$configuration' => '

The description of the resource configuration.

', 'PutResourceConfigRequest$Configuration' => '

The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.

The configuration JSON must not exceed 64 KB.

', ], ], 'ConfigurationAggregator' => [ 'base' => '

The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.

', 'refs' => [ 'ConfigurationAggregatorList$member' => NULL, 'PutConfigurationAggregatorResponse$ConfigurationAggregator' => '

Returns a ConfigurationAggregator object.

', ], ], 'ConfigurationAggregatorArn' => [ 'base' => NULL, 'refs' => [ 'ConfigurationAggregator$ConfigurationAggregatorArn' => '

The Amazon Resource Name (ARN) of the aggregator.

', ], ], 'ConfigurationAggregatorList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationAggregatorsResponse$ConfigurationAggregators' => '

Returns a ConfigurationAggregators object.

', ], ], 'ConfigurationAggregatorName' => [ 'base' => NULL, 'refs' => [ 'BatchGetAggregateResourceConfigRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'ConfigurationAggregator$ConfigurationAggregatorName' => '

The name of the aggregator.

', 'ConfigurationAggregatorNameList$member' => NULL, 'DeleteConfigurationAggregatorRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'DescribeAggregateComplianceByConfigRulesRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'DescribeAggregateComplianceByConformancePacksRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'DescribeConfigurationAggregatorSourcesStatusRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'GetAggregateConfigRuleComplianceSummaryRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'GetAggregateConformancePackComplianceSummaryRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'GetAggregateDiscoveredResourceCountsRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'GetAggregateResourceConfigRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'ListAggregateDiscoveredResourcesRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'PutConfigurationAggregatorRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', 'SelectAggregateResourceConfigRequest$ConfigurationAggregatorName' => '

The name of the configuration aggregator.

', ], ], 'ConfigurationAggregatorNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationAggregatorsRequest$ConfigurationAggregatorNames' => '

The name of the configuration aggregators.

', ], ], 'ConfigurationItem' => [ 'base' => '

A list that contains detailed configurations of a specified resource.

', 'refs' => [ 'ConfigurationItemList$member' => NULL, 'GetAggregateResourceConfigResponse$ConfigurationItem' => '

Returns a ConfigurationItem object.

', ], ], 'ConfigurationItemCaptureTime' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$configurationItemCaptureTime' => '

The time when the recording of configuration changes was initiated for the resource.

', 'ConfigurationItem$configurationItemCaptureTime' => '

The time when the recording of configuration changes was initiated for the resource.

', ], ], 'ConfigurationItemDeliveryTime' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$configurationItemDeliveryTime' => '

The time when configuration changes for the resource were delivered.

', 'ConfigurationItem$configurationItemDeliveryTime' => '

The time when configuration changes for the resource were delivered.

', ], ], 'ConfigurationItemList' => [ 'base' => NULL, 'refs' => [ 'GetResourceConfigHistoryResponse$configurationItems' => '

A list that contains the configuration history of one or more resources.

', ], ], 'ConfigurationItemMD5Hash' => [ 'base' => NULL, 'refs' => [ 'ConfigurationItem$configurationItemMD5Hash' => '

Unique MD5 hash that represents the configuration item\'s state.

You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

', ], ], 'ConfigurationItemStatus' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$configurationItemStatus' => '

The configuration item status. Valid values include:

', 'ConfigurationItem$configurationItemStatus' => '

The configuration item status. Valid values include:

', ], ], 'ConfigurationRecorder' => [ 'base' => '

Records configuration changes to your specified resource types. For more information about the configuration recorder, see Managing the Configuration Recorder in the Config Developer Guide.

', 'refs' => [ 'ConfigurationRecorderList$member' => NULL, 'PutConfigurationRecorderRequest$ConfigurationRecorder' => '

An object for the configuration recorder to record configuration changes for specified resource types.

', ], ], 'ConfigurationRecorderList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationRecordersResponse$ConfigurationRecorders' => '

A list that contains the descriptions of the specified configuration recorders.

', ], ], 'ConfigurationRecorderNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationRecorderStatusRequest$ConfigurationRecorderNames' => '

The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.

', 'DescribeConfigurationRecordersRequest$ConfigurationRecorderNames' => '

A list of configuration recorder names.

', ], ], 'ConfigurationRecorderStatus' => [ 'base' => '

The current status of the configuration recorder.

For a detailed status of recording events over time, add your Config events to CloudWatch metrics and use CloudWatch metrics.

', 'refs' => [ 'ConfigurationRecorderStatusList$member' => NULL, ], ], 'ConfigurationRecorderStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigurationRecorderStatusResponse$ConfigurationRecordersStatus' => '

A list that contains status of the specified recorders.

', ], ], 'ConfigurationStateId' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$configurationStateId' => '

An identifier that indicates the ordering of the configuration items of a resource.

', 'ConfigurationItem$configurationStateId' => '

An identifier that indicates the ordering of the configuration items of a resource.

', ], ], 'ConformancePackArn' => [ 'base' => NULL, 'refs' => [ 'ConformancePackDetail$ConformancePackArn' => '

Amazon Resource Name (ARN) of the conformance pack.

', 'ConformancePackStatusDetail$ConformancePackArn' => '

Amazon Resource Name (ARN) of comformance pack.

', 'PutConformancePackResponse$ConformancePackArn' => '

ARN of the conformance pack.

', ], ], 'ConformancePackComplianceFilters' => [ 'base' => '

Filters the conformance pack by compliance types and Config rule names.

', 'refs' => [ 'DescribeConformancePackComplianceRequest$Filters' => '

A ConformancePackComplianceFilters object.

', ], ], 'ConformancePackComplianceResourceIds' => [ 'base' => NULL, 'refs' => [ 'ConformancePackEvaluationFilters$ResourceIds' => '

Filters the results by resource IDs.

This is valid only when you provide resource type. If there is no resource type, you will see an error.

', ], ], 'ConformancePackComplianceScore' => [ 'base' => '

A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.

', 'refs' => [ 'ConformancePackComplianceScores$member' => NULL, ], ], 'ConformancePackComplianceScores' => [ 'base' => NULL, 'refs' => [ 'ListConformancePackComplianceScoresResponse$ConformancePackComplianceScores' => '

A list of ConformancePackComplianceScore objects.

', ], ], 'ConformancePackComplianceScoresFilters' => [ 'base' => '

A list of filters to apply to the conformance pack compliance score result set.

', 'refs' => [ 'ListConformancePackComplianceScoresRequest$Filters' => '

Filters the results based on the ConformancePackComplianceScoresFilters.

', ], ], 'ConformancePackComplianceSummary' => [ 'base' => '

Summary includes the name and status of the conformance pack.

', 'refs' => [ 'ConformancePackComplianceSummaryList$member' => NULL, ], ], 'ConformancePackComplianceSummaryList' => [ 'base' => NULL, 'refs' => [ 'GetConformancePackComplianceSummaryResponse$ConformancePackComplianceSummaryList' => '

A list of ConformancePackComplianceSummary objects.

', ], ], 'ConformancePackComplianceType' => [ 'base' => NULL, 'refs' => [ 'AggregateConformancePackCompliance$ComplianceType' => '

The compliance status of the conformance pack.

', 'AggregateConformancePackComplianceFilters$ComplianceType' => '

The compliance status of the conformance pack.

', 'ConformancePackComplianceFilters$ComplianceType' => '

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

', 'ConformancePackComplianceSummary$ConformancePackComplianceStatus' => '

The status of the conformance pack.

', 'ConformancePackEvaluationFilters$ComplianceType' => '

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

', 'ConformancePackEvaluationResult$ComplianceType' => '

The compliance type. The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

', 'ConformancePackRuleCompliance$ComplianceType' => '

Compliance of the Config rule.

', ], ], 'ConformancePackConfigRuleNames' => [ 'base' => NULL, 'refs' => [ 'ConformancePackComplianceFilters$ConfigRuleNames' => '

Filters the results by Config rule names.

', 'ConformancePackEvaluationFilters$ConfigRuleNames' => '

Filters the results by Config rule names.

', ], ], 'ConformancePackDetail' => [ 'base' => '

Returns details of a conformance pack. A conformance pack is a collection of Config rules and remediation actions that can be easily deployed in an account and a region.

', 'refs' => [ 'ConformancePackDetailList$member' => NULL, ], ], 'ConformancePackDetailList' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePacksResponse$ConformancePackDetails' => '

Returns a list of ConformancePackDetail objects.

', ], ], 'ConformancePackEvaluationFilters' => [ 'base' => '

Filters a conformance pack by Config rule names, compliance types, Amazon Web Services resource types, and resource IDs.

', 'refs' => [ 'GetConformancePackComplianceDetailsRequest$Filters' => '

A ConformancePackEvaluationFilters object.

', ], ], 'ConformancePackEvaluationResult' => [ 'base' => '

The details of a conformance pack evaluation. Provides Config rule and Amazon Web Services resource type that was evaluated, the compliance of the conformance pack, related time stamps, and supplementary information.

', 'refs' => [ 'ConformancePackRuleEvaluationResultsList$member' => NULL, ], ], 'ConformancePackId' => [ 'base' => NULL, 'refs' => [ 'ConformancePackDetail$ConformancePackId' => '

ID of the conformance pack.

', 'ConformancePackStatusDetail$ConformancePackId' => '

ID of the conformance pack.

', ], ], 'ConformancePackInputParameter' => [ 'base' => '

Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.

', 'refs' => [ 'ConformancePackInputParameters$member' => NULL, ], ], 'ConformancePackInputParameters' => [ 'base' => NULL, 'refs' => [ 'ConformancePackDetail$ConformancePackInputParameters' => '

A list of ConformancePackInputParameter objects.

', 'OrganizationConformancePack$ConformancePackInputParameters' => '

A list of ConformancePackInputParameter objects.

', 'PutConformancePackRequest$ConformancePackInputParameters' => '

A list of ConformancePackInputParameter objects.

', 'PutOrganizationConformancePackRequest$ConformancePackInputParameters' => '

A list of ConformancePackInputParameter objects.

', ], ], 'ConformancePackName' => [ 'base' => NULL, 'refs' => [ 'AggregateComplianceByConformancePack$ConformancePackName' => '

The name of the conformance pack.

', 'AggregateConformancePackComplianceFilters$ConformancePackName' => '

The name of the conformance pack.

', 'ConformancePackComplianceScore$ConformancePackName' => '

The name of the conformance pack.

', 'ConformancePackComplianceSummary$ConformancePackName' => '

The name of the conformance pack name.

', 'ConformancePackDetail$ConformancePackName' => '

Name of the conformance pack.

', 'ConformancePackNameFilter$member' => NULL, 'ConformancePackNamesList$member' => NULL, 'ConformancePackNamesToSummarizeList$member' => NULL, 'ConformancePackStatusDetail$ConformancePackName' => '

Name of the conformance pack.

', 'DeleteConformancePackRequest$ConformancePackName' => '

Name of the conformance pack you want to delete.

', 'DescribeConformancePackComplianceRequest$ConformancePackName' => '

Name of the conformance pack.

', 'DescribeConformancePackComplianceResponse$ConformancePackName' => '

Name of the conformance pack.

', 'GetConformancePackComplianceDetailsRequest$ConformancePackName' => '

Name of the conformance pack.

', 'GetConformancePackComplianceDetailsResponse$ConformancePackName' => '

Name of the conformance pack.

', 'PutConformancePackRequest$ConformancePackName' => '

The unique name of the conformance pack you want to deploy.

', ], ], 'ConformancePackNameFilter' => [ 'base' => NULL, 'refs' => [ 'ConformancePackComplianceScoresFilters$ConformancePackNames' => '

The names of the conformance packs whose compliance scores you want to include in the conformance pack compliance score result set. You can include up to 25 conformance packs in the ConformancePackNames array of strings, each with a character limit of 256 characters for the conformance pack name.

', ], ], 'ConformancePackNamesList' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePackStatusRequest$ConformancePackNames' => '

Comma-separated list of conformance pack names.

', 'DescribeConformancePacksRequest$ConformancePackNames' => '

Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs.

', ], ], 'ConformancePackNamesToSummarizeList' => [ 'base' => NULL, 'refs' => [ 'GetConformancePackComplianceSummaryRequest$ConformancePackNames' => '

Names of conformance packs.

', ], ], 'ConformancePackRuleCompliance' => [ 'base' => '

Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.

', 'refs' => [ 'ConformancePackRuleComplianceList$member' => NULL, ], ], 'ConformancePackRuleComplianceList' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePackComplianceResponse$ConformancePackRuleComplianceList' => '

Returns a list of ConformancePackRuleCompliance objects.

', ], ], 'ConformancePackRuleEvaluationResultsList' => [ 'base' => NULL, 'refs' => [ 'GetConformancePackComplianceDetailsResponse$ConformancePackRuleEvaluationResults' => '

Returns a list of ConformancePackEvaluationResult objects.

', ], ], 'ConformancePackState' => [ 'base' => NULL, 'refs' => [ 'ConformancePackStatusDetail$ConformancePackState' => '

Indicates deployment status of conformance pack.

Config sets the state of the conformance pack to:

', ], ], 'ConformancePackStatusDetail' => [ 'base' => '

Status details of a conformance pack.

', 'refs' => [ 'ConformancePackStatusDetailsList$member' => NULL, ], ], 'ConformancePackStatusDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePackStatusResponse$ConformancePackStatusDetails' => '

A list of ConformancePackStatusDetail objects.

', ], ], 'ConformancePackStatusReason' => [ 'base' => NULL, 'refs' => [ 'ConformancePackStatusDetail$ConformancePackStatusReason' => '

The reason of conformance pack creation failure.

', ], ], 'ConformancePackTemplateValidationException' => [ 'base' => '

You have specified a template that is not valid or supported.

', 'refs' => [], ], 'ControlsList' => [ 'base' => NULL, 'refs' => [ 'ConformancePackRuleCompliance$Controls' => '

Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.

', ], ], 'CosmosPageLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConfigRuleStatusesRequest$Limit' => '

The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

', 'DescribeOrganizationConfigRulesRequest$Limit' => '

The maximum number of organization Config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.

', 'DescribeOrganizationConformancePackStatusesRequest$Limit' => '

The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

', 'DescribeOrganizationConformancePacksRequest$Limit' => '

The maximum number of organization config packs returned on each page. If you do no specify a number, Config uses the default. The default is 100.

', 'GetOrganizationConfigRuleDetailedStatusRequest$Limit' => '

The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not specify a number, Config uses the default. The default is 100.

', 'GetOrganizationConformancePackDetailedStatusRequest$Limit' => '

The maximum number of OrganizationConformancePackDetailedStatuses returned on each page. If you do not specify a number, Config uses the default. The default is 100.

', ], ], 'CustomPolicyDetails' => [ 'base' => '

Provides the runtime system, policy definition, and whether debug logging enabled. You can specify the following CustomPolicyDetails parameter values only for Config Custom Policy rules.

', 'refs' => [ 'Source$CustomPolicyDetails' => '

Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to CUSTOM_POLICY.

', ], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'AggregateEvaluationResult$ResultRecordedTime' => '

The time when Config recorded the aggregate evaluation result.

', 'AggregateEvaluationResult$ConfigRuleInvokedTime' => '

The time when the Config rule evaluated the Amazon Web Services resource.

', 'AggregatedSourceStatus$LastUpdateTime' => '

The time of the last update.

', 'AggregationAuthorization$CreationTime' => '

The time stamp when the aggregation authorization was created.

', 'ComplianceSummary$ComplianceSummaryTimestamp' => '

The time that Config created the compliance summary.

', 'ConfigExportDeliveryInfo$lastAttemptTime' => '

The time of the last attempted delivery.

', 'ConfigExportDeliveryInfo$lastSuccessfulTime' => '

The time of the last successful delivery.

', 'ConfigExportDeliveryInfo$nextDeliveryTime' => '

The time that the next delivery occurs.

', 'ConfigRuleEvaluationStatus$LastSuccessfulInvocationTime' => '

The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.

', 'ConfigRuleEvaluationStatus$LastFailedInvocationTime' => '

The time that Config last failed to invoke the Config rule to evaluate your Amazon Web Services resources.

', 'ConfigRuleEvaluationStatus$LastSuccessfulEvaluationTime' => '

The time that Config last successfully evaluated your Amazon Web Services resources against the rule.

', 'ConfigRuleEvaluationStatus$LastFailedEvaluationTime' => '

The time that Config last failed to evaluate your Amazon Web Services resources against the rule.

', 'ConfigRuleEvaluationStatus$FirstActivatedTime' => '

The time that you first activated the Config rule.

', 'ConfigRuleEvaluationStatus$LastDeactivatedTime' => '

The time that you last turned off the Config rule.

', 'ConfigRuleEvaluationStatus$LastDebugLogDeliveryTime' => '

The time Config last attempted to deliver a debug log for your Config Custom Policy rules.

', 'ConfigStreamDeliveryInfo$lastStatusChangeTime' => '

The time from the last status change.

', 'ConfigurationAggregator$CreationTime' => '

The time stamp when the configuration aggregator was created.

', 'ConfigurationAggregator$LastUpdatedTime' => '

The time of the last update.

', 'ConfigurationRecorderStatus$lastStartTime' => '

The time the recorder was last started.

', 'ConfigurationRecorderStatus$lastStopTime' => '

The time the recorder was last stopped.

', 'ConfigurationRecorderStatus$lastStatusChangeTime' => '

The time of the latest change in status of an recording event processed by the recorder.

', 'ConformancePackDetail$LastUpdateRequestedTime' => '

The last time a conformation pack update was requested.

', 'ConformancePackEvaluationResult$ConfigRuleInvokedTime' => '

The time when Config rule evaluated Amazon Web Services resource.

', 'ConformancePackEvaluationResult$ResultRecordedTime' => '

The time when Config recorded the evaluation result.

', 'ConformancePackStatusDetail$LastUpdateRequestedTime' => '

Last time when conformation pack creation and update was requested.

', 'ConformancePackStatusDetail$LastUpdateCompletedTime' => '

Last time when conformation pack creation and update was successful.

', 'EvaluationResult$ResultRecordedTime' => '

The time when Config recorded the evaluation result.

', 'EvaluationResult$ConfigRuleInvokedTime' => '

The time when the Config rule evaluated the Amazon Web Services resource.

', 'EvaluationResultIdentifier$OrderingTimestamp' => '

The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.

', 'GetResourceEvaluationSummaryResponse$EvaluationStartTimestamp' => '

The start timestamp when Config rule starts evaluating compliance for the provided resource details.

', 'MemberAccountStatus$LastUpdateTime' => '

The timestamp of the last status update.

', 'OrganizationConfigRule$LastUpdateTime' => '

The timestamp of the last update.

', 'OrganizationConfigRuleStatus$LastUpdateTime' => '

The timestamp of the last update.

', 'OrganizationConformancePack$LastUpdateTime' => '

Last time when organization conformation pack was updated.

', 'OrganizationConformancePackDetailedStatus$LastUpdateTime' => '

The timestamp of the last status update.

', 'OrganizationConformancePackStatus$LastUpdateTime' => '

The timestamp of the last update.

', 'PutRemediationExceptionsRequest$ExpirationTime' => '

The exception is automatically deleted after the expiration date.

', 'RemediationException$ExpirationTime' => '

The time when the remediation exception will be deleted.

', 'RemediationExecutionStatus$InvocationTime' => '

Start time when the remediation was executed.

', 'RemediationExecutionStatus$LastUpdatedTime' => '

The time when the remediation execution was last updated.

', 'RemediationExecutionStep$StartTime' => '

The time when the step started.

', 'RemediationExecutionStep$StopTime' => '

The time when the step stopped.

', 'ResourceEvaluation$EvaluationStartTimestamp' => '

The starting time of an execution.

', 'TimeWindow$StartTime' => '

The start time of an execution.

', 'TimeWindow$EndTime' => '

The end time of an execution. The end time must be after the start date.

', ], ], 'DebugLogDeliveryAccounts' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$DebugLogDeliveryAccounts' => '

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$DebugLogDeliveryAccounts' => '

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

', ], ], 'DeleteAggregationAuthorizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConfigRuleRequest' => [ 'base' => '

', 'refs' => [], ], 'DeleteConfigurationAggregatorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConfigurationRecorderRequest' => [ 'base' => '

The request object for the DeleteConfigurationRecorder action.

', 'refs' => [], ], 'DeleteConformancePackRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDeliveryChannelRequest' => [ 'base' => '

The input for the DeleteDeliveryChannel action. The action accepts the following data, in JSON format.

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

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

The output when you delete the evaluation results for the specified Config rule.

', 'refs' => [], ], 'DeleteOrganizationConfigRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOrganizationConformancePackRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePendingAggregationRequestRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRemediationConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRemediationConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRemediationExceptionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRemediationExceptionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetentionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStoredQueryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStoredQueryResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeliverConfigSnapshotRequest' => [ 'base' => '

The input for the DeliverConfigSnapshot action.

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

The output for the DeliverConfigSnapshot action, in JSON format.

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

The channel through which Config delivers notifications and updated configuration states.

', 'refs' => [ 'DeliveryChannelList$member' => NULL, 'PutDeliveryChannelRequest$DeliveryChannel' => '

The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.

', ], ], 'DeliveryChannelList' => [ 'base' => NULL, 'refs' => [ 'DescribeDeliveryChannelsResponse$DeliveryChannels' => '

A list that contains the descriptions of the specified delivery channel.

', ], ], 'DeliveryChannelNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeDeliveryChannelStatusRequest$DeliveryChannelNames' => '

A list of delivery channel names.

', 'DescribeDeliveryChannelsRequest$DeliveryChannelNames' => '

A list of delivery channel names.

', ], ], 'DeliveryChannelStatus' => [ 'base' => '

The status of a specified delivery channel.

Valid values: Success | Failure

', 'refs' => [ 'DeliveryChannelStatusList$member' => NULL, ], ], 'DeliveryChannelStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeDeliveryChannelStatusResponse$DeliveryChannelsStatus' => '

A list that contains the status of a specified delivery channel.

', ], ], 'DeliveryS3Bucket' => [ 'base' => NULL, 'refs' => [ 'ConformancePackDetail$DeliveryS3Bucket' => '

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

', 'OrganizationConformancePack$DeliveryS3Bucket' => '

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

', 'PutConformancePackRequest$DeliveryS3Bucket' => '

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

', 'PutOrganizationConformancePackRequest$DeliveryS3Bucket' => '

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional. If used, it must be prefixed with awsconfigconforms.

', ], ], 'DeliveryS3KeyPrefix' => [ 'base' => NULL, 'refs' => [ 'ConformancePackDetail$DeliveryS3KeyPrefix' => '

The prefix for the Amazon S3 bucket.

This field is optional.

', 'OrganizationConformancePack$DeliveryS3KeyPrefix' => '

Any folder structure you want to add to an Amazon S3 bucket.

This field is optional.

', 'PutConformancePackRequest$DeliveryS3KeyPrefix' => '

The prefix for the Amazon S3 bucket.

This field is optional.

', 'PutOrganizationConformancePackRequest$DeliveryS3KeyPrefix' => '

The prefix for the Amazon S3 bucket.

This field is optional.

', ], ], 'DeliveryStatus' => [ 'base' => NULL, 'refs' => [ 'ConfigExportDeliveryInfo$lastStatus' => '

Status of the last attempted delivery.

', 'ConfigStreamDeliveryInfo$lastStatus' => '

Status of the last attempted delivery.

Note Providing an SNS topic on a DeliveryChannel for Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.

', ], ], 'DescribeAggregateComplianceByConfigRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAggregateComplianceByConfigRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAggregateComplianceByConformancePacksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAggregateComplianceByConformancePacksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAggregationAuthorizationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAggregationAuthorizationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeComplianceByConfigRuleRequest' => [ 'base' => '

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

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

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

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

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

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

Returns a filtered list of Detective or Proactive Config rules. By default, if the filter is not defined, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.

', 'refs' => [ 'DescribeConfigRulesRequest$Filters' => '

Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.

', ], ], 'DescribeConfigRulesRequest' => [ 'base' => '

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

', 'refs' => [], ], 'DescribeConfigurationAggregatorSourcesStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationAggregatorSourcesStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationAggregatorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationAggregatorsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConfigurationRecorderStatusRequest' => [ 'base' => '

The input for the DescribeConfigurationRecorderStatus action.

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

The output for the DescribeConfigurationRecorderStatus action, in JSON format.

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

The input for the DescribeConfigurationRecorders action.

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

The output for the DescribeConfigurationRecorders action.

', 'refs' => [], ], 'DescribeConformancePackComplianceLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePackComplianceRequest$Limit' => '

The maximum number of Config rules within a conformance pack are returned on each page.

', ], ], 'DescribeConformancePackComplianceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConformancePackComplianceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConformancePackStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConformancePackStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConformancePacksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConformancePacksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeliveryChannelStatusRequest' => [ 'base' => '

The input for the DeliveryChannelStatus action.

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

The output for the DescribeDeliveryChannelStatus action.

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

The input for the DescribeDeliveryChannels action.

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

The output for the DescribeDeliveryChannels action.

', 'refs' => [], ], 'DescribeOrganizationConfigRuleStatusesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConfigRuleStatusesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConfigRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConfigRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConformancePackStatusesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConformancePackStatusesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConformancePacksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationConformancePacksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePendingAggregationRequestsLimit' => [ 'base' => NULL, 'refs' => [ 'DescribePendingAggregationRequestsRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

', ], ], 'DescribePendingAggregationRequestsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePendingAggregationRequestsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationExceptionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationExceptionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationExecutionStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRemediationExecutionStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRetentionConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRetentionConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'RecordingModeOverride$description' => '

A description that you provide for the override.

', ], ], 'DiscoveredResourceIdentifierList' => [ 'base' => NULL, 'refs' => [ 'ListAggregateDiscoveredResourcesResponse$ResourceIdentifiers' => '

Returns a list of ResourceIdentifiers objects.

', ], ], 'EarlierTime' => [ 'base' => NULL, 'refs' => [ 'GetResourceConfigHistoryRequest$earlierTime' => '

The chronologically earliest time in the time range for which the history requested. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.

', ], ], 'EmptiableStringWithCharLimit256' => [ 'base' => NULL, 'refs' => [ 'ConfigRule$Description' => '

The description that you provide for the Config rule.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ResourceConcurrentModificationException$message' => NULL, ], ], 'Evaluation' => [ 'base' => '

Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.

', 'refs' => [ 'Evaluations$member' => NULL, ], ], 'EvaluationContext' => [ 'base' => '

Use EvaluationContext to group independently initiated proactive resource evaluations. For example, CFN Stack. If you want to check just a resource definition, you do not need to provide evaluation context.

', 'refs' => [ 'GetResourceEvaluationSummaryResponse$EvaluationContext' => '

Returns an EvaluationContext object.

', 'StartResourceEvaluationRequest$EvaluationContext' => '

Returns an EvaluationContext object.

', ], ], 'EvaluationContextIdentifier' => [ 'base' => NULL, 'refs' => [ 'EvaluationContext$EvaluationContextIdentifier' => '

A unique EvaluationContextIdentifier ID for an EvaluationContext.

', 'ResourceEvaluationFilters$EvaluationContextIdentifier' => '

Filters evaluations for a given infrastructure deployment. For example: CFN Stack.

', ], ], 'EvaluationMode' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigRulesFilters$EvaluationMode' => '

The mode of an evaluation. The valid values are Detective or Proactive.

', 'EvaluationModeConfiguration$Mode' => '

The mode of an evaluation. The valid values are Detective or Proactive.

', 'EvaluationResultQualifier$EvaluationMode' => '

The mode of an evaluation. The valid values are Detective or Proactive.

', 'GetResourceEvaluationSummaryResponse$EvaluationMode' => '

Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.

', 'ResourceEvaluation$EvaluationMode' => '

The mode of an evaluation. The valid values are Detective or Proactive.

', 'ResourceEvaluationFilters$EvaluationMode' => '

Filters all resource evaluations results based on an evaluation mode. the valid value for this API is Proactive.

', 'StartResourceEvaluationRequest$EvaluationMode' => '

The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE.

', ], ], 'EvaluationModeConfiguration' => [ 'base' => '

The configuration object for Config rule evaluation mode. The supported valid values are Detective or Proactive.

', 'refs' => [ 'EvaluationModes$member' => NULL, ], ], 'EvaluationModes' => [ 'base' => NULL, 'refs' => [ 'ConfigRule$EvaluationModes' => '

The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.

', ], ], 'EvaluationResult' => [ 'base' => '

The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

', 'refs' => [ 'EvaluationResults$member' => NULL, ], ], 'EvaluationResultIdentifier' => [ 'base' => '

Uniquely identifies an evaluation result.

', 'refs' => [ 'AggregateEvaluationResult$EvaluationResultIdentifier' => '

Uniquely identifies the evaluation result.

', 'ConformancePackEvaluationResult$EvaluationResultIdentifier' => NULL, 'EvaluationResult$EvaluationResultIdentifier' => '

Uniquely identifies the evaluation result.

', ], ], 'EvaluationResultQualifier' => [ 'base' => '

Identifies an Config rule that evaluated an Amazon Web Services resource, and provides the type and ID of the resource that the rule evaluated.

', 'refs' => [ 'EvaluationResultIdentifier$EvaluationResultQualifier' => '

Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.

', ], ], 'EvaluationResults' => [ 'base' => NULL, 'refs' => [ 'GetComplianceDetailsByConfigRuleResponse$EvaluationResults' => '

Indicates whether the Amazon Web Services resource complies with the specified Config rule.

', 'GetComplianceDetailsByResourceResponse$EvaluationResults' => '

Indicates whether the specified Amazon Web Services resource complies each Config rule.

', ], ], 'EvaluationStatus' => [ 'base' => '

Returns status details of an evaluation.

', 'refs' => [ 'GetResourceEvaluationSummaryResponse$EvaluationStatus' => '

Returns an EvaluationStatus object.

', ], ], 'EvaluationTimeout' => [ 'base' => NULL, 'refs' => [ 'StartResourceEvaluationRequest$EvaluationTimeout' => '

The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.

', ], ], 'Evaluations' => [ 'base' => NULL, 'refs' => [ 'PutEvaluationsRequest$Evaluations' => '

The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function.

', 'PutEvaluationsResponse$FailedEvaluations' => '

Requests that failed because of a client or server error.

', ], ], 'EventSource' => [ 'base' => NULL, 'refs' => [ 'SourceDetail$EventSource' => '

The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.

', ], ], 'ExcludedAccounts' => [ 'base' => NULL, 'refs' => [ 'OrganizationConfigRule$ExcludedAccounts' => '

A comma-separated list of accounts excluded from organization Config rule.

', 'OrganizationConformancePack$ExcludedAccounts' => '

A comma-separated list of accounts excluded from organization conformance pack.

', 'PutOrganizationConfigRuleRequest$ExcludedAccounts' => '

A comma-separated list of accounts that you want to exclude from an organization Config rule.

', 'PutOrganizationConformancePackRequest$ExcludedAccounts' => '

A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.

', ], ], 'ExclusionByResourceTypes' => [ 'base' => '

Specifies whether the configuration recorder excludes certain resource types from being recorded. Use the resourceTypes field to enter a comma-separated list of resource types you want to exclude from recording.

By default, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.

How to use the exclusion recording strategy

To use this option, you must set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES.

Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded.

Global resource types and the exclusion recording strategy

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

  • Asia Pacific (Hyderabad)

  • Asia Pacific (Melbourne)

  • Europe (Spain)

  • Europe (Zurich)

  • Israel (Tel Aviv)

  • Middle East (UAE)

', 'refs' => [ 'RecordingGroup$exclusionByResourceTypes' => '

An object that specifies how Config excludes resource types from being recorded by the configuration recorder.

Required fields

To use this option, you must set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES.

', ], ], 'ExecutionControls' => [ 'base' => '

The controls that Config uses for executing remediations.

', 'refs' => [ 'RemediationConfiguration$ExecutionControls' => '

An ExecutionControls object.

', ], ], 'Expression' => [ 'base' => NULL, 'refs' => [ 'SelectAggregateResourceConfigRequest$Expression' => '

The SQL query SELECT command.

', 'SelectResourceConfigRequest$Expression' => '

The SQL query SELECT command.

', ], ], 'ExternalEvaluation' => [ 'base' => '

Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.

', 'refs' => [ 'PutExternalEvaluationRequest$ExternalEvaluation' => '

An ExternalEvaluation object that provides details about compliance.

', ], ], 'FailedDeleteRemediationExceptionsBatch' => [ 'base' => '

List of each of the failed delete remediation exceptions with specific reasons.

', 'refs' => [ 'FailedDeleteRemediationExceptionsBatches$member' => NULL, ], ], 'FailedDeleteRemediationExceptionsBatches' => [ 'base' => NULL, 'refs' => [ 'DeleteRemediationExceptionsResponse$FailedBatches' => '

Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

', ], ], 'FailedRemediationBatch' => [ 'base' => '

List of each of the failed remediations with specific reasons.

', 'refs' => [ 'FailedRemediationBatches$member' => NULL, ], ], 'FailedRemediationBatches' => [ 'base' => NULL, 'refs' => [ 'PutRemediationConfigurationsResponse$FailedBatches' => '

Returns a list of failed remediation batch objects.

', ], ], 'FailedRemediationExceptionBatch' => [ 'base' => '

List of each of the failed remediation exceptions with specific reasons.

', 'refs' => [ 'FailedRemediationExceptionBatches$member' => NULL, ], ], 'FailedRemediationExceptionBatches' => [ 'base' => NULL, 'refs' => [ 'PutRemediationExceptionsResponse$FailedBatches' => '

Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

', ], ], 'FieldInfo' => [ 'base' => '

Details about the fields such as name of the field.

', 'refs' => [ 'FieldInfoList$member' => NULL, ], ], 'FieldInfoList' => [ 'base' => NULL, 'refs' => [ 'QueryInfo$SelectFields' => '

Returns a FieldInfo object.

', ], ], 'FieldName' => [ 'base' => NULL, 'refs' => [ 'FieldInfo$Name' => '

Name of the field.

', ], ], 'GetAggregateComplianceDetailsByConfigRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateComplianceDetailsByConfigRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateConfigRuleComplianceSummaryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateConfigRuleComplianceSummaryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateConformancePackComplianceSummaryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateConformancePackComplianceSummaryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateDiscoveredResourceCountsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateDiscoveredResourceCountsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAggregateResourceConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetComplianceDetailsByConfigRuleRequest' => [ 'base' => '

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

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

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

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

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

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

', 'refs' => [], ], 'GetConformancePackComplianceDetailsLimit' => [ 'base' => NULL, 'refs' => [ 'GetConformancePackComplianceDetailsRequest$Limit' => '

The maximum number of evaluation results returned on each page. If you do no specify a number, Config uses the default. The default is 100.

', ], ], 'GetConformancePackComplianceDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConformancePackComplianceDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConformancePackComplianceSummaryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConformancePackComplianceSummaryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomRulePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomRulePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDiscoveredResourceCountsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDiscoveredResourceCountsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationConfigRuleDetailedStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationConfigRuleDetailedStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationConformancePackDetailedStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationConformancePackDetailedStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationCustomRulePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOrganizationCustomRulePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceConfigHistoryRequest' => [ 'base' => '

The input for the GetResourceConfigHistory action.

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

The output for the GetResourceConfigHistory action.

', 'refs' => [], ], 'GetResourceEvaluationSummaryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourceEvaluationSummaryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetStoredQueryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStoredQueryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GroupByAPILimit' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregateComplianceByConfigRulesRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'GetAggregateConfigRuleComplianceSummaryRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

', 'GetAggregateDiscoveredResourceCountsRequest$Limit' => '

The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

', ], ], 'GroupedResourceCount' => [ 'base' => '

The count of resources that are grouped by the group name.

', 'refs' => [ 'GroupedResourceCountList$member' => NULL, ], ], 'GroupedResourceCountList' => [ 'base' => NULL, 'refs' => [ 'GetAggregateDiscoveredResourceCountsResponse$GroupedResourceCounts' => '

Returns a list of GroupedResourceCount objects.

', ], ], 'IdempotentParameterMismatch' => [ 'base' => '

Using the same client token with one or more different parameters. Specify a new client token with the parameter changes and try again.

', 'refs' => [], ], 'IncludeGlobalResourceTypes' => [ 'base' => NULL, 'refs' => [ 'RecordingGroup$includeGlobalResourceTypes' => '

This option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded by Config in Regions where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

Aurora global clusters are recorded in all enabled Regions

The AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if includeGlobalResourceTypes is not set to true. The includeGlobalResourceTypes option is a bundle which only applies to IAM users, groups, roles, and customer managed policies.

If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, use one of the following recording strategies:

  1. Record all current and future resource types with exclusions (EXCLUSION_BY_RESOURCE_TYPES), or

  2. Record specific resource types (INCLUSION_BY_RESOURCE_TYPES).

For more information, see Selecting Which Resources are Recorded in the Config developer guide.

Before you set this field to true, set the allSupported field of RecordingGroup to true. Optionally, you can set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES.

Overriding fields

If you set this field to false but list global IAM resource types in the resourceTypes field of RecordingGroup, Config will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.

If you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the resourceTypes field in addition to setting the includeGlobalResourceTypes field to false.

', ], ], 'InsufficientDeliveryPolicyException' => [ 'base' => '

Your Amazon S3 bucket policy does not permit Config to write to it.

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

Indicates one of the following errors:

', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'AggregateConformancePackCompliance$CompliantRuleCount' => '

The number of compliant Config Rules.

', 'AggregateConformancePackCompliance$NonCompliantRuleCount' => '

The number of noncompliant Config Rules.

', 'AggregateConformancePackCompliance$TotalRuleCount' => '

Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.

', 'AggregateConformancePackComplianceCount$CompliantConformancePackCount' => '

Number of compliant conformance packs.

', 'AggregateConformancePackComplianceCount$NonCompliantConformancePackCount' => '

Number of noncompliant conformance packs.

', 'ComplianceContributorCount$CappedCount' => '

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

', ], ], 'InvalidConfigurationRecorderNameException' => [ 'base' => '

You have provided a name for the configuration recorder that is not valid.

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

The specified delivery channel name is not valid.

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

The syntax of the query is incorrect.

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

The specified limit is outside the allowable range.

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

The specified next token is not valid. Specify the nextToken string that was returned in the previous response to get the next page of results.

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

One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.

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

Indicates one of the following errors:

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

The specified ResultToken is not valid.

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

You have provided a null or empty Amazon Resource Name (ARN) for the IAM role assumed by Config and used by the configuration recorder.

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

The specified Amazon S3 key prefix is not valid.

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

The specified Amazon KMS Key ARN is not valid.

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

The specified Amazon SNS topic does not exist.

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

The specified time range is not valid. The earlier time is not chronologically before the later time.

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

You cannot delete the delivery channel you specified because the configuration recorder is running.

', 'refs' => [], ], 'LastUpdatedTime' => [ 'base' => NULL, 'refs' => [ 'ConformancePackComplianceScore$LastUpdatedTime' => '

The time that the conformance pack compliance score was last updated.

', ], ], 'LaterTime' => [ 'base' => NULL, 'refs' => [ 'GetResourceConfigHistoryRequest$laterTime' => '

The chronologically latest time in the time range for which the history requested. If not specified, current time is taken.

', ], ], 'Limit' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregateComplianceByConformancePacksRequest$Limit' => '

The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'DescribeAggregationAuthorizationsRequest$Limit' => '

The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'DescribeComplianceByResourceRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'DescribeConfigurationAggregatorSourcesStatusRequest$Limit' => '

The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'DescribeConfigurationAggregatorsRequest$Limit' => '

The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'DescribeRemediationExceptionsRequest$Limit' => '

The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default.

', 'DescribeRemediationExecutionStatusRequest$Limit' => '

The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'GetAggregateConformancePackComplianceSummaryRequest$Limit' => '

The maximum number of results returned on each page. The default is maximum. If you specify 0, Config uses the default.

', 'GetComplianceDetailsByConfigRuleRequest$Limit' => '

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'GetDiscoveredResourceCountsRequest$limit' => '

The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'GetResourceConfigHistoryRequest$limit' => '

The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'ListAggregateDiscoveredResourcesRequest$Limit' => '

The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'ListDiscoveredResourcesRequest$limit' => '

The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', 'ListStoredQueriesRequest$MaxResults' => '

The maximum number of results to be returned with a single call.

', 'ListTagsForResourceRequest$Limit' => '

The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, Config uses the default.

', 'SelectAggregateResourceConfigRequest$Limit' => '

The maximum number of query results returned on each page.

', 'SelectAggregateResourceConfigRequest$MaxResults' => '

The maximum number of query results returned on each page. Config also allows the Limit request parameter.

', 'SelectResourceConfigRequest$Limit' => '

The maximum number of query results returned on each page.

', ], ], 'LimitExceededException' => [ 'base' => '

For StartConfigRulesEvaluation API, this exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.

For PutConfigurationAggregator API, this exception is thrown if the number of accounts and aggregators exceeds the limit.

', 'refs' => [], ], 'ListAggregateDiscoveredResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAggregateDiscoveredResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListConformancePackComplianceScoresRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConformancePackComplianceScoresResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDiscoveredResourcesRequest' => [ 'base' => '

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

', 'refs' => [], ], 'ListResourceEvaluationsPageItemLimit' => [ 'base' => NULL, 'refs' => [ 'ListResourceEvaluationsRequest$Limit' => '

The maximum number of evaluations returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

', ], ], 'ListResourceEvaluationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceEvaluationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStoredQueriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStoredQueriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'GetAggregateDiscoveredResourceCountsResponse$TotalDiscoveredResources' => '

The total number of resources that are present in an aggregator with the filters that you provide.

', 'GetDiscoveredResourceCountsResponse$totalDiscoveredResources' => '

The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.

Example

  1. Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.

  2. You make a call to the GetDiscoveredResourceCounts action and specify the resource type, "AWS::EC2::Instances", in the request.

  3. Config returns 25 for totalDiscoveredResources.

', 'GroupedResourceCount$ResourceCount' => '

The number of resources in the group.

', 'ResourceCount$count' => '

The number of resources.

', ], ], 'MaxActiveResourcesExceededException' => [ 'base' => '

You have reached the limit of active custom resource types in your account. There is a limit of 100,000. Delete unused resources using DeleteResourceConfig .

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

Failed to add the Config rule because the account already contains the maximum number of 150 rules. Consider deleting any deactivated rules before you add new rules.

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

You have reached the limit of the number of configuration recorders you can create.

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

You have reached the limit of the number of conformance packs you can create in an account. For more information, see Service Limits in the Config Developer Guide.

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

You have reached the limit of the number of delivery channels you can create.

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

You have reached the limit of the number of organization Config rules you can create. For more information, see see Service Limits in the Config Developer Guide.

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

You have reached the limit of the number of organization conformance packs you can create in an account. For more information, see Service Limits in the Config Developer Guide.

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

Failed to add the retention configuration because a retention configuration with that name already exists.

', 'refs' => [], ], 'MaximumExecutionFrequency' => [ 'base' => NULL, 'refs' => [ 'ConfigRule$MaximumExecutionFrequency' => '

The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

  • This is for an Config managed rule that is triggered at a periodic frequency.

  • Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

', 'ConfigSnapshotDeliveryProperties$deliveryFrequency' => '

The frequency with which Config delivers configuration snapshots.

', 'OrganizationCustomPolicyRuleMetadata$MaximumExecutionFrequency' => '

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$MaximumExecutionFrequency' => '

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

', 'OrganizationCustomRuleMetadata$MaximumExecutionFrequency' => '

The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

', 'OrganizationManagedRuleMetadata$MaximumExecutionFrequency' => '

The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

', 'SourceDetail$MaximumExecutionFrequency' => '

The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

', ], ], 'MemberAccountRuleStatus' => [ 'base' => NULL, 'refs' => [ 'MemberAccountStatus$MemberAccountRuleStatus' => '

Indicates deployment status for Config rule in the member account. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the management account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when Config rule has been created in the member account.

  • CREATE_IN_PROGRESS when Config rule is being created in the member account.

  • CREATE_FAILED when Config rule creation has failed in the member account.

  • DELETE_FAILED when Config rule deletion has failed in the member account.

  • DELETE_IN_PROGRESS when Config rule is being deleted in the member account.

  • DELETE_SUCCESSFUL when Config rule has been deleted in the member account.

  • UPDATE_SUCCESSFUL when Config rule has been updated in the member account.

  • UPDATE_IN_PROGRESS when Config rule is being updated in the member account.

  • UPDATE_FAILED when Config rule deletion has failed in the member account.

', 'StatusDetailFilters$MemberAccountRuleStatus' => '

Indicates deployment status for Config rule in the member account. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the management account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when Config rule has been created in the member account.

  • CREATE_IN_PROGRESS when Config rule is being created in the member account.

  • CREATE_FAILED when Config rule creation has failed in the member account.

  • DELETE_FAILED when Config rule deletion has failed in the member account.

  • DELETE_IN_PROGRESS when Config rule is being deleted in the member account.

  • DELETE_SUCCESSFUL when Config rule has been deleted in the member account.

  • UPDATE_SUCCESSFUL when Config rule has been updated in the member account.

  • UPDATE_IN_PROGRESS when Config rule is being updated in the member account.

  • UPDATE_FAILED when Config rule deletion has failed in the member account.

', ], ], 'MemberAccountStatus' => [ 'base' => '

Organization Config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.

', 'refs' => [ 'OrganizationConfigRuleDetailedStatus$member' => NULL, ], ], 'MessageType' => [ 'base' => NULL, 'refs' => [ 'SourceDetail$MessageType' => '

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

  • ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a configuration snapshot.

If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'Tags$key' => NULL, ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeAggregateComplianceByConfigRulesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeAggregateComplianceByConfigRulesResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeAggregateComplianceByConformancePacksRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeAggregateComplianceByConformancePacksResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeComplianceByResourceRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeComplianceByResourceResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'DescribeConformancePackComplianceRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeConformancePackComplianceResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeConformancePackStatusRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeConformancePackStatusResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeConformancePacksRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeConformancePacksResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeRetentionConfigurationsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeRetentionConfigurationsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateComplianceDetailsByConfigRuleRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateComplianceDetailsByConfigRuleResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateConfigRuleComplianceSummaryRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateConfigRuleComplianceSummaryResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateConformancePackComplianceSummaryRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateConformancePackComplianceSummaryResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateDiscoveredResourceCountsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetAggregateDiscoveredResourceCountsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetComplianceDetailsByConfigRuleRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetComplianceDetailsByConfigRuleResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'GetConformancePackComplianceDetailsRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'GetConformancePackComplianceDetailsResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'GetConformancePackComplianceSummaryRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetConformancePackComplianceSummaryResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetDiscoveredResourceCountsRequest$nextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetDiscoveredResourceCountsResponse$nextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'GetResourceConfigHistoryRequest$nextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetResourceConfigHistoryResponse$nextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'ListAggregateDiscoveredResourcesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListAggregateDiscoveredResourcesResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListConformancePackComplianceScoresRequest$NextToken' => '

The nextToken string in a prior request that you can use to get the paginated response for the next set of conformance pack compliance scores.

', 'ListConformancePackComplianceScoresResponse$NextToken' => '

The nextToken string that you can use to get the next page of results in a paginated response.

', 'ListDiscoveredResourcesRequest$nextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListDiscoveredResourcesResponse$nextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'ListTagsForResourceRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListTagsForResourceResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'SelectAggregateResourceConfigRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'SelectAggregateResourceConfigResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'SelectResourceConfigRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'SelectResourceConfigResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', ], ], 'NoAvailableConfigurationRecorderException' => [ 'base' => '

There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

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

There is no delivery channel available to record configurations.

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

Organization is no longer available.

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

There is no configuration recorder running.

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

The specified Amazon S3 bucket does not exist.

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

The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

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

Config rule that you passed in the filter does not exist.

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

You have specified a configuration aggregator that does not exist.

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

You have specified a configuration recorder that does not exist.

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

You specified one or more conformance packs that do not exist.

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

You have specified a delivery channel that does not exist.

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

The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

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

Config organization conformance pack that you passed in the filter does not exist.

For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.

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

You specified an Config rule without a remediation configuration.

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

You tried to delete a remediation exception that does not exist.

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

You have specified a retention configuration that does not exist.

', 'refs' => [], ], 'OrderingTimestamp' => [ 'base' => NULL, 'refs' => [ 'Evaluation$OrderingTimestamp' => '

The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

', 'ExternalEvaluation$OrderingTimestamp' => '

The time when the compliance was recorded.

', ], ], 'OrganizationAccessDeniedException' => [ 'base' => '

For PutConfigurationAggregator API, you can see this exception for the following reasons:

  • No permission to call EnableAWSServiceAccess API

  • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

  • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

  • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.

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

This object contains regions to set up the aggregator and an IAM role to retrieve organization details.

', 'refs' => [ 'ConfigurationAggregator$OrganizationAggregationSource' => '

Provides an organization and list of regions to be aggregated.

', 'PutConfigurationAggregatorRequest$OrganizationAggregationSource' => '

An OrganizationAggregationSource object.

', ], ], 'OrganizationAllFeaturesNotEnabledException' => [ 'base' => '

Config resource cannot be created because your organization does not have all features enabled.

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

An organization Config rule that has information about Config rules that Config creates in member accounts.

', 'refs' => [ 'OrganizationConfigRules$member' => NULL, ], ], 'OrganizationConfigRuleDetailedStatus' => [ 'base' => NULL, 'refs' => [ 'GetOrganizationConfigRuleDetailedStatusResponse$OrganizationConfigRuleDetailedStatus' => '

A list of MemberAccountStatus objects.

', ], ], 'OrganizationConfigRuleName' => [ 'base' => NULL, 'refs' => [ 'DeleteOrganizationConfigRuleRequest$OrganizationConfigRuleName' => '

The name of organization Config rule that you want to delete.

', 'GetOrganizationConfigRuleDetailedStatusRequest$OrganizationConfigRuleName' => '

The name of your organization Config rule for which you want status details for member accounts.

', 'GetOrganizationCustomRulePolicyRequest$OrganizationConfigRuleName' => '

The name of your organization Config Custom Policy rule.

', 'OrganizationConfigRule$OrganizationConfigRuleName' => '

The name that you assign to organization Config rule.

', 'OrganizationConfigRuleStatus$OrganizationConfigRuleName' => '

The name that you assign to organization Config rule.

', 'PutOrganizationConfigRuleRequest$OrganizationConfigRuleName' => '

The name that you assign to an organization Config rule.

', ], ], 'OrganizationConfigRuleNames' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConfigRuleStatusesRequest$OrganizationConfigRuleNames' => '

The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.

', 'DescribeOrganizationConfigRulesRequest$OrganizationConfigRuleNames' => '

The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.

', ], ], 'OrganizationConfigRuleStatus' => [ 'base' => '

Returns the status for an organization Config rule in an organization.

', 'refs' => [ 'OrganizationConfigRuleStatuses$member' => NULL, ], ], 'OrganizationConfigRuleStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConfigRuleStatusesResponse$OrganizationConfigRuleStatuses' => '

A list of OrganizationConfigRuleStatus objects.

', ], ], 'OrganizationConfigRuleTriggerType' => [ 'base' => NULL, 'refs' => [ 'OrganizationConfigRuleTriggerTypes$member' => NULL, ], ], 'OrganizationConfigRuleTriggerTypeNoSN' => [ 'base' => NULL, 'refs' => [ 'OrganizationConfigRuleTriggerTypeNoSNs$member' => NULL, ], ], 'OrganizationConfigRuleTriggerTypeNoSNs' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$OrganizationConfigRuleTriggerTypes' => '

The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

  • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$OrganizationConfigRuleTriggerTypes' => '

The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

', ], ], 'OrganizationConfigRuleTriggerTypes' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomRuleMetadata$OrganizationConfigRuleTriggerTypes' => '

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

', ], ], 'OrganizationConfigRules' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConfigRulesResponse$OrganizationConfigRules' => '

Returns a list of OrganizationConfigRule objects.

', ], ], 'OrganizationConformancePack' => [ 'base' => '

An organization conformance pack that has information about conformance packs that Config creates in member accounts.

', 'refs' => [ 'OrganizationConformancePacks$member' => NULL, ], ], 'OrganizationConformancePackDetailedStatus' => [ 'base' => '

Organization conformance pack creation or deletion status in each member account. This includes the name of the conformance pack, the status, error code and error message when the conformance pack creation or deletion failed.

', 'refs' => [ 'OrganizationConformancePackDetailedStatuses$member' => NULL, ], ], 'OrganizationConformancePackDetailedStatuses' => [ 'base' => NULL, 'refs' => [ 'GetOrganizationConformancePackDetailedStatusResponse$OrganizationConformancePackDetailedStatuses' => '

A list of OrganizationConformancePackDetailedStatus objects.

', ], ], 'OrganizationConformancePackName' => [ 'base' => NULL, 'refs' => [ 'DeleteOrganizationConformancePackRequest$OrganizationConformancePackName' => '

The name of organization conformance pack that you want to delete.

', 'GetOrganizationConformancePackDetailedStatusRequest$OrganizationConformancePackName' => '

The name of organization conformance pack for which you want status details for member accounts.

', 'OrganizationConformancePack$OrganizationConformancePackName' => '

The name you assign to an organization conformance pack.

', 'OrganizationConformancePackNames$member' => NULL, 'OrganizationConformancePackStatus$OrganizationConformancePackName' => '

The name that you assign to organization conformance pack.

', 'PutOrganizationConformancePackRequest$OrganizationConformancePackName' => '

Name of the organization conformance pack you want to create.

', ], ], 'OrganizationConformancePackNames' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConformancePackStatusesRequest$OrganizationConformancePackNames' => '

The names of organization conformance packs for which you want status details. If you do not specify any names, Config returns details for all your organization conformance packs.

', 'DescribeOrganizationConformancePacksRequest$OrganizationConformancePackNames' => '

The name that you assign to an organization conformance pack.

', ], ], 'OrganizationConformancePackStatus' => [ 'base' => '

Returns the status for an organization conformance pack in an organization.

', 'refs' => [ 'OrganizationConformancePackStatuses$member' => NULL, ], ], 'OrganizationConformancePackStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConformancePackStatusesResponse$OrganizationConformancePackStatuses' => '

A list of OrganizationConformancePackStatus objects.

', ], ], 'OrganizationConformancePackTemplateValidationException' => [ 'base' => '

You have specified a template that is not valid or supported.

', 'refs' => [], ], 'OrganizationConformancePacks' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationConformancePacksResponse$OrganizationConformancePacks' => '

Returns a list of OrganizationConformancePacks objects.

', ], ], 'OrganizationCustomPolicyRuleMetadata' => [ 'base' => '

An object that specifies metadata for your organization\'s Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

', 'refs' => [ 'PutOrganizationConfigRuleRequest$OrganizationCustomPolicyRuleMetadata' => '

An OrganizationCustomPolicyRuleMetadata object. This object specifies metadata for your organization\'s Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

', ], ], 'OrganizationCustomPolicyRuleMetadataNoPolicy' => [ 'base' => '

metadata for your organization Config Custom Policy rule including the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that trigger Config to evaluate Amazon Web Services resources against a rule.

', 'refs' => [ 'OrganizationConfigRule$OrganizationCustomPolicyRuleMetadata' => '

An object that specifies metadata for your organization\'s Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

', ], ], 'OrganizationCustomRuleMetadata' => [ 'base' => '

An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

', 'refs' => [ 'OrganizationConfigRule$OrganizationCustomRuleMetadata' => '

An OrganizationCustomRuleMetadata object.

', 'PutOrganizationConfigRuleRequest$OrganizationCustomRuleMetadata' => '

An OrganizationCustomRuleMetadata object. This object specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

', ], ], 'OrganizationManagedRuleMetadata' => [ 'base' => '

An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

', 'refs' => [ 'OrganizationConfigRule$OrganizationManagedRuleMetadata' => '

An OrganizationManagedRuleMetadata object.

', 'PutOrganizationConfigRuleRequest$OrganizationManagedRuleMetadata' => '

An OrganizationManagedRuleMetadata object. This object specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

', ], ], 'OrganizationResourceDetailedStatus' => [ 'base' => NULL, 'refs' => [ 'OrganizationConformancePackDetailedStatus$Status' => '

Indicates deployment status for conformance pack in a member account. When management account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When management account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the management account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

  • CREATE_SUCCESSFUL when conformance pack has been created in the member account.

  • CREATE_IN_PROGRESS when conformance pack is being created in the member account.

  • CREATE_FAILED when conformance pack creation has failed in the member account.

  • DELETE_FAILED when conformance pack deletion has failed in the member account.

  • DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.

  • DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.

  • UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.

  • UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.

  • UPDATE_FAILED when conformance pack deletion has failed in the member account.

', 'OrganizationResourceDetailedStatusFilters$Status' => '

Indicates deployment status for conformance pack in a member account. When management account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When management account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the management account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

  • CREATE_SUCCESSFUL when conformance pack has been created in the member account.

  • CREATE_IN_PROGRESS when conformance pack is being created in the member account.

  • CREATE_FAILED when conformance pack creation has failed in the member account.

  • DELETE_FAILED when conformance pack deletion has failed in the member account.

  • DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.

  • DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.

  • UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.

  • UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.

  • UPDATE_FAILED when conformance pack deletion has failed in the member account.

', ], ], 'OrganizationResourceDetailedStatusFilters' => [ 'base' => '

Status filter object to filter results based on specific member account ID or status type for an organization conformance pack.

', 'refs' => [ 'GetOrganizationConformancePackDetailedStatusRequest$Filters' => '

An OrganizationResourceDetailedStatusFilters object.

', ], ], 'OrganizationResourceStatus' => [ 'base' => NULL, 'refs' => [ 'OrganizationConformancePackStatus$Status' => '

Indicates deployment status of an organization conformance pack. When management account calls PutOrganizationConformancePack for the first time, conformance pack status is created in all the member accounts. When management account calls PutOrganizationConformancePack for the second time, conformance pack status is updated in all the member accounts. Additionally, conformance pack status is updated when one or more member accounts join or leave an organization. Conformance pack status is deleted when the management account deletes OrganizationConformancePack in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

  • CREATE_SUCCESSFUL when an organization conformance pack has been successfully created in all the member accounts.

  • CREATE_IN_PROGRESS when an organization conformance pack creation is in progress.

  • CREATE_FAILED when an organization conformance pack creation failed in one or more member accounts within that organization.

  • DELETE_FAILED when an organization conformance pack deletion failed in one or more member accounts within that organization.

  • DELETE_IN_PROGRESS when an organization conformance pack deletion is in progress.

  • DELETE_SUCCESSFUL when an organization conformance pack has been successfully deleted from all the member accounts.

  • UPDATE_SUCCESSFUL when an organization conformance pack has been successfully updated in all the member accounts.

  • UPDATE_IN_PROGRESS when an organization conformance pack update is in progress.

  • UPDATE_FAILED when an organization conformance pack update failed in one or more member accounts within that organization.

', ], ], 'OrganizationRuleStatus' => [ 'base' => NULL, 'refs' => [ 'OrganizationConfigRuleStatus$OrganizationRuleStatus' => '

Indicates deployment status of an organization Config rule. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the management account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when an organization Config rule has been successfully created in all the member accounts.

  • CREATE_IN_PROGRESS when an organization Config rule creation is in progress.

  • CREATE_FAILED when an organization Config rule creation failed in one or more member accounts within that organization.

  • DELETE_FAILED when an organization Config rule deletion failed in one or more member accounts within that organization.

  • DELETE_IN_PROGRESS when an organization Config rule deletion is in progress.

  • DELETE_SUCCESSFUL when an organization Config rule has been successfully deleted from all the member accounts.

  • UPDATE_SUCCESSFUL when an organization Config rule has been successfully updated in all the member accounts.

  • UPDATE_IN_PROGRESS when an organization Config rule update is in progress.

  • UPDATE_FAILED when an organization Config rule update failed in one or more member accounts within that organization.

', ], ], 'OversizedConfigurationItemException' => [ 'base' => '

The configuration item size is outside the allowable range.

', 'refs' => [], ], 'Owner' => [ 'base' => NULL, 'refs' => [ 'Source$Owner' => '

Indicates whether Amazon Web Services or the customer owns and manages the Config rule.

Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see Config Managed Rules in the Config developer guide.

Config Custom Rules are rules that you can develop either with Guard (CUSTOM_POLICY) or Lambda (CUSTOM_LAMBDA). For more information, see Config Custom Rules in the Config developer guide.

', ], ], 'PageSizeLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeConformancePackStatusRequest$Limit' => '

The maximum number of conformance packs status returned on each page.

', 'DescribeConformancePacksRequest$Limit' => '

The maximum number of conformance packs returned on each page.

', 'GetConformancePackComplianceSummaryRequest$Limit' => '

The maximum number of conformance packs returned on each page.

', 'ListConformancePackComplianceScoresRequest$Limit' => '

The maximum number of conformance pack compliance scores returned on each page.

', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'ConformancePackInputParameter$ParameterName' => '

One part of a key-value pair.

', ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'ConformancePackInputParameter$ParameterValue' => '

Another part of the key-value pair.

', ], ], 'PendingAggregationRequest' => [ 'base' => '

An object that represents the account ID and region of an aggregator account that is requesting authorization but is not yet authorized.

', 'refs' => [ 'PendingAggregationRequestList$member' => NULL, ], ], 'PendingAggregationRequestList' => [ 'base' => NULL, 'refs' => [ 'DescribePendingAggregationRequestsResponse$PendingAggregationRequests' => '

Returns a PendingAggregationRequests object.

', ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'SsmControls$ConcurrentExecutionRatePercentage' => '

The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.

', 'SsmControls$ErrorPercentage' => '

The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.

', ], ], 'PolicyRuntime' => [ 'base' => NULL, 'refs' => [ 'CustomPolicyDetails$PolicyRuntime' => '

The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

', 'OrganizationCustomPolicyRuleMetadata$PolicyRuntime' => '

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$PolicyRuntime' => '

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

', ], ], 'PolicyText' => [ 'base' => NULL, 'refs' => [ 'CustomPolicyDetails$PolicyText' => '

The policy definition containing the logic for your Config Custom Policy rule.

', 'GetCustomRulePolicyResponse$PolicyText' => '

The policy definition containing the logic for your Config Custom Policy rule.

', 'GetOrganizationCustomRulePolicyResponse$PolicyText' => '

The policy definition containing the logic for your organization Config Custom Policy rule.

', 'OrganizationCustomPolicyRuleMetadata$PolicyText' => '

The policy definition containing the logic for your organization Config Custom Policy rule.

', ], ], 'PutAggregationAuthorizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAggregationAuthorizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutConfigRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutConfigurationAggregatorRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutConfigurationAggregatorResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutConfigurationRecorderRequest' => [ 'base' => '

The input for the PutConfigurationRecorder action.

', 'refs' => [], ], 'PutConformancePackRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutConformancePackResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutDeliveryChannelRequest' => [ 'base' => '

The input for the PutDeliveryChannel action.

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

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

', 'refs' => [], ], 'PutExternalEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutExternalEvaluationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutOrganizationConfigRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutOrganizationConfigRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutOrganizationConformancePackRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutOrganizationConformancePackResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutRemediationConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRemediationConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutRemediationExceptionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRemediationExceptionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRetentionConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRetentionConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutStoredQueryRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutStoredQueryResponse' => [ 'base' => NULL, 'refs' => [], ], 'QueryArn' => [ 'base' => NULL, 'refs' => [ 'PutStoredQueryResponse$QueryArn' => '

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

', 'StoredQuery$QueryArn' => '

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

', 'StoredQueryMetadata$QueryArn' => '

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

', ], ], 'QueryDescription' => [ 'base' => NULL, 'refs' => [ 'StoredQuery$Description' => '

A unique description for the query.

', 'StoredQueryMetadata$Description' => '

A unique description for the query.

', ], ], 'QueryExpression' => [ 'base' => NULL, 'refs' => [ 'StoredQuery$Expression' => '

The expression of the query. For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = \'AWS::S3::Bucket\' AND supplementaryConfiguration.BucketVersioningConfiguration.status = \'Off\'.

', ], ], 'QueryId' => [ 'base' => NULL, 'refs' => [ 'StoredQuery$QueryId' => '

The ID of the query.

', 'StoredQueryMetadata$QueryId' => '

The ID of the query.

', ], ], 'QueryInfo' => [ 'base' => '

Details about the query.

', 'refs' => [ 'SelectAggregateResourceConfigResponse$QueryInfo' => NULL, 'SelectResourceConfigResponse$QueryInfo' => '

Returns the QueryInfo object.

', ], ], 'QueryName' => [ 'base' => NULL, 'refs' => [ 'DeleteStoredQueryRequest$QueryName' => '

The name of the query that you want to delete.

', 'GetStoredQueryRequest$QueryName' => '

The name of the query.

', 'StoredQuery$QueryName' => '

The name of the query.

', 'StoredQueryMetadata$QueryName' => '

The name of the query.

', ], ], 'RecorderName' => [ 'base' => NULL, 'refs' => [ 'ConfigurationRecorder$name' => '

The name of the configuration recorder. Config automatically assigns the name of "default" when creating the configuration recorder.

You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name.

', 'ConfigurationRecorderNameList$member' => NULL, 'DeleteConfigurationRecorderRequest$ConfigurationRecorderName' => '

The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action.

', 'StartConfigurationRecorderRequest$ConfigurationRecorderName' => '

The name of the recorder object that records each configuration change made to the resources.

', 'StopConfigurationRecorderRequest$ConfigurationRecorderName' => '

The name of the recorder object that records each configuration change made to the resources.

', ], ], 'RecorderStatus' => [ 'base' => NULL, 'refs' => [ 'ConfigurationRecorderStatus$lastStatus' => '

The status of the latest recording event processed by the recorder.

', ], ], 'RecordingFrequency' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$recordingFrequency' => '

The recording frequency that Config uses to record configuration changes for the resource.

', 'ConfigurationItem$recordingFrequency' => '

The recording frequency that Config uses to record configuration changes for the resource.

', 'RecordingMode$recordingFrequency' => '

The default recording frequency that Config uses to record configuration changes.

Daily recording is not supported for the following resource types:

  • AWS::Config::ResourceCompliance

  • AWS::Config::ConformancePackCompliance

  • AWS::Config::ConfigurationRecorder

For the allSupported (ALL_SUPPORTED_RESOURCE_TYPES) recording strategy, these resource types will be set to Continuous recording.

', 'RecordingModeOverride$recordingFrequency' => '

The recording frequency that will be applied to all the resource types specified in the override.

  • Continuous recording allows you to record configuration changes continuously whenever a change occurs.

  • Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

', ], ], 'RecordingGroup' => [ 'base' => '

Specifies which resource types Config records for configuration changes. By default, Config records configuration changes for all current and future supported resource types in the Amazon Web Services Region where you have enabled Config, excluding the global IAM resource types: IAM users, groups, roles, and customer managed policies.

In the recording group, you specify whether you want to record all supported current and future supported resource types or to include or exclude specific resources types. For a list of supported resource types, see Supported Resource Types in the Config developer guide.

If you don\'t want Config to record all current and future supported resource types (excluding the global IAM resource types), use one of the following recording strategies:

  1. Record all current and future resource types with exclusions (EXCLUSION_BY_RESOURCE_TYPES), or

  2. Record specific resource types (INCLUSION_BY_RESOURCE_TYPES).

If you use the recording strategy to Record all current and future resource types (ALL_SUPPORTED_RESOURCE_TYPES), you can use the flag includeGlobalResourceTypes to include the global IAM resource types in your recording.

Aurora global clusters are recorded in all enabled Regions

The AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled.

If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, use the EXCLUSION_BY_RESOURCE_TYPES or INCLUSION_BY_RESOURCE_TYPES recording strategy.

', 'refs' => [ 'ConfigurationRecorder$recordingGroup' => '

Specifies which resource types Config records for configuration changes.

High Number of Config Evaluations

You may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.

If you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An ephemeral workload is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.

', ], ], 'RecordingMode' => [ 'base' => '

Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.

  • Continuous recording allows you to record configuration changes continuously whenever a change occurs.

  • Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

', 'refs' => [ 'ConfigurationRecorder$recordingMode' => '

Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.

  • Continuous recording allows you to record configuration changes continuously whenever a change occurs.

  • Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

', ], ], 'RecordingModeOverride' => [ 'base' => '

An object for you to specify your overrides for the recording mode.

', 'refs' => [ 'RecordingModeOverrides$member' => NULL, ], ], 'RecordingModeOverrides' => [ 'base' => NULL, 'refs' => [ 'RecordingMode$recordingModeOverrides' => '

An array of recordingModeOverride objects for you to specify your overrides for the recording mode. The recordingModeOverride object in the recordingModeOverrides array consists of three fields: a description, the new recordingFrequency, and an array of resourceTypes to override.

', ], ], 'RecordingModeResourceTypesList' => [ 'base' => NULL, 'refs' => [ 'RecordingModeOverride$resourceTypes' => '

A comma-separated list that specifies which resource types Config includes in the override.

Daily recording is not supported for the following resource types:

  • AWS::Config::ResourceCompliance

  • AWS::Config::ConformancePackCompliance

  • AWS::Config::ConfigurationRecorder

', ], ], 'RecordingStrategy' => [ 'base' => '

Specifies the recording strategy of the configuration recorder.

', 'refs' => [ 'RecordingGroup$recordingStrategy' => '

An object that specifies the recording strategy for the configuration recorder.

  • If you set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the allSupported field of RecordingGroup to true. When Config adds support for a new resource type, Config automatically starts recording resources of that type.

  • If you set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for only the resource types you specify in the resourceTypes field of RecordingGroup.

  • If you set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for all supported resource types except the resource types that you specify to exclude from being recorded in the resourceTypes field of ExclusionByResourceTypes.

Required and optional fields

The recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true.

The recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

Overriding fields

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

Global resources types and the resource exclusion recording strategy

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

  • Asia Pacific (Hyderabad)

  • Asia Pacific (Melbourne)

  • Europe (Spain)

  • Europe (Zurich)

  • Israel (Tel Aviv)

  • Middle East (UAE)

', ], ], 'RecordingStrategyType' => [ 'base' => NULL, 'refs' => [ 'RecordingStrategy$useOnly' => '

The recording strategy for the configuration recorder.

  • If you set this option to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the allSupported field of RecordingGroup to true. When Config adds support for a new resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide.

  • If you set this option to INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for only the resource types that you specify in the resourceTypes field of RecordingGroup.

  • If you set this option to EXCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded in the resourceTypes field of ExclusionByResourceTypes.

Required and optional fields

The recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true.

The recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

Overriding fields

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

Global resource types and the exclusion recording strategy

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

  • Asia Pacific (Hyderabad)

  • Asia Pacific (Melbourne)

  • Europe (Spain)

  • Europe (Zurich)

  • Israel (Tel Aviv)

  • Middle East (UAE)

', ], ], 'ReevaluateConfigRuleNames' => [ 'base' => NULL, 'refs' => [ 'StartConfigRulesEvaluationRequest$ConfigRuleNames' => '

The list of names of Config rules that you want to run evaluations for.

', ], ], 'RelatedEvent' => [ 'base' => NULL, 'refs' => [ 'RelatedEventList$member' => NULL, ], ], 'RelatedEventList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationItem$relatedEvents' => '

A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

', ], ], 'Relationship' => [ 'base' => '

The relationship of the related resource to the main resource.

', 'refs' => [ 'RelationshipList$member' => NULL, ], ], 'RelationshipList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationItem$relationships' => '

A list of related Amazon Web Services resources.

', ], ], 'RelationshipName' => [ 'base' => NULL, 'refs' => [ 'Relationship$relationshipName' => '

The type of relationship with the related resource.

', ], ], 'RemediationConfiguration' => [ 'base' => '

An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

', 'refs' => [ 'RemediationConfigurations$member' => NULL, ], ], 'RemediationConfigurations' => [ 'base' => NULL, 'refs' => [ 'DescribeRemediationConfigurationsResponse$RemediationConfigurations' => '

Returns a remediation configuration object.

', 'FailedRemediationBatch$FailedItems' => '

Returns remediation configurations of the failed items.

', 'PutRemediationConfigurationsRequest$RemediationConfigurations' => '

A list of remediation configuration objects.

', ], ], 'RemediationException' => [ 'base' => '

An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type.

', 'refs' => [ 'RemediationExceptions$member' => NULL, ], ], 'RemediationExceptionResourceKey' => [ 'base' => '

The details that identify a resource within Config, including the resource type and resource ID.

', 'refs' => [ 'RemediationExceptionResourceKeys$member' => NULL, ], ], 'RemediationExceptionResourceKeys' => [ 'base' => NULL, 'refs' => [ 'DeleteRemediationExceptionsRequest$ResourceKeys' => '

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

', 'DescribeRemediationExceptionsRequest$ResourceKeys' => '

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

', 'FailedDeleteRemediationExceptionsBatch$FailedItems' => '

Returns remediation exception resource key object of the failed items.

', 'PutRemediationExceptionsRequest$ResourceKeys' => '

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

', ], ], 'RemediationExceptions' => [ 'base' => NULL, 'refs' => [ 'DescribeRemediationExceptionsResponse$RemediationExceptions' => '

Returns a list of remediation exception objects.

', 'FailedRemediationExceptionBatch$FailedItems' => '

Returns remediation exception resource key object of the failed items.

', ], ], 'RemediationExecutionState' => [ 'base' => NULL, 'refs' => [ 'RemediationExecutionStatus$State' => '

ENUM of the values.

', ], ], 'RemediationExecutionStatus' => [ 'base' => '

Provides details of the current status of the invoked remediation action for that resource.

', 'refs' => [ 'RemediationExecutionStatuses$member' => NULL, ], ], 'RemediationExecutionStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeRemediationExecutionStatusResponse$RemediationExecutionStatuses' => '

Returns a list of remediation execution statuses objects.

', ], ], 'RemediationExecutionStep' => [ 'base' => '

Name of the step from the SSM document.

', 'refs' => [ 'RemediationExecutionSteps$member' => NULL, ], ], 'RemediationExecutionStepState' => [ 'base' => NULL, 'refs' => [ 'RemediationExecutionStep$State' => '

The valid status of the step.

', ], ], 'RemediationExecutionSteps' => [ 'base' => NULL, 'refs' => [ 'RemediationExecutionStatus$StepDetails' => '

Details of every step.

', ], ], 'RemediationInProgressException' => [ 'base' => '

Remediation action is in progress. You can either cancel execution in Amazon Web Services Systems Manager or wait and try again later.

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

The value is either a dynamic (resource) value or a static value. You must select either a dynamic value or a static value.

', 'refs' => [ 'RemediationParameters$value' => NULL, ], ], 'RemediationParameters' => [ 'base' => NULL, 'refs' => [ 'RemediationConfiguration$Parameters' => '

An object of the RemediationParameterValue.

', ], ], 'RemediationTargetType' => [ 'base' => NULL, 'refs' => [ 'RemediationConfiguration$TargetType' => '

The type of the target. Target executes remediation. For example, SSM document.

', ], ], 'ResourceConcurrentModificationException' => [ 'base' => '

Two users are trying to modify the same query at the same time. Wait for a moment and try again.

', 'refs' => [], ], 'ResourceConfiguration' => [ 'base' => NULL, 'refs' => [ 'ResourceDetails$ResourceConfiguration' => '

The resource definition to be evaluated as per the resource configuration schema type.

', ], ], 'ResourceConfigurationSchemaType' => [ 'base' => NULL, 'refs' => [ 'ResourceDetails$ResourceConfigurationSchemaType' => '

The schema type of the resource configuration.

You can find the Resource type schema, or CFN_RESOURCE_SCHEMA, in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand: aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE.

For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.

', ], ], 'ResourceCount' => [ 'base' => '

An object that contains the resource type and the number of resources.

', 'refs' => [ 'ResourceCounts$member' => NULL, ], ], 'ResourceCountFilters' => [ 'base' => '

Filters the resource count based on account ID, region, and resource type.

', 'refs' => [ 'GetAggregateDiscoveredResourceCountsRequest$Filters' => '

Filters the results based on the ResourceCountFilters object.

', ], ], 'ResourceCountGroupKey' => [ 'base' => NULL, 'refs' => [ 'GetAggregateDiscoveredResourceCountsRequest$GroupByKey' => '

The key to group the resource counts.

', ], ], 'ResourceCounts' => [ 'base' => NULL, 'refs' => [ 'GetDiscoveredResourceCountsResponse$resourceCounts' => '

The list of ResourceCount objects. Each object is listed in descending order by the number of resources.

', ], ], 'ResourceCreationTime' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$resourceCreationTime' => '

The time stamp when the resource was created.

', 'ConfigurationItem$resourceCreationTime' => '

The time stamp when the resource was created.

', ], ], 'ResourceDeletionTime' => [ 'base' => NULL, 'refs' => [ 'ResourceIdentifier$resourceDeletionTime' => '

The time that the resource was deleted.

', ], ], 'ResourceDetails' => [ 'base' => '

Returns information about the resource being evaluated.

', 'refs' => [ 'GetResourceEvaluationSummaryResponse$ResourceDetails' => '

Returns a ResourceDetails object.

', 'StartResourceEvaluationRequest$ResourceDetails' => '

Returns a ResourceDetails object.

', ], ], 'ResourceEvaluation' => [ 'base' => '

Returns details of a resource evaluation.

', 'refs' => [ 'ResourceEvaluations$member' => NULL, ], ], 'ResourceEvaluationFilters' => [ 'base' => '

Returns details of a resource evaluation based on the selected filter.

', 'refs' => [ 'ListResourceEvaluationsRequest$Filters' => '

Returns a ResourceEvaluationFilters object.

', ], ], 'ResourceEvaluationId' => [ 'base' => NULL, 'refs' => [ 'EvaluationResultIdentifier$ResourceEvaluationId' => '

A Unique ID for an evaluation result.

', 'GetComplianceDetailsByResourceRequest$ResourceEvaluationId' => '

The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.

You need to only provide either a ResourceEvaluationID or a ResourceID and ResourceType.

', 'GetResourceEvaluationSummaryRequest$ResourceEvaluationId' => '

The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

', 'GetResourceEvaluationSummaryResponse$ResourceEvaluationId' => '

The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

', 'ResourceEvaluation$ResourceEvaluationId' => '

The ResourceEvaluationId of a evaluation.

', 'StartResourceEvaluationResponse$ResourceEvaluationId' => '

A unique ResourceEvaluationId that is associated with a single execution.

', ], ], 'ResourceEvaluationStatus' => [ 'base' => NULL, 'refs' => [ 'EvaluationStatus$Status' => '

The status of an execution. The valid values are In_Progress, Succeeded or Failed.

', ], ], 'ResourceEvaluations' => [ 'base' => NULL, 'refs' => [ 'ListResourceEvaluationsResponse$ResourceEvaluations' => '

Returns a ResourceEvaluations object.

', ], ], 'ResourceFilters' => [ 'base' => '

Filters the results by resource account ID, region, resource ID, and resource name.

', 'refs' => [ 'ListAggregateDiscoveredResourcesRequest$Filters' => '

Filters the results based on the ResourceFilters object.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AggregateResourceIdentifier$ResourceId' => '

The ID of the Amazon Web Services resource.

', 'BaseConfigurationItem$resourceId' => '

The ID of the resource (for example., sg-xxxxxx).

', 'ConfigurationItem$resourceId' => '

The ID of the resource (for example, sg-xxxxxx).

', 'DeleteResourceConfigRequest$ResourceId' => '

Unique identifier of the resource.

', 'GetResourceConfigHistoryRequest$resourceId' => '

The ID of the resource (for example., sg-xxxxxx).

', 'PutResourceConfigRequest$ResourceId' => '

Unique identifier of the resource.

', 'Relationship$resourceId' => '

The ID of the related resource (for example, sg-xxxxxx).

', 'ResourceFilters$ResourceId' => '

The ID of the resource.

', 'ResourceIdList$member' => NULL, 'ResourceIdentifier$resourceId' => '

The ID of the resource (for example, sg-xxxxxx).

', 'ResourceKey$resourceId' => '

The ID of the resource (for example., sg-xxxxxx).

', ], ], 'ResourceIdList' => [ 'base' => NULL, 'refs' => [ 'ListDiscoveredResourcesRequest$resourceIds' => '

The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered. You can list a minimum of 1 resourceID and a maximum of 20 resourceIds.

', ], ], 'ResourceIdentifier' => [ 'base' => '

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

', 'refs' => [ 'ResourceIdentifierList$member' => NULL, ], ], 'ResourceIdentifierList' => [ 'base' => NULL, 'refs' => [ 'ListDiscoveredResourcesResponse$resourceIdentifiers' => '

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

', ], ], 'ResourceIdentifiersList' => [ 'base' => NULL, 'refs' => [ 'BatchGetAggregateResourceConfigRequest$ResourceIdentifiers' => '

A list of aggregate ResourceIdentifiers objects.

', ], ], 'ResourceInUseException' => [ 'base' => '

You see this exception in the following cases:

  • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

  • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

  • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

  • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

  • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

  • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

  • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

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

The details that identify a resource within Config, including the resource type and resource ID.

', 'refs' => [ 'RemediationExecutionStatus$ResourceKey' => NULL, 'ResourceKeys$member' => NULL, ], ], 'ResourceKeys' => [ 'base' => NULL, 'refs' => [ 'BatchGetResourceConfigRequest$resourceKeys' => '

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

', 'BatchGetResourceConfigResponse$unprocessedResourceKeys' => '

A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys list.

', 'DescribeRemediationExecutionStatusRequest$ResourceKeys' => '

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

', 'StartRemediationExecutionRequest$ResourceKeys' => '

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

', 'StartRemediationExecutionResponse$FailedItems' => '

For resources that have failed to start execution, the API returns a resource key object.

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'AggregateResourceIdentifier$ResourceName' => '

The name of the Amazon Web Services resource.

', 'BaseConfigurationItem$resourceName' => '

The custom name of the resource, if available.

', 'ConfigurationItem$resourceName' => '

The custom name of the resource, if available.

', 'ListDiscoveredResourcesRequest$resourceName' => '

The custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.

', 'PutResourceConfigRequest$ResourceName' => '

Name of the resource.

', 'Relationship$resourceName' => '

The custom name of the related resource, if available.

', 'ResourceFilters$ResourceName' => '

The name of the resource.

', 'ResourceIdentifier$resourceName' => '

The custom name of the resource (if available).

', ], ], 'ResourceNotDiscoveredException' => [ 'base' => '

You have specified a resource that is either unknown or has not been discovered.

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

You have specified a resource that does not exist.

', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'AggregateResourceIdentifier$ResourceType' => '

The type of the Amazon Web Services resource.

', 'BaseConfigurationItem$resourceType' => '

The type of Amazon Web Services resource.

', 'ConfigurationItem$resourceType' => '

The type of Amazon Web Services resource.

', 'GetResourceConfigHistoryRequest$resourceType' => '

The resource type.

', 'ListAggregateDiscoveredResourcesRequest$ResourceType' => '

The type of resources that you want Config to list in the response.

', 'ListDiscoveredResourcesRequest$resourceType' => '

The type of resources that you want Config to list in the response.

', 'RecordingModeResourceTypesList$member' => NULL, 'Relationship$resourceType' => '

The resource type of the related resource.

', 'ResourceCount$resourceType' => '

The resource type (for example, "AWS::EC2::Instance").

', 'ResourceCountFilters$ResourceType' => '

The type of the Amazon Web Services resource.

', 'ResourceIdentifier$resourceType' => '

The type of resource.

', 'ResourceKey$resourceType' => '

The resource type.

', 'ResourceTypeList$member' => NULL, ], ], 'ResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'ExclusionByResourceTypes$resourceTypes' => '

A comma-separated list of resource types to exclude from recording by the configuration recorder.

', 'RecordingGroup$resourceTypes' => '

A comma-separated list that specifies which resource types Config records.

For a list of valid resourceTypes values, see the Resource Type Value column in Supported Amazon Web Services resource Types in the Config developer guide.

Required and optional fields

Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.

To record all configuration changes, set the allSupported field of RecordingGroup to true, and either omit this field or don\'t specify any resource types in this field. If you set the allSupported field to false and specify values for resourceTypes, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

Region availability

Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.

', ], ], 'ResourceTypeString' => [ 'base' => NULL, 'refs' => [ 'DeleteResourceConfigRequest$ResourceType' => '

The type of the resource.

', 'PutResourceConfigRequest$ResourceType' => '

The type of the resource. The custom resource type must be registered with CloudFormation.

You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.

', ], ], 'ResourceTypes' => [ 'base' => NULL, 'refs' => [ 'GetComplianceSummaryByResourceTypeRequest$ResourceTypes' => '

Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.

For this request, you can specify an Amazon Web Services resource type such as AWS::EC2::Instance. You can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

', 'GetDiscoveredResourceCountsRequest$resourceTypes' => '

The comma-separated list that specifies the resource types that you want Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User").

If a value for resourceTypes is not specified, Config returns all resource types that Config is recording in the region for your account.

If the configuration recorder is turned off, Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.

', ], ], 'ResourceTypesScope' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$ResourceTypesScope' => '

The type of the Amazon Web Services resource that was evaluated.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$ResourceTypesScope' => '

The type of the Amazon Web Services resource that was evaluated.

', 'OrganizationCustomRuleMetadata$ResourceTypesScope' => '

The type of the Amazon Web Services resource that was evaluated.

', 'OrganizationManagedRuleMetadata$ResourceTypesScope' => '

The type of the Amazon Web Services resource that was evaluated.

', ], ], 'ResourceValue' => [ 'base' => '

The dynamic value of the resource.

', 'refs' => [ 'RemediationParameterValue$ResourceValue' => '

The value is dynamic and changes at run-time.

', ], ], 'ResourceValueType' => [ 'base' => NULL, 'refs' => [ 'ResourceValue$Value' => '

The value is a resource ID.

', ], ], 'Results' => [ 'base' => NULL, 'refs' => [ 'SelectAggregateResourceConfigResponse$Results' => '

Returns the results for the SQL query.

', 'SelectResourceConfigResponse$Results' => '

Returns the results for the SQL query.

', ], ], 'RetentionConfiguration' => [ 'base' => '

An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in Config.

', 'refs' => [ 'PutRetentionConfigurationResponse$RetentionConfiguration' => '

Returns a retention configuration object.

', 'RetentionConfigurationList$member' => NULL, ], ], 'RetentionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'DescribeRetentionConfigurationsResponse$RetentionConfigurations' => '

Returns a retention configuration object.

', ], ], 'RetentionConfigurationName' => [ 'base' => NULL, 'refs' => [ 'DeleteRetentionConfigurationRequest$RetentionConfigurationName' => '

The name of the retention configuration to delete.

', 'RetentionConfiguration$Name' => '

The name of the retention configuration object.

', 'RetentionConfigurationNameList$member' => NULL, ], ], 'RetentionConfigurationNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeRetentionConfigurationsRequest$RetentionConfigurationNames' => '

A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.

Currently, Config supports only one retention configuration per region in your account.

', ], ], 'RetentionPeriodInDays' => [ 'base' => NULL, 'refs' => [ 'PutRetentionConfigurationRequest$RetentionPeriodInDays' => '

Number of days Config stores your historical information.

Currently, only applicable to the configuration item history.

', 'RetentionConfiguration$RetentionPeriodInDays' => '

Number of days Config stores your historical information.

Currently, only applicable to the configuration item history.

', ], ], 'RuleLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeConfigRuleEvaluationStatusRequest$Limit' => '

The number of rule evaluation results that you want returned.

This parameter is required if the rule limit for your account is more than the default of 150 rules.

For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.

', ], ], 'SSMDocumentName' => [ 'base' => NULL, 'refs' => [ 'TemplateSSMDocumentDetails$DocumentName' => '

The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.

', ], ], 'SSMDocumentVersion' => [ 'base' => NULL, 'refs' => [ 'TemplateSSMDocumentDetails$DocumentVersion' => '

The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.

This field is optional.

', ], ], 'SchemaVersionId' => [ 'base' => NULL, 'refs' => [ 'PutResourceConfigRequest$SchemaVersionId' => '

Version of the schema registered for the ResourceType in CloudFormation.

', ], ], 'Scope' => [ 'base' => '

Defines which resources trigger an evaluation for an Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

', 'refs' => [ 'ConfigRule$Scope' => '

Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

The scope can be empty.

', ], ], 'SelectAggregateResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'SelectAggregateResourceConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'SelectResourceConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'SelectResourceConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'SortBy' => [ 'base' => NULL, 'refs' => [ 'ListConformancePackComplianceScoresRequest$SortBy' => '

Sorts your conformance pack compliance scores in either ascending or descending order, depending on SortOrder.

By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Enter SCORE, to sort conformance pack compliance scores by the numerical value of the compliance score.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListConformancePackComplianceScoresRequest$SortOrder' => '

Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.

By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Conformance pack compliance scores are sorted in reverse alphabetical order if you enter DESCENDING.

You can sort conformance pack compliance scores by the numerical value of the compliance score by entering SCORE in the SortBy action. When compliance scores are sorted by SCORE, conformance packs with a compliance score of INSUFFICIENT_DATA will be last when sorting by ascending order and first when sorting by descending order.

', ], ], 'Source' => [ 'base' => '

Provides the CustomPolicyDetails, the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your Amazon Web Services resources.

', 'refs' => [ 'ConfigRule$Source' => '

Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.

', ], ], 'SourceDetail' => [ 'base' => '

Provides the source and the message types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.

', 'refs' => [ 'SourceDetails$member' => NULL, ], ], 'SourceDetails' => [ 'base' => NULL, 'refs' => [ 'Source$SourceDetails' => '

Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

If the owner is set to CUSTOM_POLICY, the only acceptable values for the Config rule trigger message type are ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification.

', ], ], 'SsmControls' => [ 'base' => '

Amazon Web Services Systems Manager (SSM) specific remediation controls.

', 'refs' => [ 'ExecutionControls$SsmControls' => '

A SsmControls object.

', ], ], 'StackArn' => [ 'base' => NULL, 'refs' => [ 'ConformancePackStatusDetail$StackArn' => '

Amazon Resource Name (ARN) of CloudFormation stack.

', ], ], 'StartConfigRulesEvaluationRequest' => [ 'base' => '

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

The output when you start the evaluation for the specified Config rule.

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

The input for the StartConfigurationRecorder action.

', 'refs' => [], ], 'StartRemediationExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRemediationExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartResourceEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartResourceEvaluationResponse' => [ 'base' => NULL, 'refs' => [], ], 'StaticParameterValues' => [ 'base' => NULL, 'refs' => [ 'StaticValue$Values' => '

A list of values. For example, the ARN of the assumed role.

', ], ], 'StaticValue' => [ 'base' => '

The static value of the resource.

', 'refs' => [ 'RemediationParameterValue$StaticValue' => '

The value is static and does not change at run-time.

', ], ], 'StatusDetailFilters' => [ 'base' => '

Status filter object to filter results based on specific member account ID or status type for an organization Config rule.

', 'refs' => [ 'GetOrganizationConfigRuleDetailedStatusRequest$Filters' => '

A StatusDetailFilters object.

', ], ], 'StopConfigurationRecorderRequest' => [ 'base' => '

The input for the StopConfigurationRecorder action.

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

Provides the details of a stored query.

', 'refs' => [ 'GetStoredQueryResponse$StoredQuery' => '

Returns a StoredQuery object.

', 'PutStoredQueryRequest$StoredQuery' => '

A list of StoredQuery objects. The mandatory fields are QueryName and Expression.

When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional.

', ], ], 'StoredQueryMetadata' => [ 'base' => '

Returns details of a specific query.

', 'refs' => [ 'StoredQueryMetadataList$member' => NULL, ], ], 'StoredQueryMetadataList' => [ 'base' => NULL, 'refs' => [ 'ListStoredQueriesResponse$StoredQueryMetadata' => '

A list of StoredQueryMetadata objects.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AggregatedSourceStatus$SourceId' => '

The source account ID or an organization.

', 'AggregatedSourceStatus$LastErrorCode' => '

The error code that Config returned when the source account aggregation last failed.

', 'AggregatedSourceStatus$LastErrorMessage' => '

The message indicating that the source account aggregation failed due to an error.

', 'AggregationAuthorization$AggregationAuthorizationArn' => '

The Amazon Resource Name (ARN) of the aggregation object.

', 'AggregatorRegionList$member' => NULL, 'ConfigExportDeliveryInfo$lastErrorCode' => '

The error code from the last attempted delivery.

', 'ConfigExportDeliveryInfo$lastErrorMessage' => '

The error message from the last attempted delivery.

', 'ConfigRuleEvaluationStatus$ConfigRuleArn' => '

The Amazon Resource Name (ARN) of the Config rule.

', 'ConfigRuleEvaluationStatus$ConfigRuleId' => '

The ID of the Config rule.

', 'ConfigRuleEvaluationStatus$LastErrorCode' => '

The error code that Config returned when the rule last failed.

', 'ConfigRuleEvaluationStatus$LastErrorMessage' => '

The error message that Config returned when the rule last failed.

', 'ConfigRuleEvaluationStatus$LastDebugLogDeliveryStatus' => '

The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either Successful or Failed.

', 'ConfigRuleEvaluationStatus$LastDebugLogDeliveryStatusReason' => '

The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.

', 'ConfigStreamDeliveryInfo$lastErrorCode' => '

The error code from the last attempted delivery.

', 'ConfigStreamDeliveryInfo$lastErrorMessage' => '

The error message from the last attempted delivery.

', 'ConfigurationRecorder$roleARN' => '

Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.

While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.

Pre-existing Config role

If you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected.

For example, if Control Tower has an IAM role that allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see Identity and Access Management for Config in the Config Developer Guide.

', 'ConfigurationRecorderStatus$name' => '

The name of the configuration recorder.

', 'ConfigurationRecorderStatus$lastErrorCode' => '

The latest error code from when the recorder last failed.

', 'ConfigurationRecorderStatus$lastErrorMessage' => '

The latest error message from when the recorder last failed.

', 'DeleteRemediationConfigurationRequest$ResourceType' => '

The type of a resource.

', 'DeliverConfigSnapshotResponse$configSnapshotId' => '

The ID of the snapshot that is being created.

', 'DeliveryChannel$s3BucketName' => '

The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.

', 'DeliveryChannel$s3KeyPrefix' => '

The prefix for the specified Amazon S3 bucket.

', 'DeliveryChannel$s3KmsKeyArn' => '

The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.

', 'DeliveryChannel$snsTopicARN' => '

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.

', 'DeliveryChannelStatus$name' => '

The name of the delivery channel.

', 'DescribeAggregationAuthorizationsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeAggregationAuthorizationsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeComplianceByConfigRuleRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeComplianceByConfigRuleResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'DescribeConfigRuleEvaluationStatusRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeConfigRuleEvaluationStatusResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'DescribeConfigRulesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeConfigRulesResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'DescribeConfigurationAggregatorSourcesStatusRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeConfigurationAggregatorSourcesStatusResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeConfigurationAggregatorsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeConfigurationAggregatorsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConfigRuleStatusesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConfigRuleStatusesResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConfigRulesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConfigRulesResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConformancePackStatusesRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConformancePackStatusesResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConformancePacksRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeOrganizationConformancePacksResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribePendingAggregationRequestsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribePendingAggregationRequestsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeRemediationExceptionsRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeRemediationExceptionsResponse$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'DescribeRemediationExecutionStatusRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'DescribeRemediationExecutionStatusResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'EvaluationResult$ResultToken' => '

An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.

', 'FailedDeleteRemediationExceptionsBatch$FailureMessage' => '

Returns a failure message for delete remediation exception. For example, Config creates an exception due to an internal error.

', 'FailedRemediationBatch$FailureMessage' => '

Returns a failure message. For example, the resource is already compliant.

', 'FailedRemediationExceptionBatch$FailureMessage' => '

Returns a failure message. For example, the auto-remediation has failed.

', 'GetComplianceDetailsByResourceRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetComplianceDetailsByResourceResponse$NextToken' => '

The string that you use in a subsequent request to get the next page of results in a paginated response.

', 'GetOrganizationConfigRuleDetailedStatusRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetOrganizationConfigRuleDetailedStatusResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetOrganizationConformancePackDetailedStatusRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'GetOrganizationConformancePackDetailedStatusResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'IdempotentParameterMismatch$message' => NULL, 'ListResourceEvaluationsRequest$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListResourceEvaluationsResponse$NextToken' => '

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

', 'ListStoredQueriesRequest$NextToken' => '

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

', 'ListStoredQueriesResponse$NextToken' => '

If the previous paginated request didn\'t return all of the remaining results, the response object\'s NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s NextToken parameter. If there are no remaining results, the previous response object\'s NextToken parameter is set to null.

', 'MemberAccountStatus$ErrorCode' => '

An error code that is returned when Config rule creation or deletion failed in the member account.

', 'MemberAccountStatus$ErrorMessage' => '

An error message indicating that Config rule account creation or deletion has failed due to an error in the member account.

', 'OrganizationAggregationSource$RoleArn' => '

ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.

', 'OrganizationConfigRuleStatus$ErrorCode' => '

An error code that is returned when organization Config rule creation or deletion has failed.

', 'OrganizationConfigRuleStatus$ErrorMessage' => '

An error message indicating that organization Config rule creation or deletion failed due to an error.

', 'OrganizationConformancePackDetailedStatus$ErrorCode' => '

An error code that is returned when conformance pack creation or deletion failed in the member account.

', 'OrganizationConformancePackDetailedStatus$ErrorMessage' => '

An error message indicating that conformance pack account creation or deletion has failed due to an error in the member account.

', 'OrganizationConformancePackStatus$ErrorCode' => '

An error code that is returned when organization conformance pack creation or deletion has failed in a member account.

', 'OrganizationConformancePackStatus$ErrorMessage' => '

An error message indicating that organization conformance pack creation or deletion failed due to an error.

', 'PutEvaluationsRequest$ResultToken' => '

An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.

', 'RemediationConfiguration$TargetVersion' => '

Version of the target. For example, version of the SSM document.

If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.

', 'RemediationConfiguration$ResourceType' => '

The type of a resource.

', 'RemediationExecutionStep$Name' => '

The details of the step.

', 'RemediationExecutionStep$ErrorMessage' => '

An error message if the step was interrupted during execution.

', 'Results$member' => NULL, 'StartRemediationExecutionResponse$FailureMessage' => '

Returns a failure message. For example, the resource is already compliant.

', ], ], 'StringWithCharLimit1024' => [ 'base' => NULL, 'refs' => [ 'ConfigRule$InputParameters' => '

A string, in JSON format, that is passed to the Config rule Lambda function.

', 'EvaluationStatus$FailureReason' => '

An explanation for failed execution status.

', 'PutRemediationExceptionsRequest$Message' => '

The message contains an explanation of the exception.

', 'RemediationConfiguration$Arn' => '

Amazon Resource Name (ARN) of remediation configuration.

', 'RemediationConfiguration$CreatedByService' => '

Name of the service that owns the service-linked rule, if applicable.

', 'RemediationException$ResourceId' => '

The ID of the resource (for example., sg-xxxxxx).

', 'RemediationException$Message' => '

An explanation of an remediation exception.

', 'RemediationExceptionResourceKey$ResourceId' => '

The ID of the resource (for example., sg-xxxxxx).

', ], ], 'StringWithCharLimit128' => [ 'base' => NULL, 'refs' => [ 'ControlsList$member' => NULL, 'OrganizationCustomPolicyRuleMetadata$TagKeyScope' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$TagKeyScope' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

', 'OrganizationCustomRuleMetadata$TagKeyScope' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

', 'OrganizationManagedRuleMetadata$TagKeyScope' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

', 'Scope$TagKey' => '

The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

', ], ], 'StringWithCharLimit2048' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$InputParameters' => '

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$InputParameters' => '

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

', 'OrganizationCustomRuleMetadata$InputParameters' => '

A string, in JSON format, that is passed to your organization Config rule Lambda function.

', 'OrganizationManagedRuleMetadata$InputParameters' => '

A string, in JSON format, that is passed to your organization Config rule Lambda function.

', ], ], 'StringWithCharLimit256' => [ 'base' => NULL, 'refs' => [ 'AggregateComplianceCount$GroupName' => '

The 12-digit account ID or region based on the GroupByKey value.

', 'AggregateConformancePackComplianceSummary$GroupName' => '

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

', 'AggregateEvaluationResult$Annotation' => '

Supplementary information about how the agrregate evaluation determined the compliance.

', 'ComplianceByResource$ResourceType' => '

The type of the Amazon Web Services resource that was evaluated.

', 'ComplianceResourceTypes$member' => NULL, 'ComplianceSummaryByResourceType$ResourceType' => '

The type of Amazon Web Services resource.

', 'ConfigRule$ConfigRuleArn' => '

The Amazon Resource Name (ARN) of the Config rule.

', 'ConfigRule$CreatedBy' => '

Service principal name of the service that created the rule.

The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.

', 'ConfigurationAggregator$CreatedBy' => '

Amazon Web Services service that created the configuration aggregator.

', 'ConformancePackComplianceResourceIds$member' => NULL, 'ConformancePackDetail$CreatedBy' => '

The Amazon Web Services service that created the conformance pack.

', 'ConformancePackEvaluationFilters$ResourceType' => '

Filters the results by the resource type (for example, "AWS::EC2::Instance").

', 'DescribeComplianceByResourceRequest$ResourceType' => '

The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

', 'Evaluation$ComplianceResourceType' => '

The type of Amazon Web Services resource that was evaluated.

', 'Evaluation$Annotation' => '

Supplementary information about how the evaluation determined the compliance.

', 'EvaluationResult$Annotation' => '

Supplementary information about how the evaluation determined the compliance.

', 'EvaluationResultQualifier$ResourceType' => '

The type of Amazon Web Services resource that was evaluated.

', 'ExternalEvaluation$ComplianceResourceType' => '

The evaluated compliance resource type. Config accepts AWS::::Account resource type.

', 'ExternalEvaluation$Annotation' => '

Supplementary information about the reason of compliance. For example, this task was completed on a specific date.

', 'GetAggregateConfigRuleComplianceSummaryResponse$GroupByKey' => '

Groups the result based on ACCOUNT_ID or AWS_REGION.

', 'GetAggregateConformancePackComplianceSummaryResponse$GroupByKey' => '

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

', 'GetAggregateDiscoveredResourceCountsResponse$GroupByKey' => '

The key passed into the request object. If GroupByKey is not provided, the result will be empty.

', 'GetComplianceDetailsByResourceRequest$ResourceType' => '

The type of the Amazon Web Services resource for which you want compliance information.

', 'GroupedResourceCount$GroupName' => '

The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the region was chosen as GroupByKey.

', 'OrganizationConfigRule$OrganizationConfigRuleArn' => '

Amazon Resource Name (ARN) of organization Config rule.

', 'OrganizationConformancePack$OrganizationConformancePackArn' => '

Amazon Resource Name (ARN) of organization conformance pack.

', 'OrganizationConformancePackDetailedStatus$ConformancePackName' => '

The name of conformance pack deployed in the member account.

', 'OrganizationCustomPolicyRuleMetadata$TagValueScope' => '

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$TagValueScope' => '

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', 'OrganizationCustomRuleMetadata$LambdaFunctionArn' => '

The lambda function ARN.

', 'OrganizationCustomRuleMetadata$TagValueScope' => '

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', 'OrganizationManagedRuleMetadata$RuleIdentifier' => '

For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

', 'OrganizationManagedRuleMetadata$TagValueScope' => '

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', 'PutOrganizationConfigRuleResponse$OrganizationConfigRuleArn' => '

The Amazon Resource Name (ARN) of an organization Config rule.

', 'PutOrganizationConformancePackResponse$OrganizationConformancePackArn' => '

ARN of the organization conformance pack.

', 'RemediationConfiguration$TargetId' => '

Target ID is the name of the SSM document.

', 'RemediationException$ResourceType' => '

The type of a resource.

', 'RemediationExceptionResourceKey$ResourceType' => '

The type of a resource.

', 'RemediationParameters$key' => NULL, 'ResourceDetails$ResourceType' => '

The type of resource being evaluated.

', 'ResourceTypes$member' => NULL, 'ResourceTypesScope$member' => NULL, 'Scope$TagValue' => '

The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

', 'Source$SourceIdentifier' => '

For Config Managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see List of Config Managed Rules.

For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule\'s Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name.

For Config Custom Policy rules, this field will be ignored.

', 'StaticParameterValues$member' => NULL, ], ], 'StringWithCharLimit256Min0' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$Description' => '

The description that you provide for your organization Config Custom Policy rule.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$Description' => '

The description that you provide for your organization Config Custom Policy rule.

', 'OrganizationCustomRuleMetadata$Description' => '

The description that you provide for your organization Config rule.

', 'OrganizationManagedRuleMetadata$Description' => '

The description that you provide for your organization Config rule.

', ], ], 'StringWithCharLimit64' => [ 'base' => NULL, 'refs' => [ 'ComplianceByConfigRule$ConfigRuleName' => '

The name of the Config rule.

', 'ConfigRule$ConfigRuleId' => '

The ID of the Config rule.

', 'ConformancePackConfigRuleNames$member' => NULL, 'DeleteEvaluationResultsRequest$ConfigRuleName' => '

The name of the Config rule for which you want to delete the evaluation results.

', 'GetComplianceDetailsByConfigRuleRequest$ConfigRuleName' => '

The name of the Config rule for which you want compliance information.

', 'MemberAccountStatus$ConfigRuleName' => '

The name of Config rule deployed in the member account.

', 'OrganizationConfigRuleNames$member' => NULL, ], ], 'StringWithCharLimit768' => [ 'base' => NULL, 'refs' => [ 'OrganizationCustomPolicyRuleMetadata$ResourceIdScope' => '

The ID of the Amazon Web Services resource that was evaluated.

', 'OrganizationCustomPolicyRuleMetadataNoPolicy$ResourceIdScope' => '

The ID of the Amazon Web Services resource that was evaluated.

', 'OrganizationCustomRuleMetadata$ResourceIdScope' => '

The ID of the Amazon Web Services resource that was evaluated.

', 'OrganizationManagedRuleMetadata$ResourceIdScope' => '

The ID of the Amazon Web Services resource that was evaluated.

', ], ], 'SupplementaryConfiguration' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$supplementaryConfiguration' => '

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

', 'ConfigurationItem$supplementaryConfiguration' => '

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

', ], ], 'SupplementaryConfigurationName' => [ 'base' => NULL, 'refs' => [ 'SupplementaryConfiguration$key' => NULL, ], ], 'SupplementaryConfigurationValue' => [ 'base' => NULL, 'refs' => [ 'SupplementaryConfiguration$value' => NULL, ], ], 'Tag' => [ 'base' => '

The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

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

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

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

The keys of the tags to be removed.

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

The tags for the resource.

', 'TagResourceRequest$Tags' => '

An array of tag object.

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

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'ConfigurationItem$tags' => '

A mapping of key value tags associated with the resource.

', 'PutResourceConfigRequest$Tags' => '

Tags associated with the resource.

This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for PutResourceConfig are tags that you supply for the configuration items of your custom resources.

', ], ], 'TagsList' => [ 'base' => NULL, 'refs' => [ 'PutAggregationAuthorizationRequest$Tags' => '

An array of tag object.

', 'PutConfigRuleRequest$Tags' => '

An array of tag object.

', 'PutConfigurationAggregatorRequest$Tags' => '

An array of tag object.

', 'PutStoredQueryRequest$Tags' => '

A list of Tags object.

', ], ], 'TemplateBody' => [ 'base' => NULL, 'refs' => [ 'PutConformancePackRequest$TemplateBody' => '

A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.

You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

', 'PutOrganizationConformancePackRequest$TemplateBody' => '

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

', ], ], 'TemplateS3Uri' => [ 'base' => NULL, 'refs' => [ 'PutConformancePackRequest$TemplateS3Uri' => '

The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.

You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.

', 'PutOrganizationConformancePackRequest$TemplateS3Uri' => '

Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).

You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.

', ], ], 'TemplateSSMDocumentDetails' => [ 'base' => '

This API allows you to create a conformance pack template with an Amazon Web Services Systems Manager document (SSM document). To deploy a conformance pack using an SSM document, first create an SSM document with conformance pack content, and then provide the DocumentName in the PutConformancePack API. You can also provide the DocumentVersion.

The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.

', 'refs' => [ 'ConformancePackDetail$TemplateSSMDocumentDetails' => '

An object that contains the name or Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

', 'PutConformancePackRequest$TemplateSSMDocumentDetails' => '

An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

', ], ], 'TimeWindow' => [ 'base' => '

Filters evaluation results based on start and end times.

', 'refs' => [ 'ResourceEvaluationFilters$TimeWindow' => '

Returns a TimeWindow object.

', ], ], 'TooManyTagsException' => [ 'base' => '

You have reached the limit of the number of tags you can use. For more information, see Service Limits in the Config Developer Guide.

', 'refs' => [], ], 'UnprocessedResourceIdentifierList' => [ 'base' => NULL, 'refs' => [ 'BatchGetAggregateResourceConfigResponse$UnprocessedResourceIdentifiers' => '

A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

The requested action is not valid.

For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

', 'refs' => [], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'Tags$value' => NULL, ], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'BaseConfigurationItem$version' => '

The version number of the resource configuration.

', 'ConfigurationItem$version' => '

The version number of the resource configuration.

', ], ], ],]; diff --git a/src/data/docdb/2014-10-31/api-2.json b/src/data/docdb/2014-10-31/api-2.json index 1fbe84ddd6..32d8cb003b 100644 --- a/src/data/docdb/2014-10-31/api-2.json +++ b/src/data/docdb/2014-10-31/api-2.json @@ -1594,7 +1594,9 @@ "PromotionTier":{"shape":"IntegerOptional"}, "DBInstanceArn":{"shape":"String"}, "EnabledCloudwatchLogsExports":{"shape":"LogTypeList"}, - "CertificateDetails":{"shape":"CertificateDetails"} + "CertificateDetails":{"shape":"CertificateDetails"}, + "PerformanceInsightsEnabled":{"shape":"BooleanOptional"}, + "PerformanceInsightsKMSKeyId":{"shape":"String"} }, "wrapper":true }, diff --git a/src/data/docdb/2014-10-31/api-2.json.php b/src/data/docdb/2014-10-31/api-2.json.php index 17ae506fb3..958e6ca7b5 100644 --- a/src/data/docdb/2014-10-31/api-2.json.php +++ b/src/data/docdb/2014-10-31/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2014-10-31', 'endpointPrefix' => 'rds', 'protocol' => 'query', 'serviceAbbreviation' => 'Amazon DocDB', 'serviceFullName' => 'Amazon DocumentDB with MongoDB compatibility', 'serviceId' => 'DocDB', 'signatureVersion' => 'v4', 'signingName' => 'rds', 'uid' => 'docdb-2014-10-31', 'xmlNamespace' => 'http://rds.amazonaws.com/doc/2014-10-31/', ], 'operations' => [ 'AddSourceIdentifierToSubscription' => [ 'name' => 'AddSourceIdentifierToSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddSourceIdentifierToSubscriptionMessage', ], 'output' => [ 'shape' => 'AddSourceIdentifierToSubscriptionResult', 'resultWrapper' => 'AddSourceIdentifierToSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'AddTagsToResource' => [ 'name' => 'AddTagsToResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsToResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ApplyPendingMaintenanceAction' => [ 'name' => 'ApplyPendingMaintenanceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ApplyPendingMaintenanceActionMessage', ], 'output' => [ 'shape' => 'ApplyPendingMaintenanceActionResult', 'resultWrapper' => 'ApplyPendingMaintenanceActionResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'CopyDBClusterParameterGroup' => [ 'name' => 'CopyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CopyDBClusterParameterGroupResult', 'resultWrapper' => 'CopyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CopyDBClusterSnapshot' => [ 'name' => 'CopyDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CopyDBClusterSnapshotResult', 'resultWrapper' => 'CopyDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CreateDBCluster' => [ 'name' => 'CreateDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterMessage', ], 'output' => [ 'shape' => 'CreateDBClusterResult', 'resultWrapper' => 'CreateDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'CreateDBClusterParameterGroup' => [ 'name' => 'CreateDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateDBClusterParameterGroupResult', 'resultWrapper' => 'CreateDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CreateDBClusterSnapshot' => [ 'name' => 'CreateDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CreateDBClusterSnapshotResult', 'resultWrapper' => 'CreateDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], ], ], 'CreateDBInstance' => [ 'name' => 'CreateDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBInstanceMessage', ], 'output' => [ 'shape' => 'CreateDBInstanceResult', 'resultWrapper' => 'CreateDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CreateDBSubnetGroup' => [ 'name' => 'CreateDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'CreateDBSubnetGroupResult', 'resultWrapper' => 'CreateDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupAlreadyExistsFault', ], [ 'shape' => 'DBSubnetGroupQuotaExceededFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'CreateEventSubscription' => [ 'name' => 'CreateEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEventSubscriptionMessage', ], 'output' => [ 'shape' => 'CreateEventSubscriptionResult', 'resultWrapper' => 'CreateEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionAlreadyExistFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'CreateGlobalCluster' => [ 'name' => 'CreateGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGlobalClusterMessage', ], 'output' => [ 'shape' => 'CreateGlobalClusterResult', 'resultWrapper' => 'CreateGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterAlreadyExistsFault', ], [ 'shape' => 'GlobalClusterQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DeleteDBCluster' => [ 'name' => 'DeleteDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterResult', 'resultWrapper' => 'DeleteDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], ], ], 'DeleteDBClusterParameterGroup' => [ 'name' => 'DeleteDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DeleteDBClusterSnapshot' => [ 'name' => 'DeleteDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterSnapshotResult', 'resultWrapper' => 'DeleteDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DeleteDBInstance' => [ 'name' => 'DeleteDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBInstanceMessage', ], 'output' => [ 'shape' => 'DeleteDBInstanceResult', 'resultWrapper' => 'DeleteDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'DeleteDBSubnetGroup' => [ 'name' => 'DeleteDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSubnetGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidDBSubnetStateFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DeleteEventSubscription' => [ 'name' => 'DeleteEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEventSubscriptionMessage', ], 'output' => [ 'shape' => 'DeleteEventSubscriptionResult', 'resultWrapper' => 'DeleteEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'InvalidEventSubscriptionStateFault', ], ], ], 'DeleteGlobalCluster' => [ 'name' => 'DeleteGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGlobalClusterMessage', ], 'output' => [ 'shape' => 'DeleteGlobalClusterResult', 'resultWrapper' => 'DeleteGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'DescribeCertificates' => [ 'name' => 'DescribeCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCertificatesMessage', ], 'output' => [ 'shape' => 'CertificateMessage', 'resultWrapper' => 'DescribeCertificatesResult', ], 'errors' => [ [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'DescribeDBClusterParameterGroups' => [ 'name' => 'DescribeDBClusterParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParameterGroupsMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupsMessage', 'resultWrapper' => 'DescribeDBClusterParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterParameters' => [ 'name' => 'DescribeDBClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParametersMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupDetails', 'resultWrapper' => 'DescribeDBClusterParametersResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterSnapshotAttributes' => [ 'name' => 'DescribeDBClusterSnapshotAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesMessage', ], 'output' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesResult', 'resultWrapper' => 'DescribeDBClusterSnapshotAttributesResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusterSnapshots' => [ 'name' => 'DescribeDBClusterSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotsMessage', ], 'output' => [ 'shape' => 'DBClusterSnapshotMessage', 'resultWrapper' => 'DescribeDBClusterSnapshotsResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusters' => [ 'name' => 'DescribeDBClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClustersMessage', ], 'output' => [ 'shape' => 'DBClusterMessage', 'resultWrapper' => 'DescribeDBClustersResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBEngineVersions' => [ 'name' => 'DescribeDBEngineVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBEngineVersionsMessage', ], 'output' => [ 'shape' => 'DBEngineVersionMessage', 'resultWrapper' => 'DescribeDBEngineVersionsResult', ], ], 'DescribeDBInstances' => [ 'name' => 'DescribeDBInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBInstancesMessage', ], 'output' => [ 'shape' => 'DBInstanceMessage', 'resultWrapper' => 'DescribeDBInstancesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeDBSubnetGroups' => [ 'name' => 'DescribeDBSubnetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSubnetGroupsMessage', ], 'output' => [ 'shape' => 'DBSubnetGroupMessage', 'resultWrapper' => 'DescribeDBSubnetGroupsResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DescribeEngineDefaultClusterParameters' => [ 'name' => 'DescribeEngineDefaultClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultClusterParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultClusterParametersResult', 'resultWrapper' => 'DescribeEngineDefaultClusterParametersResult', ], ], 'DescribeEventCategories' => [ 'name' => 'DescribeEventCategories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventCategoriesMessage', ], 'output' => [ 'shape' => 'EventCategoriesMessage', 'resultWrapper' => 'DescribeEventCategoriesResult', ], ], 'DescribeEventSubscriptions' => [ 'name' => 'DescribeEventSubscriptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventSubscriptionsMessage', ], 'output' => [ 'shape' => 'EventSubscriptionsMessage', 'resultWrapper' => 'DescribeEventSubscriptionsResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], ], ], 'DescribeEvents' => [ 'name' => 'DescribeEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventsMessage', ], 'output' => [ 'shape' => 'EventsMessage', 'resultWrapper' => 'DescribeEventsResult', ], ], 'DescribeGlobalClusters' => [ 'name' => 'DescribeGlobalClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGlobalClustersMessage', ], 'output' => [ 'shape' => 'GlobalClustersMessage', 'resultWrapper' => 'DescribeGlobalClustersResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], ], ], 'DescribeOrderableDBInstanceOptions' => [ 'name' => 'DescribeOrderableDBInstanceOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrderableDBInstanceOptionsMessage', ], 'output' => [ 'shape' => 'OrderableDBInstanceOptionsMessage', 'resultWrapper' => 'DescribeOrderableDBInstanceOptionsResult', ], ], 'DescribePendingMaintenanceActions' => [ 'name' => 'DescribePendingMaintenanceActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePendingMaintenanceActionsMessage', ], 'output' => [ 'shape' => 'PendingMaintenanceActionsMessage', 'resultWrapper' => 'DescribePendingMaintenanceActionsResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], ], ], 'FailoverDBCluster' => [ 'name' => 'FailoverDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'FailoverDBClusterMessage', ], 'output' => [ 'shape' => 'FailoverDBClusterResult', 'resultWrapper' => 'FailoverDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ModifyDBCluster' => [ 'name' => 'ModifyDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterResult', 'resultWrapper' => 'ModifyDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterAlreadyExistsFault', ], ], ], 'ModifyDBClusterParameterGroup' => [ 'name' => 'ModifyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ModifyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBParameterGroupStateFault', ], ], ], 'ModifyDBClusterSnapshotAttribute' => [ 'name' => 'ModifyDBClusterSnapshotAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeResult', 'resultWrapper' => 'ModifyDBClusterSnapshotAttributeResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SharedSnapshotQuotaExceededFault', ], ], ], 'ModifyDBInstance' => [ 'name' => 'ModifyDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBInstanceMessage', ], 'output' => [ 'shape' => 'ModifyDBInstanceResult', 'resultWrapper' => 'ModifyDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'DBUpgradeDependencyFailureFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'ModifyDBSubnetGroup' => [ 'name' => 'ModifyDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'ModifyDBSubnetGroupResult', 'resultWrapper' => 'ModifyDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'SubnetAlreadyInUse', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'ModifyEventSubscription' => [ 'name' => 'ModifyEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyEventSubscriptionMessage', ], 'output' => [ 'shape' => 'ModifyEventSubscriptionResult', 'resultWrapper' => 'ModifyEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], ], ], 'ModifyGlobalCluster' => [ 'name' => 'ModifyGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyGlobalClusterMessage', ], 'output' => [ 'shape' => 'ModifyGlobalClusterResult', 'resultWrapper' => 'ModifyGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'RebootDBInstance' => [ 'name' => 'RebootDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootDBInstanceMessage', ], 'output' => [ 'shape' => 'RebootDBInstanceResult', 'resultWrapper' => 'RebootDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'RemoveFromGlobalCluster' => [ 'name' => 'RemoveFromGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveFromGlobalClusterMessage', ], 'output' => [ 'shape' => 'RemoveFromGlobalClusterResult', 'resultWrapper' => 'RemoveFromGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'RemoveSourceIdentifierFromSubscription' => [ 'name' => 'RemoveSourceIdentifierFromSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionMessage', ], 'output' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionResult', 'resultWrapper' => 'RemoveSourceIdentifierFromSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'RemoveTagsFromResource' => [ 'name' => 'RemoveTagsFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveTagsFromResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ResetDBClusterParameterGroup' => [ 'name' => 'ResetDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ResetDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'RestoreDBClusterFromSnapshot' => [ 'name' => 'RestoreDBClusterFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterFromSnapshotMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterFromSnapshotResult', 'resultWrapper' => 'RestoreDBClusterFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'RestoreDBClusterToPointInTime' => [ 'name' => 'RestoreDBClusterToPointInTime', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterToPointInTimeMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterToPointInTimeResult', 'resultWrapper' => 'RestoreDBClusterToPointInTimeResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], ], ], 'StartDBCluster' => [ 'name' => 'StartDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBClusterMessage', ], 'output' => [ 'shape' => 'StartDBClusterResult', 'resultWrapper' => 'StartDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'StopDBCluster' => [ 'name' => 'StopDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBClusterMessage', ], 'output' => [ 'shape' => 'StopDBClusterResult', 'resultWrapper' => 'StopDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], ], 'shapes' => [ 'AddSourceIdentifierToSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'AddTagsToResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'Tags', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ApplyMethod' => [ 'type' => 'string', 'enum' => [ 'immediate', 'pending-reboot', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceIdentifier', 'ApplyAction', 'OptInType', ], 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'ApplyAction' => [ 'shape' => 'String', ], 'OptInType' => [ 'shape' => 'String', ], ], ], 'ApplyPendingMaintenanceActionResult' => [ 'type' => 'structure', 'members' => [ 'ResourcePendingMaintenanceActions' => [ 'shape' => 'ResourcePendingMaintenanceActions', ], ], ], 'AttributeValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AttributeValue', ], ], 'AuthorizationNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', 'locationName' => 'AvailabilityZone', ], ], 'AvailabilityZones' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AvailabilityZone', ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOptional' => [ 'type' => 'boolean', ], 'CACertificateIdentifiersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Certificate' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'CertificateType' => [ 'shape' => 'String', ], 'Thumbprint' => [ 'shape' => 'String', ], 'ValidFrom' => [ 'shape' => 'TStamp', ], 'ValidTill' => [ 'shape' => 'TStamp', ], 'CertificateArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'CertificateDetails' => [ 'type' => 'structure', 'members' => [ 'CAIdentifier' => [ 'shape' => 'String', ], 'ValidTill' => [ 'shape' => 'TStamp', ], ], ], 'CertificateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Certificate', 'locationName' => 'Certificate', ], ], 'CertificateMessage' => [ 'type' => 'structure', 'members' => [ 'Certificates' => [ 'shape' => 'CertificateList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'CertificateNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CertificateNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CloudwatchLogsExportConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableLogTypes' => [ 'shape' => 'LogTypeList', ], 'DisableLogTypes' => [ 'shape' => 'LogTypeList', ], ], ], 'CopyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupDescription', ], 'members' => [ 'SourceDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CopyDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterSnapshotIdentifier', 'TargetDBClusterSnapshotIdentifier', ], 'members' => [ 'SourceDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'CopyTags' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CreateDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'StorageType' => [ 'shape' => 'String', ], ], ], 'CreateDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'DBParameterGroupFamily', 'Description', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CreateDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'CreateDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'DBClusterIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CreateDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBInstanceClass', 'Engine', 'DBClusterIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], ], ], 'CreateDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'CreateDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'DBSubnetGroupDescription', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'CreateEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SnsTopicArn', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'SourceIds' => [ 'shape' => 'SourceIdsList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'CreateGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'DBCluster' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroup' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'String', ], 'EarliestRestorableTime' => [ 'shape' => 'TStamp', ], 'Endpoint' => [ 'shape' => 'String', ], 'ReaderEndpoint' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'ReplicationSourceIdentifier' => [ 'shape' => 'String', ], 'ReadReplicaIdentifiers' => [ 'shape' => 'ReadReplicaIdentifierList', ], 'DBClusterMembers' => [ 'shape' => 'DBClusterMemberList', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'HostedZoneId' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], 'DBClusterArn' => [ 'shape' => 'String', ], 'AssociatedRoles' => [ 'shape' => 'DBClusterRoles', ], 'CloneGroupId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBCluster', 'locationName' => 'DBCluster', ], ], 'DBClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'IsClusterWriter' => [ 'shape' => 'Boolean', ], 'DBClusterParameterGroupStatus' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], ], 'wrapper' => true, ], 'DBClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterMember', 'locationName' => 'DBClusterMember', ], ], 'DBClusterMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusters' => [ 'shape' => 'DBClusterList', ], ], ], 'DBClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterParameterGroup' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'DBClusterParameterGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Parameters' => [ 'shape' => 'ParametersList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterParameterGroup', 'locationName' => 'DBClusterParameterGroup', ], ], 'DBClusterParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterParameterGroups' => [ 'shape' => 'DBClusterParameterGroupList', ], ], ], 'DBClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterQuotaExceededFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRole' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBClusterRoles' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterRole', 'locationName' => 'DBClusterRole', ], ], 'DBClusterSnapshot' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'Engine' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'VpcId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DBClusterSnapshotArn' => [ 'shape' => 'String', ], 'SourceDBClusterSnapshotArn' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterSnapshotAttribute' => [ 'type' => 'structure', 'members' => [ 'AttributeName' => [ 'shape' => 'String', ], 'AttributeValues' => [ 'shape' => 'AttributeValueList', ], ], ], 'DBClusterSnapshotAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshotAttribute', 'locationName' => 'DBClusterSnapshotAttribute', ], ], 'DBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotAttributes' => [ 'shape' => 'DBClusterSnapshotAttributeList', ], ], 'wrapper' => true, ], 'DBClusterSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshot', 'locationName' => 'DBClusterSnapshot', ], ], 'DBClusterSnapshotMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterSnapshots' => [ 'shape' => 'DBClusterSnapshotList', ], ], ], 'DBClusterSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBEngineVersion' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'DBEngineDescription' => [ 'shape' => 'String', ], 'DBEngineVersionDescription' => [ 'shape' => 'String', ], 'ValidUpgradeTarget' => [ 'shape' => 'ValidUpgradeTargetList', ], 'ExportableLogTypes' => [ 'shape' => 'LogTypeList', ], 'SupportsLogExportsToCloudwatchLogs' => [ 'shape' => 'Boolean', ], 'SupportedCACertificateIdentifiers' => [ 'shape' => 'CACertificateIdentifiersList', ], 'SupportsCertificateRotationWithoutRestart' => [ 'shape' => 'BooleanOptional', ], ], ], 'DBEngineVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBEngineVersion', 'locationName' => 'DBEngineVersion', ], ], 'DBEngineVersionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBEngineVersions' => [ 'shape' => 'DBEngineVersionList', ], ], ], 'DBInstance' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'DBInstanceStatus' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'Integer', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'PendingModifiedValues' => [ 'shape' => 'PendingModifiedValues', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'PubliclyAccessible' => [ 'shape' => 'Boolean', ], 'StatusInfos' => [ 'shape' => 'DBInstanceStatusInfoList', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceArn' => [ 'shape' => 'String', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'CertificateDetails' => [ 'shape' => 'CertificateDetails', ], ], 'wrapper' => true, ], 'DBInstanceAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstance', 'locationName' => 'DBInstance', ], ], 'DBInstanceMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBInstances' => [ 'shape' => 'DBInstanceList', ], ], ], 'DBInstanceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceStatusInfo' => [ 'type' => 'structure', 'members' => [ 'StatusType' => [ 'shape' => 'String', ], 'Normal' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'DBInstanceStatusInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceStatusInfo', 'locationName' => 'DBInstanceStatusInfo', ], ], 'DBParameterGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroup' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'SubnetGroupStatus' => [ 'shape' => 'String', ], 'Subnets' => [ 'shape' => 'SubnetList', ], 'DBSubnetGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBSubnetGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupDoesNotCoverEnoughAZs' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupDoesNotCoverEnoughAZs', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSubnetGroups' => [ 'shape' => 'DBSubnetGroups', ], ], ], 'DBSubnetGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSubnetGroup', 'locationName' => 'DBSubnetGroup', ], ], 'DBSubnetQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBUpgradeDependencyFailureFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBUpgradeDependencyFailure', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DeleteDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'DeleteDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'DeleteDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'DeleteDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'DeleteGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], ], ], 'DeleteGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'DescribeCertificatesMessage' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'DescribeDBClusterSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], 'IncludePublic' => [ 'shape' => 'Boolean', ], ], ], 'DescribeDBClustersMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBEngineVersionsMessage' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DefaultOnly' => [ 'shape' => 'Boolean', ], 'ListSupportedCharacterSets' => [ 'shape' => 'BooleanOptional', ], 'ListSupportedTimezones' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeDBInstancesMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBSubnetGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupFamily', ], 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'DescribeEventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEventsMessage' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'IntegerOptional', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeGlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', ], 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Vpc' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribePendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], ], ], 'Endpoint' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'HostedZoneId' => [ 'shape' => 'String', ], ], ], 'EngineDefaults' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], 'wrapper' => true, ], 'Event' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'Message' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Date' => [ 'shape' => 'TStamp', ], 'SourceArn' => [ 'shape' => 'String', ], ], ], 'EventCategoriesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'EventCategory', ], ], 'EventCategoriesMap' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], ], 'wrapper' => true, ], 'EventCategoriesMapList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventCategoriesMap', 'locationName' => 'EventCategoriesMap', ], ], 'EventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'EventCategoriesMapList' => [ 'shape' => 'EventCategoriesMapList', ], ], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', 'locationName' => 'Event', ], ], 'EventSubscription' => [ 'type' => 'structure', 'members' => [ 'CustomerAwsId' => [ 'shape' => 'String', ], 'CustSubscriptionId' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'SubscriptionCreationTime' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'SourceIdsList' => [ 'shape' => 'SourceIdsList', ], 'EventCategoriesList' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'Boolean', ], 'EventSubscriptionArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'EventSubscriptionQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'EventSubscriptionQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'EventSubscriptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventSubscription', 'locationName' => 'EventSubscription', ], ], 'EventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'EventSubscriptionsList' => [ 'shape' => 'EventSubscriptionsList', ], ], ], 'EventsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Events' => [ 'shape' => 'EventList', ], ], ], 'FailoverDBClusterMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'TargetDBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'FailoverDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', 'locationName' => 'Filter', ], ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'Value', ], ], 'GlobalCluster' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'GlobalClusterResourceId' => [ 'shape' => 'String', ], 'GlobalClusterArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterMembers' => [ 'shape' => 'GlobalClusterMemberList', ], ], 'wrapper' => true, ], 'GlobalClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterIdentifier' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z][0-9A-Za-z-:._]*', ], 'GlobalClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalCluster', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBClusterArn' => [ 'shape' => 'String', ], 'Readers' => [ 'shape' => 'ReadersArnList', ], 'IsWriter' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'GlobalClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalClusterMember', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'GlobalClusters' => [ 'shape' => 'GlobalClusterList', ], ], ], 'InstanceQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InstanceQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBClusterCapacityFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBInstanceCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBInstanceCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientStorageClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientStorageClusterCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Integer' => [ 'type' => 'integer', ], 'IntegerOptional' => [ 'type' => 'integer', ], 'InvalidDBClusterSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterSnapshotStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBInstanceStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBInstanceState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBParameterGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBParameterGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSecurityGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSecurityGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSnapshotState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetGroupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidEventSubscriptionStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidEventSubscriptionState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidGlobalClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidGlobalClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidRestoreFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidRestoreFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidSubnet' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidSubnet', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidVPCNetworkStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidVPCNetworkStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'KMSKeyNotAccessibleFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'KMSKeyNotAccessibleFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'KeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ListTagsForResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'LogTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ModifyDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'NewDBClusterIdentifier' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'CloudwatchLogsExportConfiguration' => [ 'shape' => 'CloudwatchLogsExportConfiguration', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AllowMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'StorageType' => [ 'shape' => 'String', ], ], ], 'ModifyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'Parameters', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ModifyDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'AttributeName', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'AttributeName' => [ 'shape' => 'String', ], 'ValuesToAdd' => [ 'shape' => 'AttributeValueList', ], 'ValuesToRemove' => [ 'shape' => 'AttributeValueList', ], ], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'ModifyDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'NewDBInstanceIdentifier' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'CertificateRotationRestart' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'ModifyDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], ], ], 'ModifyDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'ModifyEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'ModifyGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'NewGlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'OrderableDBInstanceOption' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], 'Vpc' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'OrderableDBInstanceOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrderableDBInstanceOption', 'locationName' => 'OrderableDBInstanceOption', ], ], 'OrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'members' => [ 'OrderableDBInstanceOptions' => [ 'shape' => 'OrderableDBInstanceOptionsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'Parameter' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'ParameterValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'ApplyMethod' => [ 'shape' => 'ApplyMethod', ], ], ], 'ParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', 'locationName' => 'Parameter', ], ], 'PendingCloudwatchLogsExports' => [ 'type' => 'structure', 'members' => [ 'LogTypesToEnable' => [ 'shape' => 'LogTypeList', ], 'LogTypesToDisable' => [ 'shape' => 'LogTypeList', ], ], ], 'PendingMaintenanceAction' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'String', ], 'AutoAppliedAfterDate' => [ 'shape' => 'TStamp', ], 'ForcedApplyDate' => [ 'shape' => 'TStamp', ], 'OptInStatus' => [ 'shape' => 'String', ], 'CurrentApplyDate' => [ 'shape' => 'TStamp', ], 'Description' => [ 'shape' => 'String', ], ], ], 'PendingMaintenanceActionDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingMaintenanceAction', 'locationName' => 'PendingMaintenanceAction', ], ], 'PendingMaintenanceActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePendingMaintenanceActions', 'locationName' => 'ResourcePendingMaintenanceActions', ], ], 'PendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'PendingMaintenanceActions' => [ 'shape' => 'PendingMaintenanceActions', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'PendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'DBInstanceClass' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PendingCloudwatchLogsExports' => [ 'shape' => 'PendingCloudwatchLogsExports', ], ], ], 'ReadReplicaIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaIdentifier', ], ], 'ReadersArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RebootDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'ForceFailover' => [ 'shape' => 'BooleanOptional', ], ], ], 'RebootDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RemoveFromGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', 'DbClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'DbClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveFromGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'RemoveTagsFromResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'TagKeys', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'TagKeys' => [ 'shape' => 'KeyList', ], ], ], 'ResetDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ResourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ResourceNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResourcePendingMaintenanceActions' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'PendingMaintenanceActionDetails' => [ 'shape' => 'PendingMaintenanceActionDetails', ], ], 'wrapper' => true, ], 'RestoreDBClusterFromSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'SnapshotIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], ], ], 'RestoreDBClusterFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'SourceDBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreType' => [ 'shape' => 'String', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreToTime' => [ 'shape' => 'TStamp', ], 'UseLatestRestorableTime' => [ 'shape' => 'Boolean', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'StorageType' => [ 'shape' => 'String', ], ], ], 'RestoreDBClusterToPointInTimeResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'SNSInvalidTopicFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSInvalidTopic', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSNoAuthorizationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSNoAuthorization', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSTopicArnNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSTopicArnNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SharedSnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SharedSnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SourceId', ], ], 'SourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SourceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'db-instance', 'db-parameter-group', 'db-security-group', 'db-snapshot', 'db-cluster', 'db-cluster-snapshot', ], ], 'StartDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StartDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StopDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StopDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StorageQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'StorageTypeNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageTypeNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'Subnet' => [ 'type' => 'structure', 'members' => [ 'SubnetIdentifier' => [ 'shape' => 'String', ], 'SubnetAvailabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'SubnetStatus' => [ 'shape' => 'String', ], ], ], 'SubnetAlreadyInUse' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubnetAlreadyInUse', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubnetIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SubnetIdentifier', ], ], 'SubnetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Subnet', 'locationName' => 'Subnet', ], ], 'SubscriptionAlreadyExistFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionAlreadyExist', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionCategoryNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionCategoryNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'TStamp' => [ 'type' => 'timestamp', ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', 'locationName' => 'Tag', ], ], 'TagListMessage' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'UpgradeTarget' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'AutoUpgrade' => [ 'shape' => 'Boolean', ], 'IsMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], ], ], 'ValidUpgradeTargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeTarget', 'locationName' => 'UpgradeTarget', ], ], 'VpcSecurityGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'VpcSecurityGroupId', ], ], 'VpcSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'VpcSecurityGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'VpcSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcSecurityGroupMembership', 'locationName' => 'VpcSecurityGroupMembership', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2014-10-31', 'endpointPrefix' => 'rds', 'protocol' => 'query', 'serviceAbbreviation' => 'Amazon DocDB', 'serviceFullName' => 'Amazon DocumentDB with MongoDB compatibility', 'serviceId' => 'DocDB', 'signatureVersion' => 'v4', 'signingName' => 'rds', 'uid' => 'docdb-2014-10-31', 'xmlNamespace' => 'http://rds.amazonaws.com/doc/2014-10-31/', ], 'operations' => [ 'AddSourceIdentifierToSubscription' => [ 'name' => 'AddSourceIdentifierToSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddSourceIdentifierToSubscriptionMessage', ], 'output' => [ 'shape' => 'AddSourceIdentifierToSubscriptionResult', 'resultWrapper' => 'AddSourceIdentifierToSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'AddTagsToResource' => [ 'name' => 'AddTagsToResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsToResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ApplyPendingMaintenanceAction' => [ 'name' => 'ApplyPendingMaintenanceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ApplyPendingMaintenanceActionMessage', ], 'output' => [ 'shape' => 'ApplyPendingMaintenanceActionResult', 'resultWrapper' => 'ApplyPendingMaintenanceActionResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'CopyDBClusterParameterGroup' => [ 'name' => 'CopyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CopyDBClusterParameterGroupResult', 'resultWrapper' => 'CopyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CopyDBClusterSnapshot' => [ 'name' => 'CopyDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CopyDBClusterSnapshotResult', 'resultWrapper' => 'CopyDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CreateDBCluster' => [ 'name' => 'CreateDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterMessage', ], 'output' => [ 'shape' => 'CreateDBClusterResult', 'resultWrapper' => 'CreateDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'CreateDBClusterParameterGroup' => [ 'name' => 'CreateDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateDBClusterParameterGroupResult', 'resultWrapper' => 'CreateDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupQuotaExceededFault', ], [ 'shape' => 'DBParameterGroupAlreadyExistsFault', ], ], ], 'CreateDBClusterSnapshot' => [ 'name' => 'CreateDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'CreateDBClusterSnapshotResult', 'resultWrapper' => 'CreateDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], ], ], 'CreateDBInstance' => [ 'name' => 'CreateDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBInstanceMessage', ], 'output' => [ 'shape' => 'CreateDBInstanceResult', 'resultWrapper' => 'CreateDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'InstanceQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'CreateDBSubnetGroup' => [ 'name' => 'CreateDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'CreateDBSubnetGroupResult', 'resultWrapper' => 'CreateDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupAlreadyExistsFault', ], [ 'shape' => 'DBSubnetGroupQuotaExceededFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'CreateEventSubscription' => [ 'name' => 'CreateEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEventSubscriptionMessage', ], 'output' => [ 'shape' => 'CreateEventSubscriptionResult', 'resultWrapper' => 'CreateEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionAlreadyExistFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'CreateGlobalCluster' => [ 'name' => 'CreateGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGlobalClusterMessage', ], 'output' => [ 'shape' => 'CreateGlobalClusterResult', 'resultWrapper' => 'CreateGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterAlreadyExistsFault', ], [ 'shape' => 'GlobalClusterQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DeleteDBCluster' => [ 'name' => 'DeleteDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterResult', 'resultWrapper' => 'DeleteDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'DBClusterSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], ], ], 'DeleteDBClusterParameterGroup' => [ 'name' => 'DeleteDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DeleteDBClusterSnapshot' => [ 'name' => 'DeleteDBClusterSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBClusterSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteDBClusterSnapshotResult', 'resultWrapper' => 'DeleteDBClusterSnapshotResult', ], 'errors' => [ [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DeleteDBInstance' => [ 'name' => 'DeleteDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBInstanceMessage', ], 'output' => [ 'shape' => 'DeleteDBInstanceResult', 'resultWrapper' => 'DeleteDBInstanceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBSnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], ], ], 'DeleteDBSubnetGroup' => [ 'name' => 'DeleteDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDBSubnetGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidDBSubnetStateFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DeleteEventSubscription' => [ 'name' => 'DeleteEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEventSubscriptionMessage', ], 'output' => [ 'shape' => 'DeleteEventSubscriptionResult', 'resultWrapper' => 'DeleteEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'InvalidEventSubscriptionStateFault', ], ], ], 'DeleteGlobalCluster' => [ 'name' => 'DeleteGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGlobalClusterMessage', ], 'output' => [ 'shape' => 'DeleteGlobalClusterResult', 'resultWrapper' => 'DeleteGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'DescribeCertificates' => [ 'name' => 'DescribeCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCertificatesMessage', ], 'output' => [ 'shape' => 'CertificateMessage', 'resultWrapper' => 'DescribeCertificatesResult', ], 'errors' => [ [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'DescribeDBClusterParameterGroups' => [ 'name' => 'DescribeDBClusterParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParameterGroupsMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupsMessage', 'resultWrapper' => 'DescribeDBClusterParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterParameters' => [ 'name' => 'DescribeDBClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterParametersMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupDetails', 'resultWrapper' => 'DescribeDBClusterParametersResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'DescribeDBClusterSnapshotAttributes' => [ 'name' => 'DescribeDBClusterSnapshotAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesMessage', ], 'output' => [ 'shape' => 'DescribeDBClusterSnapshotAttributesResult', 'resultWrapper' => 'DescribeDBClusterSnapshotAttributesResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusterSnapshots' => [ 'name' => 'DescribeDBClusterSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClusterSnapshotsMessage', ], 'output' => [ 'shape' => 'DBClusterSnapshotMessage', 'resultWrapper' => 'DescribeDBClusterSnapshotsResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], ], ], 'DescribeDBClusters' => [ 'name' => 'DescribeDBClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBClustersMessage', ], 'output' => [ 'shape' => 'DBClusterMessage', 'resultWrapper' => 'DescribeDBClustersResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'DescribeDBEngineVersions' => [ 'name' => 'DescribeDBEngineVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBEngineVersionsMessage', ], 'output' => [ 'shape' => 'DBEngineVersionMessage', 'resultWrapper' => 'DescribeDBEngineVersionsResult', ], ], 'DescribeDBInstances' => [ 'name' => 'DescribeDBInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBInstancesMessage', ], 'output' => [ 'shape' => 'DBInstanceMessage', 'resultWrapper' => 'DescribeDBInstancesResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'DescribeDBSubnetGroups' => [ 'name' => 'DescribeDBSubnetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDBSubnetGroupsMessage', ], 'output' => [ 'shape' => 'DBSubnetGroupMessage', 'resultWrapper' => 'DescribeDBSubnetGroupsResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], ], ], 'DescribeEngineDefaultClusterParameters' => [ 'name' => 'DescribeEngineDefaultClusterParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultClusterParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultClusterParametersResult', 'resultWrapper' => 'DescribeEngineDefaultClusterParametersResult', ], ], 'DescribeEventCategories' => [ 'name' => 'DescribeEventCategories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventCategoriesMessage', ], 'output' => [ 'shape' => 'EventCategoriesMessage', 'resultWrapper' => 'DescribeEventCategoriesResult', ], ], 'DescribeEventSubscriptions' => [ 'name' => 'DescribeEventSubscriptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventSubscriptionsMessage', ], 'output' => [ 'shape' => 'EventSubscriptionsMessage', 'resultWrapper' => 'DescribeEventSubscriptionsResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], ], ], 'DescribeEvents' => [ 'name' => 'DescribeEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventsMessage', ], 'output' => [ 'shape' => 'EventsMessage', 'resultWrapper' => 'DescribeEventsResult', ], ], 'DescribeGlobalClusters' => [ 'name' => 'DescribeGlobalClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGlobalClustersMessage', ], 'output' => [ 'shape' => 'GlobalClustersMessage', 'resultWrapper' => 'DescribeGlobalClustersResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], ], ], 'DescribeOrderableDBInstanceOptions' => [ 'name' => 'DescribeOrderableDBInstanceOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrderableDBInstanceOptionsMessage', ], 'output' => [ 'shape' => 'OrderableDBInstanceOptionsMessage', 'resultWrapper' => 'DescribeOrderableDBInstanceOptionsResult', ], ], 'DescribePendingMaintenanceActions' => [ 'name' => 'DescribePendingMaintenanceActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePendingMaintenanceActionsMessage', ], 'output' => [ 'shape' => 'PendingMaintenanceActionsMessage', 'resultWrapper' => 'DescribePendingMaintenanceActionsResult', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundFault', ], ], ], 'FailoverDBCluster' => [ 'name' => 'FailoverDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'FailoverDBClusterMessage', ], 'output' => [ 'shape' => 'FailoverDBClusterResult', 'resultWrapper' => 'FailoverDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ModifyDBCluster' => [ 'name' => 'ModifyDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterResult', 'resultWrapper' => 'ModifyDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidDBSubnetGroupStateFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'DBClusterParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBClusterAlreadyExistsFault', ], ], ], 'ModifyDBClusterParameterGroup' => [ 'name' => 'ModifyDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ModifyDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidDBParameterGroupStateFault', ], ], ], 'ModifyDBClusterSnapshotAttribute' => [ 'name' => 'ModifyDBClusterSnapshotAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeMessage', ], 'output' => [ 'shape' => 'ModifyDBClusterSnapshotAttributeResult', 'resultWrapper' => 'ModifyDBClusterSnapshotAttributeResult', ], 'errors' => [ [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'SharedSnapshotQuotaExceededFault', ], ], ], 'ModifyDBInstance' => [ 'name' => 'ModifyDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBInstanceMessage', ], 'output' => [ 'shape' => 'ModifyDBInstanceResult', 'resultWrapper' => 'ModifyDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'InvalidDBSecurityGroupStateFault', ], [ 'shape' => 'DBInstanceAlreadyExistsFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSecurityGroupNotFoundFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBInstanceCapacityFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'DBUpgradeDependencyFailureFault', ], [ 'shape' => 'StorageTypeNotSupportedFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'CertificateNotFoundFault', ], ], ], 'ModifyDBSubnetGroup' => [ 'name' => 'ModifyDBSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyDBSubnetGroupMessage', ], 'output' => [ 'shape' => 'ModifyDBSubnetGroupResult', 'resultWrapper' => 'ModifyDBSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSubnetQuotaExceededFault', ], [ 'shape' => 'SubnetAlreadyInUse', ], [ 'shape' => 'DBSubnetGroupDoesNotCoverEnoughAZs', ], [ 'shape' => 'InvalidSubnet', ], ], ], 'ModifyEventSubscription' => [ 'name' => 'ModifyEventSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyEventSubscriptionMessage', ], 'output' => [ 'shape' => 'ModifyEventSubscriptionResult', 'resultWrapper' => 'ModifyEventSubscriptionResult', ], 'errors' => [ [ 'shape' => 'EventSubscriptionQuotaExceededFault', ], [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SNSInvalidTopicFault', ], [ 'shape' => 'SNSNoAuthorizationFault', ], [ 'shape' => 'SNSTopicArnNotFoundFault', ], [ 'shape' => 'SubscriptionCategoryNotFoundFault', ], ], ], 'ModifyGlobalCluster' => [ 'name' => 'ModifyGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyGlobalClusterMessage', ], 'output' => [ 'shape' => 'ModifyGlobalClusterResult', 'resultWrapper' => 'ModifyGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], ], ], 'RebootDBInstance' => [ 'name' => 'RebootDBInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootDBInstanceMessage', ], 'output' => [ 'shape' => 'RebootDBInstanceResult', 'resultWrapper' => 'RebootDBInstanceResult', ], 'errors' => [ [ 'shape' => 'InvalidDBInstanceStateFault', ], [ 'shape' => 'DBInstanceNotFoundFault', ], ], ], 'RemoveFromGlobalCluster' => [ 'name' => 'RemoveFromGlobalCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveFromGlobalClusterMessage', ], 'output' => [ 'shape' => 'RemoveFromGlobalClusterResult', 'resultWrapper' => 'RemoveFromGlobalClusterResult', ], 'errors' => [ [ 'shape' => 'GlobalClusterNotFoundFault', ], [ 'shape' => 'InvalidGlobalClusterStateFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'RemoveSourceIdentifierFromSubscription' => [ 'name' => 'RemoveSourceIdentifierFromSubscription', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionMessage', ], 'output' => [ 'shape' => 'RemoveSourceIdentifierFromSubscriptionResult', 'resultWrapper' => 'RemoveSourceIdentifierFromSubscriptionResult', ], 'errors' => [ [ 'shape' => 'SubscriptionNotFoundFault', ], [ 'shape' => 'SourceNotFoundFault', ], ], ], 'RemoveTagsFromResource' => [ 'name' => 'RemoveTagsFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveTagsFromResourceMessage', ], 'errors' => [ [ 'shape' => 'DBInstanceNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], ], ], 'ResetDBClusterParameterGroup' => [ 'name' => 'ResetDBClusterParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDBClusterParameterGroupMessage', ], 'output' => [ 'shape' => 'DBClusterParameterGroupNameMessage', 'resultWrapper' => 'ResetDBClusterParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidDBParameterGroupStateFault', ], [ 'shape' => 'DBParameterGroupNotFoundFault', ], ], ], 'RestoreDBClusterFromSnapshot' => [ 'name' => 'RestoreDBClusterFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterFromSnapshotMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterFromSnapshotResult', 'resultWrapper' => 'RestoreDBClusterFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'DBSnapshotNotFoundFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], ], ], 'RestoreDBClusterToPointInTime' => [ 'name' => 'RestoreDBClusterToPointInTime', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreDBClusterToPointInTimeMessage', ], 'output' => [ 'shape' => 'RestoreDBClusterToPointInTimeResult', 'resultWrapper' => 'RestoreDBClusterToPointInTimeResult', ], 'errors' => [ [ 'shape' => 'DBClusterAlreadyExistsFault', ], [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'DBClusterQuotaExceededFault', ], [ 'shape' => 'DBClusterSnapshotNotFoundFault', ], [ 'shape' => 'DBSubnetGroupNotFoundFault', ], [ 'shape' => 'InsufficientDBClusterCapacityFault', ], [ 'shape' => 'InsufficientStorageClusterCapacityFault', ], [ 'shape' => 'InvalidDBClusterSnapshotStateFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBSnapshotStateFault', ], [ 'shape' => 'InvalidRestoreFault', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'KMSKeyNotAccessibleFault', ], [ 'shape' => 'StorageQuotaExceededFault', ], ], ], 'StartDBCluster' => [ 'name' => 'StartDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDBClusterMessage', ], 'output' => [ 'shape' => 'StartDBClusterResult', 'resultWrapper' => 'StartDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], 'StopDBCluster' => [ 'name' => 'StopDBCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDBClusterMessage', ], 'output' => [ 'shape' => 'StopDBClusterResult', 'resultWrapper' => 'StopDBClusterResult', ], 'errors' => [ [ 'shape' => 'DBClusterNotFoundFault', ], [ 'shape' => 'InvalidDBClusterStateFault', ], [ 'shape' => 'InvalidDBInstanceStateFault', ], ], ], ], 'shapes' => [ 'AddSourceIdentifierToSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'AddTagsToResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'Tags', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ApplyMethod' => [ 'type' => 'string', 'enum' => [ 'immediate', 'pending-reboot', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceIdentifier', 'ApplyAction', 'OptInType', ], 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'ApplyAction' => [ 'shape' => 'String', ], 'OptInType' => [ 'shape' => 'String', ], ], ], 'ApplyPendingMaintenanceActionResult' => [ 'type' => 'structure', 'members' => [ 'ResourcePendingMaintenanceActions' => [ 'shape' => 'ResourcePendingMaintenanceActions', ], ], ], 'AttributeValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AttributeValue', ], ], 'AuthorizationNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', 'locationName' => 'AvailabilityZone', ], ], 'AvailabilityZones' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AvailabilityZone', ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOptional' => [ 'type' => 'boolean', ], 'CACertificateIdentifiersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Certificate' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'CertificateType' => [ 'shape' => 'String', ], 'Thumbprint' => [ 'shape' => 'String', ], 'ValidFrom' => [ 'shape' => 'TStamp', ], 'ValidTill' => [ 'shape' => 'TStamp', ], 'CertificateArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'CertificateDetails' => [ 'type' => 'structure', 'members' => [ 'CAIdentifier' => [ 'shape' => 'String', ], 'ValidTill' => [ 'shape' => 'TStamp', ], ], ], 'CertificateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Certificate', 'locationName' => 'Certificate', ], ], 'CertificateMessage' => [ 'type' => 'structure', 'members' => [ 'Certificates' => [ 'shape' => 'CertificateList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'CertificateNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CertificateNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CloudwatchLogsExportConfiguration' => [ 'type' => 'structure', 'members' => [ 'EnableLogTypes' => [ 'shape' => 'LogTypeList', ], 'DisableLogTypes' => [ 'shape' => 'LogTypeList', ], ], ], 'CopyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupIdentifier', 'TargetDBClusterParameterGroupDescription', ], 'members' => [ 'SourceDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterParameterGroupDescription' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CopyDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceDBClusterSnapshotIdentifier', 'TargetDBClusterSnapshotIdentifier', ], 'members' => [ 'SourceDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'TargetDBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'CopyTags' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CreateDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'PreSignedUrl' => [ 'shape' => 'String', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'StorageType' => [ 'shape' => 'String', ], ], ], 'CreateDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'DBParameterGroupFamily', 'Description', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroup' => [ 'shape' => 'DBClusterParameterGroup', ], ], ], 'CreateDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'CreateDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'DBClusterIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'CreateDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', 'DBInstanceClass', 'Engine', 'DBClusterIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], ], ], 'CreateDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'CreateDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'DBSubnetGroupDescription', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'CreateEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SnsTopicArn', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'SourceIds' => [ 'shape' => 'SourceIdsList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'CreateGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], ], ], 'CreateGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'DBCluster' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterParameterGroup' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'String', ], 'EarliestRestorableTime' => [ 'shape' => 'TStamp', ], 'Endpoint' => [ 'shape' => 'String', ], 'ReaderEndpoint' => [ 'shape' => 'String', ], 'MultiAZ' => [ 'shape' => 'Boolean', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUsername' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'ReplicationSourceIdentifier' => [ 'shape' => 'String', ], 'ReadReplicaIdentifiers' => [ 'shape' => 'ReadReplicaIdentifierList', ], 'DBClusterMembers' => [ 'shape' => 'DBClusterMemberList', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'HostedZoneId' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbClusterResourceId' => [ 'shape' => 'String', ], 'DBClusterArn' => [ 'shape' => 'String', ], 'AssociatedRoles' => [ 'shape' => 'DBClusterRoles', ], 'CloneGroupId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBCluster', 'locationName' => 'DBCluster', ], ], 'DBClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'IsClusterWriter' => [ 'shape' => 'Boolean', ], 'DBClusterParameterGroupStatus' => [ 'shape' => 'String', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], ], 'wrapper' => true, ], 'DBClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterMember', 'locationName' => 'DBClusterMember', ], ], 'DBClusterMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusters' => [ 'shape' => 'DBClusterList', ], ], ], 'DBClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterParameterGroup' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'DBClusterParameterGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Parameters' => [ 'shape' => 'ParametersList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterParameterGroup', 'locationName' => 'DBClusterParameterGroup', ], ], 'DBClusterParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DBClusterParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterParameterGroups' => [ 'shape' => 'DBClusterParameterGroupList', ], ], ], 'DBClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterQuotaExceededFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterRole' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'DBClusterRoles' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterRole', 'locationName' => 'DBClusterRole', ], ], 'DBClusterSnapshot' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], 'Engine' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'VpcId' => [ 'shape' => 'String', ], 'ClusterCreateTime' => [ 'shape' => 'TStamp', ], 'MasterUsername' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'PercentProgress' => [ 'shape' => 'Integer', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DBClusterSnapshotArn' => [ 'shape' => 'String', ], 'SourceDBClusterSnapshotArn' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBClusterSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBClusterSnapshotAttribute' => [ 'type' => 'structure', 'members' => [ 'AttributeName' => [ 'shape' => 'String', ], 'AttributeValues' => [ 'shape' => 'AttributeValueList', ], ], ], 'DBClusterSnapshotAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshotAttribute', 'locationName' => 'DBClusterSnapshotAttribute', ], ], 'DBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotAttributes' => [ 'shape' => 'DBClusterSnapshotAttributeList', ], ], 'wrapper' => true, ], 'DBClusterSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBClusterSnapshot', 'locationName' => 'DBClusterSnapshot', ], ], 'DBClusterSnapshotMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBClusterSnapshots' => [ 'shape' => 'DBClusterSnapshotList', ], ], ], 'DBClusterSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBClusterSnapshotNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBEngineVersion' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'DBEngineDescription' => [ 'shape' => 'String', ], 'DBEngineVersionDescription' => [ 'shape' => 'String', ], 'ValidUpgradeTarget' => [ 'shape' => 'ValidUpgradeTargetList', ], 'ExportableLogTypes' => [ 'shape' => 'LogTypeList', ], 'SupportsLogExportsToCloudwatchLogs' => [ 'shape' => 'Boolean', ], 'SupportedCACertificateIdentifiers' => [ 'shape' => 'CACertificateIdentifiersList', ], 'SupportsCertificateRotationWithoutRestart' => [ 'shape' => 'BooleanOptional', ], ], ], 'DBEngineVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBEngineVersion', 'locationName' => 'DBEngineVersion', ], ], 'DBEngineVersionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBEngineVersions' => [ 'shape' => 'DBEngineVersionList', ], ], ], 'DBInstance' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'DBInstanceStatus' => [ 'shape' => 'String', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'InstanceCreateTime' => [ 'shape' => 'TStamp', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'BackupRetentionPeriod' => [ 'shape' => 'Integer', ], 'VpcSecurityGroups' => [ 'shape' => 'VpcSecurityGroupMembershipList', ], 'AvailabilityZone' => [ 'shape' => 'String', ], 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'PendingModifiedValues' => [ 'shape' => 'PendingModifiedValues', ], 'LatestRestorableTime' => [ 'shape' => 'TStamp', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'PubliclyAccessible' => [ 'shape' => 'Boolean', ], 'StatusInfos' => [ 'shape' => 'DBInstanceStatusInfoList', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'Boolean', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'DbiResourceId' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceArn' => [ 'shape' => 'String', ], 'EnabledCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'CertificateDetails' => [ 'shape' => 'CertificateDetails', ], 'PerformanceInsightsEnabled' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBInstanceAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstance', 'locationName' => 'DBInstance', ], ], 'DBInstanceMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBInstances' => [ 'shape' => 'DBInstanceList', ], ], ], 'DBInstanceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBInstanceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBInstanceStatusInfo' => [ 'type' => 'structure', 'members' => [ 'StatusType' => [ 'shape' => 'String', ], 'Normal' => [ 'shape' => 'Boolean', ], 'Status' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'DBInstanceStatusInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBInstanceStatusInfo', 'locationName' => 'DBInstanceStatusInfo', ], ], 'DBParameterGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBParameterGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBParameterGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSecurityGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSecurityGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSnapshotNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroup' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'SubnetGroupStatus' => [ 'shape' => 'String', ], 'Subnets' => [ 'shape' => 'SubnetList', ], 'DBSubnetGroupArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'DBSubnetGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupDoesNotCoverEnoughAZs' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupDoesNotCoverEnoughAZs', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'DBSubnetGroups' => [ 'shape' => 'DBSubnetGroups', ], ], ], 'DBSubnetGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBSubnetGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'DBSubnetGroup', 'locationName' => 'DBSubnetGroup', ], ], 'DBSubnetQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBSubnetQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DBUpgradeDependencyFailureFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DBUpgradeDependencyFailure', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DeleteDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SkipFinalSnapshot' => [ 'shape' => 'Boolean', ], 'FinalDBSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'DeleteDBClusterSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBClusterSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshot' => [ 'shape' => 'DBClusterSnapshot', ], ], ], 'DeleteDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'DeleteDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], ], ], 'DeleteEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'DeleteGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], ], ], 'DeleteGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'DescribeCertificatesMessage' => [ 'type' => 'structure', 'members' => [ 'CertificateIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'DescribeDBClusterSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'IncludeShared' => [ 'shape' => 'Boolean', ], 'IncludePublic' => [ 'shape' => 'Boolean', ], ], ], 'DescribeDBClustersMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBEngineVersionsMessage' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DefaultOnly' => [ 'shape' => 'Boolean', ], 'ListSupportedCharacterSets' => [ 'shape' => 'BooleanOptional', ], 'ListSupportedTimezones' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeDBInstancesMessage' => [ 'type' => 'structure', 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeDBSubnetGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersMessage' => [ 'type' => 'structure', 'required' => [ 'DBParameterGroupFamily', ], 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'DescribeEventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEventsMessage' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'IntegerOptional', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeGlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'required' => [ 'Engine', ], 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Vpc' => [ 'shape' => 'BooleanOptional', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribePendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], ], ], 'Endpoint' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], 'HostedZoneId' => [ 'shape' => 'String', ], ], ], 'EngineDefaults' => [ 'type' => 'structure', 'members' => [ 'DBParameterGroupFamily' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], 'wrapper' => true, ], 'Event' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'Message' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Date' => [ 'shape' => 'TStamp', ], 'SourceArn' => [ 'shape' => 'String', ], ], ], 'EventCategoriesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'EventCategory', ], ], 'EventCategoriesMap' => [ 'type' => 'structure', 'members' => [ 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], ], 'wrapper' => true, ], 'EventCategoriesMapList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventCategoriesMap', 'locationName' => 'EventCategoriesMap', ], ], 'EventCategoriesMessage' => [ 'type' => 'structure', 'members' => [ 'EventCategoriesMapList' => [ 'shape' => 'EventCategoriesMapList', ], ], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', 'locationName' => 'Event', ], ], 'EventSubscription' => [ 'type' => 'structure', 'members' => [ 'CustomerAwsId' => [ 'shape' => 'String', ], 'CustSubscriptionId' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'SubscriptionCreationTime' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'SourceIdsList' => [ 'shape' => 'SourceIdsList', ], 'EventCategoriesList' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'Boolean', ], 'EventSubscriptionArn' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'EventSubscriptionQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'EventSubscriptionQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'EventSubscriptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EventSubscription', 'locationName' => 'EventSubscription', ], ], 'EventSubscriptionsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'EventSubscriptionsList' => [ 'shape' => 'EventSubscriptionsList', ], ], ], 'EventsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Events' => [ 'shape' => 'EventList', ], ], ], 'FailoverDBClusterMessage' => [ 'type' => 'structure', 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'TargetDBInstanceIdentifier' => [ 'shape' => 'String', ], ], ], 'FailoverDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', 'locationName' => 'Filter', ], ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'Value', ], ], 'GlobalCluster' => [ 'type' => 'structure', 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'GlobalClusterResourceId' => [ 'shape' => 'String', ], 'GlobalClusterArn' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DatabaseName' => [ 'shape' => 'String', ], 'StorageEncrypted' => [ 'shape' => 'BooleanOptional', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'GlobalClusterMembers' => [ 'shape' => 'GlobalClusterMemberList', ], ], 'wrapper' => true, ], 'GlobalClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterIdentifier' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[A-Za-z][0-9A-Za-z-:._]*', ], 'GlobalClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalCluster', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterMember' => [ 'type' => 'structure', 'members' => [ 'DBClusterArn' => [ 'shape' => 'String', ], 'Readers' => [ 'shape' => 'ReadersArnList', ], 'IsWriter' => [ 'shape' => 'Boolean', ], ], 'wrapper' => true, ], 'GlobalClusterMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalClusterMember', 'locationName' => 'GlobalClusterMember', ], ], 'GlobalClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClusterQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalClusterQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalClustersMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'GlobalClusters' => [ 'shape' => 'GlobalClusterList', ], ], ], 'InstanceQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InstanceQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBClusterCapacityFault', 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientDBInstanceCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientDBInstanceCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InsufficientStorageClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientStorageClusterCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Integer' => [ 'type' => 'integer', ], 'IntegerOptional' => [ 'type' => 'integer', ], 'InvalidDBClusterSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterSnapshotStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBInstanceStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBInstanceState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBParameterGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBParameterGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSecurityGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSecurityGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSnapshotState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetGroupStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidDBSubnetStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidDBSubnetStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidEventSubscriptionStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidEventSubscriptionState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidGlobalClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidGlobalClusterStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidRestoreFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidRestoreFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidSubnet' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidSubnet', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidVPCNetworkStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidVPCNetworkStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'KMSKeyNotAccessibleFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'KMSKeyNotAccessibleFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'KeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ListTagsForResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'LogTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ModifyDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'NewDBClusterIdentifier' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'PreferredBackupWindow' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'CloudwatchLogsExportConfiguration' => [ 'shape' => 'CloudwatchLogsExportConfiguration', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AllowMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'StorageType' => [ 'shape' => 'String', ], ], ], 'ModifyDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', 'Parameters', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ModifyDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterSnapshotIdentifier', 'AttributeName', ], 'members' => [ 'DBClusterSnapshotIdentifier' => [ 'shape' => 'String', ], 'AttributeName' => [ 'shape' => 'String', ], 'ValuesToAdd' => [ 'shape' => 'AttributeValueList', ], 'ValuesToRemove' => [ 'shape' => 'AttributeValueList', ], ], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'type' => 'structure', 'members' => [ 'DBClusterSnapshotAttributesResult' => [ 'shape' => 'DBClusterSnapshotAttributesResult', ], ], ], 'ModifyDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'NewDBInstanceIdentifier' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'CopyTagsToSnapshot' => [ 'shape' => 'BooleanOptional', ], 'PromotionTier' => [ 'shape' => 'IntegerOptional', ], 'EnablePerformanceInsights' => [ 'shape' => 'BooleanOptional', ], 'PerformanceInsightsKMSKeyId' => [ 'shape' => 'String', ], 'CertificateRotationRestart' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'ModifyDBSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBSubnetGroupName', 'SubnetIds', ], 'members' => [ 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'DBSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], ], ], 'ModifyDBSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'DBSubnetGroup' => [ 'shape' => 'DBSubnetGroup', ], ], ], 'ModifyEventSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SnsTopicArn' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'String', ], 'EventCategories' => [ 'shape' => 'EventCategoriesList', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyEventSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'ModifyGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'NewGlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'OrderableDBInstanceOption' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'DBInstanceClass' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], 'Vpc' => [ 'shape' => 'Boolean', ], 'StorageType' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'OrderableDBInstanceOptionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrderableDBInstanceOption', 'locationName' => 'OrderableDBInstanceOption', ], ], 'OrderableDBInstanceOptionsMessage' => [ 'type' => 'structure', 'members' => [ 'OrderableDBInstanceOptions' => [ 'shape' => 'OrderableDBInstanceOptionsList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'Parameter' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'ParameterValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'ApplyType' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'ApplyMethod' => [ 'shape' => 'ApplyMethod', ], ], ], 'ParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', 'locationName' => 'Parameter', ], ], 'PendingCloudwatchLogsExports' => [ 'type' => 'structure', 'members' => [ 'LogTypesToEnable' => [ 'shape' => 'LogTypeList', ], 'LogTypesToDisable' => [ 'shape' => 'LogTypeList', ], ], ], 'PendingMaintenanceAction' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'String', ], 'AutoAppliedAfterDate' => [ 'shape' => 'TStamp', ], 'ForcedApplyDate' => [ 'shape' => 'TStamp', ], 'OptInStatus' => [ 'shape' => 'String', ], 'CurrentApplyDate' => [ 'shape' => 'TStamp', ], 'Description' => [ 'shape' => 'String', ], ], ], 'PendingMaintenanceActionDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingMaintenanceAction', 'locationName' => 'PendingMaintenanceAction', ], ], 'PendingMaintenanceActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourcePendingMaintenanceActions', 'locationName' => 'ResourcePendingMaintenanceActions', ], ], 'PendingMaintenanceActionsMessage' => [ 'type' => 'structure', 'members' => [ 'PendingMaintenanceActions' => [ 'shape' => 'PendingMaintenanceActions', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'PendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'DBInstanceClass' => [ 'shape' => 'String', ], 'AllocatedStorage' => [ 'shape' => 'IntegerOptional', ], 'MasterUserPassword' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'BackupRetentionPeriod' => [ 'shape' => 'IntegerOptional', ], 'MultiAZ' => [ 'shape' => 'BooleanOptional', ], 'EngineVersion' => [ 'shape' => 'String', ], 'LicenseModel' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'IntegerOptional', ], 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], 'CACertificateIdentifier' => [ 'shape' => 'String', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'PendingCloudwatchLogsExports' => [ 'shape' => 'PendingCloudwatchLogsExports', ], ], ], 'ReadReplicaIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReadReplicaIdentifier', ], ], 'ReadersArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RebootDBInstanceMessage' => [ 'type' => 'structure', 'required' => [ 'DBInstanceIdentifier', ], 'members' => [ 'DBInstanceIdentifier' => [ 'shape' => 'String', ], 'ForceFailover' => [ 'shape' => 'BooleanOptional', ], ], ], 'RebootDBInstanceResult' => [ 'type' => 'structure', 'members' => [ 'DBInstance' => [ 'shape' => 'DBInstance', ], ], ], 'RemoveFromGlobalClusterMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalClusterIdentifier', 'DbClusterIdentifier', ], 'members' => [ 'GlobalClusterIdentifier' => [ 'shape' => 'GlobalClusterIdentifier', ], 'DbClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveFromGlobalClusterResult' => [ 'type' => 'structure', 'members' => [ 'GlobalCluster' => [ 'shape' => 'GlobalCluster', ], ], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'type' => 'structure', 'required' => [ 'SubscriptionName', 'SourceIdentifier', ], 'members' => [ 'SubscriptionName' => [ 'shape' => 'String', ], 'SourceIdentifier' => [ 'shape' => 'String', ], ], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'type' => 'structure', 'members' => [ 'EventSubscription' => [ 'shape' => 'EventSubscription', ], ], ], 'RemoveTagsFromResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'TagKeys', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'TagKeys' => [ 'shape' => 'KeyList', ], ], ], 'ResetDBClusterParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterParameterGroupName', ], 'members' => [ 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'Parameters' => [ 'shape' => 'ParametersList', ], ], ], 'ResourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ResourceNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResourcePendingMaintenanceActions' => [ 'type' => 'structure', 'members' => [ 'ResourceIdentifier' => [ 'shape' => 'String', ], 'PendingMaintenanceActionDetails' => [ 'shape' => 'PendingMaintenanceActionDetails', ], ], 'wrapper' => true, ], 'RestoreDBClusterFromSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'SnapshotIdentifier', 'Engine', ], 'members' => [ 'AvailabilityZones' => [ 'shape' => 'AvailabilityZones', ], 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'SnapshotIdentifier' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'DBClusterParameterGroupName' => [ 'shape' => 'String', ], 'StorageType' => [ 'shape' => 'String', ], ], ], 'RestoreDBClusterFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', 'SourceDBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreType' => [ 'shape' => 'String', ], 'SourceDBClusterIdentifier' => [ 'shape' => 'String', ], 'RestoreToTime' => [ 'shape' => 'TStamp', ], 'UseLatestRestorableTime' => [ 'shape' => 'Boolean', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'DBSubnetGroupName' => [ 'shape' => 'String', ], 'VpcSecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIdList', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'EnableCloudwatchLogsExports' => [ 'shape' => 'LogTypeList', ], 'DeletionProtection' => [ 'shape' => 'BooleanOptional', ], 'StorageType' => [ 'shape' => 'String', ], ], ], 'RestoreDBClusterToPointInTimeResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'SNSInvalidTopicFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSInvalidTopic', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSNoAuthorizationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSNoAuthorization', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SNSTopicArnNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SNSTopicArnNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SharedSnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SharedSnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SourceId', ], ], 'SourceNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SourceNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'db-instance', 'db-parameter-group', 'db-security-group', 'db-snapshot', 'db-cluster', 'db-cluster-snapshot', ], ], 'StartDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StartDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StopDBClusterMessage' => [ 'type' => 'structure', 'required' => [ 'DBClusterIdentifier', ], 'members' => [ 'DBClusterIdentifier' => [ 'shape' => 'String', ], ], ], 'StopDBClusterResult' => [ 'type' => 'structure', 'members' => [ 'DBCluster' => [ 'shape' => 'DBCluster', ], ], ], 'StorageQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'StorageTypeNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'StorageTypeNotSupported', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'Subnet' => [ 'type' => 'structure', 'members' => [ 'SubnetIdentifier' => [ 'shape' => 'String', ], 'SubnetAvailabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'SubnetStatus' => [ 'shape' => 'String', ], ], ], 'SubnetAlreadyInUse' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubnetAlreadyInUse', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubnetIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SubnetIdentifier', ], ], 'SubnetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Subnet', 'locationName' => 'Subnet', ], ], 'SubscriptionAlreadyExistFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionAlreadyExist', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionCategoryNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionCategoryNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SubscriptionNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubscriptionNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'TStamp' => [ 'type' => 'timestamp', ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', 'locationName' => 'Tag', ], ], 'TagListMessage' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'UpgradeTarget' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'AutoUpgrade' => [ 'shape' => 'Boolean', ], 'IsMajorVersionUpgrade' => [ 'shape' => 'Boolean', ], ], ], 'ValidUpgradeTargetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeTarget', 'locationName' => 'UpgradeTarget', ], ], 'VpcSecurityGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'VpcSecurityGroupId', ], ], 'VpcSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'VpcSecurityGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'VpcSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcSecurityGroupMembership', 'locationName' => 'VpcSecurityGroupMembership', ], ], ],]; diff --git a/src/data/docdb/2014-10-31/docs-2.json b/src/data/docdb/2014-10-31/docs-2.json index 054788258c..5d897c615b 100644 --- a/src/data/docdb/2014-10-31/docs-2.json +++ b/src/data/docdb/2014-10-31/docs-2.json @@ -167,6 +167,7 @@ "CreateGlobalClusterMessage$StorageEncrypted": "

The storage encryption setting for the new global cluster.

", "DBEngineVersion$SupportsCertificateRotationWithoutRestart": "

Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

", "DBInstance$CopyTagsToSnapshot": "

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

", + "DBInstance$PerformanceInsightsEnabled": "

Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

", "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

", "DescribeDBEngineVersionsMessage$ListSupportedTimezones": "

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

", "DescribeOrderableDBInstanceOptionsMessage$Vpc": "

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

", @@ -1516,6 +1517,7 @@ "DBInstance$DbiResourceId": "

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

", "DBInstance$CACertificateIdentifier": "

The identifier of the CA certificate for this DB instance.

", "DBInstance$DBInstanceArn": "

The Amazon Resource Name (ARN) for the instance.

", + "DBInstance$PerformanceInsightsKMSKeyId": "

The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

", "DBInstanceMessage$Marker": "

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

", "DBInstanceStatusInfo$StatusType": "

This value is currently \"read replication.\"

", "DBInstanceStatusInfo$Status": "

Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

", diff --git a/src/data/docdb/2014-10-31/docs-2.json.php b/src/data/docdb/2014-10-31/docs-2.json.php index e161fd73cf..39cf23be28 100644 --- a/src/data/docdb/2014-10-31/docs-2.json.php +++ b/src/data/docdb/2014-10-31/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.

', 'operations' => [ 'AddSourceIdentifierToSubscription' => '

Adds a source identifier to an existing event notification subscription.

', 'AddTagsToResource' => '

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.

', 'ApplyPendingMaintenanceAction' => '

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

', 'CopyDBClusterParameterGroup' => '

Copies the specified cluster parameter group.

', 'CopyDBClusterSnapshot' => '

Copies a snapshot of a cluster.

To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web Services Region.

To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.

', 'CreateDBCluster' => '

Creates a new Amazon DocumentDB cluster.

', 'CreateDBClusterParameterGroup' => '

Creates a new cluster parameter group.

Parameters in a cluster parameter group apply to all of the instances in a cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.

', 'CreateDBClusterSnapshot' => '

Creates a snapshot of a cluster.

', 'CreateDBInstance' => '

Creates a new instance.

', 'CreateDBSubnetGroup' => '

Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

', 'CreateEventSubscription' => '

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

', 'CreateGlobalCluster' => '

Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.

You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.

This action only applies to Amazon DocumentDB clusters.

', 'DeleteDBCluster' => '

Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can\'t be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.

', 'DeleteDBClusterParameterGroup' => '

Deletes a specified cluster parameter group. The cluster parameter group to be deleted can\'t be associated with any clusters.

', 'DeleteDBClusterSnapshot' => '

Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The cluster snapshot must be in the available state to be deleted.

', 'DeleteDBInstance' => '

Deletes a previously provisioned instance.

', 'DeleteDBSubnetGroup' => '

Deletes a subnet group.

The specified database subnet group must not be associated with any DB instances.

', 'DeleteEventSubscription' => '

Deletes an Amazon DocumentDB event notification subscription.

', 'DeleteGlobalCluster' => '

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.

This action only applies to Amazon DocumentDB clusters.

', 'DescribeCertificates' => '

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.

', 'DescribeDBClusterParameterGroups' => '

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

', 'DescribeDBClusterParameters' => '

Returns the detailed parameter list for a particular cluster parameter group.

', 'DescribeDBClusterSnapshotAttributes' => '

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

', 'DescribeDBClusterSnapshots' => '

Returns information about cluster snapshots. This API operation supports pagination.

', 'DescribeDBClusters' => '

Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.

', 'DescribeDBEngineVersions' => '

Returns a list of the available engines.

', 'DescribeDBInstances' => '

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

', 'DescribeDBSubnetGroups' => '

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

', 'DescribeEngineDefaultClusterParameters' => '

Returns the default engine and system parameter information for the cluster database engine.

', 'DescribeEventCategories' => '

Displays a list of categories for all event source types, or, if specified, for a specified source type.

', 'DescribeEventSubscriptions' => '

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

', 'DescribeEvents' => '

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

', 'DescribeGlobalClusters' => '

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

This action only applies to Amazon DocumentDB clusters.

', 'DescribeOrderableDBInstanceOptions' => '

Returns a list of orderable instance options for the specified engine.

', 'DescribePendingMaintenanceActions' => '

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

', 'FailoverDBCluster' => '

Forces a failover for a cluster.

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

', 'ListTagsForResource' => '

Lists all tags on an Amazon DocumentDB resource.

', 'ModifyDBCluster' => '

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

', 'ModifyDBClusterParameterGroup' => '

Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

', 'ModifyDBClusterSnapshotAttribute' => '

Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.

To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.

', 'ModifyDBInstance' => '

Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

', 'ModifyDBSubnetGroup' => '

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

', 'ModifyEventSubscription' => '

Modifies an existing Amazon DocumentDB event notification subscription.

', 'ModifyGlobalCluster' => '

Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.

This action only applies to Amazon DocumentDB clusters.

', 'RebootDBInstance' => '

You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.

Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.

', 'RemoveFromGlobalCluster' => '

Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.

This action only applies to Amazon DocumentDB clusters.

', 'RemoveSourceIdentifierFromSubscription' => '

Removes a source identifier from an existing Amazon DocumentDB event notification subscription.

', 'RemoveTagsFromResource' => '

Removes metadata tags from an Amazon DocumentDB resource.

', 'ResetDBClusterParameterGroup' => '

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

', 'RestoreDBClusterFromSnapshot' => '

Creates a new cluster from a snapshot or cluster snapshot.

If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.

If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

', 'RestoreDBClusterToPointInTime' => '

Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.

', 'StartDBCluster' => '

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

', 'StopDBCluster' => '

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

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

Represents the input to AddSourceIdentifierToSubscription.

', 'refs' => [], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsToResourceMessage' => [ 'base' => '

Represents the input to AddTagsToResource.

', 'refs' => [], ], 'ApplyMethod' => [ 'base' => NULL, 'refs' => [ 'Parameter$ApplyMethod' => '

Indicates when to apply parameter updates.

', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'base' => '

Represents the input to ApplyPendingMaintenanceAction.

', 'refs' => [], ], 'ApplyPendingMaintenanceActionResult' => [ 'base' => NULL, 'refs' => [], ], 'AttributeValueList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttribute$AttributeValues' => '

The values for the manual cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

', 'ModifyDBClusterSnapshotAttributeMessage$ValuesToAdd' => '

A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don\'t want to be available to all Amazon Web Services accounts.

', 'ModifyDBClusterSnapshotAttributeMessage$ValuesToRemove' => '

A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

', ], ], 'AuthorizationNotFoundFault' => [ 'base' => '

The specified CIDR IP or Amazon EC2 security group isn\'t authorized for the specified security group.

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

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

Information about an Availability Zone.

', 'refs' => [ 'AvailabilityZoneList$member' => NULL, 'Subnet$SubnetAvailabilityZone' => '

Specifies the Availability Zone for the subnet.

', ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$AvailabilityZones' => '

A list of Availability Zones for an instance.

', ], ], 'AvailabilityZones' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$AvailabilityZones' => '

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

', 'DBCluster$AvailabilityZones' => '

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

', 'DBClusterSnapshot$AvailabilityZones' => '

Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

', 'RestoreDBClusterFromSnapshotMessage$AvailabilityZones' => '

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'DBCluster$MultiAZ' => '

Specifies whether the cluster has instances in multiple Availability Zones.

', 'DBCluster$StorageEncrypted' => '

Specifies whether the cluster is encrypted.

', 'DBCluster$DeletionProtection' => '

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

', 'DBClusterMember$IsClusterWriter' => '

A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

', 'DBClusterSnapshot$StorageEncrypted' => '

Specifies whether the cluster snapshot is encrypted.

', 'DBEngineVersion$SupportsLogExportsToCloudwatchLogs' => '

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

', 'DBInstance$AutoMinorVersionUpgrade' => '

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

', 'DBInstance$PubliclyAccessible' => '

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

', 'DBInstance$StorageEncrypted' => '

Specifies whether or not the instance is encrypted.

', 'DBInstanceStatusInfo$Normal' => '

A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

', 'DeleteDBClusterMessage$SkipFinalSnapshot' => '

Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

', 'DescribeDBClusterSnapshotsMessage$IncludeShared' => '

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

', 'DescribeDBClusterSnapshotsMessage$IncludePublic' => '

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

', 'DescribeDBEngineVersionsMessage$DefaultOnly' => '

Indicates that only the default version of the specified engine or engine and major version combination is returned.

', 'EventSubscription$Enabled' => '

A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

', 'GlobalClusterMember$IsWriter' => '

Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

', 'ModifyDBClusterMessage$ApplyImmediately' => '

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

', 'ModifyDBClusterMessage$AllowMajorVersionUpgrade' => '

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster\'s current version.

', 'ModifyDBInstanceMessage$ApplyImmediately' => '

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

', 'OrderableDBInstanceOption$Vpc' => '

Indicates whether an instance is in a virtual private cloud (VPC).

', 'Parameter$IsModifiable' => '

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

', 'ResetDBClusterParameterGroupMessage$ResetAllParameters' => '

A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can\'t use this parameter if there is a list of parameter names specified for the Parameters parameter.

', 'RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime' => '

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

', 'UpgradeTarget$AutoUpgrade' => '

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

', 'UpgradeTarget$IsMajorVersionUpgrade' => '

A value that indicates whether a database engine is upgraded to a major version.

', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'CopyDBClusterSnapshotMessage$CopyTags' => '

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

', 'CreateDBClusterMessage$StorageEncrypted' => '

Specifies whether the cluster is encrypted.

', 'CreateDBClusterMessage$DeletionProtection' => '

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

', 'CreateDBInstanceMessage$AutoMinorVersionUpgrade' => '

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

', 'CreateDBInstanceMessage$CopyTagsToSnapshot' => '

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

', 'CreateDBInstanceMessage$EnablePerformanceInsights' => '

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

', 'CreateEventSubscriptionMessage$Enabled' => '

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

', 'CreateGlobalClusterMessage$DeletionProtection' => '

The deletion protection setting for the new global cluster. The global cluster can\'t be deleted when deletion protection is enabled.

', 'CreateGlobalClusterMessage$StorageEncrypted' => '

The storage encryption setting for the new global cluster.

', 'DBEngineVersion$SupportsCertificateRotationWithoutRestart' => '

Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

', 'DBInstance$CopyTagsToSnapshot' => '

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

', 'DescribeDBEngineVersionsMessage$ListSupportedCharacterSets' => '

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

', 'DescribeDBEngineVersionsMessage$ListSupportedTimezones' => '

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

', 'DescribeOrderableDBInstanceOptionsMessage$Vpc' => '

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

', 'GlobalCluster$StorageEncrypted' => '

The storage encryption setting for the global cluster.

', 'GlobalCluster$DeletionProtection' => '

The deletion protection setting for the new global cluster.

', 'ModifyDBClusterMessage$DeletionProtection' => '

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

', 'ModifyDBInstanceMessage$AutoMinorVersionUpgrade' => '

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

', 'ModifyDBInstanceMessage$CopyTagsToSnapshot' => '

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

', 'ModifyDBInstanceMessage$EnablePerformanceInsights' => '

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

', 'ModifyDBInstanceMessage$CertificateRotationRestart' => '

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

', 'ModifyEventSubscriptionMessage$Enabled' => '

A Boolean value; set to true to activate the subscription.

', 'ModifyGlobalClusterMessage$DeletionProtection' => '

Indicates if the global cluster has deletion protection enabled. The global cluster can\'t be deleted when deletion protection is enabled.

', 'PendingModifiedValues$MultiAZ' => '

Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

', 'RebootDBInstanceMessage$ForceFailover' => '

When true, the reboot is conducted through a Multi-AZ failover.

Constraint: You can\'t specify true if the instance is not configured for Multi-AZ.

', 'RestoreDBClusterFromSnapshotMessage$DeletionProtection' => '

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

', 'RestoreDBClusterToPointInTimeMessage$DeletionProtection' => '

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

', ], ], 'CACertificateIdentifiersList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedCACertificateIdentifiers' => '

A list of the supported CA certificate identifiers.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

', ], ], 'Certificate' => [ 'base' => '

A certificate authority (CA) certificate for an Amazon Web Services account.

', 'refs' => [ 'CertificateList$member' => NULL, ], ], 'CertificateDetails' => [ 'base' => '

Returns the details of the DB instance’s server certificate.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

', 'refs' => [ 'DBInstance$CertificateDetails' => '

The details of the DB instance\'s server certificate.

', ], ], 'CertificateList' => [ 'base' => NULL, 'refs' => [ 'CertificateMessage$Certificates' => '

A list of certificates for this Amazon Web Services account.

', ], ], 'CertificateMessage' => [ 'base' => NULL, 'refs' => [], ], 'CertificateNotFoundFault' => [ 'base' => '

CertificateIdentifier doesn\'t refer to an existing certificate.

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

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.

', 'refs' => [ 'ModifyDBClusterMessage$CloudwatchLogsExportConfiguration' => '

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

', ], ], 'CopyDBClusterParameterGroupMessage' => [ 'base' => '

Represents the input to CopyDBClusterParameterGroup.

', 'refs' => [], ], 'CopyDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBClusterSnapshotMessage' => [ 'base' => '

Represents the input to CopyDBClusterSnapshot.

', 'refs' => [], ], 'CopyDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterMessage' => [ 'base' => '

Represents the input to CreateDBCluster.

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

Represents the input of CreateDBClusterParameterGroup.

', 'refs' => [], ], 'CreateDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterSnapshotMessage' => [ 'base' => '

Represents the input of CreateDBClusterSnapshot.

', 'refs' => [], ], 'CreateDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceMessage' => [ 'base' => '

Represents the input to CreateDBInstance.

', 'refs' => [], ], 'CreateDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSubnetGroupMessage' => [ 'base' => '

Represents the input to CreateDBSubnetGroup.

', 'refs' => [], ], 'CreateDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSubscriptionMessage' => [ 'base' => '

Represents the input to CreateEventSubscription.

', 'refs' => [], ], 'CreateEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterMessage' => [ 'base' => '

Represents the input to CreateGlobalCluster.

', 'refs' => [], ], 'CreateGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DBCluster' => [ 'base' => '

Detailed information about a cluster.

', 'refs' => [ 'CreateDBClusterResult$DBCluster' => NULL, 'DBClusterList$member' => NULL, 'DeleteDBClusterResult$DBCluster' => NULL, 'FailoverDBClusterResult$DBCluster' => NULL, 'ModifyDBClusterResult$DBCluster' => NULL, 'RestoreDBClusterFromSnapshotResult$DBCluster' => NULL, 'RestoreDBClusterToPointInTimeResult$DBCluster' => NULL, 'StartDBClusterResult$DBCluster' => NULL, 'StopDBClusterResult$DBCluster' => NULL, ], ], 'DBClusterAlreadyExistsFault' => [ 'base' => '

You already have a cluster with the given identifier.

', 'refs' => [], ], 'DBClusterList' => [ 'base' => NULL, 'refs' => [ 'DBClusterMessage$DBClusters' => '

A list of clusters.

', ], ], 'DBClusterMember' => [ 'base' => '

Contains information about an instance that is part of a cluster.

', 'refs' => [ 'DBClusterMemberList$member' => NULL, ], ], 'DBClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$DBClusterMembers' => '

Provides the list of instances that make up the cluster.

', ], ], 'DBClusterMessage' => [ 'base' => '

Represents the output of DescribeDBClusters.

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

DBClusterIdentifier doesn\'t refer to an existing cluster.

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

Detailed information about a cluster parameter group.

', 'refs' => [ 'CopyDBClusterParameterGroupResult$DBClusterParameterGroup' => NULL, 'CreateDBClusterParameterGroupResult$DBClusterParameterGroup' => NULL, 'DBClusterParameterGroupList$member' => NULL, ], ], 'DBClusterParameterGroupDetails' => [ 'base' => '

Represents the output of DBClusterParameterGroup.

', 'refs' => [], ], 'DBClusterParameterGroupList' => [ 'base' => NULL, 'refs' => [ 'DBClusterParameterGroupsMessage$DBClusterParameterGroups' => '

A list of cluster parameter groups.

', ], ], 'DBClusterParameterGroupNameMessage' => [ 'base' => '

Contains the name of a cluster parameter group.

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

DBClusterParameterGroupName doesn\'t refer to an existing cluster parameter group.

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

Represents the output of DBClusterParameterGroups.

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

The cluster can\'t be created because you have reached the maximum allowed quota of clusters.

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

Describes an Identity and Access Management (IAM) role that is associated with a cluster.

', 'refs' => [ 'DBClusterRoles$member' => NULL, ], ], 'DBClusterRoles' => [ 'base' => NULL, 'refs' => [ 'DBCluster$AssociatedRoles' => '

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

', ], ], 'DBClusterSnapshot' => [ 'base' => '

Detailed information about a cluster snapshot.

', 'refs' => [ 'CopyDBClusterSnapshotResult$DBClusterSnapshot' => NULL, 'CreateDBClusterSnapshotResult$DBClusterSnapshot' => NULL, 'DBClusterSnapshotList$member' => NULL, 'DeleteDBClusterSnapshotResult$DBClusterSnapshot' => NULL, ], ], 'DBClusterSnapshotAlreadyExistsFault' => [ 'base' => '

You already have a cluster snapshot with the given identifier.

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

Contains the name and values of a manual cluster snapshot attribute.

Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.

', 'refs' => [ 'DBClusterSnapshotAttributeList$member' => NULL, ], ], 'DBClusterSnapshotAttributeList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttributesResult$DBClusterSnapshotAttributes' => '

The list of attributes and values for the cluster snapshot.

', ], ], 'DBClusterSnapshotAttributesResult' => [ 'base' => '

Detailed information about the attributes that are associated with a cluster snapshot.

', 'refs' => [ 'DescribeDBClusterSnapshotAttributesResult$DBClusterSnapshotAttributesResult' => NULL, 'ModifyDBClusterSnapshotAttributeResult$DBClusterSnapshotAttributesResult' => NULL, ], ], 'DBClusterSnapshotList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotMessage$DBClusterSnapshots' => '

Provides a list of cluster snapshots.

', ], ], 'DBClusterSnapshotMessage' => [ 'base' => '

Represents the output of DescribeDBClusterSnapshots.

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

DBClusterSnapshotIdentifier doesn\'t refer to an existing cluster snapshot.

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

Detailed information about an engine version.

', 'refs' => [ 'DBEngineVersionList$member' => NULL, ], ], 'DBEngineVersionList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersionMessage$DBEngineVersions' => '

Detailed information about one or more engine versions.

', ], ], 'DBEngineVersionMessage' => [ 'base' => '

Represents the output of DescribeDBEngineVersions.

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

Detailed information about an instance.

', 'refs' => [ 'CreateDBInstanceResult$DBInstance' => NULL, 'DBInstanceList$member' => NULL, 'DeleteDBInstanceResult$DBInstance' => NULL, 'ModifyDBInstanceResult$DBInstance' => NULL, 'RebootDBInstanceResult$DBInstance' => NULL, ], ], 'DBInstanceAlreadyExistsFault' => [ 'base' => '

You already have a instance with the given identifier.

', 'refs' => [], ], 'DBInstanceList' => [ 'base' => NULL, 'refs' => [ 'DBInstanceMessage$DBInstances' => '

Detailed information about one or more instances.

', ], ], 'DBInstanceMessage' => [ 'base' => '

Represents the output of DescribeDBInstances.

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

DBInstanceIdentifier doesn\'t refer to an existing instance.

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

Provides a list of status information for an instance.

', 'refs' => [ 'DBInstanceStatusInfoList$member' => NULL, ], ], 'DBInstanceStatusInfoList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$StatusInfos' => '

The status of a read replica. If the instance is not a read replica, this is blank.

', ], ], 'DBParameterGroupAlreadyExistsFault' => [ 'base' => '

A parameter group with the same name already exists.

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

DBParameterGroupName doesn\'t refer to an existing parameter group.

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

This request would cause you to exceed the allowed number of parameter groups.

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

DBSecurityGroupName doesn\'t refer to an existing security group.

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

DBSnapshotIdentifier is already being used by an existing snapshot.

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

DBSnapshotIdentifier doesn\'t refer to an existing snapshot.

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

Detailed information about a subnet group.

', 'refs' => [ 'CreateDBSubnetGroupResult$DBSubnetGroup' => NULL, 'DBInstance$DBSubnetGroup' => '

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

', 'DBSubnetGroups$member' => NULL, 'ModifyDBSubnetGroupResult$DBSubnetGroup' => NULL, ], ], 'DBSubnetGroupAlreadyExistsFault' => [ 'base' => '

DBSubnetGroupName is already being used by an existing subnet group.

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

Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

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

Represents the output of DescribeDBSubnetGroups.

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

DBSubnetGroupName doesn\'t refer to an existing subnet group.

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

The request would cause you to exceed the allowed number of subnet groups.

', 'refs' => [], ], 'DBSubnetGroups' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroupMessage$DBSubnetGroups' => '

Detailed information about one or more subnet groups.

', ], ], 'DBSubnetQuotaExceededFault' => [ 'base' => '

The request would cause you to exceed the allowed number of subnets in a subnet group.

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

The upgrade failed because a resource that the depends on can\'t be modified.

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

Represents the input to DeleteDBCluster.

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

Represents the input to DeleteDBClusterParameterGroup.

', 'refs' => [], ], 'DeleteDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterSnapshotMessage' => [ 'base' => '

Represents the input to DeleteDBClusterSnapshot.

', 'refs' => [], ], 'DeleteDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBInstanceMessage' => [ 'base' => '

Represents the input to DeleteDBInstance.

', 'refs' => [], ], 'DeleteDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBSubnetGroupMessage' => [ 'base' => '

Represents the input to DeleteDBSubnetGroup.

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

Represents the input to DeleteEventSubscription.

', 'refs' => [], ], 'DeleteEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalClusterMessage' => [ 'base' => '

Represents the input to DeleteGlobalCluster.

', 'refs' => [], ], 'DeleteGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCertificatesMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'base' => '

Represents the input to DescribeDBClusterParameterGroups.

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

Represents the input to DescribeDBClusterParameters.

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

Represents the input to DescribeDBClusterSnapshotAttributes.

', 'refs' => [], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBClusterSnapshotsMessage' => [ 'base' => '

Represents the input to DescribeDBClusterSnapshots.

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

Represents the input to DescribeDBClusters.

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

Represents the input to DescribeDBEngineVersions.

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

Represents the input to DescribeDBInstances.

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

Represents the input to DescribeDBSubnetGroups.

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

Represents the input to DescribeEngineDefaultClusterParameters.

', 'refs' => [], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEventCategoriesMessage' => [ 'base' => '

Represents the input to DescribeEventCategories.

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

Represents the input to DescribeEventSubscriptions.

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

Represents the input to DescribeEvents.

', 'refs' => [], ], 'DescribeGlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'base' => '

Represents the input to DescribeOrderableDBInstanceOptions.

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

Represents the input to DescribePendingMaintenanceActions.

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

Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

', 'refs' => [ 'DBInstance$Endpoint' => '

Specifies the connection endpoint.

', ], ], 'EngineDefaults' => [ 'base' => '

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

', 'refs' => [ 'DescribeEngineDefaultClusterParametersResult$EngineDefaults' => NULL, ], ], 'Event' => [ 'base' => '

Detailed information about an event.

', 'refs' => [ 'EventList$member' => NULL, ], ], 'EventCategoriesList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$EventCategories' => '

A list of event categories for a SourceType that you want to subscribe to.

', 'DescribeEventsMessage$EventCategories' => '

A list of event categories that trigger notifications for an event notification subscription.

', 'Event$EventCategories' => '

Specifies the category for the event.

', 'EventCategoriesMap$EventCategories' => '

The event categories for the specified source type.

', 'EventSubscription$EventCategoriesList' => '

A list of event categories for the Amazon DocumentDB event notification subscription.

', 'ModifyEventSubscriptionMessage$EventCategories' => '

A list of event categories for a SourceType that you want to subscribe to.

', ], ], 'EventCategoriesMap' => [ 'base' => '

An event source type, accompanied by one or more event category names.

', 'refs' => [ 'EventCategoriesMapList$member' => NULL, ], ], 'EventCategoriesMapList' => [ 'base' => NULL, 'refs' => [ 'EventCategoriesMessage$EventCategoriesMapList' => '

A list of event category maps.

', ], ], 'EventCategoriesMessage' => [ 'base' => '

Represents the output of DescribeEventCategories.

', 'refs' => [], ], 'EventList' => [ 'base' => NULL, 'refs' => [ 'EventsMessage$Events' => '

Detailed information about one or more events.

', ], ], 'EventSubscription' => [ 'base' => '

Detailed information about an event to which you have subscribed.

', 'refs' => [ 'AddSourceIdentifierToSubscriptionResult$EventSubscription' => NULL, 'CreateEventSubscriptionResult$EventSubscription' => NULL, 'DeleteEventSubscriptionResult$EventSubscription' => NULL, 'EventSubscriptionsList$member' => NULL, 'ModifyEventSubscriptionResult$EventSubscription' => NULL, 'RemoveSourceIdentifierFromSubscriptionResult$EventSubscription' => NULL, ], ], 'EventSubscriptionQuotaExceededFault' => [ 'base' => '

You have reached the maximum number of event subscriptions.

', 'refs' => [], ], 'EventSubscriptionsList' => [ 'base' => NULL, 'refs' => [ 'EventSubscriptionsMessage$EventSubscriptionsList' => '

A list of event subscriptions.

', ], ], 'EventSubscriptionsMessage' => [ 'base' => '

Represents the output of DescribeEventSubscriptions.

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

Represents the output of DescribeEvents.

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

Represents the input to FailoverDBCluster.

', 'refs' => [], ], 'FailoverDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'Filter' => [ 'base' => '

A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Wildcards are not supported in filters.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeCertificatesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterParameterGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterSnapshotsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClustersMessage$Filters' => '

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

', 'DescribeDBEngineVersionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBInstancesMessage$Filters' => '

A filter that specifies one or more instances to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

', 'DescribeDBSubnetGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEngineDefaultClusterParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventCategoriesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventSubscriptionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeGlobalClustersMessage$Filters' => '

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

', 'DescribeOrderableDBInstanceOptionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribePendingMaintenanceActionsMessage$Filters' => '

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

', 'ListTagsForResourceMessage$Filters' => '

This parameter is not currently supported.

', ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

One or more filter values. Filter values are case sensitive.

', ], ], 'GlobalCluster' => [ 'base' => '

A data type representing an Amazon DocumentDB global cluster.

', 'refs' => [ 'CreateGlobalClusterResult$GlobalCluster' => NULL, 'DeleteGlobalClusterResult$GlobalCluster' => NULL, 'GlobalClusterList$member' => NULL, 'ModifyGlobalClusterResult$GlobalCluster' => NULL, 'RemoveFromGlobalClusterResult$GlobalCluster' => NULL, ], ], 'GlobalClusterAlreadyExistsFault' => [ 'base' => '

The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique name) to create a new global cluster.

', 'refs' => [], ], 'GlobalClusterIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier of the new global cluster.

', 'CreateGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier of the new global cluster.

', 'DeleteGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier of the global cluster being deleted.

', 'DescribeGlobalClustersMessage$GlobalClusterIdentifier' => '

The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn\'t case-sensitive.

', 'GlobalCluster$GlobalClusterIdentifier' => '

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

', 'ModifyGlobalClusterMessage$GlobalClusterIdentifier' => '

The identifier for the global cluster being modified. This parameter isn\'t case-sensitive.

Constraints:

  • Must match the identifier of an existing global cluster.

', 'ModifyGlobalClusterMessage$NewGlobalClusterIdentifier' => '

The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

  • Must contain from 1 to 63 letters, numbers, or hyphens

    The first character must be a letter

    Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

', 'RemoveFromGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier to detach from the Amazon DocumentDB global cluster.

', ], ], 'GlobalClusterList' => [ 'base' => NULL, 'refs' => [ 'GlobalClustersMessage$GlobalClusters' => '

', ], ], 'GlobalClusterMember' => [ 'base' => '

A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

', 'refs' => [ 'GlobalClusterMemberList$member' => NULL, ], ], 'GlobalClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'GlobalCluster$GlobalClusterMembers' => '

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

', ], ], 'GlobalClusterNotFoundFault' => [ 'base' => '

The GlobalClusterIdentifier doesn\'t refer to an existing global cluster.

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

The number of global clusters for this account is already at the maximum allowed.

', 'refs' => [], ], 'GlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'InstanceQuotaExceededFault' => [ 'base' => '

The request would cause you to exceed the allowed number of instances.

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

The cluster doesn\'t have enough capacity for the current operation.

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

The specified instance class isn\'t available in the specified Availability Zone.

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

There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshot$Port' => '

Specifies the port that the cluster was listening on at the time of the snapshot.

', 'DBClusterSnapshot$PercentProgress' => '

Specifies the percentage of the estimated data that has been transferred.

', 'DBInstance$BackupRetentionPeriod' => '

Specifies the number of days for which automatic snapshots are retained.

', 'Endpoint$Port' => '

Specifies the port that the database engine is listening on.

', ], ], 'IntegerOptional' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35.

', 'CreateDBClusterMessage$Port' => '

The port number on which the instances in the cluster accept connections.

', 'CreateDBInstanceMessage$PromotionTier' => '

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

', 'DBCluster$BackupRetentionPeriod' => '

Specifies the number of days for which automatic snapshots are retained.

', 'DBCluster$Port' => '

Specifies the port that the database engine is listening on.

', 'DBClusterMember$PromotionTier' => '

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

', 'DBInstance$PromotionTier' => '

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

', 'DescribeCertificatesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints:

  • Minimum: 20

  • Maximum: 100

', 'DescribeDBClusterParameterGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterSnapshotsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClustersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBEngineVersionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBInstancesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBSubnetGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEngineDefaultClusterParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEventSubscriptionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEventsMessage$Duration' => '

The number of minutes to retrieve events for.

Default: 60

', 'DescribeEventsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeGlobalClustersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

', 'DescribeOrderableDBInstanceOptionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribePendingMaintenanceActionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'ModifyDBClusterMessage$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35.

', 'ModifyDBClusterMessage$Port' => '

The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

', 'ModifyDBInstanceMessage$PromotionTier' => '

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

', 'PendingModifiedValues$AllocatedStorage' => '

Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

', 'PendingModifiedValues$Port' => '

Specifies the pending port for the instance.

', 'PendingModifiedValues$BackupRetentionPeriod' => '

Specifies the pending number of days for which automated backups are retained.

', 'PendingModifiedValues$Iops' => '

Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

', 'RestoreDBClusterFromSnapshotMessage$Port' => '

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

', 'RestoreDBClusterToPointInTimeMessage$Port' => '

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

', ], ], 'InvalidDBClusterSnapshotStateFault' => [ 'base' => '

The provided value isn\'t a valid cluster snapshot state.

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

The cluster isn\'t in a valid state.

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

The specified instance isn\'t in the available state.

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

The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can\'t delete it when the parameter group is in this state.

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

The state of the security group doesn\'t allow deletion.

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

The state of the snapshot doesn\'t allow deletion.

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

The subnet group can\'t be deleted because it\'s in use.

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

The subnet isn\'t in the available state.

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

Someone else might be modifying a subscription. Wait a few seconds, and try again.

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

The requested operation can\'t be performed while the cluster is in this state.

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

You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

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

The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

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

The subnet group doesn\'t cover all Availability Zones after it is created because of changes that were made.

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

An error occurred when accessing an KMS key.

', 'refs' => [], ], 'KeyList' => [ 'base' => NULL, 'refs' => [ 'RemoveTagsFromResourceMessage$TagKeys' => '

The tag key (name) of the tag to be removed.

', ], ], 'ListTagsForResourceMessage' => [ 'base' => '

Represents the input to ListTagsForResource.

', 'refs' => [], ], 'LogTypeList' => [ 'base' => NULL, 'refs' => [ 'CloudwatchLogsExportConfiguration$EnableLogTypes' => '

The list of log types to enable.

', 'CloudwatchLogsExportConfiguration$DisableLogTypes' => '

The list of log types to disable.

', 'CreateDBClusterMessage$EnableCloudwatchLogsExports' => '

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

', 'DBCluster$EnabledCloudwatchLogsExports' => '

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

', 'DBEngineVersion$ExportableLogTypes' => '

The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

', 'DBInstance$EnabledCloudwatchLogsExports' => '

A list of log types that this instance is configured to export to CloudWatch Logs.

', 'PendingCloudwatchLogsExports$LogTypesToEnable' => '

Log types that are in the process of being deactivated. After they are deactivated, these log types aren\'t exported to CloudWatch Logs.

', 'PendingCloudwatchLogsExports$LogTypesToDisable' => '

Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

', 'RestoreDBClusterFromSnapshotMessage$EnableCloudwatchLogsExports' => '

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

', 'RestoreDBClusterToPointInTimeMessage$EnableCloudwatchLogsExports' => '

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

', ], ], 'ModifyDBClusterMessage' => [ 'base' => '

Represents the input to ModifyDBCluster.

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

Represents the input to ModifyDBClusterParameterGroup.

', 'refs' => [], ], 'ModifyDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'base' => '

Represents the input to ModifyDBClusterSnapshotAttribute.

', 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBInstanceMessage' => [ 'base' => '

Represents the input to ModifyDBInstance.

', 'refs' => [], ], 'ModifyDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSubnetGroupMessage' => [ 'base' => '

Represents the input to ModifyDBSubnetGroup.

', 'refs' => [], ], 'ModifyDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyEventSubscriptionMessage' => [ 'base' => '

Represents the input to ModifyEventSubscription.

', 'refs' => [], ], 'ModifyEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterMessage' => [ 'base' => '

Represents the input to ModifyGlobalCluster.

', 'refs' => [], ], 'ModifyGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'OrderableDBInstanceOption' => [ 'base' => '

The options that are available for an instance.

', 'refs' => [ 'OrderableDBInstanceOptionsList$member' => NULL, ], ], 'OrderableDBInstanceOptionsList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOptionsMessage$OrderableDBInstanceOptions' => '

The options that are available for a particular orderable instance.

', ], ], 'OrderableDBInstanceOptionsMessage' => [ 'base' => '

Represents the output of DescribeOrderableDBInstanceOptions.

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

Detailed information about an individual parameter.

', 'refs' => [ 'ParametersList$member' => NULL, ], ], 'ParametersList' => [ 'base' => NULL, 'refs' => [ 'DBClusterParameterGroupDetails$Parameters' => '

Provides a list of parameters for the cluster parameter group.

', 'EngineDefaults$Parameters' => '

The parameters of a particular cluster parameter group family.

', 'ModifyDBClusterParameterGroupMessage$Parameters' => '

A list of parameters in the cluster parameter group to modify.

', 'ResetDBClusterParameterGroupMessage$Parameters' => '

A list of parameter names in the cluster parameter group to reset to the default values. You can\'t use this parameter if the ResetAllParameters parameter is set to true.

', ], ], 'PendingCloudwatchLogsExports' => [ 'base' => '

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

', 'refs' => [ 'PendingModifiedValues$PendingCloudwatchLogsExports' => '

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

', ], ], 'PendingMaintenanceAction' => [ 'base' => '

Provides information about a pending maintenance action for a resource.

', 'refs' => [ 'PendingMaintenanceActionDetails$member' => NULL, ], ], 'PendingMaintenanceActionDetails' => [ 'base' => NULL, 'refs' => [ 'ResourcePendingMaintenanceActions$PendingMaintenanceActionDetails' => '

A list that provides details about the pending maintenance actions for the resource.

', ], ], 'PendingMaintenanceActions' => [ 'base' => NULL, 'refs' => [ 'PendingMaintenanceActionsMessage$PendingMaintenanceActions' => '

The maintenance actions to be applied.

', ], ], 'PendingMaintenanceActionsMessage' => [ 'base' => '

Represents the output of DescribePendingMaintenanceActions.

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

One or more modified settings for an instance. These modified settings have been requested, but haven\'t been applied yet.

', 'refs' => [ 'DBInstance$PendingModifiedValues' => '

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

', ], ], 'ReadReplicaIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$ReadReplicaIdentifiers' => '

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

', ], ], 'ReadersArnList' => [ 'base' => NULL, 'refs' => [ 'GlobalClusterMember$Readers' => '

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

', ], ], 'RebootDBInstanceMessage' => [ 'base' => '

Represents the input to RebootDBInstance.

', 'refs' => [], ], 'RebootDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveFromGlobalClusterMessage' => [ 'base' => '

Represents the input to RemoveFromGlobalCluster.

', 'refs' => [], ], 'RemoveFromGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'base' => '

Represents the input to RemoveSourceIdentifierFromSubscription.

', 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveTagsFromResourceMessage' => [ 'base' => '

Represents the input to RemoveTagsFromResource.

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

Represents the input to ResetDBClusterParameterGroup.

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

The specified resource ID was not found.

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

Represents the output of ApplyPendingMaintenanceAction.

', 'refs' => [ 'ApplyPendingMaintenanceActionResult$ResourcePendingMaintenanceActions' => NULL, 'PendingMaintenanceActions$member' => NULL, ], ], 'RestoreDBClusterFromSnapshotMessage' => [ 'base' => '

Represents the input to RestoreDBClusterFromSnapshot.

', 'refs' => [], ], 'RestoreDBClusterFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'base' => '

Represents the input to RestoreDBClusterToPointInTime.

', 'refs' => [], ], 'RestoreDBClusterToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'SNSInvalidTopicFault' => [ 'base' => '

Amazon SNS has responded that there is a problem with the specified topic.

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

You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).

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

The SNS topic Amazon Resource Name (ARN) does not exist.

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

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

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

The request would cause you to exceed the allowed number of snapshots.

', 'refs' => [], ], 'SourceIdsList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$SourceIds' => '

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are provided, SourceType must also be provided.

  • If the source type is an instance, a DBInstanceIdentifier must be provided.

  • If the source type is a security group, a DBSecurityGroupName must be provided.

  • If the source type is a parameter group, a DBParameterGroupName must be provided.

  • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

', 'EventSubscription$SourceIdsList' => '

A list of source IDs for the Amazon DocumentDB event notification subscription.

', ], ], 'SourceNotFoundFault' => [ 'base' => '

The requested source could not be found.

', 'refs' => [], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'DescribeEventsMessage$SourceType' => '

The event source to retrieve events for. If no value is specified, all events are returned.

', 'Event$SourceType' => '

Specifies the source type for this event.

', ], ], 'StartDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StorageQuotaExceededFault' => [ 'base' => '

The request would cause you to exceed the allowed amount of storage available across all instances.

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

Storage of the specified StorageType can\'t be associated with the DB instance.

', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddSourceIdentifierToSubscriptionMessage$SubscriptionName' => '

The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

', 'AddSourceIdentifierToSubscriptionMessage$SourceIdentifier' => '

The identifier of the event source to be added:

  • If the source type is an instance, a DBInstanceIdentifier must be provided.

  • If the source type is a security group, a DBSecurityGroupName must be provided.

  • If the source type is a parameter group, a DBParameterGroupName must be provided.

  • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

', 'AddTagsToResourceMessage$ResourceName' => '

The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .

', 'ApplyPendingMaintenanceActionMessage$ResourceIdentifier' => '

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

', 'ApplyPendingMaintenanceActionMessage$ApplyAction' => '

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

', 'ApplyPendingMaintenanceActionMessage$OptInType' => '

A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can\'t be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

', 'AttributeValueList$member' => NULL, 'AvailabilityZone$Name' => '

The name of the Availability Zone.

', 'AvailabilityZones$member' => NULL, 'CACertificateIdentifiersList$member' => NULL, 'Certificate$CertificateIdentifier' => '

The unique key that identifies a certificate.

Example: rds-ca-2019

', 'Certificate$CertificateType' => '

The type of the certificate.

Example: CA

', 'Certificate$Thumbprint' => '

The thumbprint of the certificate.

', 'Certificate$CertificateArn' => '

The Amazon Resource Name (ARN) for the certificate.

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

', 'CertificateDetails$CAIdentifier' => '

The CA identifier of the CA certificate used for the DB instance\'s server certificate.

', 'CertificateMessage$Marker' => '

An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

', 'CopyDBClusterParameterGroupMessage$SourceDBClusterParameterGroupIdentifier' => '

The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

Constraints:

  • Must specify a valid cluster parameter group.

  • If the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.

  • If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.

', 'CopyDBClusterParameterGroupMessage$TargetDBClusterParameterGroupIdentifier' => '

The identifier for the copied cluster parameter group.

Constraints:

  • Cannot be null, empty, or blank.

  • Must contain from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-param-group1

', 'CopyDBClusterParameterGroupMessage$TargetDBClusterParameterGroupDescription' => '

A description for the copied cluster parameter group.

', 'CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier' => '

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

', 'CopyDBClusterSnapshotMessage$TargetDBClusterSnapshotIdentifier' => '

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

', 'CopyDBClusterSnapshotMessage$KmsKeyId' => '

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don\'t specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

', 'CopyDBClusterSnapshotMessage$PreSignedUrl' => '

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn\'t case sensitive.

', 'CreateDBClusterMessage$DBClusterIdentifier' => '

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

', 'CreateDBClusterMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group to associate with this cluster.

', 'CreateDBClusterMessage$DBSubnetGroupName' => '

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'CreateDBClusterMessage$Engine' => '

The name of the database engine to be used for this cluster.

Valid values: docdb

', 'CreateDBClusterMessage$EngineVersion' => '

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

', 'CreateDBClusterMessage$MasterUsername' => '

The name of the master user for the cluster.

Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

', 'CreateDBClusterMessage$MasterUserPassword' => '

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

', 'CreateDBClusterMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'CreateDBClusterMessage$PreferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

', 'CreateDBClusterMessage$KmsKeyId' => '

The KMS key identifier for an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

', 'CreateDBClusterMessage$PreSignedUrl' => '

Not currently supported.

', 'CreateDBClusterMessage$StorageType' => '

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn\'t returned when you set it to standard.

', 'CreateDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group.

Constraints:

  • Must not match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

', 'CreateDBClusterParameterGroupMessage$DBParameterGroupFamily' => '

The cluster parameter group family name.

', 'CreateDBClusterParameterGroupMessage$Description' => '

The description for the cluster parameter group.

', 'CreateDBClusterSnapshotMessage$DBClusterSnapshotIdentifier' => '

The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

', 'CreateDBClusterSnapshotMessage$DBClusterIdentifier' => '

The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster

', 'CreateDBInstanceMessage$DBInstanceIdentifier' => '

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

', 'CreateDBInstanceMessage$DBInstanceClass' => '

The compute and memory capacity of the instance; for example, db.r5.large.

', 'CreateDBInstanceMessage$Engine' => '

The name of the database engine to be used for this instance.

Valid value: docdb

', 'CreateDBInstanceMessage$AvailabilityZone' => '

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint\'s Amazon Web Services Region.

Example: us-east-1d

', 'CreateDBInstanceMessage$PreferredMaintenanceWindow' => '

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

', 'CreateDBInstanceMessage$DBClusterIdentifier' => '

The identifier of the cluster that the instance will belong to.

', 'CreateDBInstanceMessage$PerformanceInsightsKMSKeyId' => '

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

', 'CreateDBInstanceMessage$CACertificateIdentifier' => '

The CA certificate identifier to use for the DB instance\'s server certificate.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

', 'CreateDBSubnetGroupMessage$DBSubnetGroupName' => '

The name for the subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

', 'CreateDBSubnetGroupMessage$DBSubnetGroupDescription' => '

The description for the subnet group.

', 'CreateEventSubscriptionMessage$SubscriptionName' => '

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

', 'CreateEventSubscriptionMessage$SnsTopicArn' => '

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

', 'CreateEventSubscriptionMessage$SourceType' => '

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

', 'CreateGlobalClusterMessage$SourceDBClusterIdentifier' => '

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

', 'CreateGlobalClusterMessage$Engine' => '

The name of the database engine to be used for this cluster.

', 'CreateGlobalClusterMessage$EngineVersion' => '

The engine version of the global cluster.

', 'CreateGlobalClusterMessage$DatabaseName' => '

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.

', 'DBCluster$DBClusterIdentifier' => '

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

', 'DBCluster$DBClusterParameterGroup' => '

Specifies the name of the cluster parameter group for the cluster.

', 'DBCluster$DBSubnetGroup' => '

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

', 'DBCluster$Status' => '

Specifies the current state of this cluster.

', 'DBCluster$PercentProgress' => '

Specifies the progress of the operation as a percentage.

', 'DBCluster$Endpoint' => '

Specifies the connection endpoint for the primary instance of the cluster.

', 'DBCluster$ReaderEndpoint' => '

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

', 'DBCluster$Engine' => '

Provides the name of the database engine to be used for this cluster.

', 'DBCluster$EngineVersion' => '

Indicates the database engine version.

', 'DBCluster$MasterUsername' => '

Contains the master user name for the cluster.

', 'DBCluster$PreferredBackupWindow' => '

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

', 'DBCluster$PreferredMaintenanceWindow' => '

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

', 'DBCluster$ReplicationSourceIdentifier' => '

Contains the identifier of the source cluster if this cluster is a secondary cluster.

', 'DBCluster$HostedZoneId' => '

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

', 'DBCluster$KmsKeyId' => '

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

', 'DBCluster$DbClusterResourceId' => '

The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

', 'DBCluster$DBClusterArn' => '

The Amazon Resource Name (ARN) for the cluster.

', 'DBCluster$CloneGroupId' => '

Identifies the clone group to which the DB cluster is associated.

', 'DBCluster$StorageType' => '

Storage type associated with your cluster

Storage type associated with your cluster

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

', 'DBClusterMember$DBInstanceIdentifier' => '

Specifies the instance identifier for this member of the cluster.

', 'DBClusterMember$DBClusterParameterGroupStatus' => '

Specifies the status of the cluster parameter group for this member of the DB cluster.

', 'DBClusterMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBClusterParameterGroup$DBClusterParameterGroupName' => '

Provides the name of the cluster parameter group.

', 'DBClusterParameterGroup$DBParameterGroupFamily' => '

Provides the name of the parameter group family that this cluster parameter group is compatible with.

', 'DBClusterParameterGroup$Description' => '

Provides the customer-specified description for this cluster parameter group.

', 'DBClusterParameterGroup$DBClusterParameterGroupArn' => '

The Amazon Resource Name (ARN) for the cluster parameter group.

', 'DBClusterParameterGroupDetails$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBClusterParameterGroupNameMessage$DBClusterParameterGroupName' => '

The name of a cluster parameter group.

Constraints:

  • Must be from 1 to 255 letters or numbers.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

', 'DBClusterParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBClusterRole$RoleArn' => '

The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

', 'DBClusterRole$Status' => '

Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

  • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

  • PENDING - The IAMrole ARN is being associated with the cluster.

  • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

', 'DBClusterSnapshot$DBClusterSnapshotIdentifier' => '

Specifies the identifier for the cluster snapshot.

', 'DBClusterSnapshot$DBClusterIdentifier' => '

Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

', 'DBClusterSnapshot$Engine' => '

Specifies the name of the database engine.

', 'DBClusterSnapshot$Status' => '

Specifies the status of this cluster snapshot.

', 'DBClusterSnapshot$VpcId' => '

Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

', 'DBClusterSnapshot$MasterUsername' => '

Provides the master user name for the cluster snapshot.

', 'DBClusterSnapshot$EngineVersion' => '

Provides the version of the database engine for this cluster snapshot.

', 'DBClusterSnapshot$SnapshotType' => '

Provides the type of the cluster snapshot.

', 'DBClusterSnapshot$KmsKeyId' => '

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

', 'DBClusterSnapshot$DBClusterSnapshotArn' => '

The Amazon Resource Name (ARN) for the cluster snapshot.

', 'DBClusterSnapshot$SourceDBClusterSnapshotArn' => '

If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

', 'DBClusterSnapshot$StorageType' => '

Storage type associated with your cluster snapshot

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

', 'DBClusterSnapshotAttribute$AttributeName' => '

The name of the manual cluster snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.

', 'DBClusterSnapshotAttributesResult$DBClusterSnapshotIdentifier' => '

The identifier of the cluster snapshot that the attributes apply to.

', 'DBClusterSnapshotMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBEngineVersion$Engine' => '

The name of the database engine.

', 'DBEngineVersion$EngineVersion' => '

The version number of the database engine.

', 'DBEngineVersion$DBParameterGroupFamily' => '

The name of the parameter group family for the database engine.

', 'DBEngineVersion$DBEngineDescription' => '

The description of the database engine.

', 'DBEngineVersion$DBEngineVersionDescription' => '

The description of the database engine version.

', 'DBEngineVersionMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBInstance$DBInstanceIdentifier' => '

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

', 'DBInstance$DBInstanceClass' => '

Contains the name of the compute and memory capacity class of the instance.

', 'DBInstance$Engine' => '

Provides the name of the database engine to be used for this instance.

', 'DBInstance$DBInstanceStatus' => '

Specifies the current state of this database.

', 'DBInstance$PreferredBackupWindow' => '

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

', 'DBInstance$AvailabilityZone' => '

Specifies the name of the Availability Zone that the instance is located in.

', 'DBInstance$PreferredMaintenanceWindow' => '

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

', 'DBInstance$EngineVersion' => '

Indicates the database engine version.

', 'DBInstance$DBClusterIdentifier' => '

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

', 'DBInstance$KmsKeyId' => '

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

', 'DBInstance$DbiResourceId' => '

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

', 'DBInstance$CACertificateIdentifier' => '

The identifier of the CA certificate for this DB instance.

', 'DBInstance$DBInstanceArn' => '

The Amazon Resource Name (ARN) for the instance.

', 'DBInstanceMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBInstanceStatusInfo$StatusType' => '

This value is currently "read replication."

', 'DBInstanceStatusInfo$Status' => '

Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

', 'DBInstanceStatusInfo$Message' => '

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

', 'DBSubnetGroup$DBSubnetGroupName' => '

The name of the subnet group.

', 'DBSubnetGroup$DBSubnetGroupDescription' => '

Provides the description of the subnet group.

', 'DBSubnetGroup$VpcId' => '

Provides the virtual private cloud (VPC) ID of the subnet group.

', 'DBSubnetGroup$SubnetGroupStatus' => '

Provides the status of the subnet group.

', 'DBSubnetGroup$DBSubnetGroupArn' => '

The Amazon Resource Name (ARN) for the DB subnet group.

', 'DBSubnetGroupMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DeleteDBClusterMessage$DBClusterIdentifier' => '

The cluster identifier for the cluster to be deleted. This parameter isn\'t case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

', 'DeleteDBClusterMessage$FinalDBSnapshotIdentifier' => '

The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

', 'DeleteDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group.

Constraints:

  • Must be the name of an existing cluster parameter group.

  • You can\'t delete a default cluster parameter group.

  • Cannot be associated with any clusters.

', 'DeleteDBClusterSnapshotMessage$DBClusterSnapshotIdentifier' => '

The identifier of the cluster snapshot to delete.

Constraints: Must be the name of an existing cluster snapshot in the available state.

', 'DeleteDBInstanceMessage$DBInstanceIdentifier' => '

The instance identifier for the instance to be deleted. This parameter isn\'t case sensitive.

Constraints:

  • Must match the name of an existing instance.

', 'DeleteDBSubnetGroupMessage$DBSubnetGroupName' => '

The name of the database subnet group to delete.

You can\'t delete the default subnet group.

Constraints:

Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'DeleteEventSubscriptionMessage$SubscriptionName' => '

The name of the Amazon DocumentDB event notification subscription that you want to delete.

', 'DescribeCertificatesMessage$CertificateIdentifier' => '

The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

  • Must match an existing CertificateIdentifier.

', 'DescribeCertificatesMessage$Marker' => '

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterParameterGroupsMessage$DBClusterParameterGroupName' => '

The name of a specific cluster parameter group to return details for.

Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup.

', 'DescribeDBClusterParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterParametersMessage$DBClusterParameterGroupName' => '

The name of a specific cluster parameter group to return parameter details for.

Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup.

', 'DescribeDBClusterParametersMessage$Source' => '

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

', 'DescribeDBClusterParametersMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterSnapshotAttributesMessage$DBClusterSnapshotIdentifier' => '

The identifier for the cluster snapshot to describe the attributes for.

', 'DescribeDBClusterSnapshotsMessage$DBClusterIdentifier' => '

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can\'t be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

  • If provided, must match the identifier of an existing DBCluster.

', 'DescribeDBClusterSnapshotsMessage$DBClusterSnapshotIdentifier' => '

A specific cluster snapshot identifier to describe. This parameter can\'t be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • If provided, must match the identifier of an existing DBClusterSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

', 'DescribeDBClusterSnapshotsMessage$SnapshotType' => '

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

  • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

  • shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.

  • public - Return all cluster snapshots that have been marked as public.

If you don\'t specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.

', 'DescribeDBClusterSnapshotsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClustersMessage$DBClusterIdentifier' => '

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn\'t case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

', 'DescribeDBClustersMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBEngineVersionsMessage$Engine' => '

The database engine to return.

', 'DescribeDBEngineVersionsMessage$EngineVersion' => '

The database engine version to return.

Example: 3.6.0

', 'DescribeDBEngineVersionsMessage$DBParameterGroupFamily' => '

The name of a specific parameter group family to return details for.

Constraints:

  • If provided, must match an existing DBParameterGroupFamily.

', 'DescribeDBEngineVersionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBInstancesMessage$DBInstanceIdentifier' => '

The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn\'t case sensitive.

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

', 'DescribeDBInstancesMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBSubnetGroupsMessage$DBSubnetGroupName' => '

The name of the subnet group to return details for.

', 'DescribeDBSubnetGroupsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEngineDefaultClusterParametersMessage$DBParameterGroupFamily' => '

The name of the cluster parameter group family to return the engine parameter information for.

', 'DescribeEngineDefaultClusterParametersMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEventCategoriesMessage$SourceType' => '

The type of source that is generating the events.

Valid values: db-instance, db-parameter-group, db-security-group

', 'DescribeEventSubscriptionsMessage$SubscriptionName' => '

The name of the Amazon DocumentDB event notification subscription that you want to describe.

', 'DescribeEventSubscriptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEventsMessage$SourceIdentifier' => '

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

', 'DescribeEventsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeGlobalClustersMessage$Marker' => '

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeOrderableDBInstanceOptionsMessage$Engine' => '

The name of the engine to retrieve instance options for.

', 'DescribeOrderableDBInstanceOptionsMessage$EngineVersion' => '

The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

', 'DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass' => '

The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

', 'DescribeOrderableDBInstanceOptionsMessage$LicenseModel' => '

The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

', 'DescribeOrderableDBInstanceOptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribePendingMaintenanceActionsMessage$ResourceIdentifier' => '

The ARN of a resource to return pending maintenance actions for.

', 'DescribePendingMaintenanceActionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'Endpoint$Address' => '

Specifies the DNS address of the instance.

', 'Endpoint$HostedZoneId' => '

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

', 'EngineDefaults$DBParameterGroupFamily' => '

The name of the cluster parameter group family to return the engine parameter information for.

', 'EngineDefaults$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'Event$SourceIdentifier' => '

Provides the identifier for the source of the event.

', 'Event$Message' => '

Provides the text of this event.

', 'Event$SourceArn' => '

The Amazon Resource Name (ARN) for the event.

', 'EventCategoriesList$member' => NULL, 'EventCategoriesMap$SourceType' => '

The source type that the returned categories belong to.

', 'EventSubscription$CustomerAwsId' => '

The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

', 'EventSubscription$CustSubscriptionId' => '

The Amazon DocumentDB event notification subscription ID.

', 'EventSubscription$SnsTopicArn' => '

The topic ARN of the Amazon DocumentDB event notification subscription.

', 'EventSubscription$Status' => '

The status of the Amazon DocumentDB event notification subscription.

Constraints:

Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

', 'EventSubscription$SubscriptionCreationTime' => '

The time at which the Amazon DocumentDB event notification subscription was created.

', 'EventSubscription$SourceType' => '

The source type for the Amazon DocumentDB event notification subscription.

', 'EventSubscription$EventSubscriptionArn' => '

The Amazon Resource Name (ARN) for the event subscription.

', 'EventSubscriptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'EventsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'FailoverDBClusterMessage$DBClusterIdentifier' => '

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'FailoverDBClusterMessage$TargetDBInstanceIdentifier' => '

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

', 'Filter$Name' => '

The name of the filter. Filter names are case sensitive.

', 'FilterValueList$member' => NULL, 'GlobalCluster$GlobalClusterResourceId' => '

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

', 'GlobalCluster$GlobalClusterArn' => '

The Amazon Resource Name (ARN) for the global cluster.

', 'GlobalCluster$Status' => '

Specifies the current state of this global cluster.

', 'GlobalCluster$Engine' => '

The Amazon DocumentDB database engine used by the global cluster.

', 'GlobalCluster$EngineVersion' => '

Indicates the database engine version.

', 'GlobalCluster$DatabaseName' => '

The default database name within the new global cluster.

', 'GlobalClusterMember$DBClusterArn' => '

The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

', 'GlobalClustersMessage$Marker' => '

', 'KeyList$member' => NULL, 'ListTagsForResourceMessage$ResourceName' => '

The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

', 'LogTypeList$member' => NULL, 'ModifyDBClusterMessage$DBClusterIdentifier' => '

The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'ModifyDBClusterMessage$NewDBClusterIdentifier' => '

The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

', 'ModifyDBClusterMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group to use for the cluster.

', 'ModifyDBClusterMessage$MasterUserPassword' => '

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

', 'ModifyDBClusterMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'ModifyDBClusterMessage$PreferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

', 'ModifyDBClusterMessage$EngineVersion' => '

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for Amazon DocumentDB use the following command:

aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

', 'ModifyDBClusterMessage$StorageType' => '

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

', 'ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group to modify.

', 'ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier' => '

The identifier for the cluster snapshot to modify the attributes for.

', 'ModifyDBClusterSnapshotAttributeMessage$AttributeName' => '

The name of the cluster snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.

', 'ModifyDBInstanceMessage$DBInstanceIdentifier' => '

The instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'ModifyDBInstanceMessage$DBInstanceClass' => '

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.

If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

', 'ModifyDBInstanceMessage$PreferredMaintenanceWindow' => '

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn\'t result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Must be at least 30 minutes.

', 'ModifyDBInstanceMessage$NewDBInstanceIdentifier' => '

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

', 'ModifyDBInstanceMessage$CACertificateIdentifier' => '

Indicates the certificate that needs to be associated with the instance.

', 'ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId' => '

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

', 'ModifyDBSubnetGroupMessage$DBSubnetGroupName' => '

The name for the subnet group. This value is stored as a lowercase string. You can\'t modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'ModifyDBSubnetGroupMessage$DBSubnetGroupDescription' => '

The description for the subnet group.

', 'ModifyEventSubscriptionMessage$SubscriptionName' => '

The name of the Amazon DocumentDB event notification subscription.

', 'ModifyEventSubscriptionMessage$SnsTopicArn' => '

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

', 'ModifyEventSubscriptionMessage$SourceType' => '

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-parameter-group, db-security-group

', 'OrderableDBInstanceOption$Engine' => '

The engine type of an instance.

', 'OrderableDBInstanceOption$EngineVersion' => '

The engine version of an instance.

', 'OrderableDBInstanceOption$DBInstanceClass' => '

The instance class for an instance.

', 'OrderableDBInstanceOption$LicenseModel' => '

The license model for an instance.

', 'OrderableDBInstanceOption$StorageType' => '

The storage type to associate with the DB cluster

', 'OrderableDBInstanceOptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'Parameter$ParameterName' => '

Specifies the name of the parameter.

', 'Parameter$ParameterValue' => '

Specifies the value of the parameter.

', 'Parameter$Description' => '

Provides a description of the parameter.

', 'Parameter$Source' => '

Indicates the source of the parameter value.

', 'Parameter$ApplyType' => '

Specifies the engine-specific parameters type.

', 'Parameter$DataType' => '

Specifies the valid data type for the parameter.

', 'Parameter$AllowedValues' => '

Specifies the valid range of values for the parameter.

', 'Parameter$MinimumEngineVersion' => '

The earliest engine version to which the parameter can apply.

', 'PendingMaintenanceAction$Action' => '

The type of pending maintenance action that is available for the resource.

', 'PendingMaintenanceAction$OptInStatus' => '

Indicates the type of opt-in request that has been received for the resource.

', 'PendingMaintenanceAction$Description' => '

A description providing more detail about the maintenance action.

', 'PendingMaintenanceActionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'PendingModifiedValues$DBInstanceClass' => '

Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

', 'PendingModifiedValues$MasterUserPassword' => '

Contains the pending or currently in-progress change of the master credentials for the instance.

', 'PendingModifiedValues$EngineVersion' => '

Indicates the database engine version.

', 'PendingModifiedValues$LicenseModel' => '

The license model for the instance.

Valid values: license-included, bring-your-own-license, general-public-license

', 'PendingModifiedValues$DBInstanceIdentifier' => '

Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

', 'PendingModifiedValues$StorageType' => '

Specifies the storage type to be associated with the instance.

', 'PendingModifiedValues$CACertificateIdentifier' => '

Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

', 'PendingModifiedValues$DBSubnetGroupName' => '

The new subnet group for the instance.

', 'ReadReplicaIdentifierList$member' => NULL, 'ReadersArnList$member' => NULL, 'RebootDBInstanceMessage$DBInstanceIdentifier' => '

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'RemoveFromGlobalClusterMessage$DbClusterIdentifier' => '

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.

', 'RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName' => '

The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.

', 'RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier' => '

The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group.

', 'RemoveTagsFromResourceMessage$ResourceName' => '

The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).

', 'ResetDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group to reset.

', 'ResourcePendingMaintenanceActions$ResourceIdentifier' => '

The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

', 'RestoreDBClusterFromSnapshotMessage$DBClusterIdentifier' => '

The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn\'t case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

', 'RestoreDBClusterFromSnapshotMessage$SnapshotIdentifier' => '

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

', 'RestoreDBClusterFromSnapshotMessage$Engine' => '

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

', 'RestoreDBClusterFromSnapshotMessage$EngineVersion' => '

The version of the database engine to use for the new cluster.

', 'RestoreDBClusterFromSnapshotMessage$DBSubnetGroupName' => '

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBClusterFromSnapshotMessage$KmsKeyId' => '

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

', 'RestoreDBClusterFromSnapshotMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to associate with this DB cluster.

Type: String.       Required: No.

If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBClusterFromSnapshotMessage$StorageType' => '

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

', 'RestoreDBClusterToPointInTimeMessage$DBClusterIdentifier' => '

The name of the new cluster to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBClusterToPointInTimeMessage$RestoreType' => '

The type of restore to be performed. You can specify one of the following values:

  • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

  • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can\'t specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don\'t specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

', 'RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier' => '

The identifier of the source cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'RestoreDBClusterToPointInTimeMessage$DBSubnetGroupName' => '

The subnet group name to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBClusterToPointInTimeMessage$KmsKeyId' => '

The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.

  • If the cluster is not encrypted, then the restored cluster is not encrypted.

If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

', 'RestoreDBClusterToPointInTimeMessage$StorageType' => '

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

', 'SourceIdsList$member' => NULL, 'StartDBClusterMessage$DBClusterIdentifier' => '

The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

', 'StopDBClusterMessage$DBClusterIdentifier' => '

The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

', 'Subnet$SubnetIdentifier' => '

Specifies the identifier of the subnet.

', 'Subnet$SubnetStatus' => '

Specifies the status of the subnet.

', 'SubnetIdentifierList$member' => NULL, 'Tag$Key' => '

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 contain only the set of Unicode letters, digits, white space, \'_\', \'.\', \'/\', \'=\', \'+\', \'-\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$").

', 'Tag$Value' => '

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 contain only the set of Unicode letters, digits, white space, \'_\', \'.\', \'/\', \'=\', \'+\', \'-\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$").

', 'UpgradeTarget$Engine' => '

The name of the upgrade target database engine.

', 'UpgradeTarget$EngineVersion' => '

The version number of the upgrade target database engine.

', 'UpgradeTarget$Description' => '

The version of the database engine that an instance can be upgraded to.

', 'VpcSecurityGroupIdList$member' => NULL, 'VpcSecurityGroupMembership$VpcSecurityGroupId' => '

The name of the VPC security group.

', 'VpcSecurityGroupMembership$Status' => '

The status of the VPC security group.

', ], ], 'Subnet' => [ 'base' => '

Detailed information about a subnet.

', 'refs' => [ 'SubnetList$member' => NULL, ], ], 'SubnetAlreadyInUse' => [ 'base' => '

The subnet is already in use in the Availability Zone.

', 'refs' => [], ], 'SubnetIdentifierList' => [ 'base' => NULL, 'refs' => [ 'CreateDBSubnetGroupMessage$SubnetIds' => '

The Amazon EC2 subnet IDs for the subnet group.

', 'ModifyDBSubnetGroupMessage$SubnetIds' => '

The Amazon EC2 subnet IDs for the subnet group.

', ], ], 'SubnetList' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroup$Subnets' => '

Detailed information about one or more subnets within a subnet group.

', ], ], 'SubscriptionAlreadyExistFault' => [ 'base' => '

The provided subscription name already exists.

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

The provided category does not exist.

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

The subscription name does not exist.

', 'refs' => [], ], 'TStamp' => [ 'base' => NULL, 'refs' => [ 'Certificate$ValidFrom' => '

The starting date-time from which the certificate is valid.

Example: 2019-07-31T17:57:09Z

', 'Certificate$ValidTill' => '

The date-time after which the certificate is no longer valid.

Example: 2024-07-31T17:57:09Z

', 'CertificateDetails$ValidTill' => '

The expiration date of the DB instance’s server certificate.

', 'DBCluster$EarliestRestorableTime' => '

The earliest time to which a database can be restored with point-in-time restore.

', 'DBCluster$LatestRestorableTime' => '

Specifies the latest time to which a database can be restored with point-in-time restore.

', 'DBCluster$ClusterCreateTime' => '

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

', 'DBClusterSnapshot$SnapshotCreateTime' => '

Provides the time when the snapshot was taken, in UTC.

', 'DBClusterSnapshot$ClusterCreateTime' => '

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

', 'DBInstance$InstanceCreateTime' => '

Provides the date and time that the instance was created.

', 'DBInstance$LatestRestorableTime' => '

Specifies the latest time to which a database can be restored with point-in-time restore.

', 'DescribeEventsMessage$StartTime' => '

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

', 'DescribeEventsMessage$EndTime' => '

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

', 'Event$Date' => '

Specifies the date and time of the event.

', 'PendingMaintenanceAction$AutoAppliedAfterDate' => '

The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

', 'PendingMaintenanceAction$ForcedApplyDate' => '

The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

', 'PendingMaintenanceAction$CurrentApplyDate' => '

The effective date when the pending maintenance action is applied to the resource.

', 'RestoreDBClusterToPointInTimeMessage$RestoreToTime' => '

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

  • Must be before the latest restorable time for the instance.

  • Must be specified if the UseLatestRestorableTime parameter is not provided.

  • Cannot be specified if the UseLatestRestorableTime parameter is true.

  • Cannot be specified if the RestoreType parameter is copy-on-write.

Example: 2015-03-07T23:45:00Z

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

Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

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

The tags to be assigned to the Amazon DocumentDB resource.

', 'CopyDBClusterParameterGroupMessage$Tags' => '

The tags that are to be assigned to the parameter group.

', 'CopyDBClusterSnapshotMessage$Tags' => '

The tags to be assigned to the cluster snapshot.

', 'CreateDBClusterMessage$Tags' => '

The tags to be assigned to the cluster.

', 'CreateDBClusterParameterGroupMessage$Tags' => '

The tags to be assigned to the cluster parameter group.

', 'CreateDBClusterSnapshotMessage$Tags' => '

The tags to be assigned to the cluster snapshot.

', 'CreateDBInstanceMessage$Tags' => '

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

', 'CreateDBSubnetGroupMessage$Tags' => '

The tags to be assigned to the subnet group.

', 'CreateEventSubscriptionMessage$Tags' => '

The tags to be assigned to the event subscription.

', 'RestoreDBClusterFromSnapshotMessage$Tags' => '

The tags to be assigned to the restored cluster.

', 'RestoreDBClusterToPointInTimeMessage$Tags' => '

The tags to be assigned to the restored cluster.

', 'TagListMessage$TagList' => '

A list of one or more tags.

', ], ], 'TagListMessage' => [ 'base' => '

Represents the output of ListTagsForResource.

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

The version of the database engine that an instance can be upgraded to.

', 'refs' => [ 'ValidUpgradeTargetList$member' => NULL, ], ], 'ValidUpgradeTargetList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$ValidUpgradeTarget' => '

A list of engine versions that this database engine version can be upgraded to.

', ], ], 'VpcSecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with this cluster.

', 'ModifyDBClusterMessage$VpcSecurityGroupIds' => '

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

', 'RestoreDBClusterFromSnapshotMessage$VpcSecurityGroupIds' => '

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

', 'RestoreDBClusterToPointInTimeMessage$VpcSecurityGroupIds' => '

A list of VPC security groups that the new cluster belongs to.

', ], ], 'VpcSecurityGroupMembership' => [ 'base' => '

Used as a response element for queries on virtual private cloud (VPC) security group membership.

', 'refs' => [ 'VpcSecurityGroupMembershipList$member' => NULL, ], ], 'VpcSecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$VpcSecurityGroups' => '

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

', 'DBInstance$VpcSecurityGroups' => '

Provides a list of VPC security group elements that the instance belongs to.

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

Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.

', 'operations' => [ 'AddSourceIdentifierToSubscription' => '

Adds a source identifier to an existing event notification subscription.

', 'AddTagsToResource' => '

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.

', 'ApplyPendingMaintenanceAction' => '

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

', 'CopyDBClusterParameterGroup' => '

Copies the specified cluster parameter group.

', 'CopyDBClusterSnapshot' => '

Copies a snapshot of a cluster.

To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web Services Region.

To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.

', 'CreateDBCluster' => '

Creates a new Amazon DocumentDB cluster.

', 'CreateDBClusterParameterGroup' => '

Creates a new cluster parameter group.

Parameters in a cluster parameter group apply to all of the instances in a cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.

', 'CreateDBClusterSnapshot' => '

Creates a snapshot of a cluster.

', 'CreateDBInstance' => '

Creates a new instance.

', 'CreateDBSubnetGroup' => '

Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

', 'CreateEventSubscription' => '

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

', 'CreateGlobalCluster' => '

Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.

You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.

This action only applies to Amazon DocumentDB clusters.

', 'DeleteDBCluster' => '

Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can\'t be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.

', 'DeleteDBClusterParameterGroup' => '

Deletes a specified cluster parameter group. The cluster parameter group to be deleted can\'t be associated with any clusters.

', 'DeleteDBClusterSnapshot' => '

Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The cluster snapshot must be in the available state to be deleted.

', 'DeleteDBInstance' => '

Deletes a previously provisioned instance.

', 'DeleteDBSubnetGroup' => '

Deletes a subnet group.

The specified database subnet group must not be associated with any DB instances.

', 'DeleteEventSubscription' => '

Deletes an Amazon DocumentDB event notification subscription.

', 'DeleteGlobalCluster' => '

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.

This action only applies to Amazon DocumentDB clusters.

', 'DescribeCertificates' => '

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.

', 'DescribeDBClusterParameterGroups' => '

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

', 'DescribeDBClusterParameters' => '

Returns the detailed parameter list for a particular cluster parameter group.

', 'DescribeDBClusterSnapshotAttributes' => '

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

', 'DescribeDBClusterSnapshots' => '

Returns information about cluster snapshots. This API operation supports pagination.

', 'DescribeDBClusters' => '

Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.

', 'DescribeDBEngineVersions' => '

Returns a list of the available engines.

', 'DescribeDBInstances' => '

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

', 'DescribeDBSubnetGroups' => '

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

', 'DescribeEngineDefaultClusterParameters' => '

Returns the default engine and system parameter information for the cluster database engine.

', 'DescribeEventCategories' => '

Displays a list of categories for all event source types, or, if specified, for a specified source type.

', 'DescribeEventSubscriptions' => '

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

', 'DescribeEvents' => '

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

', 'DescribeGlobalClusters' => '

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

This action only applies to Amazon DocumentDB clusters.

', 'DescribeOrderableDBInstanceOptions' => '

Returns a list of orderable instance options for the specified engine.

', 'DescribePendingMaintenanceActions' => '

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

', 'FailoverDBCluster' => '

Forces a failover for a cluster.

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

', 'ListTagsForResource' => '

Lists all tags on an Amazon DocumentDB resource.

', 'ModifyDBCluster' => '

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

', 'ModifyDBClusterParameterGroup' => '

Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

', 'ModifyDBClusterSnapshotAttribute' => '

Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.

To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don\'t want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can\'t use all as a value for that parameter in this case.

', 'ModifyDBInstance' => '

Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

', 'ModifyDBSubnetGroup' => '

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

', 'ModifyEventSubscription' => '

Modifies an existing Amazon DocumentDB event notification subscription.

', 'ModifyGlobalCluster' => '

Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.

This action only applies to Amazon DocumentDB clusters.

', 'RebootDBInstance' => '

You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.

Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.

', 'RemoveFromGlobalCluster' => '

Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.

This action only applies to Amazon DocumentDB clusters.

', 'RemoveSourceIdentifierFromSubscription' => '

Removes a source identifier from an existing Amazon DocumentDB event notification subscription.

', 'RemoveTagsFromResource' => '

Removes metadata tags from an Amazon DocumentDB resource.

', 'ResetDBClusterParameterGroup' => '

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

', 'RestoreDBClusterFromSnapshot' => '

Creates a new cluster from a snapshot or cluster snapshot.

If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.

If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

', 'RestoreDBClusterToPointInTime' => '

Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.

', 'StartDBCluster' => '

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

', 'StopDBCluster' => '

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

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

Represents the input to AddSourceIdentifierToSubscription.

', 'refs' => [], ], 'AddSourceIdentifierToSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsToResourceMessage' => [ 'base' => '

Represents the input to AddTagsToResource.

', 'refs' => [], ], 'ApplyMethod' => [ 'base' => NULL, 'refs' => [ 'Parameter$ApplyMethod' => '

Indicates when to apply parameter updates.

', ], ], 'ApplyPendingMaintenanceActionMessage' => [ 'base' => '

Represents the input to ApplyPendingMaintenanceAction.

', 'refs' => [], ], 'ApplyPendingMaintenanceActionResult' => [ 'base' => NULL, 'refs' => [], ], 'AttributeValueList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttribute$AttributeValues' => '

The values for the manual cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

', 'ModifyDBClusterSnapshotAttributeMessage$ValuesToAdd' => '

A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don\'t want to be available to all Amazon Web Services accounts.

', 'ModifyDBClusterSnapshotAttributeMessage$ValuesToRemove' => '

A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

', ], ], 'AuthorizationNotFoundFault' => [ 'base' => '

The specified CIDR IP or Amazon EC2 security group isn\'t authorized for the specified security group.

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

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

Information about an Availability Zone.

', 'refs' => [ 'AvailabilityZoneList$member' => NULL, 'Subnet$SubnetAvailabilityZone' => '

Specifies the Availability Zone for the subnet.

', ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOption$AvailabilityZones' => '

A list of Availability Zones for an instance.

', ], ], 'AvailabilityZones' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$AvailabilityZones' => '

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

', 'DBCluster$AvailabilityZones' => '

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

', 'DBClusterSnapshot$AvailabilityZones' => '

Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

', 'RestoreDBClusterFromSnapshotMessage$AvailabilityZones' => '

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'DBCluster$MultiAZ' => '

Specifies whether the cluster has instances in multiple Availability Zones.

', 'DBCluster$StorageEncrypted' => '

Specifies whether the cluster is encrypted.

', 'DBCluster$DeletionProtection' => '

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

', 'DBClusterMember$IsClusterWriter' => '

A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

', 'DBClusterSnapshot$StorageEncrypted' => '

Specifies whether the cluster snapshot is encrypted.

', 'DBEngineVersion$SupportsLogExportsToCloudwatchLogs' => '

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

', 'DBInstance$AutoMinorVersionUpgrade' => '

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

', 'DBInstance$PubliclyAccessible' => '

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

', 'DBInstance$StorageEncrypted' => '

Specifies whether or not the instance is encrypted.

', 'DBInstanceStatusInfo$Normal' => '

A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

', 'DeleteDBClusterMessage$SkipFinalSnapshot' => '

Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

', 'DescribeDBClusterSnapshotsMessage$IncludeShared' => '

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

', 'DescribeDBClusterSnapshotsMessage$IncludePublic' => '

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

', 'DescribeDBEngineVersionsMessage$DefaultOnly' => '

Indicates that only the default version of the specified engine or engine and major version combination is returned.

', 'EventSubscription$Enabled' => '

A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

', 'GlobalClusterMember$IsWriter' => '

Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

', 'ModifyDBClusterMessage$ApplyImmediately' => '

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

', 'ModifyDBClusterMessage$AllowMajorVersionUpgrade' => '

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster\'s current version.

', 'ModifyDBInstanceMessage$ApplyImmediately' => '

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

', 'OrderableDBInstanceOption$Vpc' => '

Indicates whether an instance is in a virtual private cloud (VPC).

', 'Parameter$IsModifiable' => '

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

', 'ResetDBClusterParameterGroupMessage$ResetAllParameters' => '

A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can\'t use this parameter if there is a list of parameter names specified for the Parameters parameter.

', 'RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime' => '

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

', 'UpgradeTarget$AutoUpgrade' => '

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

', 'UpgradeTarget$IsMajorVersionUpgrade' => '

A value that indicates whether a database engine is upgraded to a major version.

', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'CopyDBClusterSnapshotMessage$CopyTags' => '

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

', 'CreateDBClusterMessage$StorageEncrypted' => '

Specifies whether the cluster is encrypted.

', 'CreateDBClusterMessage$DeletionProtection' => '

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

', 'CreateDBInstanceMessage$AutoMinorVersionUpgrade' => '

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

', 'CreateDBInstanceMessage$CopyTagsToSnapshot' => '

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

', 'CreateDBInstanceMessage$EnablePerformanceInsights' => '

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

', 'CreateEventSubscriptionMessage$Enabled' => '

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

', 'CreateGlobalClusterMessage$DeletionProtection' => '

The deletion protection setting for the new global cluster. The global cluster can\'t be deleted when deletion protection is enabled.

', 'CreateGlobalClusterMessage$StorageEncrypted' => '

The storage encryption setting for the new global cluster.

', 'DBEngineVersion$SupportsCertificateRotationWithoutRestart' => '

Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

', 'DBInstance$CopyTagsToSnapshot' => '

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

', 'DBInstance$PerformanceInsightsEnabled' => '

Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

', 'DescribeDBEngineVersionsMessage$ListSupportedCharacterSets' => '

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

', 'DescribeDBEngineVersionsMessage$ListSupportedTimezones' => '

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

', 'DescribeOrderableDBInstanceOptionsMessage$Vpc' => '

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

', 'GlobalCluster$StorageEncrypted' => '

The storage encryption setting for the global cluster.

', 'GlobalCluster$DeletionProtection' => '

The deletion protection setting for the new global cluster.

', 'ModifyDBClusterMessage$DeletionProtection' => '

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

', 'ModifyDBInstanceMessage$AutoMinorVersionUpgrade' => '

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

', 'ModifyDBInstanceMessage$CopyTagsToSnapshot' => '

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

', 'ModifyDBInstanceMessage$EnablePerformanceInsights' => '

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

', 'ModifyDBInstanceMessage$CertificateRotationRestart' => '

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

', 'ModifyEventSubscriptionMessage$Enabled' => '

A Boolean value; set to true to activate the subscription.

', 'ModifyGlobalClusterMessage$DeletionProtection' => '

Indicates if the global cluster has deletion protection enabled. The global cluster can\'t be deleted when deletion protection is enabled.

', 'PendingModifiedValues$MultiAZ' => '

Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

', 'RebootDBInstanceMessage$ForceFailover' => '

When true, the reboot is conducted through a Multi-AZ failover.

Constraint: You can\'t specify true if the instance is not configured for Multi-AZ.

', 'RestoreDBClusterFromSnapshotMessage$DeletionProtection' => '

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

', 'RestoreDBClusterToPointInTimeMessage$DeletionProtection' => '

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

', ], ], 'CACertificateIdentifiersList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$SupportedCACertificateIdentifiers' => '

A list of the supported CA certificate identifiers.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

', ], ], 'Certificate' => [ 'base' => '

A certificate authority (CA) certificate for an Amazon Web Services account.

', 'refs' => [ 'CertificateList$member' => NULL, ], ], 'CertificateDetails' => [ 'base' => '

Returns the details of the DB instance’s server certificate.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

', 'refs' => [ 'DBInstance$CertificateDetails' => '

The details of the DB instance\'s server certificate.

', ], ], 'CertificateList' => [ 'base' => NULL, 'refs' => [ 'CertificateMessage$Certificates' => '

A list of certificates for this Amazon Web Services account.

', ], ], 'CertificateMessage' => [ 'base' => NULL, 'refs' => [], ], 'CertificateNotFoundFault' => [ 'base' => '

CertificateIdentifier doesn\'t refer to an existing certificate.

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

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.

', 'refs' => [ 'ModifyDBClusterMessage$CloudwatchLogsExportConfiguration' => '

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

', ], ], 'CopyDBClusterParameterGroupMessage' => [ 'base' => '

Represents the input to CopyDBClusterParameterGroup.

', 'refs' => [], ], 'CopyDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CopyDBClusterSnapshotMessage' => [ 'base' => '

Represents the input to CopyDBClusterSnapshot.

', 'refs' => [], ], 'CopyDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterMessage' => [ 'base' => '

Represents the input to CreateDBCluster.

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

Represents the input of CreateDBClusterParameterGroup.

', 'refs' => [], ], 'CreateDBClusterParameterGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBClusterSnapshotMessage' => [ 'base' => '

Represents the input of CreateDBClusterSnapshot.

', 'refs' => [], ], 'CreateDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBInstanceMessage' => [ 'base' => '

Represents the input to CreateDBInstance.

', 'refs' => [], ], 'CreateDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDBSubnetGroupMessage' => [ 'base' => '

Represents the input to CreateDBSubnetGroup.

', 'refs' => [], ], 'CreateDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateEventSubscriptionMessage' => [ 'base' => '

Represents the input to CreateEventSubscription.

', 'refs' => [], ], 'CreateEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalClusterMessage' => [ 'base' => '

Represents the input to CreateGlobalCluster.

', 'refs' => [], ], 'CreateGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DBCluster' => [ 'base' => '

Detailed information about a cluster.

', 'refs' => [ 'CreateDBClusterResult$DBCluster' => NULL, 'DBClusterList$member' => NULL, 'DeleteDBClusterResult$DBCluster' => NULL, 'FailoverDBClusterResult$DBCluster' => NULL, 'ModifyDBClusterResult$DBCluster' => NULL, 'RestoreDBClusterFromSnapshotResult$DBCluster' => NULL, 'RestoreDBClusterToPointInTimeResult$DBCluster' => NULL, 'StartDBClusterResult$DBCluster' => NULL, 'StopDBClusterResult$DBCluster' => NULL, ], ], 'DBClusterAlreadyExistsFault' => [ 'base' => '

You already have a cluster with the given identifier.

', 'refs' => [], ], 'DBClusterList' => [ 'base' => NULL, 'refs' => [ 'DBClusterMessage$DBClusters' => '

A list of clusters.

', ], ], 'DBClusterMember' => [ 'base' => '

Contains information about an instance that is part of a cluster.

', 'refs' => [ 'DBClusterMemberList$member' => NULL, ], ], 'DBClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$DBClusterMembers' => '

Provides the list of instances that make up the cluster.

', ], ], 'DBClusterMessage' => [ 'base' => '

Represents the output of DescribeDBClusters.

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

DBClusterIdentifier doesn\'t refer to an existing cluster.

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

Detailed information about a cluster parameter group.

', 'refs' => [ 'CopyDBClusterParameterGroupResult$DBClusterParameterGroup' => NULL, 'CreateDBClusterParameterGroupResult$DBClusterParameterGroup' => NULL, 'DBClusterParameterGroupList$member' => NULL, ], ], 'DBClusterParameterGroupDetails' => [ 'base' => '

Represents the output of DBClusterParameterGroup.

', 'refs' => [], ], 'DBClusterParameterGroupList' => [ 'base' => NULL, 'refs' => [ 'DBClusterParameterGroupsMessage$DBClusterParameterGroups' => '

A list of cluster parameter groups.

', ], ], 'DBClusterParameterGroupNameMessage' => [ 'base' => '

Contains the name of a cluster parameter group.

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

DBClusterParameterGroupName doesn\'t refer to an existing cluster parameter group.

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

Represents the output of DBClusterParameterGroups.

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

The cluster can\'t be created because you have reached the maximum allowed quota of clusters.

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

Describes an Identity and Access Management (IAM) role that is associated with a cluster.

', 'refs' => [ 'DBClusterRoles$member' => NULL, ], ], 'DBClusterRoles' => [ 'base' => NULL, 'refs' => [ 'DBCluster$AssociatedRoles' => '

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

', ], ], 'DBClusterSnapshot' => [ 'base' => '

Detailed information about a cluster snapshot.

', 'refs' => [ 'CopyDBClusterSnapshotResult$DBClusterSnapshot' => NULL, 'CreateDBClusterSnapshotResult$DBClusterSnapshot' => NULL, 'DBClusterSnapshotList$member' => NULL, 'DeleteDBClusterSnapshotResult$DBClusterSnapshot' => NULL, ], ], 'DBClusterSnapshotAlreadyExistsFault' => [ 'base' => '

You already have a cluster snapshot with the given identifier.

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

Contains the name and values of a manual cluster snapshot attribute.

Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.

', 'refs' => [ 'DBClusterSnapshotAttributeList$member' => NULL, ], ], 'DBClusterSnapshotAttributeList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotAttributesResult$DBClusterSnapshotAttributes' => '

The list of attributes and values for the cluster snapshot.

', ], ], 'DBClusterSnapshotAttributesResult' => [ 'base' => '

Detailed information about the attributes that are associated with a cluster snapshot.

', 'refs' => [ 'DescribeDBClusterSnapshotAttributesResult$DBClusterSnapshotAttributesResult' => NULL, 'ModifyDBClusterSnapshotAttributeResult$DBClusterSnapshotAttributesResult' => NULL, ], ], 'DBClusterSnapshotList' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshotMessage$DBClusterSnapshots' => '

Provides a list of cluster snapshots.

', ], ], 'DBClusterSnapshotMessage' => [ 'base' => '

Represents the output of DescribeDBClusterSnapshots.

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

DBClusterSnapshotIdentifier doesn\'t refer to an existing cluster snapshot.

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

Detailed information about an engine version.

', 'refs' => [ 'DBEngineVersionList$member' => NULL, ], ], 'DBEngineVersionList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersionMessage$DBEngineVersions' => '

Detailed information about one or more engine versions.

', ], ], 'DBEngineVersionMessage' => [ 'base' => '

Represents the output of DescribeDBEngineVersions.

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

Detailed information about an instance.

', 'refs' => [ 'CreateDBInstanceResult$DBInstance' => NULL, 'DBInstanceList$member' => NULL, 'DeleteDBInstanceResult$DBInstance' => NULL, 'ModifyDBInstanceResult$DBInstance' => NULL, 'RebootDBInstanceResult$DBInstance' => NULL, ], ], 'DBInstanceAlreadyExistsFault' => [ 'base' => '

You already have a instance with the given identifier.

', 'refs' => [], ], 'DBInstanceList' => [ 'base' => NULL, 'refs' => [ 'DBInstanceMessage$DBInstances' => '

Detailed information about one or more instances.

', ], ], 'DBInstanceMessage' => [ 'base' => '

Represents the output of DescribeDBInstances.

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

DBInstanceIdentifier doesn\'t refer to an existing instance.

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

Provides a list of status information for an instance.

', 'refs' => [ 'DBInstanceStatusInfoList$member' => NULL, ], ], 'DBInstanceStatusInfoList' => [ 'base' => NULL, 'refs' => [ 'DBInstance$StatusInfos' => '

The status of a read replica. If the instance is not a read replica, this is blank.

', ], ], 'DBParameterGroupAlreadyExistsFault' => [ 'base' => '

A parameter group with the same name already exists.

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

DBParameterGroupName doesn\'t refer to an existing parameter group.

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

This request would cause you to exceed the allowed number of parameter groups.

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

DBSecurityGroupName doesn\'t refer to an existing security group.

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

DBSnapshotIdentifier is already being used by an existing snapshot.

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

DBSnapshotIdentifier doesn\'t refer to an existing snapshot.

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

Detailed information about a subnet group.

', 'refs' => [ 'CreateDBSubnetGroupResult$DBSubnetGroup' => NULL, 'DBInstance$DBSubnetGroup' => '

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

', 'DBSubnetGroups$member' => NULL, 'ModifyDBSubnetGroupResult$DBSubnetGroup' => NULL, ], ], 'DBSubnetGroupAlreadyExistsFault' => [ 'base' => '

DBSubnetGroupName is already being used by an existing subnet group.

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

Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

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

Represents the output of DescribeDBSubnetGroups.

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

DBSubnetGroupName doesn\'t refer to an existing subnet group.

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

The request would cause you to exceed the allowed number of subnet groups.

', 'refs' => [], ], 'DBSubnetGroups' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroupMessage$DBSubnetGroups' => '

Detailed information about one or more subnet groups.

', ], ], 'DBSubnetQuotaExceededFault' => [ 'base' => '

The request would cause you to exceed the allowed number of subnets in a subnet group.

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

The upgrade failed because a resource that the depends on can\'t be modified.

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

Represents the input to DeleteDBCluster.

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

Represents the input to DeleteDBClusterParameterGroup.

', 'refs' => [], ], 'DeleteDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBClusterSnapshotMessage' => [ 'base' => '

Represents the input to DeleteDBClusterSnapshot.

', 'refs' => [], ], 'DeleteDBClusterSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBInstanceMessage' => [ 'base' => '

Represents the input to DeleteDBInstance.

', 'refs' => [], ], 'DeleteDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDBSubnetGroupMessage' => [ 'base' => '

Represents the input to DeleteDBSubnetGroup.

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

Represents the input to DeleteEventSubscription.

', 'refs' => [], ], 'DeleteEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalClusterMessage' => [ 'base' => '

Represents the input to DeleteGlobalCluster.

', 'refs' => [], ], 'DeleteGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCertificatesMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBClusterParameterGroupsMessage' => [ 'base' => '

Represents the input to DescribeDBClusterParameterGroups.

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

Represents the input to DescribeDBClusterParameters.

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

Represents the input to DescribeDBClusterSnapshotAttributes.

', 'refs' => [], ], 'DescribeDBClusterSnapshotAttributesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDBClusterSnapshotsMessage' => [ 'base' => '

Represents the input to DescribeDBClusterSnapshots.

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

Represents the input to DescribeDBClusters.

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

Represents the input to DescribeDBEngineVersions.

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

Represents the input to DescribeDBInstances.

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

Represents the input to DescribeDBSubnetGroups.

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

Represents the input to DescribeEngineDefaultClusterParameters.

', 'refs' => [], ], 'DescribeEngineDefaultClusterParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEventCategoriesMessage' => [ 'base' => '

Represents the input to DescribeEventCategories.

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

Represents the input to DescribeEventSubscriptions.

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

Represents the input to DescribeEvents.

', 'refs' => [], ], 'DescribeGlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrderableDBInstanceOptionsMessage' => [ 'base' => '

Represents the input to DescribeOrderableDBInstanceOptions.

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

Represents the input to DescribePendingMaintenanceActions.

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

Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

', 'refs' => [ 'DBInstance$Endpoint' => '

Specifies the connection endpoint.

', ], ], 'EngineDefaults' => [ 'base' => '

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

', 'refs' => [ 'DescribeEngineDefaultClusterParametersResult$EngineDefaults' => NULL, ], ], 'Event' => [ 'base' => '

Detailed information about an event.

', 'refs' => [ 'EventList$member' => NULL, ], ], 'EventCategoriesList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$EventCategories' => '

A list of event categories for a SourceType that you want to subscribe to.

', 'DescribeEventsMessage$EventCategories' => '

A list of event categories that trigger notifications for an event notification subscription.

', 'Event$EventCategories' => '

Specifies the category for the event.

', 'EventCategoriesMap$EventCategories' => '

The event categories for the specified source type.

', 'EventSubscription$EventCategoriesList' => '

A list of event categories for the Amazon DocumentDB event notification subscription.

', 'ModifyEventSubscriptionMessage$EventCategories' => '

A list of event categories for a SourceType that you want to subscribe to.

', ], ], 'EventCategoriesMap' => [ 'base' => '

An event source type, accompanied by one or more event category names.

', 'refs' => [ 'EventCategoriesMapList$member' => NULL, ], ], 'EventCategoriesMapList' => [ 'base' => NULL, 'refs' => [ 'EventCategoriesMessage$EventCategoriesMapList' => '

A list of event category maps.

', ], ], 'EventCategoriesMessage' => [ 'base' => '

Represents the output of DescribeEventCategories.

', 'refs' => [], ], 'EventList' => [ 'base' => NULL, 'refs' => [ 'EventsMessage$Events' => '

Detailed information about one or more events.

', ], ], 'EventSubscription' => [ 'base' => '

Detailed information about an event to which you have subscribed.

', 'refs' => [ 'AddSourceIdentifierToSubscriptionResult$EventSubscription' => NULL, 'CreateEventSubscriptionResult$EventSubscription' => NULL, 'DeleteEventSubscriptionResult$EventSubscription' => NULL, 'EventSubscriptionsList$member' => NULL, 'ModifyEventSubscriptionResult$EventSubscription' => NULL, 'RemoveSourceIdentifierFromSubscriptionResult$EventSubscription' => NULL, ], ], 'EventSubscriptionQuotaExceededFault' => [ 'base' => '

You have reached the maximum number of event subscriptions.

', 'refs' => [], ], 'EventSubscriptionsList' => [ 'base' => NULL, 'refs' => [ 'EventSubscriptionsMessage$EventSubscriptionsList' => '

A list of event subscriptions.

', ], ], 'EventSubscriptionsMessage' => [ 'base' => '

Represents the output of DescribeEventSubscriptions.

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

Represents the output of DescribeEvents.

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

Represents the input to FailoverDBCluster.

', 'refs' => [], ], 'FailoverDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'Filter' => [ 'base' => '

A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Wildcards are not supported in filters.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeCertificatesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterParameterGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClusterSnapshotsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBClustersMessage$Filters' => '

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

', 'DescribeDBEngineVersionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeDBInstancesMessage$Filters' => '

A filter that specifies one or more instances to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

', 'DescribeDBSubnetGroupsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEngineDefaultClusterParametersMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventCategoriesMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventSubscriptionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeEventsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribeGlobalClustersMessage$Filters' => '

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

', 'DescribeOrderableDBInstanceOptionsMessage$Filters' => '

This parameter is not currently supported.

', 'DescribePendingMaintenanceActionsMessage$Filters' => '

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

', 'ListTagsForResourceMessage$Filters' => '

This parameter is not currently supported.

', ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

One or more filter values. Filter values are case sensitive.

', ], ], 'GlobalCluster' => [ 'base' => '

A data type representing an Amazon DocumentDB global cluster.

', 'refs' => [ 'CreateGlobalClusterResult$GlobalCluster' => NULL, 'DeleteGlobalClusterResult$GlobalCluster' => NULL, 'GlobalClusterList$member' => NULL, 'ModifyGlobalClusterResult$GlobalCluster' => NULL, 'RemoveFromGlobalClusterResult$GlobalCluster' => NULL, ], ], 'GlobalClusterAlreadyExistsFault' => [ 'base' => '

The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique name) to create a new global cluster.

', 'refs' => [], ], 'GlobalClusterIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier of the new global cluster.

', 'CreateGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier of the new global cluster.

', 'DeleteGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier of the global cluster being deleted.

', 'DescribeGlobalClustersMessage$GlobalClusterIdentifier' => '

The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn\'t case-sensitive.

', 'GlobalCluster$GlobalClusterIdentifier' => '

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

', 'ModifyGlobalClusterMessage$GlobalClusterIdentifier' => '

The identifier for the global cluster being modified. This parameter isn\'t case-sensitive.

Constraints:

  • Must match the identifier of an existing global cluster.

', 'ModifyGlobalClusterMessage$NewGlobalClusterIdentifier' => '

The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

  • Must contain from 1 to 63 letters, numbers, or hyphens

    The first character must be a letter

    Can\'t end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

', 'RemoveFromGlobalClusterMessage$GlobalClusterIdentifier' => '

The cluster identifier to detach from the Amazon DocumentDB global cluster.

', ], ], 'GlobalClusterList' => [ 'base' => NULL, 'refs' => [ 'GlobalClustersMessage$GlobalClusters' => '

', ], ], 'GlobalClusterMember' => [ 'base' => '

A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

', 'refs' => [ 'GlobalClusterMemberList$member' => NULL, ], ], 'GlobalClusterMemberList' => [ 'base' => NULL, 'refs' => [ 'GlobalCluster$GlobalClusterMembers' => '

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

', ], ], 'GlobalClusterNotFoundFault' => [ 'base' => '

The GlobalClusterIdentifier doesn\'t refer to an existing global cluster.

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

The number of global clusters for this account is already at the maximum allowed.

', 'refs' => [], ], 'GlobalClustersMessage' => [ 'base' => NULL, 'refs' => [], ], 'InstanceQuotaExceededFault' => [ 'base' => '

The request would cause you to exceed the allowed number of instances.

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

The cluster doesn\'t have enough capacity for the current operation.

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

The specified instance class isn\'t available in the specified Availability Zone.

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

There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DBClusterSnapshot$Port' => '

Specifies the port that the cluster was listening on at the time of the snapshot.

', 'DBClusterSnapshot$PercentProgress' => '

Specifies the percentage of the estimated data that has been transferred.

', 'DBInstance$BackupRetentionPeriod' => '

Specifies the number of days for which automatic snapshots are retained.

', 'Endpoint$Port' => '

Specifies the port that the database engine is listening on.

', ], ], 'IntegerOptional' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35.

', 'CreateDBClusterMessage$Port' => '

The port number on which the instances in the cluster accept connections.

', 'CreateDBInstanceMessage$PromotionTier' => '

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

', 'DBCluster$BackupRetentionPeriod' => '

Specifies the number of days for which automatic snapshots are retained.

', 'DBCluster$Port' => '

Specifies the port that the database engine is listening on.

', 'DBClusterMember$PromotionTier' => '

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

', 'DBInstance$PromotionTier' => '

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

', 'DescribeCertificatesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints:

  • Minimum: 20

  • Maximum: 100

', 'DescribeDBClusterParameterGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClusterSnapshotsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBClustersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBEngineVersionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBInstancesMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeDBSubnetGroupsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEngineDefaultClusterParametersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEventSubscriptionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeEventsMessage$Duration' => '

The number of minutes to retrieve events for.

Default: 60

', 'DescribeEventsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribeGlobalClustersMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

', 'DescribeOrderableDBInstanceOptionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'DescribePendingMaintenanceActionsMessage$MaxRecords' => '

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

', 'ModifyDBClusterMessage$BackupRetentionPeriod' => '

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35.

', 'ModifyDBClusterMessage$Port' => '

The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

', 'ModifyDBInstanceMessage$PromotionTier' => '

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

', 'PendingModifiedValues$AllocatedStorage' => '

Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

', 'PendingModifiedValues$Port' => '

Specifies the pending port for the instance.

', 'PendingModifiedValues$BackupRetentionPeriod' => '

Specifies the pending number of days for which automated backups are retained.

', 'PendingModifiedValues$Iops' => '

Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

', 'RestoreDBClusterFromSnapshotMessage$Port' => '

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

', 'RestoreDBClusterToPointInTimeMessage$Port' => '

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

', ], ], 'InvalidDBClusterSnapshotStateFault' => [ 'base' => '

The provided value isn\'t a valid cluster snapshot state.

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

The cluster isn\'t in a valid state.

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

The specified instance isn\'t in the available state.

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

The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can\'t delete it when the parameter group is in this state.

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

The state of the security group doesn\'t allow deletion.

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

The state of the snapshot doesn\'t allow deletion.

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

The subnet group can\'t be deleted because it\'s in use.

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

The subnet isn\'t in the available state.

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

Someone else might be modifying a subscription. Wait a few seconds, and try again.

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

The requested operation can\'t be performed while the cluster is in this state.

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

You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

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

The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

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

The subnet group doesn\'t cover all Availability Zones after it is created because of changes that were made.

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

An error occurred when accessing an KMS key.

', 'refs' => [], ], 'KeyList' => [ 'base' => NULL, 'refs' => [ 'RemoveTagsFromResourceMessage$TagKeys' => '

The tag key (name) of the tag to be removed.

', ], ], 'ListTagsForResourceMessage' => [ 'base' => '

Represents the input to ListTagsForResource.

', 'refs' => [], ], 'LogTypeList' => [ 'base' => NULL, 'refs' => [ 'CloudwatchLogsExportConfiguration$EnableLogTypes' => '

The list of log types to enable.

', 'CloudwatchLogsExportConfiguration$DisableLogTypes' => '

The list of log types to disable.

', 'CreateDBClusterMessage$EnableCloudwatchLogsExports' => '

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

', 'DBCluster$EnabledCloudwatchLogsExports' => '

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

', 'DBEngineVersion$ExportableLogTypes' => '

The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

', 'DBInstance$EnabledCloudwatchLogsExports' => '

A list of log types that this instance is configured to export to CloudWatch Logs.

', 'PendingCloudwatchLogsExports$LogTypesToEnable' => '

Log types that are in the process of being deactivated. After they are deactivated, these log types aren\'t exported to CloudWatch Logs.

', 'PendingCloudwatchLogsExports$LogTypesToDisable' => '

Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

', 'RestoreDBClusterFromSnapshotMessage$EnableCloudwatchLogsExports' => '

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

', 'RestoreDBClusterToPointInTimeMessage$EnableCloudwatchLogsExports' => '

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

', ], ], 'ModifyDBClusterMessage' => [ 'base' => '

Represents the input to ModifyDBCluster.

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

Represents the input to ModifyDBClusterParameterGroup.

', 'refs' => [], ], 'ModifyDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeMessage' => [ 'base' => '

Represents the input to ModifyDBClusterSnapshotAttribute.

', 'refs' => [], ], 'ModifyDBClusterSnapshotAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBInstanceMessage' => [ 'base' => '

Represents the input to ModifyDBInstance.

', 'refs' => [], ], 'ModifyDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyDBSubnetGroupMessage' => [ 'base' => '

Represents the input to ModifyDBSubnetGroup.

', 'refs' => [], ], 'ModifyDBSubnetGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyEventSubscriptionMessage' => [ 'base' => '

Represents the input to ModifyEventSubscription.

', 'refs' => [], ], 'ModifyEventSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyGlobalClusterMessage' => [ 'base' => '

Represents the input to ModifyGlobalCluster.

', 'refs' => [], ], 'ModifyGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'OrderableDBInstanceOption' => [ 'base' => '

The options that are available for an instance.

', 'refs' => [ 'OrderableDBInstanceOptionsList$member' => NULL, ], ], 'OrderableDBInstanceOptionsList' => [ 'base' => NULL, 'refs' => [ 'OrderableDBInstanceOptionsMessage$OrderableDBInstanceOptions' => '

The options that are available for a particular orderable instance.

', ], ], 'OrderableDBInstanceOptionsMessage' => [ 'base' => '

Represents the output of DescribeOrderableDBInstanceOptions.

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

Detailed information about an individual parameter.

', 'refs' => [ 'ParametersList$member' => NULL, ], ], 'ParametersList' => [ 'base' => NULL, 'refs' => [ 'DBClusterParameterGroupDetails$Parameters' => '

Provides a list of parameters for the cluster parameter group.

', 'EngineDefaults$Parameters' => '

The parameters of a particular cluster parameter group family.

', 'ModifyDBClusterParameterGroupMessage$Parameters' => '

A list of parameters in the cluster parameter group to modify.

', 'ResetDBClusterParameterGroupMessage$Parameters' => '

A list of parameter names in the cluster parameter group to reset to the default values. You can\'t use this parameter if the ResetAllParameters parameter is set to true.

', ], ], 'PendingCloudwatchLogsExports' => [ 'base' => '

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

', 'refs' => [ 'PendingModifiedValues$PendingCloudwatchLogsExports' => '

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

', ], ], 'PendingMaintenanceAction' => [ 'base' => '

Provides information about a pending maintenance action for a resource.

', 'refs' => [ 'PendingMaintenanceActionDetails$member' => NULL, ], ], 'PendingMaintenanceActionDetails' => [ 'base' => NULL, 'refs' => [ 'ResourcePendingMaintenanceActions$PendingMaintenanceActionDetails' => '

A list that provides details about the pending maintenance actions for the resource.

', ], ], 'PendingMaintenanceActions' => [ 'base' => NULL, 'refs' => [ 'PendingMaintenanceActionsMessage$PendingMaintenanceActions' => '

The maintenance actions to be applied.

', ], ], 'PendingMaintenanceActionsMessage' => [ 'base' => '

Represents the output of DescribePendingMaintenanceActions.

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

One or more modified settings for an instance. These modified settings have been requested, but haven\'t been applied yet.

', 'refs' => [ 'DBInstance$PendingModifiedValues' => '

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

', ], ], 'ReadReplicaIdentifierList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$ReadReplicaIdentifiers' => '

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

', ], ], 'ReadersArnList' => [ 'base' => NULL, 'refs' => [ 'GlobalClusterMember$Readers' => '

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

', ], ], 'RebootDBInstanceMessage' => [ 'base' => '

Represents the input to RebootDBInstance.

', 'refs' => [], ], 'RebootDBInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveFromGlobalClusterMessage' => [ 'base' => '

Represents the input to RemoveFromGlobalCluster.

', 'refs' => [], ], 'RemoveFromGlobalClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionMessage' => [ 'base' => '

Represents the input to RemoveSourceIdentifierFromSubscription.

', 'refs' => [], ], 'RemoveSourceIdentifierFromSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveTagsFromResourceMessage' => [ 'base' => '

Represents the input to RemoveTagsFromResource.

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

Represents the input to ResetDBClusterParameterGroup.

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

The specified resource ID was not found.

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

Represents the output of ApplyPendingMaintenanceAction.

', 'refs' => [ 'ApplyPendingMaintenanceActionResult$ResourcePendingMaintenanceActions' => NULL, 'PendingMaintenanceActions$member' => NULL, ], ], 'RestoreDBClusterFromSnapshotMessage' => [ 'base' => '

Represents the input to RestoreDBClusterFromSnapshot.

', 'refs' => [], ], 'RestoreDBClusterFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'RestoreDBClusterToPointInTimeMessage' => [ 'base' => '

Represents the input to RestoreDBClusterToPointInTime.

', 'refs' => [], ], 'RestoreDBClusterToPointInTimeResult' => [ 'base' => NULL, 'refs' => [], ], 'SNSInvalidTopicFault' => [ 'base' => '

Amazon SNS has responded that there is a problem with the specified topic.

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

You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).

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

The SNS topic Amazon Resource Name (ARN) does not exist.

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

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

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

The request would cause you to exceed the allowed number of snapshots.

', 'refs' => [], ], 'SourceIdsList' => [ 'base' => NULL, 'refs' => [ 'CreateEventSubscriptionMessage$SourceIds' => '

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can\'t end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are provided, SourceType must also be provided.

  • If the source type is an instance, a DBInstanceIdentifier must be provided.

  • If the source type is a security group, a DBSecurityGroupName must be provided.

  • If the source type is a parameter group, a DBParameterGroupName must be provided.

  • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

', 'EventSubscription$SourceIdsList' => '

A list of source IDs for the Amazon DocumentDB event notification subscription.

', ], ], 'SourceNotFoundFault' => [ 'base' => '

The requested source could not be found.

', 'refs' => [], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'DescribeEventsMessage$SourceType' => '

The event source to retrieve events for. If no value is specified, all events are returned.

', 'Event$SourceType' => '

Specifies the source type for this event.

', ], ], 'StartDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterMessage' => [ 'base' => NULL, 'refs' => [], ], 'StopDBClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'StorageQuotaExceededFault' => [ 'base' => '

The request would cause you to exceed the allowed amount of storage available across all instances.

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

Storage of the specified StorageType can\'t be associated with the DB instance.

', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddSourceIdentifierToSubscriptionMessage$SubscriptionName' => '

The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

', 'AddSourceIdentifierToSubscriptionMessage$SourceIdentifier' => '

The identifier of the event source to be added:

  • If the source type is an instance, a DBInstanceIdentifier must be provided.

  • If the source type is a security group, a DBSecurityGroupName must be provided.

  • If the source type is a parameter group, a DBParameterGroupName must be provided.

  • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

', 'AddTagsToResourceMessage$ResourceName' => '

The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .

', 'ApplyPendingMaintenanceActionMessage$ResourceIdentifier' => '

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

', 'ApplyPendingMaintenanceActionMessage$ApplyAction' => '

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

', 'ApplyPendingMaintenanceActionMessage$OptInType' => '

A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can\'t be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

', 'AttributeValueList$member' => NULL, 'AvailabilityZone$Name' => '

The name of the Availability Zone.

', 'AvailabilityZones$member' => NULL, 'CACertificateIdentifiersList$member' => NULL, 'Certificate$CertificateIdentifier' => '

The unique key that identifies a certificate.

Example: rds-ca-2019

', 'Certificate$CertificateType' => '

The type of the certificate.

Example: CA

', 'Certificate$Thumbprint' => '

The thumbprint of the certificate.

', 'Certificate$CertificateArn' => '

The Amazon Resource Name (ARN) for the certificate.

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

', 'CertificateDetails$CAIdentifier' => '

The CA identifier of the CA certificate used for the DB instance\'s server certificate.

', 'CertificateMessage$Marker' => '

An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

', 'CopyDBClusterParameterGroupMessage$SourceDBClusterParameterGroupIdentifier' => '

The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

Constraints:

  • Must specify a valid cluster parameter group.

  • If the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.

  • If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.

', 'CopyDBClusterParameterGroupMessage$TargetDBClusterParameterGroupIdentifier' => '

The identifier for the copied cluster parameter group.

Constraints:

  • Cannot be null, empty, or blank.

  • Must contain from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-param-group1

', 'CopyDBClusterParameterGroupMessage$TargetDBClusterParameterGroupDescription' => '

A description for the copied cluster parameter group.

', 'CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier' => '

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

', 'CopyDBClusterSnapshotMessage$TargetDBClusterSnapshotIdentifier' => '

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

', 'CopyDBClusterSnapshotMessage$KmsKeyId' => '

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don\'t specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can\'t use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

', 'CopyDBClusterSnapshotMessage$PreSignedUrl' => '

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn\'t case sensitive.

', 'CreateDBClusterMessage$DBClusterIdentifier' => '

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

', 'CreateDBClusterMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group to associate with this cluster.

', 'CreateDBClusterMessage$DBSubnetGroupName' => '

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'CreateDBClusterMessage$Engine' => '

The name of the database engine to be used for this cluster.

Valid values: docdb

', 'CreateDBClusterMessage$EngineVersion' => '

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

', 'CreateDBClusterMessage$MasterUsername' => '

The name of the master user for the cluster.

Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

', 'CreateDBClusterMessage$MasterUserPassword' => '

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

', 'CreateDBClusterMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'CreateDBClusterMessage$PreferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

', 'CreateDBClusterMessage$KmsKeyId' => '

The KMS key identifier for an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

', 'CreateDBClusterMessage$PreSignedUrl' => '

Not currently supported.

', 'CreateDBClusterMessage$StorageType' => '

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn\'t returned when you set it to standard.

', 'CreateDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group.

Constraints:

  • Must not match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

', 'CreateDBClusterParameterGroupMessage$DBParameterGroupFamily' => '

The cluster parameter group family name.

', 'CreateDBClusterParameterGroupMessage$Description' => '

The description for the cluster parameter group.

', 'CreateDBClusterSnapshotMessage$DBClusterSnapshotIdentifier' => '

The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

', 'CreateDBClusterSnapshotMessage$DBClusterIdentifier' => '

The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster

', 'CreateDBInstanceMessage$DBInstanceIdentifier' => '

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

', 'CreateDBInstanceMessage$DBInstanceClass' => '

The compute and memory capacity of the instance; for example, db.r5.large.

', 'CreateDBInstanceMessage$Engine' => '

The name of the database engine to be used for this instance.

Valid value: docdb

', 'CreateDBInstanceMessage$AvailabilityZone' => '

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint\'s Amazon Web Services Region.

Example: us-east-1d

', 'CreateDBInstanceMessage$PreferredMaintenanceWindow' => '

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

', 'CreateDBInstanceMessage$DBClusterIdentifier' => '

The identifier of the cluster that the instance will belong to.

', 'CreateDBInstanceMessage$PerformanceInsightsKMSKeyId' => '

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

', 'CreateDBInstanceMessage$CACertificateIdentifier' => '

The CA certificate identifier to use for the DB instance\'s server certificate.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

', 'CreateDBSubnetGroupMessage$DBSubnetGroupName' => '

The name for the subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

', 'CreateDBSubnetGroupMessage$DBSubnetGroupDescription' => '

The description for the subnet group.

', 'CreateEventSubscriptionMessage$SubscriptionName' => '

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

', 'CreateEventSubscriptionMessage$SnsTopicArn' => '

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

', 'CreateEventSubscriptionMessage$SourceType' => '

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

', 'CreateGlobalClusterMessage$SourceDBClusterIdentifier' => '

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

', 'CreateGlobalClusterMessage$Engine' => '

The name of the database engine to be used for this cluster.

', 'CreateGlobalClusterMessage$EngineVersion' => '

The engine version of the global cluster.

', 'CreateGlobalClusterMessage$DatabaseName' => '

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.

', 'DBCluster$DBClusterIdentifier' => '

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

', 'DBCluster$DBClusterParameterGroup' => '

Specifies the name of the cluster parameter group for the cluster.

', 'DBCluster$DBSubnetGroup' => '

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

', 'DBCluster$Status' => '

Specifies the current state of this cluster.

', 'DBCluster$PercentProgress' => '

Specifies the progress of the operation as a percentage.

', 'DBCluster$Endpoint' => '

Specifies the connection endpoint for the primary instance of the cluster.

', 'DBCluster$ReaderEndpoint' => '

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

', 'DBCluster$Engine' => '

Provides the name of the database engine to be used for this cluster.

', 'DBCluster$EngineVersion' => '

Indicates the database engine version.

', 'DBCluster$MasterUsername' => '

Contains the master user name for the cluster.

', 'DBCluster$PreferredBackupWindow' => '

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

', 'DBCluster$PreferredMaintenanceWindow' => '

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

', 'DBCluster$ReplicationSourceIdentifier' => '

Contains the identifier of the source cluster if this cluster is a secondary cluster.

', 'DBCluster$HostedZoneId' => '

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

', 'DBCluster$KmsKeyId' => '

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

', 'DBCluster$DbClusterResourceId' => '

The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

', 'DBCluster$DBClusterArn' => '

The Amazon Resource Name (ARN) for the cluster.

', 'DBCluster$CloneGroupId' => '

Identifies the clone group to which the DB cluster is associated.

', 'DBCluster$StorageType' => '

Storage type associated with your cluster

Storage type associated with your cluster

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

', 'DBClusterMember$DBInstanceIdentifier' => '

Specifies the instance identifier for this member of the cluster.

', 'DBClusterMember$DBClusterParameterGroupStatus' => '

Specifies the status of the cluster parameter group for this member of the DB cluster.

', 'DBClusterMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBClusterParameterGroup$DBClusterParameterGroupName' => '

Provides the name of the cluster parameter group.

', 'DBClusterParameterGroup$DBParameterGroupFamily' => '

Provides the name of the parameter group family that this cluster parameter group is compatible with.

', 'DBClusterParameterGroup$Description' => '

Provides the customer-specified description for this cluster parameter group.

', 'DBClusterParameterGroup$DBClusterParameterGroupArn' => '

The Amazon Resource Name (ARN) for the cluster parameter group.

', 'DBClusterParameterGroupDetails$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBClusterParameterGroupNameMessage$DBClusterParameterGroupName' => '

The name of a cluster parameter group.

Constraints:

  • Must be from 1 to 255 letters or numbers.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

', 'DBClusterParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBClusterRole$RoleArn' => '

The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

', 'DBClusterRole$Status' => '

Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

  • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

  • PENDING - The IAMrole ARN is being associated with the cluster.

  • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

', 'DBClusterSnapshot$DBClusterSnapshotIdentifier' => '

Specifies the identifier for the cluster snapshot.

', 'DBClusterSnapshot$DBClusterIdentifier' => '

Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

', 'DBClusterSnapshot$Engine' => '

Specifies the name of the database engine.

', 'DBClusterSnapshot$Status' => '

Specifies the status of this cluster snapshot.

', 'DBClusterSnapshot$VpcId' => '

Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

', 'DBClusterSnapshot$MasterUsername' => '

Provides the master user name for the cluster snapshot.

', 'DBClusterSnapshot$EngineVersion' => '

Provides the version of the database engine for this cluster snapshot.

', 'DBClusterSnapshot$SnapshotType' => '

Provides the type of the cluster snapshot.

', 'DBClusterSnapshot$KmsKeyId' => '

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

', 'DBClusterSnapshot$DBClusterSnapshotArn' => '

The Amazon Resource Name (ARN) for the cluster snapshot.

', 'DBClusterSnapshot$SourceDBClusterSnapshotArn' => '

If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

', 'DBClusterSnapshot$StorageType' => '

Storage type associated with your cluster snapshot

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

', 'DBClusterSnapshotAttribute$AttributeName' => '

The name of the manual cluster snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.

', 'DBClusterSnapshotAttributesResult$DBClusterSnapshotIdentifier' => '

The identifier of the cluster snapshot that the attributes apply to.

', 'DBClusterSnapshotMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBEngineVersion$Engine' => '

The name of the database engine.

', 'DBEngineVersion$EngineVersion' => '

The version number of the database engine.

', 'DBEngineVersion$DBParameterGroupFamily' => '

The name of the parameter group family for the database engine.

', 'DBEngineVersion$DBEngineDescription' => '

The description of the database engine.

', 'DBEngineVersion$DBEngineVersionDescription' => '

The description of the database engine version.

', 'DBEngineVersionMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBInstance$DBInstanceIdentifier' => '

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

', 'DBInstance$DBInstanceClass' => '

Contains the name of the compute and memory capacity class of the instance.

', 'DBInstance$Engine' => '

Provides the name of the database engine to be used for this instance.

', 'DBInstance$DBInstanceStatus' => '

Specifies the current state of this database.

', 'DBInstance$PreferredBackupWindow' => '

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

', 'DBInstance$AvailabilityZone' => '

Specifies the name of the Availability Zone that the instance is located in.

', 'DBInstance$PreferredMaintenanceWindow' => '

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

', 'DBInstance$EngineVersion' => '

Indicates the database engine version.

', 'DBInstance$DBClusterIdentifier' => '

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

', 'DBInstance$KmsKeyId' => '

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

', 'DBInstance$DbiResourceId' => '

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

', 'DBInstance$CACertificateIdentifier' => '

The identifier of the CA certificate for this DB instance.

', 'DBInstance$DBInstanceArn' => '

The Amazon Resource Name (ARN) for the instance.

', 'DBInstance$PerformanceInsightsKMSKeyId' => '

The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

', 'DBInstanceMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DBInstanceStatusInfo$StatusType' => '

This value is currently "read replication."

', 'DBInstanceStatusInfo$Status' => '

Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

', 'DBInstanceStatusInfo$Message' => '

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

', 'DBSubnetGroup$DBSubnetGroupName' => '

The name of the subnet group.

', 'DBSubnetGroup$DBSubnetGroupDescription' => '

Provides the description of the subnet group.

', 'DBSubnetGroup$VpcId' => '

Provides the virtual private cloud (VPC) ID of the subnet group.

', 'DBSubnetGroup$SubnetGroupStatus' => '

Provides the status of the subnet group.

', 'DBSubnetGroup$DBSubnetGroupArn' => '

The Amazon Resource Name (ARN) for the DB subnet group.

', 'DBSubnetGroupMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DeleteDBClusterMessage$DBClusterIdentifier' => '

The cluster identifier for the cluster to be deleted. This parameter isn\'t case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

', 'DeleteDBClusterMessage$FinalDBSnapshotIdentifier' => '

The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

', 'DeleteDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group.

Constraints:

  • Must be the name of an existing cluster parameter group.

  • You can\'t delete a default cluster parameter group.

  • Cannot be associated with any clusters.

', 'DeleteDBClusterSnapshotMessage$DBClusterSnapshotIdentifier' => '

The identifier of the cluster snapshot to delete.

Constraints: Must be the name of an existing cluster snapshot in the available state.

', 'DeleteDBInstanceMessage$DBInstanceIdentifier' => '

The instance identifier for the instance to be deleted. This parameter isn\'t case sensitive.

Constraints:

  • Must match the name of an existing instance.

', 'DeleteDBSubnetGroupMessage$DBSubnetGroupName' => '

The name of the database subnet group to delete.

You can\'t delete the default subnet group.

Constraints:

Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'DeleteEventSubscriptionMessage$SubscriptionName' => '

The name of the Amazon DocumentDB event notification subscription that you want to delete.

', 'DescribeCertificatesMessage$CertificateIdentifier' => '

The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

  • Must match an existing CertificateIdentifier.

', 'DescribeCertificatesMessage$Marker' => '

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterParameterGroupsMessage$DBClusterParameterGroupName' => '

The name of a specific cluster parameter group to return details for.

Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup.

', 'DescribeDBClusterParameterGroupsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterParametersMessage$DBClusterParameterGroupName' => '

The name of a specific cluster parameter group to return parameter details for.

Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup.

', 'DescribeDBClusterParametersMessage$Source' => '

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

', 'DescribeDBClusterParametersMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClusterSnapshotAttributesMessage$DBClusterSnapshotIdentifier' => '

The identifier for the cluster snapshot to describe the attributes for.

', 'DescribeDBClusterSnapshotsMessage$DBClusterIdentifier' => '

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can\'t be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

  • If provided, must match the identifier of an existing DBCluster.

', 'DescribeDBClusterSnapshotsMessage$DBClusterSnapshotIdentifier' => '

A specific cluster snapshot identifier to describe. This parameter can\'t be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • If provided, must match the identifier of an existing DBClusterSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

', 'DescribeDBClusterSnapshotsMessage$SnapshotType' => '

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

  • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

  • shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.

  • public - Return all cluster snapshots that have been marked as public.

If you don\'t specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don\'t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn\'t apply when SnapshotType is set to shared. The IncludeShared parameter doesn\'t apply when SnapshotType is set to public.

', 'DescribeDBClusterSnapshotsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBClustersMessage$DBClusterIdentifier' => '

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn\'t case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

', 'DescribeDBClustersMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBEngineVersionsMessage$Engine' => '

The database engine to return.

', 'DescribeDBEngineVersionsMessage$EngineVersion' => '

The database engine version to return.

Example: 3.6.0

', 'DescribeDBEngineVersionsMessage$DBParameterGroupFamily' => '

The name of a specific parameter group family to return details for.

Constraints:

  • If provided, must match an existing DBParameterGroupFamily.

', 'DescribeDBEngineVersionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBInstancesMessage$DBInstanceIdentifier' => '

The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn\'t case sensitive.

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

', 'DescribeDBInstancesMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeDBSubnetGroupsMessage$DBSubnetGroupName' => '

The name of the subnet group to return details for.

', 'DescribeDBSubnetGroupsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEngineDefaultClusterParametersMessage$DBParameterGroupFamily' => '

The name of the cluster parameter group family to return the engine parameter information for.

', 'DescribeEngineDefaultClusterParametersMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEventCategoriesMessage$SourceType' => '

The type of source that is generating the events.

Valid values: db-instance, db-parameter-group, db-security-group

', 'DescribeEventSubscriptionsMessage$SubscriptionName' => '

The name of the Amazon DocumentDB event notification subscription that you want to describe.

', 'DescribeEventSubscriptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeEventsMessage$SourceIdentifier' => '

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

', 'DescribeEventsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeGlobalClustersMessage$Marker' => '

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribeOrderableDBInstanceOptionsMessage$Engine' => '

The name of the engine to retrieve instance options for.

', 'DescribeOrderableDBInstanceOptionsMessage$EngineVersion' => '

The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

', 'DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass' => '

The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

', 'DescribeOrderableDBInstanceOptionsMessage$LicenseModel' => '

The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

', 'DescribeOrderableDBInstanceOptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'DescribePendingMaintenanceActionsMessage$ResourceIdentifier' => '

The ARN of a resource to return pending maintenance actions for.

', 'DescribePendingMaintenanceActionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'Endpoint$Address' => '

Specifies the DNS address of the instance.

', 'Endpoint$HostedZoneId' => '

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

', 'EngineDefaults$DBParameterGroupFamily' => '

The name of the cluster parameter group family to return the engine parameter information for.

', 'EngineDefaults$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'Event$SourceIdentifier' => '

Provides the identifier for the source of the event.

', 'Event$Message' => '

Provides the text of this event.

', 'Event$SourceArn' => '

The Amazon Resource Name (ARN) for the event.

', 'EventCategoriesList$member' => NULL, 'EventCategoriesMap$SourceType' => '

The source type that the returned categories belong to.

', 'EventSubscription$CustomerAwsId' => '

The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

', 'EventSubscription$CustSubscriptionId' => '

The Amazon DocumentDB event notification subscription ID.

', 'EventSubscription$SnsTopicArn' => '

The topic ARN of the Amazon DocumentDB event notification subscription.

', 'EventSubscription$Status' => '

The status of the Amazon DocumentDB event notification subscription.

Constraints:

Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

', 'EventSubscription$SubscriptionCreationTime' => '

The time at which the Amazon DocumentDB event notification subscription was created.

', 'EventSubscription$SourceType' => '

The source type for the Amazon DocumentDB event notification subscription.

', 'EventSubscription$EventSubscriptionArn' => '

The Amazon Resource Name (ARN) for the event subscription.

', 'EventSubscriptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'EventsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'FailoverDBClusterMessage$DBClusterIdentifier' => '

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'FailoverDBClusterMessage$TargetDBInstanceIdentifier' => '

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

', 'Filter$Name' => '

The name of the filter. Filter names are case sensitive.

', 'FilterValueList$member' => NULL, 'GlobalCluster$GlobalClusterResourceId' => '

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

', 'GlobalCluster$GlobalClusterArn' => '

The Amazon Resource Name (ARN) for the global cluster.

', 'GlobalCluster$Status' => '

Specifies the current state of this global cluster.

', 'GlobalCluster$Engine' => '

The Amazon DocumentDB database engine used by the global cluster.

', 'GlobalCluster$EngineVersion' => '

Indicates the database engine version.

', 'GlobalCluster$DatabaseName' => '

The default database name within the new global cluster.

', 'GlobalClusterMember$DBClusterArn' => '

The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

', 'GlobalClustersMessage$Marker' => '

', 'KeyList$member' => NULL, 'ListTagsForResourceMessage$ResourceName' => '

The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

', 'LogTypeList$member' => NULL, 'ModifyDBClusterMessage$DBClusterIdentifier' => '

The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'ModifyDBClusterMessage$NewDBClusterIdentifier' => '

The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

', 'ModifyDBClusterMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group to use for the cluster.

', 'ModifyDBClusterMessage$MasterUserPassword' => '

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

', 'ModifyDBClusterMessage$PreferredBackupWindow' => '

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'ModifyDBClusterMessage$PreferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

', 'ModifyDBClusterMessage$EngineVersion' => '

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for Amazon DocumentDB use the following command:

aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

', 'ModifyDBClusterMessage$StorageType' => '

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

', 'ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group to modify.

', 'ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier' => '

The identifier for the cluster snapshot to modify the attributes for.

', 'ModifyDBClusterSnapshotAttributeMessage$AttributeName' => '

The name of the cluster snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.

', 'ModifyDBInstanceMessage$DBInstanceIdentifier' => '

The instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'ModifyDBInstanceMessage$DBInstanceClass' => '

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.

If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

', 'ModifyDBInstanceMessage$PreferredMaintenanceWindow' => '

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn\'t result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Must be at least 30 minutes.

', 'ModifyDBInstanceMessage$NewDBInstanceIdentifier' => '

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

', 'ModifyDBInstanceMessage$CACertificateIdentifier' => '

Indicates the certificate that needs to be associated with the instance.

', 'ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId' => '

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

', 'ModifyDBSubnetGroupMessage$DBSubnetGroupName' => '

The name for the subnet group. This value is stored as a lowercase string. You can\'t modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

', 'ModifyDBSubnetGroupMessage$DBSubnetGroupDescription' => '

The description for the subnet group.

', 'ModifyEventSubscriptionMessage$SubscriptionName' => '

The name of the Amazon DocumentDB event notification subscription.

', 'ModifyEventSubscriptionMessage$SnsTopicArn' => '

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

', 'ModifyEventSubscriptionMessage$SourceType' => '

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-parameter-group, db-security-group

', 'OrderableDBInstanceOption$Engine' => '

The engine type of an instance.

', 'OrderableDBInstanceOption$EngineVersion' => '

The engine version of an instance.

', 'OrderableDBInstanceOption$DBInstanceClass' => '

The instance class for an instance.

', 'OrderableDBInstanceOption$LicenseModel' => '

The license model for an instance.

', 'OrderableDBInstanceOption$StorageType' => '

The storage type to associate with the DB cluster

', 'OrderableDBInstanceOptionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'Parameter$ParameterName' => '

Specifies the name of the parameter.

', 'Parameter$ParameterValue' => '

Specifies the value of the parameter.

', 'Parameter$Description' => '

Provides a description of the parameter.

', 'Parameter$Source' => '

Indicates the source of the parameter value.

', 'Parameter$ApplyType' => '

Specifies the engine-specific parameters type.

', 'Parameter$DataType' => '

Specifies the valid data type for the parameter.

', 'Parameter$AllowedValues' => '

Specifies the valid range of values for the parameter.

', 'Parameter$MinimumEngineVersion' => '

The earliest engine version to which the parameter can apply.

', 'PendingMaintenanceAction$Action' => '

The type of pending maintenance action that is available for the resource.

', 'PendingMaintenanceAction$OptInStatus' => '

Indicates the type of opt-in request that has been received for the resource.

', 'PendingMaintenanceAction$Description' => '

A description providing more detail about the maintenance action.

', 'PendingMaintenanceActionsMessage$Marker' => '

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

', 'PendingModifiedValues$DBInstanceClass' => '

Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

', 'PendingModifiedValues$MasterUserPassword' => '

Contains the pending or currently in-progress change of the master credentials for the instance.

', 'PendingModifiedValues$EngineVersion' => '

Indicates the database engine version.

', 'PendingModifiedValues$LicenseModel' => '

The license model for the instance.

Valid values: license-included, bring-your-own-license, general-public-license

', 'PendingModifiedValues$DBInstanceIdentifier' => '

Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

', 'PendingModifiedValues$StorageType' => '

Specifies the storage type to be associated with the instance.

', 'PendingModifiedValues$CACertificateIdentifier' => '

Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

', 'PendingModifiedValues$DBSubnetGroupName' => '

The new subnet group for the instance.

', 'ReadReplicaIdentifierList$member' => NULL, 'ReadersArnList$member' => NULL, 'RebootDBInstanceMessage$DBInstanceIdentifier' => '

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

', 'RemoveFromGlobalClusterMessage$DbClusterIdentifier' => '

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.

', 'RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName' => '

The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.

', 'RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier' => '

The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group.

', 'RemoveTagsFromResourceMessage$ResourceName' => '

The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).

', 'ResetDBClusterParameterGroupMessage$DBClusterParameterGroupName' => '

The name of the cluster parameter group to reset.

', 'ResourcePendingMaintenanceActions$ResourceIdentifier' => '

The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

', 'RestoreDBClusterFromSnapshotMessage$DBClusterIdentifier' => '

The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn\'t case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

', 'RestoreDBClusterFromSnapshotMessage$SnapshotIdentifier' => '

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

', 'RestoreDBClusterFromSnapshotMessage$Engine' => '

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

', 'RestoreDBClusterFromSnapshotMessage$EngineVersion' => '

The version of the database engine to use for the new cluster.

', 'RestoreDBClusterFromSnapshotMessage$DBSubnetGroupName' => '

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBClusterFromSnapshotMessage$KmsKeyId' => '

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

', 'RestoreDBClusterFromSnapshotMessage$DBClusterParameterGroupName' => '

The name of the DB cluster parameter group to associate with this DB cluster.

Type: String.       Required: No.

If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBClusterFromSnapshotMessage$StorageType' => '

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

', 'RestoreDBClusterToPointInTimeMessage$DBClusterIdentifier' => '

The name of the new cluster to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

', 'RestoreDBClusterToPointInTimeMessage$RestoreType' => '

The type of restore to be performed. You can specify one of the following values:

  • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

  • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can\'t specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don\'t specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

', 'RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier' => '

The identifier of the source cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

', 'RestoreDBClusterToPointInTimeMessage$DBSubnetGroupName' => '

The subnet group name to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

', 'RestoreDBClusterToPointInTimeMessage$KmsKeyId' => '

The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.

  • If the cluster is not encrypted, then the restored cluster is not encrypted.

If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

', 'RestoreDBClusterToPointInTimeMessage$StorageType' => '

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

', 'SourceIdsList$member' => NULL, 'StartDBClusterMessage$DBClusterIdentifier' => '

The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

', 'StopDBClusterMessage$DBClusterIdentifier' => '

The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

', 'Subnet$SubnetIdentifier' => '

Specifies the identifier of the subnet.

', 'Subnet$SubnetStatus' => '

Specifies the status of the subnet.

', 'SubnetIdentifierList$member' => NULL, 'Tag$Key' => '

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 contain only the set of Unicode letters, digits, white space, \'_\', \'.\', \'/\', \'=\', \'+\', \'-\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$").

', 'Tag$Value' => '

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 contain only the set of Unicode letters, digits, white space, \'_\', \'.\', \'/\', \'=\', \'+\', \'-\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$").

', 'UpgradeTarget$Engine' => '

The name of the upgrade target database engine.

', 'UpgradeTarget$EngineVersion' => '

The version number of the upgrade target database engine.

', 'UpgradeTarget$Description' => '

The version of the database engine that an instance can be upgraded to.

', 'VpcSecurityGroupIdList$member' => NULL, 'VpcSecurityGroupMembership$VpcSecurityGroupId' => '

The name of the VPC security group.

', 'VpcSecurityGroupMembership$Status' => '

The status of the VPC security group.

', ], ], 'Subnet' => [ 'base' => '

Detailed information about a subnet.

', 'refs' => [ 'SubnetList$member' => NULL, ], ], 'SubnetAlreadyInUse' => [ 'base' => '

The subnet is already in use in the Availability Zone.

', 'refs' => [], ], 'SubnetIdentifierList' => [ 'base' => NULL, 'refs' => [ 'CreateDBSubnetGroupMessage$SubnetIds' => '

The Amazon EC2 subnet IDs for the subnet group.

', 'ModifyDBSubnetGroupMessage$SubnetIds' => '

The Amazon EC2 subnet IDs for the subnet group.

', ], ], 'SubnetList' => [ 'base' => NULL, 'refs' => [ 'DBSubnetGroup$Subnets' => '

Detailed information about one or more subnets within a subnet group.

', ], ], 'SubscriptionAlreadyExistFault' => [ 'base' => '

The provided subscription name already exists.

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

The provided category does not exist.

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

The subscription name does not exist.

', 'refs' => [], ], 'TStamp' => [ 'base' => NULL, 'refs' => [ 'Certificate$ValidFrom' => '

The starting date-time from which the certificate is valid.

Example: 2019-07-31T17:57:09Z

', 'Certificate$ValidTill' => '

The date-time after which the certificate is no longer valid.

Example: 2024-07-31T17:57:09Z

', 'CertificateDetails$ValidTill' => '

The expiration date of the DB instance’s server certificate.

', 'DBCluster$EarliestRestorableTime' => '

The earliest time to which a database can be restored with point-in-time restore.

', 'DBCluster$LatestRestorableTime' => '

Specifies the latest time to which a database can be restored with point-in-time restore.

', 'DBCluster$ClusterCreateTime' => '

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

', 'DBClusterSnapshot$SnapshotCreateTime' => '

Provides the time when the snapshot was taken, in UTC.

', 'DBClusterSnapshot$ClusterCreateTime' => '

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

', 'DBInstance$InstanceCreateTime' => '

Provides the date and time that the instance was created.

', 'DBInstance$LatestRestorableTime' => '

Specifies the latest time to which a database can be restored with point-in-time restore.

', 'DescribeEventsMessage$StartTime' => '

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

', 'DescribeEventsMessage$EndTime' => '

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

', 'Event$Date' => '

Specifies the date and time of the event.

', 'PendingMaintenanceAction$AutoAppliedAfterDate' => '

The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

', 'PendingMaintenanceAction$ForcedApplyDate' => '

The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

', 'PendingMaintenanceAction$CurrentApplyDate' => '

The effective date when the pending maintenance action is applied to the resource.

', 'RestoreDBClusterToPointInTimeMessage$RestoreToTime' => '

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

  • Must be before the latest restorable time for the instance.

  • Must be specified if the UseLatestRestorableTime parameter is not provided.

  • Cannot be specified if the UseLatestRestorableTime parameter is true.

  • Cannot be specified if the RestoreType parameter is copy-on-write.

Example: 2015-03-07T23:45:00Z

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

Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

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

The tags to be assigned to the Amazon DocumentDB resource.

', 'CopyDBClusterParameterGroupMessage$Tags' => '

The tags that are to be assigned to the parameter group.

', 'CopyDBClusterSnapshotMessage$Tags' => '

The tags to be assigned to the cluster snapshot.

', 'CreateDBClusterMessage$Tags' => '

The tags to be assigned to the cluster.

', 'CreateDBClusterParameterGroupMessage$Tags' => '

The tags to be assigned to the cluster parameter group.

', 'CreateDBClusterSnapshotMessage$Tags' => '

The tags to be assigned to the cluster snapshot.

', 'CreateDBInstanceMessage$Tags' => '

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

', 'CreateDBSubnetGroupMessage$Tags' => '

The tags to be assigned to the subnet group.

', 'CreateEventSubscriptionMessage$Tags' => '

The tags to be assigned to the event subscription.

', 'RestoreDBClusterFromSnapshotMessage$Tags' => '

The tags to be assigned to the restored cluster.

', 'RestoreDBClusterToPointInTimeMessage$Tags' => '

The tags to be assigned to the restored cluster.

', 'TagListMessage$TagList' => '

A list of one or more tags.

', ], ], 'TagListMessage' => [ 'base' => '

Represents the output of ListTagsForResource.

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

The version of the database engine that an instance can be upgraded to.

', 'refs' => [ 'ValidUpgradeTargetList$member' => NULL, ], ], 'ValidUpgradeTargetList' => [ 'base' => NULL, 'refs' => [ 'DBEngineVersion$ValidUpgradeTarget' => '

A list of engine versions that this database engine version can be upgraded to.

', ], ], 'VpcSecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'CreateDBClusterMessage$VpcSecurityGroupIds' => '

A list of EC2 VPC security groups to associate with this cluster.

', 'ModifyDBClusterMessage$VpcSecurityGroupIds' => '

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

', 'RestoreDBClusterFromSnapshotMessage$VpcSecurityGroupIds' => '

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

', 'RestoreDBClusterToPointInTimeMessage$VpcSecurityGroupIds' => '

A list of VPC security groups that the new cluster belongs to.

', ], ], 'VpcSecurityGroupMembership' => [ 'base' => '

Used as a response element for queries on virtual private cloud (VPC) security group membership.

', 'refs' => [ 'VpcSecurityGroupMembershipList$member' => NULL, ], ], 'VpcSecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'DBCluster$VpcSecurityGroups' => '

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

', 'DBInstance$VpcSecurityGroups' => '

Provides a list of VPC security group elements that the instance belongs to.

', ], ], ],]; diff --git a/src/data/ecs/2014-11-13/api-2.json b/src/data/ecs/2014-11-13/api-2.json index ff4c33e9d5..3e4323fe13 100644 --- a/src/data/ecs/2014-11-13/api-2.json +++ b/src/data/ecs/2014-11-13/api-2.json @@ -990,14 +990,16 @@ "members":{ "autoScalingGroupArn":{"shape":"String"}, "managedScaling":{"shape":"ManagedScaling"}, - "managedTerminationProtection":{"shape":"ManagedTerminationProtection"} + "managedTerminationProtection":{"shape":"ManagedTerminationProtection"}, + "managedDraining":{"shape":"ManagedDraining"} } }, "AutoScalingGroupProviderUpdate":{ "type":"structure", "members":{ "managedScaling":{"shape":"ManagedScaling"}, - "managedTerminationProtection":{"shape":"ManagedTerminationProtection"} + "managedTerminationProtection":{"shape":"ManagedTerminationProtection"}, + "managedDraining":{"shape":"ManagedDraining"} } }, "AwsVpcConfiguration":{ @@ -2485,6 +2487,13 @@ "type":"list", "member":{"shape":"ManagedAgent"} }, + "ManagedDraining":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "ManagedScaling":{ "type":"structure", "members":{ diff --git a/src/data/ecs/2014-11-13/api-2.json.php b/src/data/ecs/2014-11-13/api-2.json.php index 8da9fedff6..09ecf0cf33 100644 --- a/src/data/ecs/2014-11-13/api-2.json.php +++ b/src/data/ecs/2014-11-13/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2014-11-13', 'endpointPrefix' => 'ecs', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'Amazon ECS', 'serviceFullName' => 'Amazon EC2 Container Service', 'serviceId' => 'ECS', 'signatureVersion' => 'v4', 'targetPrefix' => 'AmazonEC2ContainerServiceV20141113', 'uid' => 'ecs-2014-11-13', ], 'operations' => [ 'CreateCapacityProvider' => [ 'name' => 'CreateCapacityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCapacityProviderRequest', ], 'output' => [ 'shape' => 'CreateCapacityProviderResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UpdateInProgressException', ], ], ], 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'CreateService' => [ 'name' => 'CreateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServiceRequest', ], 'output' => [ 'shape' => 'CreateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'CreateTaskSet' => [ 'name' => 'CreateTaskSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTaskSetRequest', ], 'output' => [ 'shape' => 'CreateTaskSetResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'DeleteAccountSetting' => [ 'name' => 'DeleteAccountSetting', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAccountSettingRequest', ], 'output' => [ 'shape' => 'DeleteAccountSettingResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DeleteAttributes' => [ 'name' => 'DeleteAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAttributesRequest', ], 'output' => [ 'shape' => 'DeleteAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'TargetNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DeleteCapacityProvider' => [ 'name' => 'DeleteCapacityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCapacityProviderRequest', ], 'output' => [ 'shape' => 'DeleteCapacityProviderResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ClusterContainsContainerInstancesException', ], [ 'shape' => 'ClusterContainsServicesException', ], [ 'shape' => 'ClusterContainsTasksException', ], [ 'shape' => 'UpdateInProgressException', ], ], ], 'DeleteService' => [ 'name' => 'DeleteService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServiceRequest', ], 'output' => [ 'shape' => 'DeleteServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], ], ], 'DeleteTaskDefinitions' => [ 'name' => 'DeleteTaskDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTaskDefinitionsRequest', ], 'output' => [ 'shape' => 'DeleteTaskDefinitionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ServerException', ], ], ], 'DeleteTaskSet' => [ 'name' => 'DeleteTaskSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTaskSetRequest', ], 'output' => [ 'shape' => 'DeleteTaskSetResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'TaskSetNotFoundException', ], ], ], 'DeregisterContainerInstance' => [ 'name' => 'DeregisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'DeregisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DeregisterTaskDefinition' => [ 'name' => 'DeregisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DeregisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeCapacityProviders' => [ 'name' => 'DescribeCapacityProviders', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCapacityProvidersRequest', ], 'output' => [ 'shape' => 'DescribeCapacityProvidersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeClusters' => [ 'name' => 'DescribeClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClustersRequest', ], 'output' => [ 'shape' => 'DescribeClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeContainerInstances' => [ 'name' => 'DescribeContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContainerInstancesRequest', ], 'output' => [ 'shape' => 'DescribeContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DescribeServices' => [ 'name' => 'DescribeServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServicesRequest', ], 'output' => [ 'shape' => 'DescribeServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DescribeTaskDefinition' => [ 'name' => 'DescribeTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeTaskSets' => [ 'name' => 'DescribeTaskSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTaskSetsRequest', ], 'output' => [ 'shape' => 'DescribeTaskSetsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], ], ], 'DescribeTasks' => [ 'name' => 'DescribeTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTasksRequest', ], 'output' => [ 'shape' => 'DescribeTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DiscoverPollEndpoint' => [ 'name' => 'DiscoverPollEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DiscoverPollEndpointRequest', ], 'output' => [ 'shape' => 'DiscoverPollEndpointResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], ], ], 'ExecuteCommand' => [ 'name' => 'ExecuteCommand', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExecuteCommandRequest', ], 'output' => [ 'shape' => 'ExecuteCommandResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'TargetNotConnectedException', ], ], ], 'GetTaskProtection' => [ 'name' => 'GetTaskProtection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetTaskProtectionRequest', ], 'output' => [ 'shape' => 'GetTaskProtectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServerException', ], [ 'shape' => 'UnsupportedFeatureException', ], ], ], 'ListAccountSettings' => [ 'name' => 'ListAccountSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAccountSettingsRequest', ], 'output' => [ 'shape' => 'ListAccountSettingsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListAttributes' => [ 'name' => 'ListAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAttributesRequest', ], 'output' => [ 'shape' => 'ListAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersRequest', ], 'output' => [ 'shape' => 'ListClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListContainerInstances' => [ 'name' => 'ListContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContainerInstancesRequest', ], 'output' => [ 'shape' => 'ListContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'ListServices' => [ 'name' => 'ListServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServicesRequest', ], 'output' => [ 'shape' => 'ListServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'ListServicesByNamespace' => [ 'name' => 'ListServicesByNamespace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServicesByNamespaceRequest', ], 'output' => [ 'shape' => 'ListServicesByNamespaceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTaskDefinitionFamilies' => [ 'name' => 'ListTaskDefinitionFamilies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionFamiliesRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionFamiliesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTaskDefinitions' => [ 'name' => 'ListTaskDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionsRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTasks' => [ 'name' => 'ListTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTasksRequest', ], 'output' => [ 'shape' => 'ListTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], ], ], 'PutAccountSetting' => [ 'name' => 'PutAccountSetting', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAccountSettingRequest', ], 'output' => [ 'shape' => 'PutAccountSettingResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'PutAccountSettingDefault' => [ 'name' => 'PutAccountSettingDefault', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAccountSettingDefaultRequest', ], 'output' => [ 'shape' => 'PutAccountSettingDefaultResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'PutAttributes' => [ 'name' => 'PutAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAttributesRequest', ], 'output' => [ 'shape' => 'PutAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'TargetNotFoundException', ], [ 'shape' => 'AttributeLimitExceededException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'PutClusterCapacityProviders' => [ 'name' => 'PutClusterCapacityProviders', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutClusterCapacityProvidersRequest', ], 'output' => [ 'shape' => 'PutClusterCapacityProvidersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'UpdateInProgressException', ], ], ], 'RegisterContainerInstance' => [ 'name' => 'RegisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'RegisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'RegisterTaskDefinition' => [ 'name' => 'RegisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'RegisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'RunTask' => [ 'name' => 'RunTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RunTaskRequest', ], 'output' => [ 'shape' => 'RunTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'BlockedException', ], [ 'shape' => 'ConflictException', ], ], ], 'StartTask' => [ 'name' => 'StartTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartTaskRequest', ], 'output' => [ 'shape' => 'StartTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'StopTask' => [ 'name' => 'StopTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTaskRequest', ], 'output' => [ 'shape' => 'StopTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'SubmitAttachmentStateChanges' => [ 'name' => 'SubmitAttachmentStateChanges', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitAttachmentStateChangesRequest', ], 'output' => [ 'shape' => 'SubmitAttachmentStateChangesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'SubmitContainerStateChange' => [ 'name' => 'SubmitContainerStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitContainerStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitContainerStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'SubmitTaskStateChange' => [ 'name' => 'SubmitTaskStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitTaskStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitTaskStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UpdateCapacityProvider' => [ 'name' => 'UpdateCapacityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCapacityProviderRequest', ], 'output' => [ 'shape' => 'UpdateCapacityProviderResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UpdateCluster' => [ 'name' => 'UpdateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateClusterRequest', ], 'output' => [ 'shape' => 'UpdateClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'UpdateClusterSettings' => [ 'name' => 'UpdateClusterSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateClusterSettingsRequest', ], 'output' => [ 'shape' => 'UpdateClusterSettingsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UpdateContainerAgent' => [ 'name' => 'UpdateContainerAgent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerAgentRequest', ], 'output' => [ 'shape' => 'UpdateContainerAgentResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UpdateInProgressException', ], [ 'shape' => 'NoUpdateAvailableException', ], [ 'shape' => 'MissingVersionException', ], ], ], 'UpdateContainerInstancesState' => [ 'name' => 'UpdateContainerInstancesState', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerInstancesStateRequest', ], 'output' => [ 'shape' => 'UpdateContainerInstancesStateResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'UpdateService' => [ 'name' => 'UpdateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateServiceRequest', ], 'output' => [ 'shape' => 'UpdateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'UpdateServicePrimaryTaskSet' => [ 'name' => 'UpdateServicePrimaryTaskSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateServicePrimaryTaskSetRequest', ], 'output' => [ 'shape' => 'UpdateServicePrimaryTaskSetResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'TaskSetNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateTaskProtection' => [ 'name' => 'UpdateTaskProtection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTaskProtectionRequest', ], 'output' => [ 'shape' => 'UpdateTaskProtectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServerException', ], [ 'shape' => 'UnsupportedFeatureException', ], ], ], 'UpdateTaskSet' => [ 'name' => 'UpdateTaskSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTaskSetRequest', ], 'output' => [ 'shape' => 'UpdateTaskSetResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'TaskSetNotFoundException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'AgentUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'STAGING', 'STAGED', 'UPDATING', 'UPDATED', 'FAILED', ], ], 'ApplicationProtocol' => [ 'type' => 'string', 'enum' => [ 'http', 'http2', 'grpc', ], ], 'AssignPublicIp' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'Attachment' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'details' => [ 'shape' => 'AttachmentDetails', ], ], ], 'AttachmentDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'AttachmentStateChange' => [ 'type' => 'structure', 'required' => [ 'attachmentArn', 'status', ], 'members' => [ 'attachmentArn' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], ], ], 'AttachmentStateChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachmentStateChange', ], ], 'Attachments' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attachment', ], ], 'Attribute' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], 'targetType' => [ 'shape' => 'TargetType', ], 'targetId' => [ 'shape' => 'String', ], ], ], 'AttributeLimitExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Attributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], 'AutoScalingGroupProvider' => [ 'type' => 'structure', 'required' => [ 'autoScalingGroupArn', ], 'members' => [ 'autoScalingGroupArn' => [ 'shape' => 'String', ], 'managedScaling' => [ 'shape' => 'ManagedScaling', ], 'managedTerminationProtection' => [ 'shape' => 'ManagedTerminationProtection', ], ], ], 'AutoScalingGroupProviderUpdate' => [ 'type' => 'structure', 'members' => [ 'managedScaling' => [ 'shape' => 'ManagedScaling', ], 'managedTerminationProtection' => [ 'shape' => 'ManagedTerminationProtection', ], ], ], 'AwsVpcConfiguration' => [ 'type' => 'structure', 'required' => [ 'subnets', ], 'members' => [ 'subnets' => [ 'shape' => 'StringList', ], 'securityGroups' => [ 'shape' => 'StringList', ], 'assignPublicIp' => [ 'shape' => 'AssignPublicIp', ], ], ], 'BlockedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'BoxedBoolean' => [ 'type' => 'boolean', 'box' => true, ], 'BoxedInteger' => [ 'type' => 'integer', 'box' => true, ], 'CPUArchitecture' => [ 'type' => 'string', 'enum' => [ 'X86_64', 'ARM64', ], ], 'CapacityProvider' => [ 'type' => 'structure', 'members' => [ 'capacityProviderArn' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'CapacityProviderStatus', ], 'autoScalingGroupProvider' => [ 'shape' => 'AutoScalingGroupProvider', ], 'updateStatus' => [ 'shape' => 'CapacityProviderUpdateStatus', ], 'updateStatusReason' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CapacityProviderField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'CapacityProviderFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CapacityProviderField', ], ], 'CapacityProviderStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'CapacityProviderStrategy' => [ 'type' => 'list', 'member' => [ 'shape' => 'CapacityProviderStrategyItem', ], ], 'CapacityProviderStrategyItem' => [ 'type' => 'structure', 'required' => [ 'capacityProvider', ], 'members' => [ 'capacityProvider' => [ 'shape' => 'String', ], 'weight' => [ 'shape' => 'CapacityProviderStrategyItemWeight', ], 'base' => [ 'shape' => 'CapacityProviderStrategyItemBase', ], ], ], 'CapacityProviderStrategyItemBase' => [ 'type' => 'integer', 'max' => 100000, 'min' => 0, ], 'CapacityProviderStrategyItemWeight' => [ 'type' => 'integer', 'max' => 1000, 'min' => 0, ], 'CapacityProviderUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'DELETE_IN_PROGRESS', 'DELETE_COMPLETE', 'DELETE_FAILED', 'UPDATE_IN_PROGRESS', 'UPDATE_COMPLETE', 'UPDATE_FAILED', ], ], 'CapacityProviders' => [ 'type' => 'list', 'member' => [ 'shape' => 'CapacityProvider', ], ], 'ClientException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'Cluster' => [ 'type' => 'structure', 'members' => [ 'clusterArn' => [ 'shape' => 'String', ], 'clusterName' => [ 'shape' => 'String', ], 'configuration' => [ 'shape' => 'ClusterConfiguration', ], 'status' => [ 'shape' => 'String', ], 'registeredContainerInstancesCount' => [ 'shape' => 'Integer', ], 'runningTasksCount' => [ 'shape' => 'Integer', ], 'pendingTasksCount' => [ 'shape' => 'Integer', ], 'activeServicesCount' => [ 'shape' => 'Integer', ], 'statistics' => [ 'shape' => 'Statistics', ], 'tags' => [ 'shape' => 'Tags', ], 'settings' => [ 'shape' => 'ClusterSettings', ], 'capacityProviders' => [ 'shape' => 'StringList', ], 'defaultCapacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'attachments' => [ 'shape' => 'Attachments', ], 'attachmentsStatus' => [ 'shape' => 'String', ], 'serviceConnectDefaults' => [ 'shape' => 'ClusterServiceConnectDefaults', ], ], ], 'ClusterConfiguration' => [ 'type' => 'structure', 'members' => [ 'executeCommandConfiguration' => [ 'shape' => 'ExecuteCommandConfiguration', ], ], ], 'ClusterContainsContainerInstancesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterContainsServicesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterContainsTasksException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterField' => [ 'type' => 'string', 'enum' => [ 'ATTACHMENTS', 'CONFIGURATIONS', 'SETTINGS', 'STATISTICS', 'TAGS', ], ], 'ClusterFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterField', ], ], 'ClusterNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterServiceConnectDefaults' => [ 'type' => 'structure', 'members' => [ 'namespace' => [ 'shape' => 'String', ], ], ], 'ClusterServiceConnectDefaultsRequest' => [ 'type' => 'structure', 'required' => [ 'namespace', ], 'members' => [ 'namespace' => [ 'shape' => 'String', ], ], ], 'ClusterSetting' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ClusterSettingName', ], 'value' => [ 'shape' => 'String', ], ], ], 'ClusterSettingName' => [ 'type' => 'string', 'enum' => [ 'containerInsights', ], ], 'ClusterSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterSetting', ], ], 'Clusters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cluster', ], ], 'Compatibility' => [ 'type' => 'string', 'enum' => [ 'EC2', 'FARGATE', 'EXTERNAL', ], ], 'CompatibilityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Compatibility', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'resourceIds' => [ 'shape' => 'ResourceIds', ], ], 'exception' => true, ], 'Connectivity' => [ 'type' => 'string', 'enum' => [ 'CONNECTED', 'DISCONNECTED', ], ], 'Container' => [ 'type' => 'structure', 'members' => [ 'containerArn' => [ 'shape' => 'String', ], 'taskArn' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'String', ], 'imageDigest' => [ 'shape' => 'String', ], 'runtimeId' => [ 'shape' => 'String', ], 'lastStatus' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'reason' => [ 'shape' => 'String', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], 'networkInterfaces' => [ 'shape' => 'NetworkInterfaces', ], 'healthStatus' => [ 'shape' => 'HealthStatus', ], 'managedAgents' => [ 'shape' => 'ManagedAgents', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'memoryReservation' => [ 'shape' => 'String', ], 'gpuIds' => [ 'shape' => 'GpuIds', ], ], ], 'ContainerCondition' => [ 'type' => 'string', 'enum' => [ 'START', 'COMPLETE', 'SUCCESS', 'HEALTHY', ], ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'String', ], 'repositoryCredentials' => [ 'shape' => 'RepositoryCredentials', ], 'cpu' => [ 'shape' => 'Integer', ], 'memory' => [ 'shape' => 'BoxedInteger', ], 'memoryReservation' => [ 'shape' => 'BoxedInteger', ], 'links' => [ 'shape' => 'StringList', ], 'portMappings' => [ 'shape' => 'PortMappingList', ], 'essential' => [ 'shape' => 'BoxedBoolean', ], 'entryPoint' => [ 'shape' => 'StringList', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], 'environmentFiles' => [ 'shape' => 'EnvironmentFiles', ], 'mountPoints' => [ 'shape' => 'MountPointList', ], 'volumesFrom' => [ 'shape' => 'VolumeFromList', ], 'linuxParameters' => [ 'shape' => 'LinuxParameters', ], 'secrets' => [ 'shape' => 'SecretList', ], 'dependsOn' => [ 'shape' => 'ContainerDependencies', ], 'startTimeout' => [ 'shape' => 'BoxedInteger', ], 'stopTimeout' => [ 'shape' => 'BoxedInteger', ], 'hostname' => [ 'shape' => 'String', ], 'user' => [ 'shape' => 'String', ], 'workingDirectory' => [ 'shape' => 'String', ], 'disableNetworking' => [ 'shape' => 'BoxedBoolean', ], 'privileged' => [ 'shape' => 'BoxedBoolean', ], 'readonlyRootFilesystem' => [ 'shape' => 'BoxedBoolean', ], 'dnsServers' => [ 'shape' => 'StringList', ], 'dnsSearchDomains' => [ 'shape' => 'StringList', ], 'extraHosts' => [ 'shape' => 'HostEntryList', ], 'dockerSecurityOptions' => [ 'shape' => 'StringList', ], 'interactive' => [ 'shape' => 'BoxedBoolean', ], 'pseudoTerminal' => [ 'shape' => 'BoxedBoolean', ], 'dockerLabels' => [ 'shape' => 'DockerLabelsMap', ], 'ulimits' => [ 'shape' => 'UlimitList', ], 'logConfiguration' => [ 'shape' => 'LogConfiguration', ], 'healthCheck' => [ 'shape' => 'HealthCheck', ], 'systemControls' => [ 'shape' => 'SystemControls', ], 'resourceRequirements' => [ 'shape' => 'ResourceRequirements', ], 'firelensConfiguration' => [ 'shape' => 'FirelensConfiguration', ], 'credentialSpecs' => [ 'shape' => 'StringList', ], ], ], 'ContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], ], 'ContainerDependencies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDependency', ], ], 'ContainerDependency' => [ 'type' => 'structure', 'required' => [ 'containerName', 'condition', ], 'members' => [ 'containerName' => [ 'shape' => 'String', ], 'condition' => [ 'shape' => 'ContainerCondition', ], ], ], 'ContainerInstance' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArn' => [ 'shape' => 'String', ], 'ec2InstanceId' => [ 'shape' => 'String', ], 'capacityProviderName' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'Long', ], 'versionInfo' => [ 'shape' => 'VersionInfo', ], 'remainingResources' => [ 'shape' => 'Resources', ], 'registeredResources' => [ 'shape' => 'Resources', ], 'status' => [ 'shape' => 'String', ], 'statusReason' => [ 'shape' => 'String', ], 'agentConnected' => [ 'shape' => 'Boolean', ], 'runningTasksCount' => [ 'shape' => 'Integer', ], 'pendingTasksCount' => [ 'shape' => 'Integer', ], 'agentUpdateStatus' => [ 'shape' => 'AgentUpdateStatus', ], 'attributes' => [ 'shape' => 'Attributes', ], 'registeredAt' => [ 'shape' => 'Timestamp', ], 'attachments' => [ 'shape' => 'Attachments', ], 'tags' => [ 'shape' => 'Tags', ], 'healthStatus' => [ 'shape' => 'ContainerInstanceHealthStatus', ], ], ], 'ContainerInstanceField' => [ 'type' => 'string', 'enum' => [ 'TAGS', 'CONTAINER_INSTANCE_HEALTH', ], ], 'ContainerInstanceFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerInstanceField', ], ], 'ContainerInstanceHealthStatus' => [ 'type' => 'structure', 'members' => [ 'overallStatus' => [ 'shape' => 'InstanceHealthCheckState', ], 'details' => [ 'shape' => 'InstanceHealthCheckResultList', ], ], ], 'ContainerInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DRAINING', 'REGISTERING', 'DEREGISTERING', 'REGISTRATION_FAILED', ], ], 'ContainerInstances' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerInstance', ], ], 'ContainerOverride' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], 'environmentFiles' => [ 'shape' => 'EnvironmentFiles', ], 'cpu' => [ 'shape' => 'BoxedInteger', ], 'memory' => [ 'shape' => 'BoxedInteger', ], 'memoryReservation' => [ 'shape' => 'BoxedInteger', ], 'resourceRequirements' => [ 'shape' => 'ResourceRequirements', ], ], ], 'ContainerOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerOverride', ], ], 'ContainerStateChange' => [ 'type' => 'structure', 'members' => [ 'containerName' => [ 'shape' => 'String', ], 'imageDigest' => [ 'shape' => 'String', ], 'runtimeId' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], 'reason' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], ], ], 'ContainerStateChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerStateChange', ], ], 'Containers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Container', ], ], 'CreateCapacityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'autoScalingGroupProvider', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'autoScalingGroupProvider' => [ 'shape' => 'AutoScalingGroupProvider', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateCapacityProviderResponse' => [ 'type' => 'structure', 'members' => [ 'capacityProvider' => [ 'shape' => 'CapacityProvider', ], ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'members' => [ 'clusterName' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], 'settings' => [ 'shape' => 'ClusterSettings', ], 'configuration' => [ 'shape' => 'ClusterConfiguration', ], 'capacityProviders' => [ 'shape' => 'StringList', ], 'defaultCapacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'serviceConnectDefaults' => [ 'shape' => 'ClusterServiceConnectDefaultsRequest', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'CreateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'clientToken' => [ 'shape' => 'String', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'platformVersion' => [ 'shape' => 'String', ], 'role' => [ 'shape' => 'String', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], 'deploymentController' => [ 'shape' => 'DeploymentController', ], 'tags' => [ 'shape' => 'Tags', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], 'enableExecuteCommand' => [ 'shape' => 'Boolean', ], 'serviceConnectConfiguration' => [ 'shape' => 'ServiceConnectConfiguration', ], ], ], 'CreateServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'CreateTaskSetRequest' => [ 'type' => 'structure', 'required' => [ 'service', 'cluster', 'taskDefinition', ], 'members' => [ 'service' => [ 'shape' => 'String', ], 'cluster' => [ 'shape' => 'String', ], 'externalId' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'platformVersion' => [ 'shape' => 'String', ], 'scale' => [ 'shape' => 'Scale', ], 'clientToken' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateTaskSetResponse' => [ 'type' => 'structure', 'members' => [ 'taskSet' => [ 'shape' => 'TaskSet', ], ], ], 'DeleteAccountSettingRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'principalArn' => [ 'shape' => 'String', ], ], ], 'DeleteAccountSettingResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'DeleteAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'attributes', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'DeleteAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'DeleteCapacityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'capacityProvider', ], 'members' => [ 'capacityProvider' => [ 'shape' => 'String', ], ], ], 'DeleteCapacityProviderResponse' => [ 'type' => 'structure', 'members' => [ 'capacityProvider' => [ 'shape' => 'CapacityProvider', ], ], ], 'DeleteClusterRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], ], ], 'DeleteClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'DeleteServiceRequest' => [ 'type' => 'structure', 'required' => [ 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'force' => [ 'shape' => 'BoxedBoolean', ], ], ], 'DeleteServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'DeleteTaskDefinitionsRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinitions', ], 'members' => [ 'taskDefinitions' => [ 'shape' => 'StringList', ], ], ], 'DeleteTaskDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinitions' => [ 'shape' => 'TaskDefinitionList', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DeleteTaskSetRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'service', 'taskSet', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'taskSet' => [ 'shape' => 'String', ], 'force' => [ 'shape' => 'BoxedBoolean', ], ], ], 'DeleteTaskSetResponse' => [ 'type' => 'structure', 'members' => [ 'taskSet' => [ 'shape' => 'TaskSet', ], ], ], 'Deployment' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'failedTasks' => [ 'shape' => 'Integer', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'platformFamily' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'rolloutState' => [ 'shape' => 'DeploymentRolloutState', ], 'rolloutStateReason' => [ 'shape' => 'String', ], 'serviceConnectConfiguration' => [ 'shape' => 'ServiceConnectConfiguration', ], 'serviceConnectResources' => [ 'shape' => 'ServiceConnectServiceResourceList', ], ], ], 'DeploymentAlarms' => [ 'type' => 'structure', 'required' => [ 'alarmNames', 'enable', 'rollback', ], 'members' => [ 'alarmNames' => [ 'shape' => 'StringList', ], 'enable' => [ 'shape' => 'Boolean', ], 'rollback' => [ 'shape' => 'Boolean', ], ], ], 'DeploymentCircuitBreaker' => [ 'type' => 'structure', 'required' => [ 'enable', 'rollback', ], 'members' => [ 'enable' => [ 'shape' => 'Boolean', ], 'rollback' => [ 'shape' => 'Boolean', ], ], ], 'DeploymentConfiguration' => [ 'type' => 'structure', 'members' => [ 'deploymentCircuitBreaker' => [ 'shape' => 'DeploymentCircuitBreaker', ], 'maximumPercent' => [ 'shape' => 'BoxedInteger', ], 'minimumHealthyPercent' => [ 'shape' => 'BoxedInteger', ], 'alarms' => [ 'shape' => 'DeploymentAlarms', ], ], ], 'DeploymentController' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'DeploymentControllerType', ], ], ], 'DeploymentControllerType' => [ 'type' => 'string', 'enum' => [ 'ECS', 'CODE_DEPLOY', 'EXTERNAL', ], ], 'DeploymentRolloutState' => [ 'type' => 'string', 'enum' => [ 'COMPLETED', 'FAILED', 'IN_PROGRESS', ], ], 'Deployments' => [ 'type' => 'list', 'member' => [ 'shape' => 'Deployment', ], ], 'DeregisterContainerInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstance', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], 'force' => [ 'shape' => 'BoxedBoolean', ], ], ], 'DeregisterContainerInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'DeregisterTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'taskDefinition' => [ 'shape' => 'String', ], ], ], 'DeregisterTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], ], ], 'DescribeCapacityProvidersRequest' => [ 'type' => 'structure', 'members' => [ 'capacityProviders' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'CapacityProviderFieldList', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'DescribeCapacityProvidersResponse' => [ 'type' => 'structure', 'members' => [ 'capacityProviders' => [ 'shape' => 'CapacityProviders', ], 'failures' => [ 'shape' => 'Failures', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'DescribeClustersRequest' => [ 'type' => 'structure', 'members' => [ 'clusters' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ClusterFieldList', ], ], ], 'DescribeClustersResponse' => [ 'type' => 'structure', 'members' => [ 'clusters' => [ 'shape' => 'Clusters', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeContainerInstancesRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ContainerInstanceFieldList', ], ], ], 'DescribeContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstances' => [ 'shape' => 'ContainerInstances', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeServicesRequest' => [ 'type' => 'structure', 'required' => [ 'services', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'services' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ServiceFieldList', ], ], ], 'DescribeServicesResponse' => [ 'type' => 'structure', 'members' => [ 'services' => [ 'shape' => 'Services', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'taskDefinition' => [ 'shape' => 'String', ], 'include' => [ 'shape' => 'TaskDefinitionFieldList', ], ], ], 'DescribeTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'DescribeTaskSetsRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'taskSets' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'TaskSetFieldList', ], ], ], 'DescribeTaskSetsResponse' => [ 'type' => 'structure', 'members' => [ 'taskSets' => [ 'shape' => 'TaskSets', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeTasksRequest' => [ 'type' => 'structure', 'required' => [ 'tasks', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'tasks' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'TaskFieldList', ], ], ], 'DescribeTasksResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DesiredStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'PENDING', 'STOPPED', ], ], 'Device' => [ 'type' => 'structure', 'required' => [ 'hostPath', ], 'members' => [ 'hostPath' => [ 'shape' => 'String', ], 'containerPath' => [ 'shape' => 'String', ], 'permissions' => [ 'shape' => 'DeviceCgroupPermissions', ], ], ], 'DeviceCgroupPermission' => [ 'type' => 'string', 'enum' => [ 'read', 'write', 'mknod', ], ], 'DeviceCgroupPermissions' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceCgroupPermission', ], ], 'DevicesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'DiscoverPollEndpointRequest' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'String', ], 'cluster' => [ 'shape' => 'String', ], ], ], 'DiscoverPollEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'endpoint' => [ 'shape' => 'String', ], 'telemetryEndpoint' => [ 'shape' => 'String', ], 'serviceConnectEndpoint' => [ 'shape' => 'String', ], ], ], 'DockerLabelsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'DockerVolumeConfiguration' => [ 'type' => 'structure', 'members' => [ 'scope' => [ 'shape' => 'Scope', ], 'autoprovision' => [ 'shape' => 'BoxedBoolean', ], 'driver' => [ 'shape' => 'String', ], 'driverOpts' => [ 'shape' => 'StringMap', ], 'labels' => [ 'shape' => 'StringMap', ], ], ], 'Double' => [ 'type' => 'double', ], 'EFSAuthorizationConfig' => [ 'type' => 'structure', 'members' => [ 'accessPointId' => [ 'shape' => 'String', ], 'iam' => [ 'shape' => 'EFSAuthorizationConfigIAM', ], ], ], 'EFSAuthorizationConfigIAM' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'EFSTransitEncryption' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'EFSVolumeConfiguration' => [ 'type' => 'structure', 'required' => [ 'fileSystemId', ], 'members' => [ 'fileSystemId' => [ 'shape' => 'String', ], 'rootDirectory' => [ 'shape' => 'String', ], 'transitEncryption' => [ 'shape' => 'EFSTransitEncryption', ], 'transitEncryptionPort' => [ 'shape' => 'BoxedInteger', ], 'authorizationConfig' => [ 'shape' => 'EFSAuthorizationConfig', ], ], ], 'EnvironmentFile' => [ 'type' => 'structure', 'required' => [ 'value', 'type', ], 'members' => [ 'value' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'EnvironmentFileType', ], ], ], 'EnvironmentFileType' => [ 'type' => 'string', 'enum' => [ 's3', ], ], 'EnvironmentFiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnvironmentFile', ], ], 'EnvironmentVariables' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'EphemeralStorage' => [ 'type' => 'structure', 'required' => [ 'sizeInGiB', ], 'members' => [ 'sizeInGiB' => [ 'shape' => 'Integer', ], ], ], 'ExecuteCommandConfiguration' => [ 'type' => 'structure', 'members' => [ 'kmsKeyId' => [ 'shape' => 'String', ], 'logging' => [ 'shape' => 'ExecuteCommandLogging', ], 'logConfiguration' => [ 'shape' => 'ExecuteCommandLogConfiguration', ], ], ], 'ExecuteCommandLogConfiguration' => [ 'type' => 'structure', 'members' => [ 'cloudWatchLogGroupName' => [ 'shape' => 'String', ], 'cloudWatchEncryptionEnabled' => [ 'shape' => 'Boolean', ], 's3BucketName' => [ 'shape' => 'String', ], 's3EncryptionEnabled' => [ 'shape' => 'Boolean', ], 's3KeyPrefix' => [ 'shape' => 'String', ], ], ], 'ExecuteCommandLogging' => [ 'type' => 'string', 'enum' => [ 'NONE', 'DEFAULT', 'OVERRIDE', ], ], 'ExecuteCommandRequest' => [ 'type' => 'structure', 'required' => [ 'command', 'interactive', 'task', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'container' => [ 'shape' => 'String', ], 'command' => [ 'shape' => 'String', ], 'interactive' => [ 'shape' => 'Boolean', ], 'task' => [ 'shape' => 'String', ], ], ], 'ExecuteCommandResponse' => [ 'type' => 'structure', 'members' => [ 'clusterArn' => [ 'shape' => 'String', ], 'containerArn' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'interactive' => [ 'shape' => 'Boolean', ], 'session' => [ 'shape' => 'Session', ], 'taskArn' => [ 'shape' => 'String', ], ], ], 'FSxWindowsFileServerAuthorizationConfig' => [ 'type' => 'structure', 'required' => [ 'credentialsParameter', 'domain', ], 'members' => [ 'credentialsParameter' => [ 'shape' => 'String', ], 'domain' => [ 'shape' => 'String', ], ], ], 'FSxWindowsFileServerVolumeConfiguration' => [ 'type' => 'structure', 'required' => [ 'fileSystemId', 'rootDirectory', 'authorizationConfig', ], 'members' => [ 'fileSystemId' => [ 'shape' => 'String', ], 'rootDirectory' => [ 'shape' => 'String', ], 'authorizationConfig' => [ 'shape' => 'FSxWindowsFileServerAuthorizationConfig', ], ], ], 'Failure' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], 'detail' => [ 'shape' => 'String', ], ], ], 'Failures' => [ 'type' => 'list', 'member' => [ 'shape' => 'Failure', ], ], 'FirelensConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'FirelensConfigurationType', ], 'options' => [ 'shape' => 'FirelensConfigurationOptionsMap', ], ], ], 'FirelensConfigurationOptionsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'FirelensConfigurationType' => [ 'type' => 'string', 'enum' => [ 'fluentd', 'fluentbit', ], ], 'GetTaskProtectionRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'tasks' => [ 'shape' => 'StringList', ], ], ], 'GetTaskProtectionResponse' => [ 'type' => 'structure', 'members' => [ 'protectedTasks' => [ 'shape' => 'ProtectedTasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'GpuIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'HealthCheck' => [ 'type' => 'structure', 'required' => [ 'command', ], 'members' => [ 'command' => [ 'shape' => 'StringList', ], 'interval' => [ 'shape' => 'BoxedInteger', ], 'timeout' => [ 'shape' => 'BoxedInteger', ], 'retries' => [ 'shape' => 'BoxedInteger', ], 'startPeriod' => [ 'shape' => 'BoxedInteger', ], ], ], 'HealthStatus' => [ 'type' => 'string', 'enum' => [ 'HEALTHY', 'UNHEALTHY', 'UNKNOWN', ], ], 'HostEntry' => [ 'type' => 'structure', 'required' => [ 'hostname', 'ipAddress', ], 'members' => [ 'hostname' => [ 'shape' => 'String', ], 'ipAddress' => [ 'shape' => 'String', ], ], ], 'HostEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HostEntry', ], ], 'HostVolumeProperties' => [ 'type' => 'structure', 'members' => [ 'sourcePath' => [ 'shape' => 'String', ], ], ], 'InferenceAccelerator' => [ 'type' => 'structure', 'required' => [ 'deviceName', 'deviceType', ], 'members' => [ 'deviceName' => [ 'shape' => 'String', ], 'deviceType' => [ 'shape' => 'String', ], ], ], 'InferenceAcceleratorOverride' => [ 'type' => 'structure', 'members' => [ 'deviceName' => [ 'shape' => 'String', ], 'deviceType' => [ 'shape' => 'String', ], ], ], 'InferenceAcceleratorOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceAcceleratorOverride', ], ], 'InferenceAccelerators' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceAccelerator', ], ], 'InstanceHealthCheckResult' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'InstanceHealthCheckType', ], 'status' => [ 'shape' => 'InstanceHealthCheckState', ], 'lastUpdated' => [ 'shape' => 'Timestamp', ], 'lastStatusChange' => [ 'shape' => 'Timestamp', ], ], ], 'InstanceHealthCheckResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceHealthCheckResult', ], ], 'InstanceHealthCheckState' => [ 'type' => 'string', 'enum' => [ 'OK', 'IMPAIRED', 'INSUFFICIENT_DATA', 'INITIALIZING', ], ], 'InstanceHealthCheckType' => [ 'type' => 'string', 'enum' => [ 'CONTAINER_RUNTIME', ], ], 'Integer' => [ 'type' => 'integer', ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'IpcMode' => [ 'type' => 'string', 'enum' => [ 'host', 'task', 'none', ], ], 'KernelCapabilities' => [ 'type' => 'structure', 'members' => [ 'add' => [ 'shape' => 'StringList', ], 'drop' => [ 'shape' => 'StringList', ], ], ], 'KeyValuePair' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'LaunchType' => [ 'type' => 'string', 'enum' => [ 'EC2', 'FARGATE', 'EXTERNAL', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'LinuxParameters' => [ 'type' => 'structure', 'members' => [ 'capabilities' => [ 'shape' => 'KernelCapabilities', ], 'devices' => [ 'shape' => 'DevicesList', ], 'initProcessEnabled' => [ 'shape' => 'BoxedBoolean', ], 'sharedMemorySize' => [ 'shape' => 'BoxedInteger', ], 'tmpfs' => [ 'shape' => 'TmpfsList', ], 'maxSwap' => [ 'shape' => 'BoxedInteger', ], 'swappiness' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListAccountSettingsRequest' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], 'effectiveSettings' => [ 'shape' => 'Boolean', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'Integer', ], ], ], 'ListAccountSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'settings' => [ 'shape' => 'Settings', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'targetType', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'targetType' => [ 'shape' => 'TargetType', ], 'attributeName' => [ 'shape' => 'String', ], 'attributeValue' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListClustersRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListClustersResponse' => [ 'type' => 'structure', 'members' => [ 'clusterArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListContainerInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'filter' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'status' => [ 'shape' => 'ContainerInstanceStatus', ], ], ], 'ListContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListServicesByNamespaceRequest' => [ 'type' => 'structure', 'required' => [ 'namespace', ], 'members' => [ 'namespace' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListServicesByNamespaceResponse' => [ 'type' => 'structure', 'members' => [ 'serviceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListServicesRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], ], ], 'ListServicesResponse' => [ 'type' => 'structure', 'members' => [ 'serviceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'Tags', ], ], ], 'ListTaskDefinitionFamiliesRequest' => [ 'type' => 'structure', 'members' => [ 'familyPrefix' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'TaskDefinitionFamilyStatus', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListTaskDefinitionFamiliesResponse' => [ 'type' => 'structure', 'members' => [ 'families' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTaskDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'familyPrefix' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'TaskDefinitionStatus', ], 'sort' => [ 'shape' => 'SortOrder', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListTaskDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinitionArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTasksRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], 'family' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'startedBy' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'desiredStatus' => [ 'shape' => 'DesiredStatus', ], 'launchType' => [ 'shape' => 'LaunchType', ], ], ], 'ListTasksResponse' => [ 'type' => 'structure', 'members' => [ 'taskArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'LoadBalancer' => [ 'type' => 'structure', 'members' => [ 'targetGroupArn' => [ 'shape' => 'String', ], 'loadBalancerName' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], ], ], 'LoadBalancers' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancer', ], ], 'LogConfiguration' => [ 'type' => 'structure', 'required' => [ 'logDriver', ], 'members' => [ 'logDriver' => [ 'shape' => 'LogDriver', ], 'options' => [ 'shape' => 'LogConfigurationOptionsMap', ], 'secretOptions' => [ 'shape' => 'SecretList', ], ], ], 'LogConfigurationOptionsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'LogDriver' => [ 'type' => 'string', 'enum' => [ 'json-file', 'syslog', 'journald', 'gelf', 'fluentd', 'awslogs', 'splunk', 'awsfirelens', ], ], 'Long' => [ 'type' => 'long', ], 'ManagedAgent' => [ 'type' => 'structure', 'members' => [ 'lastStartedAt' => [ 'shape' => 'Timestamp', ], 'name' => [ 'shape' => 'ManagedAgentName', ], 'reason' => [ 'shape' => 'String', ], 'lastStatus' => [ 'shape' => 'String', ], ], ], 'ManagedAgentName' => [ 'type' => 'string', 'enum' => [ 'ExecuteCommandAgent', ], ], 'ManagedAgentStateChange' => [ 'type' => 'structure', 'required' => [ 'containerName', 'managedAgentName', 'status', ], 'members' => [ 'containerName' => [ 'shape' => 'String', ], 'managedAgentName' => [ 'shape' => 'ManagedAgentName', ], 'status' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], ], ], 'ManagedAgentStateChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedAgentStateChange', ], ], 'ManagedAgents' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedAgent', ], ], 'ManagedScaling' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ManagedScalingStatus', ], 'targetCapacity' => [ 'shape' => 'ManagedScalingTargetCapacity', ], 'minimumScalingStepSize' => [ 'shape' => 'ManagedScalingStepSize', ], 'maximumScalingStepSize' => [ 'shape' => 'ManagedScalingStepSize', ], 'instanceWarmupPeriod' => [ 'shape' => 'ManagedScalingInstanceWarmupPeriod', ], ], ], 'ManagedScalingInstanceWarmupPeriod' => [ 'type' => 'integer', 'max' => 10000, 'min' => 0, ], 'ManagedScalingStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'ManagedScalingStepSize' => [ 'type' => 'integer', 'max' => 10000, 'min' => 1, ], 'ManagedScalingTargetCapacity' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ManagedTerminationProtection' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'MissingVersionException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MountPoint' => [ 'type' => 'structure', 'members' => [ 'sourceVolume' => [ 'shape' => 'String', ], 'containerPath' => [ 'shape' => 'String', ], 'readOnly' => [ 'shape' => 'BoxedBoolean', ], ], ], 'MountPointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MountPoint', ], ], 'NamespaceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NetworkBinding' => [ 'type' => 'structure', 'members' => [ 'bindIP' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], 'hostPort' => [ 'shape' => 'BoxedInteger', ], 'protocol' => [ 'shape' => 'TransportProtocol', ], 'containerPortRange' => [ 'shape' => 'String', ], 'hostPortRange' => [ 'shape' => 'String', ], ], ], 'NetworkBindings' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkBinding', ], ], 'NetworkConfiguration' => [ 'type' => 'structure', 'members' => [ 'awsvpcConfiguration' => [ 'shape' => 'AwsVpcConfiguration', ], ], ], 'NetworkInterface' => [ 'type' => 'structure', 'members' => [ 'attachmentId' => [ 'shape' => 'String', ], 'privateIpv4Address' => [ 'shape' => 'String', ], 'ipv6Address' => [ 'shape' => 'String', ], ], ], 'NetworkInterfaces' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkInterface', ], ], 'NetworkMode' => [ 'type' => 'string', 'enum' => [ 'bridge', 'host', 'awsvpc', 'none', ], ], 'NoUpdateAvailableException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OSFamily' => [ 'type' => 'string', 'enum' => [ 'WINDOWS_SERVER_2019_FULL', 'WINDOWS_SERVER_2019_CORE', 'WINDOWS_SERVER_2016_FULL', 'WINDOWS_SERVER_2004_CORE', 'WINDOWS_SERVER_2022_CORE', 'WINDOWS_SERVER_2022_FULL', 'WINDOWS_SERVER_20H2_CORE', 'LINUX', ], ], 'PidMode' => [ 'type' => 'string', 'enum' => [ 'host', 'task', ], ], 'PlacementConstraint' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'PlacementConstraintType', ], 'expression' => [ 'shape' => 'String', ], ], ], 'PlacementConstraintType' => [ 'type' => 'string', 'enum' => [ 'distinctInstance', 'memberOf', ], ], 'PlacementConstraints' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacementConstraint', ], ], 'PlacementStrategies' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacementStrategy', ], ], 'PlacementStrategy' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'PlacementStrategyType', ], 'field' => [ 'shape' => 'String', ], ], ], 'PlacementStrategyType' => [ 'type' => 'string', 'enum' => [ 'random', 'spread', 'binpack', ], ], 'PlatformDevice' => [ 'type' => 'structure', 'required' => [ 'id', 'type', ], 'members' => [ 'id' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'PlatformDeviceType', ], ], ], 'PlatformDeviceType' => [ 'type' => 'string', 'enum' => [ 'GPU', ], ], 'PlatformDevices' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlatformDevice', ], ], 'PlatformTaskDefinitionIncompatibilityException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PlatformUnknownException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PortMapping' => [ 'type' => 'structure', 'members' => [ 'containerPort' => [ 'shape' => 'BoxedInteger', ], 'hostPort' => [ 'shape' => 'BoxedInteger', ], 'protocol' => [ 'shape' => 'TransportProtocol', ], 'name' => [ 'shape' => 'String', ], 'appProtocol' => [ 'shape' => 'ApplicationProtocol', ], 'containerPortRange' => [ 'shape' => 'String', ], ], ], 'PortMappingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortMapping', ], ], 'PortNumber' => [ 'type' => 'integer', 'box' => true, 'max' => 65535, 'min' => 0, ], 'PropagateTags' => [ 'type' => 'string', 'enum' => [ 'TASK_DEFINITION', 'SERVICE', 'NONE', ], ], 'ProtectedTask' => [ 'type' => 'structure', 'members' => [ 'taskArn' => [ 'shape' => 'String', ], 'protectionEnabled' => [ 'shape' => 'Boolean', ], 'expirationDate' => [ 'shape' => 'Timestamp', ], ], ], 'ProtectedTasks' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProtectedTask', ], ], 'ProxyConfiguration' => [ 'type' => 'structure', 'required' => [ 'containerName', ], 'members' => [ 'type' => [ 'shape' => 'ProxyConfigurationType', ], 'containerName' => [ 'shape' => 'String', ], 'properties' => [ 'shape' => 'ProxyConfigurationProperties', ], ], ], 'ProxyConfigurationProperties' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'ProxyConfigurationType' => [ 'type' => 'string', 'enum' => [ 'APPMESH', ], ], 'PutAccountSettingDefaultRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'value', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], ], ], 'PutAccountSettingDefaultResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'PutAccountSettingRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'value', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], ], ], 'PutAccountSettingResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'PutAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'attributes', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'PutAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'PutClusterCapacityProvidersRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'capacityProviders', 'defaultCapacityProviderStrategy', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'capacityProviders' => [ 'shape' => 'StringList', ], 'defaultCapacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], ], ], 'PutClusterCapacityProvidersResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'RegisterContainerInstanceRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'instanceIdentityDocument' => [ 'shape' => 'String', ], 'instanceIdentityDocumentSignature' => [ 'shape' => 'String', ], 'totalResources' => [ 'shape' => 'Resources', ], 'versionInfo' => [ 'shape' => 'VersionInfo', ], 'containerInstanceArn' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], 'platformDevices' => [ 'shape' => 'PlatformDevices', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'RegisterContainerInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'RegisterTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'family', 'containerDefinitions', ], 'members' => [ 'family' => [ 'shape' => 'String', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'executionRoleArn' => [ 'shape' => 'String', ], 'networkMode' => [ 'shape' => 'NetworkMode', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'volumes' => [ 'shape' => 'VolumeList', ], 'placementConstraints' => [ 'shape' => 'TaskDefinitionPlacementConstraints', ], 'requiresCompatibilities' => [ 'shape' => 'CompatibilityList', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], 'pidMode' => [ 'shape' => 'PidMode', ], 'ipcMode' => [ 'shape' => 'IpcMode', ], 'proxyConfiguration' => [ 'shape' => 'ProxyConfiguration', ], 'inferenceAccelerators' => [ 'shape' => 'InferenceAccelerators', ], 'ephemeralStorage' => [ 'shape' => 'EphemeralStorage', ], 'runtimePlatform' => [ 'shape' => 'RuntimePlatform', ], ], ], 'RegisterTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'RepositoryCredentials' => [ 'type' => 'structure', 'required' => [ 'credentialsParameter', ], 'members' => [ 'credentialsParameter' => [ 'shape' => 'String', ], ], ], 'RequiresAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'doubleValue' => [ 'shape' => 'Double', ], 'longValue' => [ 'shape' => 'Long', ], 'integerValue' => [ 'shape' => 'Integer', ], 'stringSetValue' => [ 'shape' => 'StringList', ], ], ], 'ResourceIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceRequirement' => [ 'type' => 'structure', 'required' => [ 'value', 'type', ], 'members' => [ 'value' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'ResourceType', ], ], ], 'ResourceRequirements' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceRequirement', ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'GPU', 'InferenceAccelerator', ], ], 'Resources' => [ 'type' => 'list', 'member' => [ 'shape' => 'Resource', ], ], 'RunTaskRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'cluster' => [ 'shape' => 'String', ], 'count' => [ 'shape' => 'BoxedInteger', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'enableExecuteCommand' => [ 'shape' => 'Boolean', ], 'group' => [ 'shape' => 'String', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'platformVersion' => [ 'shape' => 'String', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], 'referenceId' => [ 'shape' => 'String', ], 'startedBy' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], 'taskDefinition' => [ 'shape' => 'String', ], 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], ], ], 'RunTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'RuntimePlatform' => [ 'type' => 'structure', 'members' => [ 'cpuArchitecture' => [ 'shape' => 'CPUArchitecture', ], 'operatingSystemFamily' => [ 'shape' => 'OSFamily', ], ], ], 'Scale' => [ 'type' => 'structure', 'members' => [ 'value' => [ 'shape' => 'Double', ], 'unit' => [ 'shape' => 'ScaleUnit', ], ], ], 'ScaleUnit' => [ 'type' => 'string', 'enum' => [ 'PERCENT', ], ], 'SchedulingStrategy' => [ 'type' => 'string', 'enum' => [ 'REPLICA', 'DAEMON', ], ], 'Scope' => [ 'type' => 'string', 'enum' => [ 'task', 'shared', ], ], 'Secret' => [ 'type' => 'structure', 'required' => [ 'name', 'valueFrom', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'valueFrom' => [ 'shape' => 'String', ], ], ], 'SecretList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Secret', ], ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'ServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'fault' => true, ], 'Service' => [ 'type' => 'structure', 'members' => [ 'serviceArn' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'clusterArn' => [ 'shape' => 'String', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'status' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'platformVersion' => [ 'shape' => 'String', ], 'platformFamily' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'taskSets' => [ 'shape' => 'TaskSets', ], 'deployments' => [ 'shape' => 'Deployments', ], 'roleArn' => [ 'shape' => 'String', ], 'events' => [ 'shape' => 'ServiceEvents', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], 'deploymentController' => [ 'shape' => 'DeploymentController', ], 'tags' => [ 'shape' => 'Tags', ], 'createdBy' => [ 'shape' => 'String', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], 'enableExecuteCommand' => [ 'shape' => 'Boolean', ], ], ], 'ServiceConnectClientAlias' => [ 'type' => 'structure', 'required' => [ 'port', ], 'members' => [ 'port' => [ 'shape' => 'PortNumber', ], 'dnsName' => [ 'shape' => 'String', ], ], ], 'ServiceConnectClientAliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceConnectClientAlias', ], ], 'ServiceConnectConfiguration' => [ 'type' => 'structure', 'required' => [ 'enabled', ], 'members' => [ 'enabled' => [ 'shape' => 'Boolean', ], 'namespace' => [ 'shape' => 'String', ], 'services' => [ 'shape' => 'ServiceConnectServiceList', ], 'logConfiguration' => [ 'shape' => 'LogConfiguration', ], ], ], 'ServiceConnectService' => [ 'type' => 'structure', 'required' => [ 'portName', ], 'members' => [ 'portName' => [ 'shape' => 'String', ], 'discoveryName' => [ 'shape' => 'String', ], 'clientAliases' => [ 'shape' => 'ServiceConnectClientAliasList', ], 'ingressPortOverride' => [ 'shape' => 'PortNumber', ], ], ], 'ServiceConnectServiceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceConnectService', ], ], 'ServiceConnectServiceResource' => [ 'type' => 'structure', 'members' => [ 'discoveryName' => [ 'shape' => 'String', ], 'discoveryArn' => [ 'shape' => 'String', ], ], ], 'ServiceConnectServiceResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceConnectServiceResource', ], ], 'ServiceEvent' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'message' => [ 'shape' => 'String', ], ], ], 'ServiceEvents' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceEvent', ], ], 'ServiceField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'ServiceFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceField', ], ], 'ServiceNotActiveException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ServiceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ServiceRegistries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceRegistry', ], ], 'ServiceRegistry' => [ 'type' => 'structure', 'members' => [ 'registryArn' => [ 'shape' => 'String', ], 'port' => [ 'shape' => 'BoxedInteger', ], 'containerName' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], ], ], 'Services' => [ 'type' => 'list', 'member' => [ 'shape' => 'Service', ], ], 'Session' => [ 'type' => 'structure', 'members' => [ 'sessionId' => [ 'shape' => 'String', ], 'streamUrl' => [ 'shape' => 'String', ], 'tokenValue' => [ 'shape' => 'SensitiveString', ], ], ], 'Setting' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'SettingType', ], ], ], 'SettingName' => [ 'type' => 'string', 'enum' => [ 'serviceLongArnFormat', 'taskLongArnFormat', 'containerInstanceLongArnFormat', 'awsvpcTrunking', 'containerInsights', 'fargateFIPSMode', 'tagResourceAuthorization', 'fargateTaskRetirementWaitPeriod', 'guardDutyActivate', ], ], 'SettingType' => [ 'type' => 'string', 'enum' => [ 'user', 'aws_managed', ], ], 'Settings' => [ 'type' => 'list', 'member' => [ 'shape' => 'Setting', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASC', 'DESC', ], ], 'StabilityStatus' => [ 'type' => 'string', 'enum' => [ 'STEADY_STATE', 'STABILIZING', ], ], 'StartTaskRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', 'taskDefinition', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'enableExecuteCommand' => [ 'shape' => 'Boolean', ], 'group' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], 'referenceId' => [ 'shape' => 'String', ], 'startedBy' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], 'taskDefinition' => [ 'shape' => 'String', ], ], ], 'StartTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'Statistics' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'StopTaskRequest' => [ 'type' => 'structure', 'required' => [ 'task', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], ], ], 'StopTaskResponse' => [ 'type' => 'structure', 'members' => [ 'task' => [ 'shape' => 'Task', ], ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'StringMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'SubmitAttachmentStateChangesRequest' => [ 'type' => 'structure', 'required' => [ 'attachments', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'attachments' => [ 'shape' => 'AttachmentStateChanges', ], ], ], 'SubmitAttachmentStateChangesResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], 'SubmitContainerStateChangeRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'runtimeId' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'reason' => [ 'shape' => 'String', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], ], ], 'SubmitContainerStateChangeResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], 'SubmitTaskStateChangeRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], 'containers' => [ 'shape' => 'ContainerStateChanges', ], 'attachments' => [ 'shape' => 'AttachmentStateChanges', ], 'managedAgents' => [ 'shape' => 'ManagedAgentStateChanges', ], 'pullStartedAt' => [ 'shape' => 'Timestamp', ], 'pullStoppedAt' => [ 'shape' => 'Timestamp', ], 'executionStoppedAt' => [ 'shape' => 'Timestamp', ], ], ], 'SubmitTaskStateChangeResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], 'SystemControl' => [ 'type' => 'structure', 'members' => [ 'namespace' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'SystemControls' => [ 'type' => 'list', 'member' => [ 'shape' => 'SystemControl', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TargetNotConnectedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'TargetNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'TargetType' => [ 'type' => 'string', 'enum' => [ 'container-instance', ], ], 'Task' => [ 'type' => 'structure', 'members' => [ 'attachments' => [ 'shape' => 'Attachments', ], 'attributes' => [ 'shape' => 'Attributes', ], 'availabilityZone' => [ 'shape' => 'String', ], 'capacityProviderName' => [ 'shape' => 'String', ], 'clusterArn' => [ 'shape' => 'String', ], 'connectivity' => [ 'shape' => 'Connectivity', ], 'connectivityAt' => [ 'shape' => 'Timestamp', ], 'containerInstanceArn' => [ 'shape' => 'String', ], 'containers' => [ 'shape' => 'Containers', ], 'cpu' => [ 'shape' => 'String', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'desiredStatus' => [ 'shape' => 'String', ], 'enableExecuteCommand' => [ 'shape' => 'Boolean', ], 'executionStoppedAt' => [ 'shape' => 'Timestamp', ], 'group' => [ 'shape' => 'String', ], 'healthStatus' => [ 'shape' => 'HealthStatus', ], 'inferenceAccelerators' => [ 'shape' => 'InferenceAccelerators', ], 'lastStatus' => [ 'shape' => 'String', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'memory' => [ 'shape' => 'String', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'platformVersion' => [ 'shape' => 'String', ], 'platformFamily' => [ 'shape' => 'String', ], 'pullStartedAt' => [ 'shape' => 'Timestamp', ], 'pullStoppedAt' => [ 'shape' => 'Timestamp', ], 'startedAt' => [ 'shape' => 'Timestamp', ], 'startedBy' => [ 'shape' => 'String', ], 'stopCode' => [ 'shape' => 'TaskStopCode', ], 'stoppedAt' => [ 'shape' => 'Timestamp', ], 'stoppedReason' => [ 'shape' => 'String', ], 'stoppingAt' => [ 'shape' => 'Timestamp', ], 'tags' => [ 'shape' => 'Tags', ], 'taskArn' => [ 'shape' => 'String', ], 'taskDefinitionArn' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'Long', ], 'ephemeralStorage' => [ 'shape' => 'EphemeralStorage', ], ], ], 'TaskDefinition' => [ 'type' => 'structure', 'members' => [ 'taskDefinitionArn' => [ 'shape' => 'String', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'family' => [ 'shape' => 'String', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'executionRoleArn' => [ 'shape' => 'String', ], 'networkMode' => [ 'shape' => 'NetworkMode', ], 'revision' => [ 'shape' => 'Integer', ], 'volumes' => [ 'shape' => 'VolumeList', ], 'status' => [ 'shape' => 'TaskDefinitionStatus', ], 'requiresAttributes' => [ 'shape' => 'RequiresAttributes', ], 'placementConstraints' => [ 'shape' => 'TaskDefinitionPlacementConstraints', ], 'compatibilities' => [ 'shape' => 'CompatibilityList', ], 'runtimePlatform' => [ 'shape' => 'RuntimePlatform', ], 'requiresCompatibilities' => [ 'shape' => 'CompatibilityList', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'inferenceAccelerators' => [ 'shape' => 'InferenceAccelerators', ], 'pidMode' => [ 'shape' => 'PidMode', ], 'ipcMode' => [ 'shape' => 'IpcMode', ], 'proxyConfiguration' => [ 'shape' => 'ProxyConfiguration', ], 'registeredAt' => [ 'shape' => 'Timestamp', ], 'deregisteredAt' => [ 'shape' => 'Timestamp', ], 'registeredBy' => [ 'shape' => 'String', ], 'ephemeralStorage' => [ 'shape' => 'EphemeralStorage', ], ], ], 'TaskDefinitionFamilyStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'ALL', ], ], 'TaskDefinitionField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'TaskDefinitionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskDefinitionField', ], ], 'TaskDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskDefinition', ], ], 'TaskDefinitionPlacementConstraint' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'TaskDefinitionPlacementConstraintType', ], 'expression' => [ 'shape' => 'String', ], ], ], 'TaskDefinitionPlacementConstraintType' => [ 'type' => 'string', 'enum' => [ 'memberOf', ], ], 'TaskDefinitionPlacementConstraints' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskDefinitionPlacementConstraint', ], ], 'TaskDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'DELETE_IN_PROGRESS', ], ], 'TaskField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'TaskFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskField', ], ], 'TaskOverride' => [ 'type' => 'structure', 'members' => [ 'containerOverrides' => [ 'shape' => 'ContainerOverrides', ], 'cpu' => [ 'shape' => 'String', ], 'inferenceAcceleratorOverrides' => [ 'shape' => 'InferenceAcceleratorOverrides', ], 'executionRoleArn' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'ephemeralStorage' => [ 'shape' => 'EphemeralStorage', ], ], ], 'TaskSet' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'taskSetArn' => [ 'shape' => 'String', ], 'serviceArn' => [ 'shape' => 'String', ], 'clusterArn' => [ 'shape' => 'String', ], 'startedBy' => [ 'shape' => 'String', ], 'externalId' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'computedDesiredCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'platformVersion' => [ 'shape' => 'String', ], 'platformFamily' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'scale' => [ 'shape' => 'Scale', ], 'stabilityStatus' => [ 'shape' => 'StabilityStatus', ], 'stabilityStatusAt' => [ 'shape' => 'Timestamp', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TaskSetField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'TaskSetFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskSetField', ], ], 'TaskSetNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'TaskSets' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskSet', ], ], 'TaskStopCode' => [ 'type' => 'string', 'enum' => [ 'TaskFailedToStart', 'EssentialContainerExited', 'UserInitiated', 'ServiceSchedulerInitiated', 'SpotInterruption', 'TerminationNotice', ], ], 'Tasks' => [ 'type' => 'list', 'member' => [ 'shape' => 'Task', ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'Tmpfs' => [ 'type' => 'structure', 'required' => [ 'containerPath', 'size', ], 'members' => [ 'containerPath' => [ 'shape' => 'String', ], 'size' => [ 'shape' => 'Integer', ], 'mountOptions' => [ 'shape' => 'StringList', ], ], ], 'TmpfsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tmpfs', ], ], 'TransportProtocol' => [ 'type' => 'string', 'enum' => [ 'tcp', 'udp', ], ], 'Ulimit' => [ 'type' => 'structure', 'required' => [ 'name', 'softLimit', 'hardLimit', ], 'members' => [ 'name' => [ 'shape' => 'UlimitName', ], 'softLimit' => [ 'shape' => 'Integer', ], 'hardLimit' => [ 'shape' => 'Integer', ], ], ], 'UlimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Ulimit', ], ], 'UlimitName' => [ 'type' => 'string', 'enum' => [ 'core', 'cpu', 'data', 'fsize', 'locks', 'memlock', 'msgqueue', 'nice', 'nofile', 'nproc', 'rss', 'rtprio', 'rttime', 'sigpending', 'stack', ], ], 'UnsupportedFeatureException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], 'tagKeys' => [ 'shape' => 'TagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateCapacityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'autoScalingGroupProvider', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'autoScalingGroupProvider' => [ 'shape' => 'AutoScalingGroupProviderUpdate', ], ], ], 'UpdateCapacityProviderResponse' => [ 'type' => 'structure', 'members' => [ 'capacityProvider' => [ 'shape' => 'CapacityProvider', ], ], ], 'UpdateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'settings' => [ 'shape' => 'ClusterSettings', ], 'configuration' => [ 'shape' => 'ClusterConfiguration', ], 'serviceConnectDefaults' => [ 'shape' => 'ClusterServiceConnectDefaultsRequest', ], ], ], 'UpdateClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'UpdateClusterSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'settings', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'settings' => [ 'shape' => 'ClusterSettings', ], ], ], 'UpdateClusterSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'UpdateContainerAgentRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstance', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], ], ], 'UpdateContainerAgentResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'UpdateContainerInstancesStateRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', 'status', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'status' => [ 'shape' => 'ContainerInstanceStatus', ], ], ], 'UpdateContainerInstancesStateResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstances' => [ 'shape' => 'ContainerInstances', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'UpdateInProgressException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UpdateServicePrimaryTaskSetRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'service', 'primaryTaskSet', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'primaryTaskSet' => [ 'shape' => 'String', ], ], ], 'UpdateServicePrimaryTaskSetResponse' => [ 'type' => 'structure', 'members' => [ 'taskSet' => [ 'shape' => 'TaskSet', ], ], ], 'UpdateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'taskDefinition' => [ 'shape' => 'String', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'platformVersion' => [ 'shape' => 'String', ], 'forceNewDeployment' => [ 'shape' => 'Boolean', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], 'enableExecuteCommand' => [ 'shape' => 'BoxedBoolean', ], 'enableECSManagedTags' => [ 'shape' => 'BoxedBoolean', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'serviceConnectConfiguration' => [ 'shape' => 'ServiceConnectConfiguration', ], ], ], 'UpdateServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'UpdateTaskProtectionRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'tasks', 'protectionEnabled', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'tasks' => [ 'shape' => 'StringList', ], 'protectionEnabled' => [ 'shape' => 'Boolean', ], 'expiresInMinutes' => [ 'shape' => 'BoxedInteger', ], ], ], 'UpdateTaskProtectionResponse' => [ 'type' => 'structure', 'members' => [ 'protectedTasks' => [ 'shape' => 'ProtectedTasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'UpdateTaskSetRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'service', 'taskSet', 'scale', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'taskSet' => [ 'shape' => 'String', ], 'scale' => [ 'shape' => 'Scale', ], ], ], 'UpdateTaskSetResponse' => [ 'type' => 'structure', 'members' => [ 'taskSet' => [ 'shape' => 'TaskSet', ], ], ], 'VersionInfo' => [ 'type' => 'structure', 'members' => [ 'agentVersion' => [ 'shape' => 'String', ], 'agentHash' => [ 'shape' => 'String', ], 'dockerVersion' => [ 'shape' => 'String', ], ], ], 'Volume' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'host' => [ 'shape' => 'HostVolumeProperties', ], 'dockerVolumeConfiguration' => [ 'shape' => 'DockerVolumeConfiguration', ], 'efsVolumeConfiguration' => [ 'shape' => 'EFSVolumeConfiguration', ], 'fsxWindowsFileServerVolumeConfiguration' => [ 'shape' => 'FSxWindowsFileServerVolumeConfiguration', ], ], ], 'VolumeFrom' => [ 'type' => 'structure', 'members' => [ 'sourceContainer' => [ 'shape' => 'String', ], 'readOnly' => [ 'shape' => 'BoxedBoolean', ], ], ], 'VolumeFromList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VolumeFrom', ], ], 'VolumeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Volume', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2014-11-13', 'endpointPrefix' => 'ecs', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'Amazon ECS', 'serviceFullName' => 'Amazon EC2 Container Service', 'serviceId' => 'ECS', 'signatureVersion' => 'v4', 'targetPrefix' => 'AmazonEC2ContainerServiceV20141113', 'uid' => 'ecs-2014-11-13', ], 'operations' => [ 'CreateCapacityProvider' => [ 'name' => 'CreateCapacityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCapacityProviderRequest', ], 'output' => [ 'shape' => 'CreateCapacityProviderResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'UpdateInProgressException', ], ], ], 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'CreateService' => [ 'name' => 'CreateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServiceRequest', ], 'output' => [ 'shape' => 'CreateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'CreateTaskSet' => [ 'name' => 'CreateTaskSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTaskSetRequest', ], 'output' => [ 'shape' => 'CreateTaskSetResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'DeleteAccountSetting' => [ 'name' => 'DeleteAccountSetting', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAccountSettingRequest', ], 'output' => [ 'shape' => 'DeleteAccountSettingResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DeleteAttributes' => [ 'name' => 'DeleteAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAttributesRequest', ], 'output' => [ 'shape' => 'DeleteAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'TargetNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DeleteCapacityProvider' => [ 'name' => 'DeleteCapacityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCapacityProviderRequest', ], 'output' => [ 'shape' => 'DeleteCapacityProviderResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ClusterContainsContainerInstancesException', ], [ 'shape' => 'ClusterContainsServicesException', ], [ 'shape' => 'ClusterContainsTasksException', ], [ 'shape' => 'UpdateInProgressException', ], ], ], 'DeleteService' => [ 'name' => 'DeleteService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServiceRequest', ], 'output' => [ 'shape' => 'DeleteServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], ], ], 'DeleteTaskDefinitions' => [ 'name' => 'DeleteTaskDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTaskDefinitionsRequest', ], 'output' => [ 'shape' => 'DeleteTaskDefinitionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ServerException', ], ], ], 'DeleteTaskSet' => [ 'name' => 'DeleteTaskSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTaskSetRequest', ], 'output' => [ 'shape' => 'DeleteTaskSetResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'TaskSetNotFoundException', ], ], ], 'DeregisterContainerInstance' => [ 'name' => 'DeregisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'DeregisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DeregisterTaskDefinition' => [ 'name' => 'DeregisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DeregisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeCapacityProviders' => [ 'name' => 'DescribeCapacityProviders', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCapacityProvidersRequest', ], 'output' => [ 'shape' => 'DescribeCapacityProvidersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeClusters' => [ 'name' => 'DescribeClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClustersRequest', ], 'output' => [ 'shape' => 'DescribeClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeContainerInstances' => [ 'name' => 'DescribeContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContainerInstancesRequest', ], 'output' => [ 'shape' => 'DescribeContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DescribeServices' => [ 'name' => 'DescribeServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServicesRequest', ], 'output' => [ 'shape' => 'DescribeServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DescribeTaskDefinition' => [ 'name' => 'DescribeTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTaskDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'DescribeTaskSets' => [ 'name' => 'DescribeTaskSets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTaskSetsRequest', ], 'output' => [ 'shape' => 'DescribeTaskSetsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], ], ], 'DescribeTasks' => [ 'name' => 'DescribeTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTasksRequest', ], 'output' => [ 'shape' => 'DescribeTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'DiscoverPollEndpoint' => [ 'name' => 'DiscoverPollEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DiscoverPollEndpointRequest', ], 'output' => [ 'shape' => 'DiscoverPollEndpointResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], ], ], 'ExecuteCommand' => [ 'name' => 'ExecuteCommand', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExecuteCommandRequest', ], 'output' => [ 'shape' => 'ExecuteCommandResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'TargetNotConnectedException', ], ], ], 'GetTaskProtection' => [ 'name' => 'GetTaskProtection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetTaskProtectionRequest', ], 'output' => [ 'shape' => 'GetTaskProtectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServerException', ], [ 'shape' => 'UnsupportedFeatureException', ], ], ], 'ListAccountSettings' => [ 'name' => 'ListAccountSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAccountSettingsRequest', ], 'output' => [ 'shape' => 'ListAccountSettingsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListAttributes' => [ 'name' => 'ListAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAttributesRequest', ], 'output' => [ 'shape' => 'ListAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersRequest', ], 'output' => [ 'shape' => 'ListClustersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListContainerInstances' => [ 'name' => 'ListContainerInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContainerInstancesRequest', ], 'output' => [ 'shape' => 'ListContainerInstancesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'ListServices' => [ 'name' => 'ListServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServicesRequest', ], 'output' => [ 'shape' => 'ListServicesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'ListServicesByNamespace' => [ 'name' => 'ListServicesByNamespace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServicesByNamespaceRequest', ], 'output' => [ 'shape' => 'ListServicesByNamespaceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTaskDefinitionFamilies' => [ 'name' => 'ListTaskDefinitionFamilies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionFamiliesRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionFamiliesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTaskDefinitions' => [ 'name' => 'ListTaskDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTaskDefinitionsRequest', ], 'output' => [ 'shape' => 'ListTaskDefinitionsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'ListTasks' => [ 'name' => 'ListTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTasksRequest', ], 'output' => [ 'shape' => 'ListTasksResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], ], ], 'PutAccountSetting' => [ 'name' => 'PutAccountSetting', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAccountSettingRequest', ], 'output' => [ 'shape' => 'PutAccountSettingResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'PutAccountSettingDefault' => [ 'name' => 'PutAccountSettingDefault', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAccountSettingDefaultRequest', ], 'output' => [ 'shape' => 'PutAccountSettingDefaultResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'PutAttributes' => [ 'name' => 'PutAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAttributesRequest', ], 'output' => [ 'shape' => 'PutAttributesResponse', ], 'errors' => [ [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'TargetNotFoundException', ], [ 'shape' => 'AttributeLimitExceededException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'PutClusterCapacityProviders' => [ 'name' => 'PutClusterCapacityProviders', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutClusterCapacityProvidersRequest', ], 'output' => [ 'shape' => 'PutClusterCapacityProvidersResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'UpdateInProgressException', ], ], ], 'RegisterContainerInstance' => [ 'name' => 'RegisterContainerInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterContainerInstanceRequest', ], 'output' => [ 'shape' => 'RegisterContainerInstanceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'RegisterTaskDefinition' => [ 'name' => 'RegisterTaskDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterTaskDefinitionRequest', ], 'output' => [ 'shape' => 'RegisterTaskDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'RunTask' => [ 'name' => 'RunTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RunTaskRequest', ], 'output' => [ 'shape' => 'RunTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'BlockedException', ], [ 'shape' => 'ConflictException', ], ], ], 'StartTask' => [ 'name' => 'StartTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartTaskRequest', ], 'output' => [ 'shape' => 'StartTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'StopTask' => [ 'name' => 'StopTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTaskRequest', ], 'output' => [ 'shape' => 'StopTaskResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'SubmitAttachmentStateChanges' => [ 'name' => 'SubmitAttachmentStateChanges', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitAttachmentStateChangesRequest', ], 'output' => [ 'shape' => 'SubmitAttachmentStateChangesResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'SubmitContainerStateChange' => [ 'name' => 'SubmitContainerStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitContainerStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitContainerStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'SubmitTaskStateChange' => [ 'name' => 'SubmitTaskStateChange', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SubmitTaskStateChangeRequest', ], 'output' => [ 'shape' => 'SubmitTaskStateChangeResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UpdateCapacityProvider' => [ 'name' => 'UpdateCapacityProvider', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCapacityProviderRequest', ], 'output' => [ 'shape' => 'UpdateCapacityProviderResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UpdateCluster' => [ 'name' => 'UpdateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateClusterRequest', ], 'output' => [ 'shape' => 'UpdateClusterResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'UpdateClusterSettings' => [ 'name' => 'UpdateClusterSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateClusterSettingsRequest', ], 'output' => [ 'shape' => 'UpdateClusterSettingsResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UpdateContainerAgent' => [ 'name' => 'UpdateContainerAgent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerAgentRequest', ], 'output' => [ 'shape' => 'UpdateContainerAgentResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UpdateInProgressException', ], [ 'shape' => 'NoUpdateAvailableException', ], [ 'shape' => 'MissingVersionException', ], ], ], 'UpdateContainerInstancesState' => [ 'name' => 'UpdateContainerInstancesState', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerInstancesStateRequest', ], 'output' => [ 'shape' => 'UpdateContainerInstancesStateResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], ], ], 'UpdateService' => [ 'name' => 'UpdateService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateServiceRequest', ], 'output' => [ 'shape' => 'UpdateServiceResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'PlatformUnknownException', ], [ 'shape' => 'PlatformTaskDefinitionIncompatibilityException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NamespaceNotFoundException', ], ], ], 'UpdateServicePrimaryTaskSet' => [ 'name' => 'UpdateServicePrimaryTaskSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateServicePrimaryTaskSetRequest', ], 'output' => [ 'shape' => 'UpdateServicePrimaryTaskSetResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'TaskSetNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateTaskProtection' => [ 'name' => 'UpdateTaskProtection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTaskProtectionRequest', ], 'output' => [ 'shape' => 'UpdateTaskProtectionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServerException', ], [ 'shape' => 'UnsupportedFeatureException', ], ], ], 'UpdateTaskSet' => [ 'name' => 'UpdateTaskSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTaskSetRequest', ], 'output' => [ 'shape' => 'UpdateTaskSetResponse', ], 'errors' => [ [ 'shape' => 'ServerException', ], [ 'shape' => 'ClientException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ClusterNotFoundException', ], [ 'shape' => 'UnsupportedFeatureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceNotFoundException', ], [ 'shape' => 'ServiceNotActiveException', ], [ 'shape' => 'TaskSetNotFoundException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'AgentUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'STAGING', 'STAGED', 'UPDATING', 'UPDATED', 'FAILED', ], ], 'ApplicationProtocol' => [ 'type' => 'string', 'enum' => [ 'http', 'http2', 'grpc', ], ], 'AssignPublicIp' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'Attachment' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'details' => [ 'shape' => 'AttachmentDetails', ], ], ], 'AttachmentDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'AttachmentStateChange' => [ 'type' => 'structure', 'required' => [ 'attachmentArn', 'status', ], 'members' => [ 'attachmentArn' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], ], ], 'AttachmentStateChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachmentStateChange', ], ], 'Attachments' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attachment', ], ], 'Attribute' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], 'targetType' => [ 'shape' => 'TargetType', ], 'targetId' => [ 'shape' => 'String', ], ], ], 'AttributeLimitExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Attributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], 'AutoScalingGroupProvider' => [ 'type' => 'structure', 'required' => [ 'autoScalingGroupArn', ], 'members' => [ 'autoScalingGroupArn' => [ 'shape' => 'String', ], 'managedScaling' => [ 'shape' => 'ManagedScaling', ], 'managedTerminationProtection' => [ 'shape' => 'ManagedTerminationProtection', ], 'managedDraining' => [ 'shape' => 'ManagedDraining', ], ], ], 'AutoScalingGroupProviderUpdate' => [ 'type' => 'structure', 'members' => [ 'managedScaling' => [ 'shape' => 'ManagedScaling', ], 'managedTerminationProtection' => [ 'shape' => 'ManagedTerminationProtection', ], 'managedDraining' => [ 'shape' => 'ManagedDraining', ], ], ], 'AwsVpcConfiguration' => [ 'type' => 'structure', 'required' => [ 'subnets', ], 'members' => [ 'subnets' => [ 'shape' => 'StringList', ], 'securityGroups' => [ 'shape' => 'StringList', ], 'assignPublicIp' => [ 'shape' => 'AssignPublicIp', ], ], ], 'BlockedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'BoxedBoolean' => [ 'type' => 'boolean', 'box' => true, ], 'BoxedInteger' => [ 'type' => 'integer', 'box' => true, ], 'CPUArchitecture' => [ 'type' => 'string', 'enum' => [ 'X86_64', 'ARM64', ], ], 'CapacityProvider' => [ 'type' => 'structure', 'members' => [ 'capacityProviderArn' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'CapacityProviderStatus', ], 'autoScalingGroupProvider' => [ 'shape' => 'AutoScalingGroupProvider', ], 'updateStatus' => [ 'shape' => 'CapacityProviderUpdateStatus', ], 'updateStatusReason' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CapacityProviderField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'CapacityProviderFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CapacityProviderField', ], ], 'CapacityProviderStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'CapacityProviderStrategy' => [ 'type' => 'list', 'member' => [ 'shape' => 'CapacityProviderStrategyItem', ], ], 'CapacityProviderStrategyItem' => [ 'type' => 'structure', 'required' => [ 'capacityProvider', ], 'members' => [ 'capacityProvider' => [ 'shape' => 'String', ], 'weight' => [ 'shape' => 'CapacityProviderStrategyItemWeight', ], 'base' => [ 'shape' => 'CapacityProviderStrategyItemBase', ], ], ], 'CapacityProviderStrategyItemBase' => [ 'type' => 'integer', 'max' => 100000, 'min' => 0, ], 'CapacityProviderStrategyItemWeight' => [ 'type' => 'integer', 'max' => 1000, 'min' => 0, ], 'CapacityProviderUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'DELETE_IN_PROGRESS', 'DELETE_COMPLETE', 'DELETE_FAILED', 'UPDATE_IN_PROGRESS', 'UPDATE_COMPLETE', 'UPDATE_FAILED', ], ], 'CapacityProviders' => [ 'type' => 'list', 'member' => [ 'shape' => 'CapacityProvider', ], ], 'ClientException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'Cluster' => [ 'type' => 'structure', 'members' => [ 'clusterArn' => [ 'shape' => 'String', ], 'clusterName' => [ 'shape' => 'String', ], 'configuration' => [ 'shape' => 'ClusterConfiguration', ], 'status' => [ 'shape' => 'String', ], 'registeredContainerInstancesCount' => [ 'shape' => 'Integer', ], 'runningTasksCount' => [ 'shape' => 'Integer', ], 'pendingTasksCount' => [ 'shape' => 'Integer', ], 'activeServicesCount' => [ 'shape' => 'Integer', ], 'statistics' => [ 'shape' => 'Statistics', ], 'tags' => [ 'shape' => 'Tags', ], 'settings' => [ 'shape' => 'ClusterSettings', ], 'capacityProviders' => [ 'shape' => 'StringList', ], 'defaultCapacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'attachments' => [ 'shape' => 'Attachments', ], 'attachmentsStatus' => [ 'shape' => 'String', ], 'serviceConnectDefaults' => [ 'shape' => 'ClusterServiceConnectDefaults', ], ], ], 'ClusterConfiguration' => [ 'type' => 'structure', 'members' => [ 'executeCommandConfiguration' => [ 'shape' => 'ExecuteCommandConfiguration', ], ], ], 'ClusterContainsContainerInstancesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterContainsServicesException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterContainsTasksException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterField' => [ 'type' => 'string', 'enum' => [ 'ATTACHMENTS', 'CONFIGURATIONS', 'SETTINGS', 'STATISTICS', 'TAGS', ], ], 'ClusterFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterField', ], ], 'ClusterNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ClusterServiceConnectDefaults' => [ 'type' => 'structure', 'members' => [ 'namespace' => [ 'shape' => 'String', ], ], ], 'ClusterServiceConnectDefaultsRequest' => [ 'type' => 'structure', 'required' => [ 'namespace', ], 'members' => [ 'namespace' => [ 'shape' => 'String', ], ], ], 'ClusterSetting' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ClusterSettingName', ], 'value' => [ 'shape' => 'String', ], ], ], 'ClusterSettingName' => [ 'type' => 'string', 'enum' => [ 'containerInsights', ], ], 'ClusterSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterSetting', ], ], 'Clusters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cluster', ], ], 'Compatibility' => [ 'type' => 'string', 'enum' => [ 'EC2', 'FARGATE', 'EXTERNAL', ], ], 'CompatibilityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Compatibility', ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'resourceIds' => [ 'shape' => 'ResourceIds', ], ], 'exception' => true, ], 'Connectivity' => [ 'type' => 'string', 'enum' => [ 'CONNECTED', 'DISCONNECTED', ], ], 'Container' => [ 'type' => 'structure', 'members' => [ 'containerArn' => [ 'shape' => 'String', ], 'taskArn' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'String', ], 'imageDigest' => [ 'shape' => 'String', ], 'runtimeId' => [ 'shape' => 'String', ], 'lastStatus' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'reason' => [ 'shape' => 'String', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], 'networkInterfaces' => [ 'shape' => 'NetworkInterfaces', ], 'healthStatus' => [ 'shape' => 'HealthStatus', ], 'managedAgents' => [ 'shape' => 'ManagedAgents', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'memoryReservation' => [ 'shape' => 'String', ], 'gpuIds' => [ 'shape' => 'GpuIds', ], ], ], 'ContainerCondition' => [ 'type' => 'string', 'enum' => [ 'START', 'COMPLETE', 'SUCCESS', 'HEALTHY', ], ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'image' => [ 'shape' => 'String', ], 'repositoryCredentials' => [ 'shape' => 'RepositoryCredentials', ], 'cpu' => [ 'shape' => 'Integer', ], 'memory' => [ 'shape' => 'BoxedInteger', ], 'memoryReservation' => [ 'shape' => 'BoxedInteger', ], 'links' => [ 'shape' => 'StringList', ], 'portMappings' => [ 'shape' => 'PortMappingList', ], 'essential' => [ 'shape' => 'BoxedBoolean', ], 'entryPoint' => [ 'shape' => 'StringList', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], 'environmentFiles' => [ 'shape' => 'EnvironmentFiles', ], 'mountPoints' => [ 'shape' => 'MountPointList', ], 'volumesFrom' => [ 'shape' => 'VolumeFromList', ], 'linuxParameters' => [ 'shape' => 'LinuxParameters', ], 'secrets' => [ 'shape' => 'SecretList', ], 'dependsOn' => [ 'shape' => 'ContainerDependencies', ], 'startTimeout' => [ 'shape' => 'BoxedInteger', ], 'stopTimeout' => [ 'shape' => 'BoxedInteger', ], 'hostname' => [ 'shape' => 'String', ], 'user' => [ 'shape' => 'String', ], 'workingDirectory' => [ 'shape' => 'String', ], 'disableNetworking' => [ 'shape' => 'BoxedBoolean', ], 'privileged' => [ 'shape' => 'BoxedBoolean', ], 'readonlyRootFilesystem' => [ 'shape' => 'BoxedBoolean', ], 'dnsServers' => [ 'shape' => 'StringList', ], 'dnsSearchDomains' => [ 'shape' => 'StringList', ], 'extraHosts' => [ 'shape' => 'HostEntryList', ], 'dockerSecurityOptions' => [ 'shape' => 'StringList', ], 'interactive' => [ 'shape' => 'BoxedBoolean', ], 'pseudoTerminal' => [ 'shape' => 'BoxedBoolean', ], 'dockerLabels' => [ 'shape' => 'DockerLabelsMap', ], 'ulimits' => [ 'shape' => 'UlimitList', ], 'logConfiguration' => [ 'shape' => 'LogConfiguration', ], 'healthCheck' => [ 'shape' => 'HealthCheck', ], 'systemControls' => [ 'shape' => 'SystemControls', ], 'resourceRequirements' => [ 'shape' => 'ResourceRequirements', ], 'firelensConfiguration' => [ 'shape' => 'FirelensConfiguration', ], 'credentialSpecs' => [ 'shape' => 'StringList', ], ], ], 'ContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], ], 'ContainerDependencies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDependency', ], ], 'ContainerDependency' => [ 'type' => 'structure', 'required' => [ 'containerName', 'condition', ], 'members' => [ 'containerName' => [ 'shape' => 'String', ], 'condition' => [ 'shape' => 'ContainerCondition', ], ], ], 'ContainerInstance' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArn' => [ 'shape' => 'String', ], 'ec2InstanceId' => [ 'shape' => 'String', ], 'capacityProviderName' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'Long', ], 'versionInfo' => [ 'shape' => 'VersionInfo', ], 'remainingResources' => [ 'shape' => 'Resources', ], 'registeredResources' => [ 'shape' => 'Resources', ], 'status' => [ 'shape' => 'String', ], 'statusReason' => [ 'shape' => 'String', ], 'agentConnected' => [ 'shape' => 'Boolean', ], 'runningTasksCount' => [ 'shape' => 'Integer', ], 'pendingTasksCount' => [ 'shape' => 'Integer', ], 'agentUpdateStatus' => [ 'shape' => 'AgentUpdateStatus', ], 'attributes' => [ 'shape' => 'Attributes', ], 'registeredAt' => [ 'shape' => 'Timestamp', ], 'attachments' => [ 'shape' => 'Attachments', ], 'tags' => [ 'shape' => 'Tags', ], 'healthStatus' => [ 'shape' => 'ContainerInstanceHealthStatus', ], ], ], 'ContainerInstanceField' => [ 'type' => 'string', 'enum' => [ 'TAGS', 'CONTAINER_INSTANCE_HEALTH', ], ], 'ContainerInstanceFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerInstanceField', ], ], 'ContainerInstanceHealthStatus' => [ 'type' => 'structure', 'members' => [ 'overallStatus' => [ 'shape' => 'InstanceHealthCheckState', ], 'details' => [ 'shape' => 'InstanceHealthCheckResultList', ], ], ], 'ContainerInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DRAINING', 'REGISTERING', 'DEREGISTERING', 'REGISTRATION_FAILED', ], ], 'ContainerInstances' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerInstance', ], ], 'ContainerOverride' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'EnvironmentVariables', ], 'environmentFiles' => [ 'shape' => 'EnvironmentFiles', ], 'cpu' => [ 'shape' => 'BoxedInteger', ], 'memory' => [ 'shape' => 'BoxedInteger', ], 'memoryReservation' => [ 'shape' => 'BoxedInteger', ], 'resourceRequirements' => [ 'shape' => 'ResourceRequirements', ], ], ], 'ContainerOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerOverride', ], ], 'ContainerStateChange' => [ 'type' => 'structure', 'members' => [ 'containerName' => [ 'shape' => 'String', ], 'imageDigest' => [ 'shape' => 'String', ], 'runtimeId' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], 'reason' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], ], ], 'ContainerStateChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerStateChange', ], ], 'Containers' => [ 'type' => 'list', 'member' => [ 'shape' => 'Container', ], ], 'CreateCapacityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'autoScalingGroupProvider', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'autoScalingGroupProvider' => [ 'shape' => 'AutoScalingGroupProvider', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateCapacityProviderResponse' => [ 'type' => 'structure', 'members' => [ 'capacityProvider' => [ 'shape' => 'CapacityProvider', ], ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'members' => [ 'clusterName' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], 'settings' => [ 'shape' => 'ClusterSettings', ], 'configuration' => [ 'shape' => 'ClusterConfiguration', ], 'capacityProviders' => [ 'shape' => 'StringList', ], 'defaultCapacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'serviceConnectDefaults' => [ 'shape' => 'ClusterServiceConnectDefaultsRequest', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'CreateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'clientToken' => [ 'shape' => 'String', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'platformVersion' => [ 'shape' => 'String', ], 'role' => [ 'shape' => 'String', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], 'deploymentController' => [ 'shape' => 'DeploymentController', ], 'tags' => [ 'shape' => 'Tags', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], 'enableExecuteCommand' => [ 'shape' => 'Boolean', ], 'serviceConnectConfiguration' => [ 'shape' => 'ServiceConnectConfiguration', ], ], ], 'CreateServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'CreateTaskSetRequest' => [ 'type' => 'structure', 'required' => [ 'service', 'cluster', 'taskDefinition', ], 'members' => [ 'service' => [ 'shape' => 'String', ], 'cluster' => [ 'shape' => 'String', ], 'externalId' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'platformVersion' => [ 'shape' => 'String', ], 'scale' => [ 'shape' => 'Scale', ], 'clientToken' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'CreateTaskSetResponse' => [ 'type' => 'structure', 'members' => [ 'taskSet' => [ 'shape' => 'TaskSet', ], ], ], 'DeleteAccountSettingRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'principalArn' => [ 'shape' => 'String', ], ], ], 'DeleteAccountSettingResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'DeleteAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'attributes', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'DeleteAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'DeleteCapacityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'capacityProvider', ], 'members' => [ 'capacityProvider' => [ 'shape' => 'String', ], ], ], 'DeleteCapacityProviderResponse' => [ 'type' => 'structure', 'members' => [ 'capacityProvider' => [ 'shape' => 'CapacityProvider', ], ], ], 'DeleteClusterRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], ], ], 'DeleteClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'DeleteServiceRequest' => [ 'type' => 'structure', 'required' => [ 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'force' => [ 'shape' => 'BoxedBoolean', ], ], ], 'DeleteServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'DeleteTaskDefinitionsRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinitions', ], 'members' => [ 'taskDefinitions' => [ 'shape' => 'StringList', ], ], ], 'DeleteTaskDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinitions' => [ 'shape' => 'TaskDefinitionList', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DeleteTaskSetRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'service', 'taskSet', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'taskSet' => [ 'shape' => 'String', ], 'force' => [ 'shape' => 'BoxedBoolean', ], ], ], 'DeleteTaskSetResponse' => [ 'type' => 'structure', 'members' => [ 'taskSet' => [ 'shape' => 'TaskSet', ], ], ], 'Deployment' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'failedTasks' => [ 'shape' => 'Integer', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'platformVersion' => [ 'shape' => 'String', ], 'platformFamily' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'rolloutState' => [ 'shape' => 'DeploymentRolloutState', ], 'rolloutStateReason' => [ 'shape' => 'String', ], 'serviceConnectConfiguration' => [ 'shape' => 'ServiceConnectConfiguration', ], 'serviceConnectResources' => [ 'shape' => 'ServiceConnectServiceResourceList', ], ], ], 'DeploymentAlarms' => [ 'type' => 'structure', 'required' => [ 'alarmNames', 'enable', 'rollback', ], 'members' => [ 'alarmNames' => [ 'shape' => 'StringList', ], 'enable' => [ 'shape' => 'Boolean', ], 'rollback' => [ 'shape' => 'Boolean', ], ], ], 'DeploymentCircuitBreaker' => [ 'type' => 'structure', 'required' => [ 'enable', 'rollback', ], 'members' => [ 'enable' => [ 'shape' => 'Boolean', ], 'rollback' => [ 'shape' => 'Boolean', ], ], ], 'DeploymentConfiguration' => [ 'type' => 'structure', 'members' => [ 'deploymentCircuitBreaker' => [ 'shape' => 'DeploymentCircuitBreaker', ], 'maximumPercent' => [ 'shape' => 'BoxedInteger', ], 'minimumHealthyPercent' => [ 'shape' => 'BoxedInteger', ], 'alarms' => [ 'shape' => 'DeploymentAlarms', ], ], ], 'DeploymentController' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'DeploymentControllerType', ], ], ], 'DeploymentControllerType' => [ 'type' => 'string', 'enum' => [ 'ECS', 'CODE_DEPLOY', 'EXTERNAL', ], ], 'DeploymentRolloutState' => [ 'type' => 'string', 'enum' => [ 'COMPLETED', 'FAILED', 'IN_PROGRESS', ], ], 'Deployments' => [ 'type' => 'list', 'member' => [ 'shape' => 'Deployment', ], ], 'DeregisterContainerInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstance', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], 'force' => [ 'shape' => 'BoxedBoolean', ], ], ], 'DeregisterContainerInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'DeregisterTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'taskDefinition' => [ 'shape' => 'String', ], ], ], 'DeregisterTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], ], ], 'DescribeCapacityProvidersRequest' => [ 'type' => 'structure', 'members' => [ 'capacityProviders' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'CapacityProviderFieldList', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'DescribeCapacityProvidersResponse' => [ 'type' => 'structure', 'members' => [ 'capacityProviders' => [ 'shape' => 'CapacityProviders', ], 'failures' => [ 'shape' => 'Failures', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'DescribeClustersRequest' => [ 'type' => 'structure', 'members' => [ 'clusters' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ClusterFieldList', ], ], ], 'DescribeClustersResponse' => [ 'type' => 'structure', 'members' => [ 'clusters' => [ 'shape' => 'Clusters', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeContainerInstancesRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ContainerInstanceFieldList', ], ], ], 'DescribeContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstances' => [ 'shape' => 'ContainerInstances', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeServicesRequest' => [ 'type' => 'structure', 'required' => [ 'services', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'services' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'ServiceFieldList', ], ], ], 'DescribeServicesResponse' => [ 'type' => 'structure', 'members' => [ 'services' => [ 'shape' => 'Services', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'taskDefinition' => [ 'shape' => 'String', ], 'include' => [ 'shape' => 'TaskDefinitionFieldList', ], ], ], 'DescribeTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'DescribeTaskSetsRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'taskSets' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'TaskSetFieldList', ], ], ], 'DescribeTaskSetsResponse' => [ 'type' => 'structure', 'members' => [ 'taskSets' => [ 'shape' => 'TaskSets', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DescribeTasksRequest' => [ 'type' => 'structure', 'required' => [ 'tasks', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'tasks' => [ 'shape' => 'StringList', ], 'include' => [ 'shape' => 'TaskFieldList', ], ], ], 'DescribeTasksResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'DesiredStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'PENDING', 'STOPPED', ], ], 'Device' => [ 'type' => 'structure', 'required' => [ 'hostPath', ], 'members' => [ 'hostPath' => [ 'shape' => 'String', ], 'containerPath' => [ 'shape' => 'String', ], 'permissions' => [ 'shape' => 'DeviceCgroupPermissions', ], ], ], 'DeviceCgroupPermission' => [ 'type' => 'string', 'enum' => [ 'read', 'write', 'mknod', ], ], 'DeviceCgroupPermissions' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceCgroupPermission', ], ], 'DevicesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'DiscoverPollEndpointRequest' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'String', ], 'cluster' => [ 'shape' => 'String', ], ], ], 'DiscoverPollEndpointResponse' => [ 'type' => 'structure', 'members' => [ 'endpoint' => [ 'shape' => 'String', ], 'telemetryEndpoint' => [ 'shape' => 'String', ], 'serviceConnectEndpoint' => [ 'shape' => 'String', ], ], ], 'DockerLabelsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'DockerVolumeConfiguration' => [ 'type' => 'structure', 'members' => [ 'scope' => [ 'shape' => 'Scope', ], 'autoprovision' => [ 'shape' => 'BoxedBoolean', ], 'driver' => [ 'shape' => 'String', ], 'driverOpts' => [ 'shape' => 'StringMap', ], 'labels' => [ 'shape' => 'StringMap', ], ], ], 'Double' => [ 'type' => 'double', ], 'EFSAuthorizationConfig' => [ 'type' => 'structure', 'members' => [ 'accessPointId' => [ 'shape' => 'String', ], 'iam' => [ 'shape' => 'EFSAuthorizationConfigIAM', ], ], ], 'EFSAuthorizationConfigIAM' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'EFSTransitEncryption' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'EFSVolumeConfiguration' => [ 'type' => 'structure', 'required' => [ 'fileSystemId', ], 'members' => [ 'fileSystemId' => [ 'shape' => 'String', ], 'rootDirectory' => [ 'shape' => 'String', ], 'transitEncryption' => [ 'shape' => 'EFSTransitEncryption', ], 'transitEncryptionPort' => [ 'shape' => 'BoxedInteger', ], 'authorizationConfig' => [ 'shape' => 'EFSAuthorizationConfig', ], ], ], 'EnvironmentFile' => [ 'type' => 'structure', 'required' => [ 'value', 'type', ], 'members' => [ 'value' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'EnvironmentFileType', ], ], ], 'EnvironmentFileType' => [ 'type' => 'string', 'enum' => [ 's3', ], ], 'EnvironmentFiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnvironmentFile', ], ], 'EnvironmentVariables' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'EphemeralStorage' => [ 'type' => 'structure', 'required' => [ 'sizeInGiB', ], 'members' => [ 'sizeInGiB' => [ 'shape' => 'Integer', ], ], ], 'ExecuteCommandConfiguration' => [ 'type' => 'structure', 'members' => [ 'kmsKeyId' => [ 'shape' => 'String', ], 'logging' => [ 'shape' => 'ExecuteCommandLogging', ], 'logConfiguration' => [ 'shape' => 'ExecuteCommandLogConfiguration', ], ], ], 'ExecuteCommandLogConfiguration' => [ 'type' => 'structure', 'members' => [ 'cloudWatchLogGroupName' => [ 'shape' => 'String', ], 'cloudWatchEncryptionEnabled' => [ 'shape' => 'Boolean', ], 's3BucketName' => [ 'shape' => 'String', ], 's3EncryptionEnabled' => [ 'shape' => 'Boolean', ], 's3KeyPrefix' => [ 'shape' => 'String', ], ], ], 'ExecuteCommandLogging' => [ 'type' => 'string', 'enum' => [ 'NONE', 'DEFAULT', 'OVERRIDE', ], ], 'ExecuteCommandRequest' => [ 'type' => 'structure', 'required' => [ 'command', 'interactive', 'task', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'container' => [ 'shape' => 'String', ], 'command' => [ 'shape' => 'String', ], 'interactive' => [ 'shape' => 'Boolean', ], 'task' => [ 'shape' => 'String', ], ], ], 'ExecuteCommandResponse' => [ 'type' => 'structure', 'members' => [ 'clusterArn' => [ 'shape' => 'String', ], 'containerArn' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'interactive' => [ 'shape' => 'Boolean', ], 'session' => [ 'shape' => 'Session', ], 'taskArn' => [ 'shape' => 'String', ], ], ], 'FSxWindowsFileServerAuthorizationConfig' => [ 'type' => 'structure', 'required' => [ 'credentialsParameter', 'domain', ], 'members' => [ 'credentialsParameter' => [ 'shape' => 'String', ], 'domain' => [ 'shape' => 'String', ], ], ], 'FSxWindowsFileServerVolumeConfiguration' => [ 'type' => 'structure', 'required' => [ 'fileSystemId', 'rootDirectory', 'authorizationConfig', ], 'members' => [ 'fileSystemId' => [ 'shape' => 'String', ], 'rootDirectory' => [ 'shape' => 'String', ], 'authorizationConfig' => [ 'shape' => 'FSxWindowsFileServerAuthorizationConfig', ], ], ], 'Failure' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], 'detail' => [ 'shape' => 'String', ], ], ], 'Failures' => [ 'type' => 'list', 'member' => [ 'shape' => 'Failure', ], ], 'FirelensConfiguration' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'FirelensConfigurationType', ], 'options' => [ 'shape' => 'FirelensConfigurationOptionsMap', ], ], ], 'FirelensConfigurationOptionsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'FirelensConfigurationType' => [ 'type' => 'string', 'enum' => [ 'fluentd', 'fluentbit', ], ], 'GetTaskProtectionRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'tasks' => [ 'shape' => 'StringList', ], ], ], 'GetTaskProtectionResponse' => [ 'type' => 'structure', 'members' => [ 'protectedTasks' => [ 'shape' => 'ProtectedTasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'GpuIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'HealthCheck' => [ 'type' => 'structure', 'required' => [ 'command', ], 'members' => [ 'command' => [ 'shape' => 'StringList', ], 'interval' => [ 'shape' => 'BoxedInteger', ], 'timeout' => [ 'shape' => 'BoxedInteger', ], 'retries' => [ 'shape' => 'BoxedInteger', ], 'startPeriod' => [ 'shape' => 'BoxedInteger', ], ], ], 'HealthStatus' => [ 'type' => 'string', 'enum' => [ 'HEALTHY', 'UNHEALTHY', 'UNKNOWN', ], ], 'HostEntry' => [ 'type' => 'structure', 'required' => [ 'hostname', 'ipAddress', ], 'members' => [ 'hostname' => [ 'shape' => 'String', ], 'ipAddress' => [ 'shape' => 'String', ], ], ], 'HostEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HostEntry', ], ], 'HostVolumeProperties' => [ 'type' => 'structure', 'members' => [ 'sourcePath' => [ 'shape' => 'String', ], ], ], 'InferenceAccelerator' => [ 'type' => 'structure', 'required' => [ 'deviceName', 'deviceType', ], 'members' => [ 'deviceName' => [ 'shape' => 'String', ], 'deviceType' => [ 'shape' => 'String', ], ], ], 'InferenceAcceleratorOverride' => [ 'type' => 'structure', 'members' => [ 'deviceName' => [ 'shape' => 'String', ], 'deviceType' => [ 'shape' => 'String', ], ], ], 'InferenceAcceleratorOverrides' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceAcceleratorOverride', ], ], 'InferenceAccelerators' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceAccelerator', ], ], 'InstanceHealthCheckResult' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'InstanceHealthCheckType', ], 'status' => [ 'shape' => 'InstanceHealthCheckState', ], 'lastUpdated' => [ 'shape' => 'Timestamp', ], 'lastStatusChange' => [ 'shape' => 'Timestamp', ], ], ], 'InstanceHealthCheckResultList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceHealthCheckResult', ], ], 'InstanceHealthCheckState' => [ 'type' => 'string', 'enum' => [ 'OK', 'IMPAIRED', 'INSUFFICIENT_DATA', 'INITIALIZING', ], ], 'InstanceHealthCheckType' => [ 'type' => 'string', 'enum' => [ 'CONTAINER_RUNTIME', ], ], 'Integer' => [ 'type' => 'integer', ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'IpcMode' => [ 'type' => 'string', 'enum' => [ 'host', 'task', 'none', ], ], 'KernelCapabilities' => [ 'type' => 'structure', 'members' => [ 'add' => [ 'shape' => 'StringList', ], 'drop' => [ 'shape' => 'StringList', ], ], ], 'KeyValuePair' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'LaunchType' => [ 'type' => 'string', 'enum' => [ 'EC2', 'FARGATE', 'EXTERNAL', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'LinuxParameters' => [ 'type' => 'structure', 'members' => [ 'capabilities' => [ 'shape' => 'KernelCapabilities', ], 'devices' => [ 'shape' => 'DevicesList', ], 'initProcessEnabled' => [ 'shape' => 'BoxedBoolean', ], 'sharedMemorySize' => [ 'shape' => 'BoxedInteger', ], 'tmpfs' => [ 'shape' => 'TmpfsList', ], 'maxSwap' => [ 'shape' => 'BoxedInteger', ], 'swappiness' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListAccountSettingsRequest' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], 'effectiveSettings' => [ 'shape' => 'Boolean', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'Integer', ], ], ], 'ListAccountSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'settings' => [ 'shape' => 'Settings', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'targetType', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'targetType' => [ 'shape' => 'TargetType', ], 'attributeName' => [ 'shape' => 'String', ], 'attributeValue' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListClustersRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListClustersResponse' => [ 'type' => 'structure', 'members' => [ 'clusterArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListContainerInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'filter' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'status' => [ 'shape' => 'ContainerInstanceStatus', ], ], ], 'ListContainerInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstanceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListServicesByNamespaceRequest' => [ 'type' => 'structure', 'required' => [ 'namespace', ], 'members' => [ 'namespace' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListServicesByNamespaceResponse' => [ 'type' => 'structure', 'members' => [ 'serviceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListServicesRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], ], ], 'ListServicesResponse' => [ 'type' => 'structure', 'members' => [ 'serviceArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'Tags', ], ], ], 'ListTaskDefinitionFamiliesRequest' => [ 'type' => 'structure', 'members' => [ 'familyPrefix' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'TaskDefinitionFamilyStatus', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListTaskDefinitionFamiliesResponse' => [ 'type' => 'structure', 'members' => [ 'families' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTaskDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'familyPrefix' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'TaskDefinitionStatus', ], 'sort' => [ 'shape' => 'SortOrder', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], ], ], 'ListTaskDefinitionsResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinitionArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListTasksRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], 'family' => [ 'shape' => 'String', ], 'nextToken' => [ 'shape' => 'String', ], 'maxResults' => [ 'shape' => 'BoxedInteger', ], 'startedBy' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'desiredStatus' => [ 'shape' => 'DesiredStatus', ], 'launchType' => [ 'shape' => 'LaunchType', ], ], ], 'ListTasksResponse' => [ 'type' => 'structure', 'members' => [ 'taskArns' => [ 'shape' => 'StringList', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'LoadBalancer' => [ 'type' => 'structure', 'members' => [ 'targetGroupArn' => [ 'shape' => 'String', ], 'loadBalancerName' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], ], ], 'LoadBalancers' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancer', ], ], 'LogConfiguration' => [ 'type' => 'structure', 'required' => [ 'logDriver', ], 'members' => [ 'logDriver' => [ 'shape' => 'LogDriver', ], 'options' => [ 'shape' => 'LogConfigurationOptionsMap', ], 'secretOptions' => [ 'shape' => 'SecretList', ], ], ], 'LogConfigurationOptionsMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'LogDriver' => [ 'type' => 'string', 'enum' => [ 'json-file', 'syslog', 'journald', 'gelf', 'fluentd', 'awslogs', 'splunk', 'awsfirelens', ], ], 'Long' => [ 'type' => 'long', ], 'ManagedAgent' => [ 'type' => 'structure', 'members' => [ 'lastStartedAt' => [ 'shape' => 'Timestamp', ], 'name' => [ 'shape' => 'ManagedAgentName', ], 'reason' => [ 'shape' => 'String', ], 'lastStatus' => [ 'shape' => 'String', ], ], ], 'ManagedAgentName' => [ 'type' => 'string', 'enum' => [ 'ExecuteCommandAgent', ], ], 'ManagedAgentStateChange' => [ 'type' => 'structure', 'required' => [ 'containerName', 'managedAgentName', 'status', ], 'members' => [ 'containerName' => [ 'shape' => 'String', ], 'managedAgentName' => [ 'shape' => 'ManagedAgentName', ], 'status' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], ], ], 'ManagedAgentStateChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedAgentStateChange', ], ], 'ManagedAgents' => [ 'type' => 'list', 'member' => [ 'shape' => 'ManagedAgent', ], ], 'ManagedDraining' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'ManagedScaling' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'ManagedScalingStatus', ], 'targetCapacity' => [ 'shape' => 'ManagedScalingTargetCapacity', ], 'minimumScalingStepSize' => [ 'shape' => 'ManagedScalingStepSize', ], 'maximumScalingStepSize' => [ 'shape' => 'ManagedScalingStepSize', ], 'instanceWarmupPeriod' => [ 'shape' => 'ManagedScalingInstanceWarmupPeriod', ], ], ], 'ManagedScalingInstanceWarmupPeriod' => [ 'type' => 'integer', 'max' => 10000, 'min' => 0, ], 'ManagedScalingStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'ManagedScalingStepSize' => [ 'type' => 'integer', 'max' => 10000, 'min' => 1, ], 'ManagedScalingTargetCapacity' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ManagedTerminationProtection' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'MissingVersionException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'MountPoint' => [ 'type' => 'structure', 'members' => [ 'sourceVolume' => [ 'shape' => 'String', ], 'containerPath' => [ 'shape' => 'String', ], 'readOnly' => [ 'shape' => 'BoxedBoolean', ], ], ], 'MountPointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MountPoint', ], ], 'NamespaceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'NetworkBinding' => [ 'type' => 'structure', 'members' => [ 'bindIP' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], 'hostPort' => [ 'shape' => 'BoxedInteger', ], 'protocol' => [ 'shape' => 'TransportProtocol', ], 'containerPortRange' => [ 'shape' => 'String', ], 'hostPortRange' => [ 'shape' => 'String', ], ], ], 'NetworkBindings' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkBinding', ], ], 'NetworkConfiguration' => [ 'type' => 'structure', 'members' => [ 'awsvpcConfiguration' => [ 'shape' => 'AwsVpcConfiguration', ], ], ], 'NetworkInterface' => [ 'type' => 'structure', 'members' => [ 'attachmentId' => [ 'shape' => 'String', ], 'privateIpv4Address' => [ 'shape' => 'String', ], 'ipv6Address' => [ 'shape' => 'String', ], ], ], 'NetworkInterfaces' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkInterface', ], ], 'NetworkMode' => [ 'type' => 'string', 'enum' => [ 'bridge', 'host', 'awsvpc', 'none', ], ], 'NoUpdateAvailableException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OSFamily' => [ 'type' => 'string', 'enum' => [ 'WINDOWS_SERVER_2019_FULL', 'WINDOWS_SERVER_2019_CORE', 'WINDOWS_SERVER_2016_FULL', 'WINDOWS_SERVER_2004_CORE', 'WINDOWS_SERVER_2022_CORE', 'WINDOWS_SERVER_2022_FULL', 'WINDOWS_SERVER_20H2_CORE', 'LINUX', ], ], 'PidMode' => [ 'type' => 'string', 'enum' => [ 'host', 'task', ], ], 'PlacementConstraint' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'PlacementConstraintType', ], 'expression' => [ 'shape' => 'String', ], ], ], 'PlacementConstraintType' => [ 'type' => 'string', 'enum' => [ 'distinctInstance', 'memberOf', ], ], 'PlacementConstraints' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacementConstraint', ], ], 'PlacementStrategies' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacementStrategy', ], ], 'PlacementStrategy' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'PlacementStrategyType', ], 'field' => [ 'shape' => 'String', ], ], ], 'PlacementStrategyType' => [ 'type' => 'string', 'enum' => [ 'random', 'spread', 'binpack', ], ], 'PlatformDevice' => [ 'type' => 'structure', 'required' => [ 'id', 'type', ], 'members' => [ 'id' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'PlatformDeviceType', ], ], ], 'PlatformDeviceType' => [ 'type' => 'string', 'enum' => [ 'GPU', ], ], 'PlatformDevices' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlatformDevice', ], ], 'PlatformTaskDefinitionIncompatibilityException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PlatformUnknownException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'PortMapping' => [ 'type' => 'structure', 'members' => [ 'containerPort' => [ 'shape' => 'BoxedInteger', ], 'hostPort' => [ 'shape' => 'BoxedInteger', ], 'protocol' => [ 'shape' => 'TransportProtocol', ], 'name' => [ 'shape' => 'String', ], 'appProtocol' => [ 'shape' => 'ApplicationProtocol', ], 'containerPortRange' => [ 'shape' => 'String', ], ], ], 'PortMappingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortMapping', ], ], 'PortNumber' => [ 'type' => 'integer', 'box' => true, 'max' => 65535, 'min' => 0, ], 'PropagateTags' => [ 'type' => 'string', 'enum' => [ 'TASK_DEFINITION', 'SERVICE', 'NONE', ], ], 'ProtectedTask' => [ 'type' => 'structure', 'members' => [ 'taskArn' => [ 'shape' => 'String', ], 'protectionEnabled' => [ 'shape' => 'Boolean', ], 'expirationDate' => [ 'shape' => 'Timestamp', ], ], ], 'ProtectedTasks' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProtectedTask', ], ], 'ProxyConfiguration' => [ 'type' => 'structure', 'required' => [ 'containerName', ], 'members' => [ 'type' => [ 'shape' => 'ProxyConfigurationType', ], 'containerName' => [ 'shape' => 'String', ], 'properties' => [ 'shape' => 'ProxyConfigurationProperties', ], ], ], 'ProxyConfigurationProperties' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'ProxyConfigurationType' => [ 'type' => 'string', 'enum' => [ 'APPMESH', ], ], 'PutAccountSettingDefaultRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'value', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], ], ], 'PutAccountSettingDefaultResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'PutAccountSettingRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'value', ], 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], ], ], 'PutAccountSettingResponse' => [ 'type' => 'structure', 'members' => [ 'setting' => [ 'shape' => 'Setting', ], ], ], 'PutAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'attributes', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'PutAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'attributes' => [ 'shape' => 'Attributes', ], ], ], 'PutClusterCapacityProvidersRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'capacityProviders', 'defaultCapacityProviderStrategy', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'capacityProviders' => [ 'shape' => 'StringList', ], 'defaultCapacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], ], ], 'PutClusterCapacityProvidersResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'RegisterContainerInstanceRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'instanceIdentityDocument' => [ 'shape' => 'String', ], 'instanceIdentityDocumentSignature' => [ 'shape' => 'String', ], 'totalResources' => [ 'shape' => 'Resources', ], 'versionInfo' => [ 'shape' => 'VersionInfo', ], 'containerInstanceArn' => [ 'shape' => 'String', ], 'attributes' => [ 'shape' => 'Attributes', ], 'platformDevices' => [ 'shape' => 'PlatformDevices', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'RegisterContainerInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'RegisterTaskDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'family', 'containerDefinitions', ], 'members' => [ 'family' => [ 'shape' => 'String', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'executionRoleArn' => [ 'shape' => 'String', ], 'networkMode' => [ 'shape' => 'NetworkMode', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'volumes' => [ 'shape' => 'VolumeList', ], 'placementConstraints' => [ 'shape' => 'TaskDefinitionPlacementConstraints', ], 'requiresCompatibilities' => [ 'shape' => 'CompatibilityList', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], 'pidMode' => [ 'shape' => 'PidMode', ], 'ipcMode' => [ 'shape' => 'IpcMode', ], 'proxyConfiguration' => [ 'shape' => 'ProxyConfiguration', ], 'inferenceAccelerators' => [ 'shape' => 'InferenceAccelerators', ], 'ephemeralStorage' => [ 'shape' => 'EphemeralStorage', ], 'runtimePlatform' => [ 'shape' => 'RuntimePlatform', ], ], ], 'RegisterTaskDefinitionResponse' => [ 'type' => 'structure', 'members' => [ 'taskDefinition' => [ 'shape' => 'TaskDefinition', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'RepositoryCredentials' => [ 'type' => 'structure', 'required' => [ 'credentialsParameter', ], 'members' => [ 'credentialsParameter' => [ 'shape' => 'String', ], ], ], 'RequiresAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'doubleValue' => [ 'shape' => 'Double', ], 'longValue' => [ 'shape' => 'Long', ], 'integerValue' => [ 'shape' => 'Integer', ], 'stringSetValue' => [ 'shape' => 'StringList', ], ], ], 'ResourceIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceRequirement' => [ 'type' => 'structure', 'required' => [ 'value', 'type', ], 'members' => [ 'value' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'ResourceType', ], ], ], 'ResourceRequirements' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceRequirement', ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'GPU', 'InferenceAccelerator', ], ], 'Resources' => [ 'type' => 'list', 'member' => [ 'shape' => 'Resource', ], ], 'RunTaskRequest' => [ 'type' => 'structure', 'required' => [ 'taskDefinition', ], 'members' => [ 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'cluster' => [ 'shape' => 'String', ], 'count' => [ 'shape' => 'BoxedInteger', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'enableExecuteCommand' => [ 'shape' => 'Boolean', ], 'group' => [ 'shape' => 'String', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'platformVersion' => [ 'shape' => 'String', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], 'referenceId' => [ 'shape' => 'String', ], 'startedBy' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], 'taskDefinition' => [ 'shape' => 'String', ], 'clientToken' => [ 'shape' => 'String', 'idempotencyToken' => true, ], ], ], 'RunTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'RuntimePlatform' => [ 'type' => 'structure', 'members' => [ 'cpuArchitecture' => [ 'shape' => 'CPUArchitecture', ], 'operatingSystemFamily' => [ 'shape' => 'OSFamily', ], ], ], 'Scale' => [ 'type' => 'structure', 'members' => [ 'value' => [ 'shape' => 'Double', ], 'unit' => [ 'shape' => 'ScaleUnit', ], ], ], 'ScaleUnit' => [ 'type' => 'string', 'enum' => [ 'PERCENT', ], ], 'SchedulingStrategy' => [ 'type' => 'string', 'enum' => [ 'REPLICA', 'DAEMON', ], ], 'Scope' => [ 'type' => 'string', 'enum' => [ 'task', 'shared', ], ], 'Secret' => [ 'type' => 'structure', 'required' => [ 'name', 'valueFrom', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'valueFrom' => [ 'shape' => 'String', ], ], ], 'SecretList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Secret', ], ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'ServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, 'fault' => true, ], 'Service' => [ 'type' => 'structure', 'members' => [ 'serviceArn' => [ 'shape' => 'String', ], 'serviceName' => [ 'shape' => 'String', ], 'clusterArn' => [ 'shape' => 'String', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'status' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'platformVersion' => [ 'shape' => 'String', ], 'platformFamily' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'taskSets' => [ 'shape' => 'TaskSets', ], 'deployments' => [ 'shape' => 'Deployments', ], 'roleArn' => [ 'shape' => 'String', ], 'events' => [ 'shape' => 'ServiceEvents', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], 'schedulingStrategy' => [ 'shape' => 'SchedulingStrategy', ], 'deploymentController' => [ 'shape' => 'DeploymentController', ], 'tags' => [ 'shape' => 'Tags', ], 'createdBy' => [ 'shape' => 'String', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], 'enableExecuteCommand' => [ 'shape' => 'Boolean', ], ], ], 'ServiceConnectClientAlias' => [ 'type' => 'structure', 'required' => [ 'port', ], 'members' => [ 'port' => [ 'shape' => 'PortNumber', ], 'dnsName' => [ 'shape' => 'String', ], ], ], 'ServiceConnectClientAliasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceConnectClientAlias', ], ], 'ServiceConnectConfiguration' => [ 'type' => 'structure', 'required' => [ 'enabled', ], 'members' => [ 'enabled' => [ 'shape' => 'Boolean', ], 'namespace' => [ 'shape' => 'String', ], 'services' => [ 'shape' => 'ServiceConnectServiceList', ], 'logConfiguration' => [ 'shape' => 'LogConfiguration', ], ], ], 'ServiceConnectService' => [ 'type' => 'structure', 'required' => [ 'portName', ], 'members' => [ 'portName' => [ 'shape' => 'String', ], 'discoveryName' => [ 'shape' => 'String', ], 'clientAliases' => [ 'shape' => 'ServiceConnectClientAliasList', ], 'ingressPortOverride' => [ 'shape' => 'PortNumber', ], ], ], 'ServiceConnectServiceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceConnectService', ], ], 'ServiceConnectServiceResource' => [ 'type' => 'structure', 'members' => [ 'discoveryName' => [ 'shape' => 'String', ], 'discoveryArn' => [ 'shape' => 'String', ], ], ], 'ServiceConnectServiceResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceConnectServiceResource', ], ], 'ServiceEvent' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'message' => [ 'shape' => 'String', ], ], ], 'ServiceEvents' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceEvent', ], ], 'ServiceField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'ServiceFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceField', ], ], 'ServiceNotActiveException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ServiceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ServiceRegistries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceRegistry', ], ], 'ServiceRegistry' => [ 'type' => 'structure', 'members' => [ 'registryArn' => [ 'shape' => 'String', ], 'port' => [ 'shape' => 'BoxedInteger', ], 'containerName' => [ 'shape' => 'String', ], 'containerPort' => [ 'shape' => 'BoxedInteger', ], ], ], 'Services' => [ 'type' => 'list', 'member' => [ 'shape' => 'Service', ], ], 'Session' => [ 'type' => 'structure', 'members' => [ 'sessionId' => [ 'shape' => 'String', ], 'streamUrl' => [ 'shape' => 'String', ], 'tokenValue' => [ 'shape' => 'SensitiveString', ], ], ], 'Setting' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'SettingName', ], 'value' => [ 'shape' => 'String', ], 'principalArn' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'SettingType', ], ], ], 'SettingName' => [ 'type' => 'string', 'enum' => [ 'serviceLongArnFormat', 'taskLongArnFormat', 'containerInstanceLongArnFormat', 'awsvpcTrunking', 'containerInsights', 'fargateFIPSMode', 'tagResourceAuthorization', 'fargateTaskRetirementWaitPeriod', 'guardDutyActivate', ], ], 'SettingType' => [ 'type' => 'string', 'enum' => [ 'user', 'aws_managed', ], ], 'Settings' => [ 'type' => 'list', 'member' => [ 'shape' => 'Setting', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASC', 'DESC', ], ], 'StabilityStatus' => [ 'type' => 'string', 'enum' => [ 'STEADY_STATE', 'STABILIZING', ], ], 'StartTaskRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', 'taskDefinition', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'enableECSManagedTags' => [ 'shape' => 'Boolean', ], 'enableExecuteCommand' => [ 'shape' => 'Boolean', ], 'group' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], 'referenceId' => [ 'shape' => 'String', ], 'startedBy' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], 'taskDefinition' => [ 'shape' => 'String', ], ], ], 'StartTaskResponse' => [ 'type' => 'structure', 'members' => [ 'tasks' => [ 'shape' => 'Tasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'Statistics' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValuePair', ], ], 'StopTaskRequest' => [ 'type' => 'structure', 'required' => [ 'task', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], ], ], 'StopTaskResponse' => [ 'type' => 'structure', 'members' => [ 'task' => [ 'shape' => 'Task', ], ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'StringMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'SubmitAttachmentStateChangesRequest' => [ 'type' => 'structure', 'required' => [ 'attachments', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'attachments' => [ 'shape' => 'AttachmentStateChanges', ], ], ], 'SubmitAttachmentStateChangesResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], 'SubmitContainerStateChangeRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'containerName' => [ 'shape' => 'String', ], 'runtimeId' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'exitCode' => [ 'shape' => 'BoxedInteger', ], 'reason' => [ 'shape' => 'String', ], 'networkBindings' => [ 'shape' => 'NetworkBindings', ], ], ], 'SubmitContainerStateChangeResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], 'SubmitTaskStateChangeRequest' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'task' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'String', ], 'containers' => [ 'shape' => 'ContainerStateChanges', ], 'attachments' => [ 'shape' => 'AttachmentStateChanges', ], 'managedAgents' => [ 'shape' => 'ManagedAgentStateChanges', ], 'pullStartedAt' => [ 'shape' => 'Timestamp', ], 'pullStoppedAt' => [ 'shape' => 'Timestamp', ], 'executionStoppedAt' => [ 'shape' => 'Timestamp', ], ], ], 'SubmitTaskStateChangeResponse' => [ 'type' => 'structure', 'members' => [ 'acknowledgment' => [ 'shape' => 'String', ], ], ], 'SystemControl' => [ 'type' => 'structure', 'members' => [ 'namespace' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'SystemControls' => [ 'type' => 'list', 'member' => [ 'shape' => 'SystemControl', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TargetNotConnectedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'TargetNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'TargetType' => [ 'type' => 'string', 'enum' => [ 'container-instance', ], ], 'Task' => [ 'type' => 'structure', 'members' => [ 'attachments' => [ 'shape' => 'Attachments', ], 'attributes' => [ 'shape' => 'Attributes', ], 'availabilityZone' => [ 'shape' => 'String', ], 'capacityProviderName' => [ 'shape' => 'String', ], 'clusterArn' => [ 'shape' => 'String', ], 'connectivity' => [ 'shape' => 'Connectivity', ], 'connectivityAt' => [ 'shape' => 'Timestamp', ], 'containerInstanceArn' => [ 'shape' => 'String', ], 'containers' => [ 'shape' => 'Containers', ], 'cpu' => [ 'shape' => 'String', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'desiredStatus' => [ 'shape' => 'String', ], 'enableExecuteCommand' => [ 'shape' => 'Boolean', ], 'executionStoppedAt' => [ 'shape' => 'Timestamp', ], 'group' => [ 'shape' => 'String', ], 'healthStatus' => [ 'shape' => 'HealthStatus', ], 'inferenceAccelerators' => [ 'shape' => 'InferenceAccelerators', ], 'lastStatus' => [ 'shape' => 'String', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'memory' => [ 'shape' => 'String', ], 'overrides' => [ 'shape' => 'TaskOverride', ], 'platformVersion' => [ 'shape' => 'String', ], 'platformFamily' => [ 'shape' => 'String', ], 'pullStartedAt' => [ 'shape' => 'Timestamp', ], 'pullStoppedAt' => [ 'shape' => 'Timestamp', ], 'startedAt' => [ 'shape' => 'Timestamp', ], 'startedBy' => [ 'shape' => 'String', ], 'stopCode' => [ 'shape' => 'TaskStopCode', ], 'stoppedAt' => [ 'shape' => 'Timestamp', ], 'stoppedReason' => [ 'shape' => 'String', ], 'stoppingAt' => [ 'shape' => 'Timestamp', ], 'tags' => [ 'shape' => 'Tags', ], 'taskArn' => [ 'shape' => 'String', ], 'taskDefinitionArn' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'Long', ], 'ephemeralStorage' => [ 'shape' => 'EphemeralStorage', ], ], ], 'TaskDefinition' => [ 'type' => 'structure', 'members' => [ 'taskDefinitionArn' => [ 'shape' => 'String', ], 'containerDefinitions' => [ 'shape' => 'ContainerDefinitions', ], 'family' => [ 'shape' => 'String', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'executionRoleArn' => [ 'shape' => 'String', ], 'networkMode' => [ 'shape' => 'NetworkMode', ], 'revision' => [ 'shape' => 'Integer', ], 'volumes' => [ 'shape' => 'VolumeList', ], 'status' => [ 'shape' => 'TaskDefinitionStatus', ], 'requiresAttributes' => [ 'shape' => 'RequiresAttributes', ], 'placementConstraints' => [ 'shape' => 'TaskDefinitionPlacementConstraints', ], 'compatibilities' => [ 'shape' => 'CompatibilityList', ], 'runtimePlatform' => [ 'shape' => 'RuntimePlatform', ], 'requiresCompatibilities' => [ 'shape' => 'CompatibilityList', ], 'cpu' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'inferenceAccelerators' => [ 'shape' => 'InferenceAccelerators', ], 'pidMode' => [ 'shape' => 'PidMode', ], 'ipcMode' => [ 'shape' => 'IpcMode', ], 'proxyConfiguration' => [ 'shape' => 'ProxyConfiguration', ], 'registeredAt' => [ 'shape' => 'Timestamp', ], 'deregisteredAt' => [ 'shape' => 'Timestamp', ], 'registeredBy' => [ 'shape' => 'String', ], 'ephemeralStorage' => [ 'shape' => 'EphemeralStorage', ], ], ], 'TaskDefinitionFamilyStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'ALL', ], ], 'TaskDefinitionField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'TaskDefinitionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskDefinitionField', ], ], 'TaskDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskDefinition', ], ], 'TaskDefinitionPlacementConstraint' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'TaskDefinitionPlacementConstraintType', ], 'expression' => [ 'shape' => 'String', ], ], ], 'TaskDefinitionPlacementConstraintType' => [ 'type' => 'string', 'enum' => [ 'memberOf', ], ], 'TaskDefinitionPlacementConstraints' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskDefinitionPlacementConstraint', ], ], 'TaskDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'DELETE_IN_PROGRESS', ], ], 'TaskField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'TaskFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskField', ], ], 'TaskOverride' => [ 'type' => 'structure', 'members' => [ 'containerOverrides' => [ 'shape' => 'ContainerOverrides', ], 'cpu' => [ 'shape' => 'String', ], 'inferenceAcceleratorOverrides' => [ 'shape' => 'InferenceAcceleratorOverrides', ], 'executionRoleArn' => [ 'shape' => 'String', ], 'memory' => [ 'shape' => 'String', ], 'taskRoleArn' => [ 'shape' => 'String', ], 'ephemeralStorage' => [ 'shape' => 'EphemeralStorage', ], ], ], 'TaskSet' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'taskSetArn' => [ 'shape' => 'String', ], 'serviceArn' => [ 'shape' => 'String', ], 'clusterArn' => [ 'shape' => 'String', ], 'startedBy' => [ 'shape' => 'String', ], 'externalId' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'String', ], 'taskDefinition' => [ 'shape' => 'String', ], 'computedDesiredCount' => [ 'shape' => 'Integer', ], 'pendingCount' => [ 'shape' => 'Integer', ], 'runningCount' => [ 'shape' => 'Integer', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'launchType' => [ 'shape' => 'LaunchType', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'platformVersion' => [ 'shape' => 'String', ], 'platformFamily' => [ 'shape' => 'String', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'scale' => [ 'shape' => 'Scale', ], 'stabilityStatus' => [ 'shape' => 'StabilityStatus', ], 'stabilityStatusAt' => [ 'shape' => 'Timestamp', ], 'tags' => [ 'shape' => 'Tags', ], ], ], 'TaskSetField' => [ 'type' => 'string', 'enum' => [ 'TAGS', ], ], 'TaskSetFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskSetField', ], ], 'TaskSetNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'TaskSets' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskSet', ], ], 'TaskStopCode' => [ 'type' => 'string', 'enum' => [ 'TaskFailedToStart', 'EssentialContainerExited', 'UserInitiated', 'ServiceSchedulerInitiated', 'SpotInterruption', 'TerminationNotice', ], ], 'Tasks' => [ 'type' => 'list', 'member' => [ 'shape' => 'Task', ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'Tmpfs' => [ 'type' => 'structure', 'required' => [ 'containerPath', 'size', ], 'members' => [ 'containerPath' => [ 'shape' => 'String', ], 'size' => [ 'shape' => 'Integer', ], 'mountOptions' => [ 'shape' => 'StringList', ], ], ], 'TmpfsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tmpfs', ], ], 'TransportProtocol' => [ 'type' => 'string', 'enum' => [ 'tcp', 'udp', ], ], 'Ulimit' => [ 'type' => 'structure', 'required' => [ 'name', 'softLimit', 'hardLimit', ], 'members' => [ 'name' => [ 'shape' => 'UlimitName', ], 'softLimit' => [ 'shape' => 'Integer', ], 'hardLimit' => [ 'shape' => 'Integer', ], ], ], 'UlimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Ulimit', ], ], 'UlimitName' => [ 'type' => 'string', 'enum' => [ 'core', 'cpu', 'data', 'fsize', 'locks', 'memlock', 'msgqueue', 'nice', 'nofile', 'nproc', 'rss', 'rtprio', 'rttime', 'sigpending', 'stack', ], ], 'UnsupportedFeatureException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', ], 'tagKeys' => [ 'shape' => 'TagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateCapacityProviderRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'autoScalingGroupProvider', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'autoScalingGroupProvider' => [ 'shape' => 'AutoScalingGroupProviderUpdate', ], ], ], 'UpdateCapacityProviderResponse' => [ 'type' => 'structure', 'members' => [ 'capacityProvider' => [ 'shape' => 'CapacityProvider', ], ], ], 'UpdateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'settings' => [ 'shape' => 'ClusterSettings', ], 'configuration' => [ 'shape' => 'ClusterConfiguration', ], 'serviceConnectDefaults' => [ 'shape' => 'ClusterServiceConnectDefaultsRequest', ], ], ], 'UpdateClusterResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'UpdateClusterSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'settings', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'settings' => [ 'shape' => 'ClusterSettings', ], ], ], 'UpdateClusterSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'cluster' => [ 'shape' => 'Cluster', ], ], ], 'UpdateContainerAgentRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstance', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstance' => [ 'shape' => 'String', ], ], ], 'UpdateContainerAgentResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstance' => [ 'shape' => 'ContainerInstance', ], ], ], 'UpdateContainerInstancesStateRequest' => [ 'type' => 'structure', 'required' => [ 'containerInstances', 'status', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'containerInstances' => [ 'shape' => 'StringList', ], 'status' => [ 'shape' => 'ContainerInstanceStatus', ], ], ], 'UpdateContainerInstancesStateResponse' => [ 'type' => 'structure', 'members' => [ 'containerInstances' => [ 'shape' => 'ContainerInstances', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'UpdateInProgressException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UpdateServicePrimaryTaskSetRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'service', 'primaryTaskSet', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'primaryTaskSet' => [ 'shape' => 'String', ], ], ], 'UpdateServicePrimaryTaskSetResponse' => [ 'type' => 'structure', 'members' => [ 'taskSet' => [ 'shape' => 'TaskSet', ], ], ], 'UpdateServiceRequest' => [ 'type' => 'structure', 'required' => [ 'service', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'desiredCount' => [ 'shape' => 'BoxedInteger', ], 'taskDefinition' => [ 'shape' => 'String', ], 'capacityProviderStrategy' => [ 'shape' => 'CapacityProviderStrategy', ], 'deploymentConfiguration' => [ 'shape' => 'DeploymentConfiguration', ], 'networkConfiguration' => [ 'shape' => 'NetworkConfiguration', ], 'placementConstraints' => [ 'shape' => 'PlacementConstraints', ], 'placementStrategy' => [ 'shape' => 'PlacementStrategies', ], 'platformVersion' => [ 'shape' => 'String', ], 'forceNewDeployment' => [ 'shape' => 'Boolean', ], 'healthCheckGracePeriodSeconds' => [ 'shape' => 'BoxedInteger', ], 'enableExecuteCommand' => [ 'shape' => 'BoxedBoolean', ], 'enableECSManagedTags' => [ 'shape' => 'BoxedBoolean', ], 'loadBalancers' => [ 'shape' => 'LoadBalancers', ], 'propagateTags' => [ 'shape' => 'PropagateTags', ], 'serviceRegistries' => [ 'shape' => 'ServiceRegistries', ], 'serviceConnectConfiguration' => [ 'shape' => 'ServiceConnectConfiguration', ], ], ], 'UpdateServiceResponse' => [ 'type' => 'structure', 'members' => [ 'service' => [ 'shape' => 'Service', ], ], ], 'UpdateTaskProtectionRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'tasks', 'protectionEnabled', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'tasks' => [ 'shape' => 'StringList', ], 'protectionEnabled' => [ 'shape' => 'Boolean', ], 'expiresInMinutes' => [ 'shape' => 'BoxedInteger', ], ], ], 'UpdateTaskProtectionResponse' => [ 'type' => 'structure', 'members' => [ 'protectedTasks' => [ 'shape' => 'ProtectedTasks', ], 'failures' => [ 'shape' => 'Failures', ], ], ], 'UpdateTaskSetRequest' => [ 'type' => 'structure', 'required' => [ 'cluster', 'service', 'taskSet', 'scale', ], 'members' => [ 'cluster' => [ 'shape' => 'String', ], 'service' => [ 'shape' => 'String', ], 'taskSet' => [ 'shape' => 'String', ], 'scale' => [ 'shape' => 'Scale', ], ], ], 'UpdateTaskSetResponse' => [ 'type' => 'structure', 'members' => [ 'taskSet' => [ 'shape' => 'TaskSet', ], ], ], 'VersionInfo' => [ 'type' => 'structure', 'members' => [ 'agentVersion' => [ 'shape' => 'String', ], 'agentHash' => [ 'shape' => 'String', ], 'dockerVersion' => [ 'shape' => 'String', ], ], ], 'Volume' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'String', ], 'host' => [ 'shape' => 'HostVolumeProperties', ], 'dockerVolumeConfiguration' => [ 'shape' => 'DockerVolumeConfiguration', ], 'efsVolumeConfiguration' => [ 'shape' => 'EFSVolumeConfiguration', ], 'fsxWindowsFileServerVolumeConfiguration' => [ 'shape' => 'FSxWindowsFileServerVolumeConfiguration', ], ], ], 'VolumeFrom' => [ 'type' => 'structure', 'members' => [ 'sourceContainer' => [ 'shape' => 'String', ], 'readOnly' => [ 'shape' => 'BoxedBoolean', ], ], ], 'VolumeFromList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VolumeFrom', ], ], 'VolumeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Volume', ], ], ],]; diff --git a/src/data/ecs/2014-11-13/docs-2.json b/src/data/ecs/2014-11-13/docs-2.json index 04feb858f0..85e90f6ff2 100644 --- a/src/data/ecs/2014-11-13/docs-2.json +++ b/src/data/ecs/2014-11-13/docs-2.json @@ -5,7 +5,7 @@ "CreateCapacityProvider": "

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.

", "CreateCluster": "

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

", "CreateService": "

Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

There are two service scheduler strategies available:

  • REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

  • DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.

When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide.

", - "CreateTaskSet": "

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

", + "CreateTaskSet": "

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

You can create a maximum of 5 tasks sets for a deployment.

", "DeleteAccountSetting": "

Disables an account setting for a specified user, role, or the root user for an account.

", "DeleteAttributes": "

Deletes one or more custom attributes from an Amazon ECS resource.

", "DeleteCapacityProvider": "

Deletes the specified capacity provider.

The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.

Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

", @@ -1371,6 +1371,13 @@ "Container$managedAgents": "

The details of any Amazon ECS managed agents associated with the container.

" } }, + "ManagedDraining": { + "base": null, + "refs": { + "AutoScalingGroupProvider$managedDraining": "

The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.

The default is ENABLED.

", + "AutoScalingGroupProviderUpdate$managedDraining": "

The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.

The default is ENABLED.

" + } + }, "ManagedScaling": { "base": "

The managed scaling settings for the Auto Scaling group capacity provider.

When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.

If managed scaling is off, the user must manage the scaling of the Auto Scaling group.

", "refs": { @@ -2017,7 +2024,7 @@ "CapacityProvider$name": "

The name of the capacity provider.

", "CapacityProvider$updateStatusReason": "

The update status reason. This provides further details about the update status for the capacity provider.

", "CapacityProviderStrategyItem$capacityProvider": "

The short name of the capacity provider.

", - "ClientException$message": null, + "ClientException$message": "

Message that describes the cause of the exception.

", "Cluster$clusterArn": "

The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

", "Cluster$clusterName": "

A user-generated string that you use to identify your cluster.

", "Cluster$status": "

The status of the cluster. The following are the possible states that are returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

", @@ -2227,7 +2234,7 @@ "RunTaskRequest$clientToken": "

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.

", "Secret$name": "

The name of the secret.

", "Secret$valueFrom": "

The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.

If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

", - "ServerException$message": null, + "ServerException$message": "

Message that describes the cause of the exception.

", "Service$serviceArn": "

The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

", "Service$serviceName": "

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.

", "Service$clusterArn": "

The Amazon Resource Name (ARN) of the cluster that hosts the service.

", diff --git a/src/data/ecs/2014-11-13/docs-2.json.php b/src/data/ecs/2014-11-13/docs-2.json.php index 8434e57645..6a40a2d5cc 100644 --- a/src/data/ecs/2014-11-13/docs-2.json.php +++ b/src/data/ecs/2014-11-13/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon Elastic Container Service

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that\'s managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.

Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don\'t need to operate your own cluster management and configuration management systems. You also don\'t need to worry about scaling your management infrastructure.

', 'operations' => [ 'CreateCapacityProvider' => '

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.

', 'CreateCluster' => '

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn\'t have permissions to create the service-linked role, it isn\'t created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

', 'CreateService' => '

Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

Tasks for services that don\'t use a load balancer are considered healthy if they\'re in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they\'re in the RUNNING state and are reported as healthy by the load balancer.

There are two service scheduler strategies available:

  • REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

  • DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don\'t meet the placement constraints. When using this strategy, you don\'t need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they\'re in the RUNNING state, tasks for services that don\'t use a load balancer are considered healthy . If they\'re in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren\'t used. This is the case even if they\'re currently visible when describing your service.

When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren\'t controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide.

', 'CreateTaskSet' => '

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

', 'DeleteAccountSetting' => '

Disables an account setting for a specified user, role, or the root user for an account.

', 'DeleteAttributes' => '

Deletes one or more custom attributes from an Amazon ECS resource.

', 'DeleteCapacityProvider' => '

Deletes the specified capacity provider.

The FARGATE and FARGATE_SPOT capacity providers are reserved and can\'t be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.

Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service\'s capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren\'t associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

', 'DeleteCluster' => '

Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don\'t recommend that you rely on INACTIVE clusters persisting.

You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

', 'DeleteService' => '

Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you can\'t delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to either STOPPING or STOPPED status, the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.

If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.

', 'DeleteTaskDefinitions' => '

Deletes one or more task definitions.

You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.

When you delete a task definition revision, it is immediately transitions from the INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS task definition revision continue to run without disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision can still scale up or down by modifying the service\'s desired count.

You can\'t use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new services. You also can\'t update an existing service to reference a DELETE_IN_PROGRESS task definition revision.

A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and services have been terminated.

When you delete all INACTIVE task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.

', 'DeleteTaskSet' => '

Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

', 'DeregisterContainerInstance' => '

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it doesn\'t terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren\'t automatically deregistered when terminated).

', 'DeregisterTaskDefinition' => '

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service\'s desired count. If you want to delete a task definition revision, you must first deregister the task definition revision.

You can\'t use an INACTIVE task definition to run new tasks or create new services, and you can\'t update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.

At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future. We don\'t recommend that you rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.

', 'DescribeCapacityProviders' => '

Describes one or more of your capacity providers.

', 'DescribeClusters' => '

Describes one or more of your clusters.

', 'DescribeContainerInstances' => '

Describes one or more container instances. Returns metadata about each container instance requested.

', 'DescribeServices' => '

Describes the specified services running in your cluster.

', 'DescribeTaskDefinition' => '

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

You can only describe INACTIVE task definitions while an active task or service references them.

', 'DescribeTaskSets' => '

Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

', 'DescribeTasks' => '

Describes a specified task or tasks.

Currently, stopped tasks appear in the returned results for at least one hour.

If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.

', 'DiscoverPollEndpoint' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon ECS agent to poll for updates.

', 'ExecuteCommand' => '

Runs a command remotely on a container within a task.

If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an AccessDeniedException when there is a mismatch between the condition key value and the corresponding parameter value.

For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.

', 'GetTaskProtection' => '

Retrieves the protection status of tasks in an Amazon ECS service.

', 'ListAccountSettings' => '

Lists the account settings for a specified principal.

', 'ListAttributes' => '

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

', 'ListClusters' => '

Returns a list of existing clusters.

', 'ListContainerInstances' => '

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'ListServices' => '

Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.

', 'ListServicesByNamespace' => '

This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, ListServices can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'ListTagsForResource' => '

List the tags for an Amazon ECS resource.

', 'ListTaskDefinitionFamilies' => '

Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.

You can filter out task definition families that don\'t contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

', 'ListTaskDefinitions' => '

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

', 'ListTasks' => '

Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.

Recently stopped tasks might appear in the returned results.

', 'PutAccountSetting' => '

Modifies an account setting. Account settings are set on a per-Region basis.

If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.

When you specify serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.

When you specify awsvpcTrunking, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.

When you specify containerInsights, the default setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If containerInsights is turned on, any new clusters that are created will have Container Insights turned on unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.

Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide.

When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

', 'PutAccountSettingDefault' => '

Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.

', 'PutAttributes' => '

Create or update an attribute on an Amazon ECS resource. If the attribute doesn\'t exist, it\'s created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

', 'PutClusterCapacityProviders' => '

Modifies the available capacity providers and the default capacity provider strategy for a cluster.

You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it\'s not being used by any existing tasks.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster\'s default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining a default strategy.

', 'RegisterContainerInstance' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.

', 'RegisterTaskDefinition' => '

Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the policy that\'s associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

', 'RunTask' => '

Starts a new task using the specified task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.

To manage eventual consistency, you can do the following:

  • Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.

  • Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.

', 'StartTask' => '

Starts a new task from the specified task definition on the specified container instance or instances.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

', 'StopTask' => '

Stops a running task. Any tags associated with the task will be deleted.

When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.

The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

', 'SubmitAttachmentStateChanges' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that an attachment changed states.

', 'SubmitContainerStateChange' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a container changed states.

', 'SubmitTaskStateChange' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

', 'TagResource' => '

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren\'t specified in the request parameters, they aren\'t changed. When a resource is deleted, the tags that are associated with that resource are deleted as well.

', 'UntagResource' => '

Deletes specified tags from a resource.

', 'UpdateCapacityProvider' => '

Modifies the parameters for a capacity provider.

', 'UpdateCluster' => '

Updates the cluster.

', 'UpdateClusterSettings' => '

Modifies the settings to use for a cluster.

', 'UpdateContainerAgent' => '

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn\'t interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.

The UpdateContainerAgent API isn\'t supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This updates the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

Agent updates with the UpdateContainerAgent API operation do not apply to Windows container instances. We recommend that you launch new container instances to update the agent version in your Windows clusters.

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

', 'UpdateContainerInstancesState' => '

Modifies the status of an Amazon ECS container instance.

Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

A container instance can\'t be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service\'s deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can\'t remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they\'re in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they\'re in the RUNNING state and are reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can\'t start until the draining tasks have stopped.

Any PENDING or RUNNING tasks that do not belong to a service aren\'t affected. You must wait for them to finish or stop them manually.

A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.

When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.

', 'UpdateService' => '

Modifies the parameters of a service.

For services using the rolling update (ECS) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration.

For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference.

For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service\'s deployment configuration) to determine the deployment strategy.

If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you don\'t need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don\'t use a load balancer are considered healthy if they\'re in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they\'re in the RUNNING state and are reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout. After this, SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic.

  • Determine which of the container instances in your cluster can support your service\'s task definition. For example, they have the required CPU, memory, ports, and container instance attributes.

  • By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy.

    • Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.

    • Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

  • Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.

  • Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.

You must have a service-linked role when you update any of the following service properties:

  • loadBalancers,

  • serviceRegistries

For more information about the role see the CreateService request parameter role .

', 'UpdateServicePrimaryTaskSet' => '

Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

', 'UpdateTaskProtection' => '

Updates the protection status of a task. You can set protectionEnabled to true to protect your task from termination during scale-in events from Service Autoscaling or deployments.

Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the protectionEnabled property making the task eligible for termination by a subsequent scale-in event.

You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes (48 hours). To specify the custom expiration period, set the expiresInMinutes property. The expiresInMinutes property is always reset when you invoke this operation for a task that already has protectionEnabled set to true. You can keep extending the protection expiration period of a task by invoking this operation repeatedly.

To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .

This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation for a standalone task will result in an TASK_NOT_VALID failure. For more information, see API failure reasons.

If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.

', 'UpdateTaskSet' => '

Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

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

You don\'t have authorization to perform the requested action.

', 'refs' => [], ], 'AgentUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentUpdateStatus' => '

The status of the most recent agent update. If an update wasn\'t ever requested, this value is NULL.

', ], ], 'ApplicationProtocol' => [ 'base' => NULL, 'refs' => [ 'PortMapping$appProtocol' => '

The application protocol that\'s used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.

If you don\'t set a value for this parameter, then TCP is used. However, Amazon ECS doesn\'t add protocol-specific telemetry for TCP.

appProtocol is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', ], ], 'AssignPublicIp' => [ 'base' => NULL, 'refs' => [ 'AwsVpcConfiguration$assignPublicIp' => '

Whether the task\'s elastic network interface receives a public IP address. The default value is DISABLED.

', ], ], 'Attachment' => [ 'base' => '

An object representing a container instance or task attachment.

', 'refs' => [ 'Attachments$member' => NULL, ], ], 'AttachmentDetails' => [ 'base' => NULL, 'refs' => [ 'Attachment$details' => '

Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

', ], ], 'AttachmentStateChange' => [ 'base' => '

An object representing a change in state for a task attachment.

', 'refs' => [ 'AttachmentStateChanges$member' => NULL, ], ], 'AttachmentStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitAttachmentStateChangesRequest$attachments' => '

Any attachments associated with the state change request.

', 'SubmitTaskStateChangeRequest$attachments' => '

Any attachments associated with the state change request.

', ], ], 'Attachments' => [ 'base' => NULL, 'refs' => [ 'Cluster$attachments' => '

The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.

', 'ContainerInstance$attachments' => '

The resources attached to a container instance, such as an elastic network interface.

', 'Task$attachments' => '

The Elastic Network Adapter that\'s associated with the task if the task uses the awsvpc network mode.

', ], ], 'Attribute' => [ 'base' => '

An attribute is a name-value pair that\'s associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Attributes$member' => NULL, 'RequiresAttributes$member' => NULL, ], ], 'AttributeLimitExceededException' => [ 'base' => '

You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

', 'refs' => [], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attributes' => '

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

', 'DeleteAttributesRequest$attributes' => '

The attributes to delete from your resource. You can specify up to 10 attributes for each request. For custom attributes, specify the attribute name and target ID, but don\'t specify the value. If you specify the target ID using the short form, you must also specify the target type.

', 'DeleteAttributesResponse$attributes' => '

A list of attribute objects that were successfully deleted from your resource.

', 'ListAttributesResponse$attributes' => '

A list of attribute objects that meet the criteria of the request.

', 'PutAttributesRequest$attributes' => '

The attributes to apply to your resource. You can specify up to 10 custom attributes for each resource. You can specify up to 10 attributes in a single call.

', 'PutAttributesResponse$attributes' => '

The attributes applied to your resource.

', 'RegisterContainerInstanceRequest$attributes' => '

The container instance attributes that this container instance supports.

', 'Task$attributes' => '

The attributes of the task

', ], ], 'AutoScalingGroupProvider' => [ 'base' => '

The details of the Auto Scaling group for the capacity provider.

', 'refs' => [ 'CapacityProvider$autoScalingGroupProvider' => '

The Auto Scaling group settings for the capacity provider.

', 'CreateCapacityProviderRequest$autoScalingGroupProvider' => '

The details of the Auto Scaling group for the capacity provider.

', ], ], 'AutoScalingGroupProviderUpdate' => [ 'base' => '

The details of the Auto Scaling group capacity provider to update.

', 'refs' => [ 'UpdateCapacityProviderRequest$autoScalingGroupProvider' => '

An object that represent the parameters to update for the Auto Scaling group capacity provider.

', ], ], 'AwsVpcConfiguration' => [ 'base' => '

An object representing the networking details for a task or service.

', 'refs' => [ 'NetworkConfiguration$awsvpcConfiguration' => '

The VPC subnets and security groups that are associated with a task.

All specified subnets and security groups must be from the same VPC.

', ], ], 'BlockedException' => [ 'base' => '

Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentConnected' => '

This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.

', 'CreateServiceRequest$enableECSManagedTags' => '

Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide.

When you use Amazon ECS managed tags, you need to set the propagateTags request parameter.

', 'CreateServiceRequest$enableExecuteCommand' => '

Determines whether the execute command functionality is turned on for the service. If true, this enables execute command functionality on all containers in the service tasks.

', 'DeploymentAlarms$enable' => '

Determines whether to use the CloudWatch alarm option in the service deployment process.

', 'DeploymentAlarms$rollback' => '

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

', 'DeploymentCircuitBreaker$enable' => '

Determines whether to use the deployment circuit breaker logic for the service.

', 'DeploymentCircuitBreaker$rollback' => '

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

', 'ExecuteCommandLogConfiguration$cloudWatchEncryptionEnabled' => '

Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.

', 'ExecuteCommandLogConfiguration$s3EncryptionEnabled' => '

Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

', 'ExecuteCommandRequest$interactive' => '

Use this flag to run your command in interactive mode.

', 'ExecuteCommandResponse$interactive' => '

Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify true for this value.

', 'ListAccountSettingsRequest$effectiveSettings' => '

Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they\'re set. Otherwise, no account settings are returned.

', 'ProtectedTask$protectionEnabled' => '

The protection status of the task. If scale-in protection is on for a task, the value is true. Otherwise, it is false.

', 'RunTaskRequest$enableECSManagedTags' => '

Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'RunTaskRequest$enableExecuteCommand' => '

Determines whether to use the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

If true, then the task definition must have a task role, or you must provide one as an override.

', 'Service$enableECSManagedTags' => '

Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'Service$enableExecuteCommand' => '

Determines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.

', 'ServiceConnectConfiguration$enabled' => '

Specifies whether to use Service Connect with this service.

', 'StartTaskRequest$enableECSManagedTags' => '

Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'StartTaskRequest$enableExecuteCommand' => '

Whether or not the execute command functionality is turned on for the task. If true, this turns on the execute command functionality on all containers in the task.

', 'Task$enableExecuteCommand' => '

Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

', 'UpdateServiceRequest$forceNewDeployment' => '

Determines whether to force a new deployment of the service. By default, deployments aren\'t forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service\'s tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

', 'UpdateTaskProtectionRequest$protectionEnabled' => '

Specify true to mark a task for protection and false to unset protection, making it eligible for termination.

', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$essential' => '

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn\'t affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that\'s composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

', 'ContainerDefinition$disableNetworking' => '

When this parameter is true, networking is off within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$privileged' => '

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on Fargate.

', 'ContainerDefinition$readonlyRootFilesystem' => '

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$interactive' => '

When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.

', 'ContainerDefinition$pseudoTerminal' => '

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.

', 'DeleteServiceRequest$force' => '

If true, allows you to delete a service even if it wasn\'t scaled down to zero tasks. It\'s only necessary to use this if the service uses the REPLICA scheduling strategy.

', 'DeleteTaskSetRequest$force' => '

If true, you can delete a task set even if it hasn\'t been scaled down to zero.

', 'DeregisterContainerInstanceRequest$force' => '

Forces the container instance to be deregistered. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they\'re orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

', 'DockerVolumeConfiguration$autoprovision' => '

If this value is true, the Docker volume is created if it doesn\'t already exist.

This field is only used if the scope is shared.

', 'LinuxParameters$initProcessEnabled' => '

Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', 'MountPoint$readOnly' => '

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

', 'UpdateServiceRequest$enableExecuteCommand' => '

If true, this enables execute command functionality on all task containers.

If you do not want to override the value that was set when the service was created, you can set this to null when performing this action.

', 'UpdateServiceRequest$enableECSManagedTags' => '

Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

', 'VolumeFrom$readOnly' => '

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

', ], ], 'BoxedInteger' => [ 'base' => NULL, 'refs' => [ 'Container$exitCode' => '

The exit code returned from the container.

', 'ContainerDefinition$memory' => '

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don\'t specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don\'t specify less than 4 MiB of memory for your containers.

', 'ContainerDefinition$memoryReservation' => '

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don\'t specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don\'t specify less than 4 MiB of memory for your containers.

', 'ContainerDefinition$startTimeout' => '

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it doesn\'t reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a STOPPED state.

When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it\'s enforced independently from this start timeout value.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.

  • Windows platform version 1.0.0 or later.

For tasks using the EC2 launch type, your container instances require at least version 1.26.0 of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you\'re using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

The valid values are 2-120 seconds.

', 'ContainerDefinition$stopTimeout' => '

Time duration (in seconds) to wait before the container is forcefully killed if it doesn\'t exit normally on its own.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.

  • Windows platform version 1.0.0 or later.

The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.

For tasks that use the EC2 launch type, if the stopTimeout parameter isn\'t specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you\'re using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

The valid values are 2-120 seconds.

', 'ContainerOverride$cpu' => '

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

', 'ContainerOverride$memory' => '

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

', 'ContainerOverride$memoryReservation' => '

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

', 'ContainerStateChange$exitCode' => '

The exit code for the container, if the state change is a result of the container exiting.

', 'CreateServiceRequest$desiredCount' => '

The number of instantiations of the specified task definition to place and keep running in your service.

This is required if schedulingStrategy is REPLICA or isn\'t specified. If schedulingStrategy is DAEMON then this isn\'t required.

', 'CreateServiceRequest$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don\'t specify a health check grace period value, the default value of 0 is used.

If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in the task definition health check parameters. For more information, see Health check.

If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

', 'DeploymentConfiguration$maximumPercent' => '

If a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service\'s tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent value for a service using the REPLICA service scheduler is 200%.

If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

', 'DeploymentConfiguration$minimumHealthyPercent' => '

If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service\'s tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.

For services that do not use a load balancer, the following should be noted:

  • A service is considered healthy if all essential containers within the tasks in the service pass their health checks.

  • If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.

  • If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.

For services are that do use a load balancer, the following should be noted:

  • If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

  • If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

', 'DescribeCapacityProvidersRequest$maxResults' => '

The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

', 'EFSVolumeConfiguration$transitEncryptionPort' => '

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

', 'HealthCheck$interval' => '

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

', 'HealthCheck$timeout' => '

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

', 'HealthCheck$retries' => '

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

', 'HealthCheck$startPeriod' => '

The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the startPeriod is off.

If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

', 'LinuxParameters$sharedMemorySize' => '

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

', 'LinuxParameters$maxSwap' => '

The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.

If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.

If you\'re using tasks that use the Fargate launch type, the maxSwap parameter isn\'t supported.

If you\'re using tasks on Amazon Linux 2023 the swappiness parameter isn\'t supported.

', 'LinuxParameters$swappiness' => '

This allows you to tune a container\'s memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.

If you\'re using tasks that use the Fargate launch type, the swappiness parameter isn\'t supported.

If you\'re using tasks on Amazon Linux 2023 the swappiness parameter isn\'t supported.

', 'ListAttributesRequest$maxResults' => '

The maximum number of cluster results that ListAttributes returned in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

', 'ListClustersRequest$maxResults' => '

The maximum number of cluster results that ListClusters returned in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListClusters returns up to 100 results and a nextToken value if applicable.

', 'ListContainerInstancesRequest$maxResults' => '

The maximum number of container instance results that ListContainerInstances returned in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

', 'ListServicesByNamespaceRequest$maxResults' => '

The maximum number of service results that ListServicesByNamespace returns in paginated output. When this parameter is used, ListServicesByNamespace only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServicesByNamespace request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.

', 'ListServicesRequest$maxResults' => '

The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListServices returns up to 10 results and a nextToken value if applicable.

', 'ListTaskDefinitionFamiliesRequest$maxResults' => '

The maximum number of task definition family results that ListTaskDefinitionFamilies returned in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

', 'ListTaskDefinitionsRequest$maxResults' => '

The maximum number of task definition results that ListTaskDefinitions returned in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

', 'ListTasksRequest$maxResults' => '

The maximum number of task results that ListTasks returned in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListTasks returns up to 100 results and a nextToken value if applicable.

', 'LoadBalancer$containerPort' => '

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they\'re launched on must allow ingress traffic on the hostPort of the port mapping.

', 'NetworkBinding$containerPort' => '

The port number on the container that\'s used with the network binding.

', 'NetworkBinding$hostPort' => '

The port number on the host that\'s used with the network binding.

', 'PortMapping$containerPort' => '

The port number on the container that\'s bound to the user-specified or automatically assigned host port.

If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.

If you use containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

', 'PortMapping$hostPort' => '

The port number on the container instance to reserve for your container.

If you specify a containerPortRange, leave this field empty and the value of the hostPort is set as follows:

  • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.

  • For containers in a task with the bridge network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.

If you use containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

If you use containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren\'t included in the 100 reserved ports quota.

', 'RunTaskRequest$count' => '

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.

', 'Service$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

', 'ServiceRegistry$port' => '

The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

', 'ServiceRegistry$containerPort' => '

The port value to be used for your service discovery service. It\'s already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can\'t specify both.

', 'SubmitContainerStateChangeRequest$exitCode' => '

The exit code that\'s returned for the state change request.

', 'UpdateServiceRequest$desiredCount' => '

The number of instantiations of the task to place and keep running in your service.

', 'UpdateServiceRequest$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

', 'UpdateTaskProtectionRequest$expiresInMinutes' => '

If you set protectionEnabled to true, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, protectionEnabled will be reset to false.

If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).

', ], ], 'CPUArchitecture' => [ 'base' => NULL, 'refs' => [ 'RuntimePlatform$cpuArchitecture' => '

The CPU architecture.

You can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.

', ], ], 'CapacityProvider' => [ 'base' => '

The details for a capacity provider.

', 'refs' => [ 'CapacityProviders$member' => NULL, 'CreateCapacityProviderResponse$capacityProvider' => '

The full description of the new capacity provider.

', 'DeleteCapacityProviderResponse$capacityProvider' => '

The details of the capacity provider.

', 'UpdateCapacityProviderResponse$capacityProvider' => '

Details about the capacity provider.

', ], ], 'CapacityProviderField' => [ 'base' => NULL, 'refs' => [ 'CapacityProviderFieldList$member' => NULL, ], ], 'CapacityProviderFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeCapacityProvidersRequest$include' => '

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren\'t included in the response.

', ], ], 'CapacityProviderStatus' => [ 'base' => NULL, 'refs' => [ 'CapacityProvider$status' => '

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

', ], ], 'CapacityProviderStrategy' => [ 'base' => NULL, 'refs' => [ 'Cluster$defaultCapacityProviderStrategy' => '

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

', 'CreateClusterRequest$defaultCapacityProviderStrategy' => '

The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.

If a default capacity provider strategy isn\'t defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.

', 'CreateServiceRequest$capacityProviderStrategy' => '

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

', 'CreateTaskSetRequest$capacityProviderStrategy' => '

The capacity provider strategy to use for the task set.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

', 'Deployment$capacityProviderStrategy' => '

The capacity provider strategy that the deployment is using.

', 'PutClusterCapacityProvidersRequest$defaultCapacityProviderStrategy' => '

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

', 'RunTaskRequest$capacityProviderStrategy' => '

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

A capacity provider strategy may contain a maximum of 6 capacity providers.

', 'Service$capacityProviderStrategy' => '

The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

', 'TaskSet$capacityProviderStrategy' => '

The capacity provider strategy that are associated with the task set.

', 'UpdateServiceRequest$capacityProviderStrategy' => '

The capacity provider strategy to update the service to use.

if the service uses the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that\'s not the default capacity provider strategy, the service can\'t be updated to use the cluster\'s default capacity provider strategy.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

', ], ], 'CapacityProviderStrategyItem' => [ 'base' => '

The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask or CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.

Only capacity providers that are already associated with a cluster and have an ACTIVE or UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.

A capacity provider strategy may contain a maximum of 6 capacity providers.

', 'refs' => [ 'CapacityProviderStrategy$member' => NULL, ], ], 'CapacityProviderStrategyItemBase' => [ 'base' => NULL, 'refs' => [ 'CapacityProviderStrategyItem$base' => '

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

', ], ], 'CapacityProviderStrategyItemWeight' => [ 'base' => NULL, 'refs' => [ 'CapacityProviderStrategyItem$weight' => '

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can\'t be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that\'s run using capacityProviderA, four tasks would use capacityProviderB.

', ], ], 'CapacityProviderUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'CapacityProvider$updateStatus' => '

The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS

The capacity provider is in the process of being deleted.

DELETE_COMPLETE

The capacity provider was successfully deleted and has an INACTIVE status.

DELETE_FAILED

The capacity provider can\'t be deleted. The update status reason provides further details about why the delete failed.

', ], ], 'CapacityProviders' => [ 'base' => NULL, 'refs' => [ 'DescribeCapacityProvidersResponse$capacityProviders' => '

The list of capacity providers.

', ], ], 'ClientException' => [ 'base' => '

These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn\'t have permissions to use the action or resource. Or, it might be specifying an identifier that isn\'t valid.

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

A regional grouping of one or more container instances where you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$cluster' => '

The full description of your new cluster.

', 'DeleteClusterResponse$cluster' => '

The full description of the deleted cluster.

', 'PutClusterCapacityProvidersResponse$cluster' => '

Details about the cluster.

', 'UpdateClusterResponse$cluster' => '

Details about the cluster.

', 'UpdateClusterSettingsResponse$cluster' => '

Details about the cluster

', ], ], 'ClusterConfiguration' => [ 'base' => '

The execute command configuration for the cluster.

', 'refs' => [ 'Cluster$configuration' => '

The execute command configuration for the cluster.

', 'CreateClusterRequest$configuration' => '

The execute command configuration for the cluster.

', 'UpdateClusterRequest$configuration' => '

The execute command configuration for the cluster.

', ], ], 'ClusterContainsContainerInstancesException' => [ 'base' => '

You can\'t delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

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

You can\'t delete a cluster that contains services. First, update the service to reduce its desired task count to 0, and then delete the service. For more information, see UpdateService and DeleteService.

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

You can\'t delete a cluster that has active tasks.

', 'refs' => [], ], 'ClusterField' => [ 'base' => NULL, 'refs' => [ 'ClusterFieldList$member' => NULL, ], ], 'ClusterFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersRequest$include' => '

Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn\'t included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

If SETTINGS is specified, the settings for the cluster are included.

If CONFIGURATIONS is specified, the configuration for the cluster is included.

If STATISTICS is specified, the task and service count is included, separated by launch type.

If TAGS is specified, the metadata tags associated with the cluster are included.

', ], ], 'ClusterNotFoundException' => [ 'base' => '

The specified cluster wasn\'t found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

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

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Cluster$serviceConnectDefaults' => '

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ClusterServiceConnectDefaultsRequest' => [ 'base' => '

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'CreateClusterRequest$serviceConnectDefaults' => '

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'UpdateClusterRequest$serviceConnectDefaults' => '

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ClusterSetting' => [ 'base' => '

The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.

', 'refs' => [ 'ClusterSettings$member' => NULL, ], ], 'ClusterSettingName' => [ 'base' => NULL, 'refs' => [ 'ClusterSetting$name' => '

The name of the cluster setting. The value is containerInsights .

', ], ], 'ClusterSettings' => [ 'base' => NULL, 'refs' => [ 'Cluster$settings' => '

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster.

', 'CreateClusterRequest$settings' => '

The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

', 'UpdateClusterRequest$settings' => '

The cluster settings for your cluster.

', 'UpdateClusterSettingsRequest$settings' => '

The setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Currently, if you delete an existing cluster that does not have Container Insights turned on, and then create a new cluster with the same name with Container Insights tuned on, Container Insights will not actually be turned on. If you want to preserve the same name for your existing cluster and turn on Container Insights, you must wait 7 days before you can re-create it.

', ], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$clusters' => '

The list of clusters.

', ], ], 'Compatibility' => [ 'base' => NULL, 'refs' => [ 'CompatibilityList$member' => NULL, ], ], 'CompatibilityList' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$requiresCompatibilities' => '

The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn\'t validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.

', 'TaskDefinition$compatibilities' => '

The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$requiresCompatibilities' => '

The task launch types the task definition was validated against. The valid values are EC2, FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

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

The RunTask request could not be processed due to conflicts. The provided clientToken is already in use with a different RunTask request. The resourceIds are the existing task ARNs which are already associated with the clientToken.

To fix this issue:

  • Run RunTask with a unique clientToken.

  • Run RunTask with the clientToken and the original set of parameters

', 'refs' => [], ], 'Connectivity' => [ 'base' => NULL, 'refs' => [ 'Task$connectivity' => '

The connectivity status of a task.

', ], ], 'Container' => [ 'base' => '

A Docker container that\'s part of a task.

', 'refs' => [ 'Containers$member' => NULL, ], ], 'ContainerCondition' => [ 'base' => NULL, 'refs' => [ 'ContainerDependency$condition' => '

The dependency condition of the container. The following are the available conditions and their behavior:

  • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

  • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can\'t be set on an essential container.

  • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can\'t be set on an essential container.

  • HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

', ], ], 'ContainerDefinition' => [ 'base' => '

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

', 'refs' => [ 'ContainerDefinitions$member' => NULL, ], ], 'ContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$containerDefinitions' => '

A list of container definitions in JSON format that describe the different containers that make up your task.

', 'TaskDefinition$containerDefinitions' => '

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ContainerDependencies' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$dependsOn' => '

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you\'re using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.

  • Windows platform version 1.0.0 or later.

', ], ], 'ContainerDependency' => [ 'base' => '

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you\'re using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks that use the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.

  • Windows platform version 1.0.0 or later.

', 'refs' => [ 'ContainerDependencies$member' => NULL, ], ], 'ContainerInstance' => [ 'base' => '

An Amazon EC2 or External instance that\'s running the Amazon ECS agent and has been registered with a cluster.

', 'refs' => [ 'ContainerInstances$member' => NULL, 'DeregisterContainerInstanceResponse$containerInstance' => '

The container instance that was deregistered.

', 'RegisterContainerInstanceResponse$containerInstance' => '

The container instance that was registered.

', 'UpdateContainerAgentResponse$containerInstance' => '

The container instance that the container agent was updated for.

', ], ], 'ContainerInstanceField' => [ 'base' => NULL, 'refs' => [ 'ContainerInstanceFieldList$member' => NULL, ], ], 'ContainerInstanceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesRequest$include' => '

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren\'t included in the response.

', ], ], 'ContainerInstanceHealthStatus' => [ 'base' => '

An object representing the health status of the container instance.

', 'refs' => [ 'ContainerInstance$healthStatus' => '

An object representing the health status of the container instance.

', ], ], 'ContainerInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'ListContainerInstancesRequest$status' => '

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don\'t specify this parameter, the default is to include container instances set to all states other than INACTIVE.

', 'UpdateContainerInstancesStateRequest$status' => '

The container instance state to update the container instance with. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but can\'t update the container instance state.

', ], ], 'ContainerInstances' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesResponse$containerInstances' => '

The list of container instances.

', 'UpdateContainerInstancesStateResponse$containerInstances' => '

The list of container instances.

', ], ], 'ContainerOverride' => [ 'base' => '

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For more information, see Retrieve secrets through environment variables in the Amazon ECS Developer Guide.

', 'refs' => [ 'ContainerOverrides$member' => NULL, ], ], 'ContainerOverrides' => [ 'base' => NULL, 'refs' => [ 'TaskOverride$containerOverrides' => '

One or more container overrides that are sent to a task.

', ], ], 'ContainerStateChange' => [ 'base' => '

An object that represents a change in state for a container.

', 'refs' => [ 'ContainerStateChanges$member' => NULL, ], ], 'ContainerStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$containers' => '

Any containers that\'s associated with the state change request.

', ], ], 'Containers' => [ 'base' => NULL, 'refs' => [ 'Task$containers' => '

The containers that\'s associated with the task.

', ], ], 'CreateCapacityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCapacityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTaskSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTaskSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCapacityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCapacityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'Deployment' => [ 'base' => '

The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.

', 'refs' => [ 'Deployments$member' => NULL, ], ], 'DeploymentAlarms' => [ 'base' => '

One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.

You can only use the DeploymentAlarms method to detect failures when the DeploymentController is set to ECS (rolling update).

For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .

', 'refs' => [ 'DeploymentConfiguration$alarms' => '

Information about the CloudWatch alarms.

', ], ], 'DeploymentCircuitBreaker' => [ 'base' => '

The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can\'t reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide.

For more information about API failure reasons, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'DeploymentConfiguration$deploymentCircuitBreaker' => '

The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can\'t reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide

', ], ], 'DeploymentConfiguration' => [ 'base' => '

Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.

', 'refs' => [ 'CreateServiceRequest$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', 'Service$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', 'UpdateServiceRequest$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', ], ], 'DeploymentController' => [ 'base' => '

The deployment controller to use for the service. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'CreateServiceRequest$deploymentController' => '

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

', 'Service$deploymentController' => '

The deployment controller type the service is using.

', ], ], 'DeploymentControllerType' => [ 'base' => NULL, 'refs' => [ 'DeploymentController$type' => '

The deployment controller type to use.

There are three deployment controller types available:

ECS

The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.

CODE_DEPLOY

The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.

EXTERNAL

The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

', ], ], 'DeploymentRolloutState' => [ 'base' => NULL, 'refs' => [ 'Deployment$rolloutState' => '

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren\'t behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a FAILED state. A deployment in FAILED state doesn\'t launch any new tasks. For more information, see DeploymentCircuitBreaker.

', ], ], 'Deployments' => [ 'base' => NULL, 'refs' => [ 'Service$deployments' => '

The current state of deployments for the service.

', ], ], 'DeregisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCapacityProvidersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCapacityProvidersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DesiredStatus' => [ 'base' => NULL, 'refs' => [ 'ListTasksRequest$desiredStatus' => '

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren\'t starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this doesn\'t return any results. Amazon ECS never sets the desired status of a task to that value (only a task\'s lastStatus may have a value of PENDING).

', ], ], 'Device' => [ 'base' => '

An object representing a container instance host device.

', 'refs' => [ 'DevicesList$member' => NULL, ], ], 'DeviceCgroupPermission' => [ 'base' => NULL, 'refs' => [ 'DeviceCgroupPermissions$member' => NULL, ], ], 'DeviceCgroupPermissions' => [ 'base' => NULL, 'refs' => [ 'Device$permissions' => '

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

', ], ], 'DevicesList' => [ 'base' => NULL, 'refs' => [ 'LinuxParameters$devices' => '

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

If you\'re using tasks that use the Fargate launch type, the devices parameter isn\'t supported.

', ], ], 'DiscoverPollEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DiscoverPollEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DockerLabelsMap' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$dockerLabels' => '

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', ], ], 'DockerVolumeConfiguration' => [ 'base' => '

This parameter is specified when you\'re using Docker volumes. Docker volumes are only supported when you\'re using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

', 'refs' => [ 'Volume$dockerVolumeConfiguration' => '

This parameter is specified when you use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren\'t supported by tasks run on Fargate.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'Resource$doubleValue' => '

When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

', 'Scale$value' => '

The value, specified as a percent total of a service\'s desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.

', ], ], 'EFSAuthorizationConfig' => [ 'base' => '

The authorization configuration details for the Amazon EFS file system.

', 'refs' => [ 'EFSVolumeConfiguration$authorizationConfig' => '

The authorization configuration details for the Amazon EFS file system.

', ], ], 'EFSAuthorizationConfigIAM' => [ 'base' => NULL, 'refs' => [ 'EFSAuthorizationConfig$iam' => '

Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.

', ], ], 'EFSTransitEncryption' => [ 'base' => NULL, 'refs' => [ 'EFSVolumeConfiguration$transitEncryption' => '

Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

', ], ], 'EFSVolumeConfiguration' => [ 'base' => '

This parameter is specified when you\'re using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Volume$efsVolumeConfiguration' => '

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

', ], ], 'EnvironmentFile' => [ 'base' => '

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they\'re processed from the top down. We recommend that you use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.

You must use the following platforms for the Fargate launch type:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

Consider the following when using the Fargate launch type:

  • The file is handled like a native Docker env-file.

  • There is no support for shell escape handling.

  • The container entry point interperts the VARIABLE values.

', 'refs' => [ 'EnvironmentFiles$member' => NULL, ], ], 'EnvironmentFileType' => [ 'base' => NULL, 'refs' => [ 'EnvironmentFile$type' => '

The file type to use. The only supported value is s3.

', ], ], 'EnvironmentFiles' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$environmentFiles' => '

A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file contains an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they\'re processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

', 'ContainerOverride$environmentFiles' => '

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

', ], ], 'EnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$environment' => '

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We don\'t recommend that you use plaintext environment variables for sensitive information, such as credential data.

', 'ContainerOverride$environment' => '

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

', ], ], 'EphemeralStorage' => [ 'base' => '

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

For tasks using the Fargate launch type, the task requires the following platforms:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

', 'refs' => [ 'RegisterTaskDefinitionRequest$ephemeralStorage' => '

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

For tasks using the Fargate launch type, the task requires the following platforms:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

', 'Task$ephemeralStorage' => '

The ephemeral storage settings for the task.

', 'TaskDefinition$ephemeralStorage' => '

The ephemeral storage settings to use for tasks run with the task definition.

', 'TaskOverride$ephemeralStorage' => '

The ephemeral storage setting override for the task.

This parameter is only supported for tasks hosted on Fargate that use the following platform versions:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

', ], ], 'ExecuteCommandConfiguration' => [ 'base' => '

The details of the execute command configuration.

', 'refs' => [ 'ClusterConfiguration$executeCommandConfiguration' => '

The details of the execute command configuration.

', ], ], 'ExecuteCommandLogConfiguration' => [ 'base' => '

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.

', 'refs' => [ 'ExecuteCommandConfiguration$logConfiguration' => '

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

', ], ], 'ExecuteCommandLogging' => [ 'base' => NULL, 'refs' => [ 'ExecuteCommandConfiguration$logging' => '

The log setting to use for redirecting logs for your execute command results. The following log settings are available.

  • NONE: The execute command session is not logged.

  • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won\'t be logged.

  • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

', ], ], 'ExecuteCommandRequest' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteCommandResponse' => [ 'base' => NULL, 'refs' => [], ], 'FSxWindowsFileServerAuthorizationConfig' => [ 'base' => '

The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API Reference.

For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'FSxWindowsFileServerVolumeConfiguration$authorizationConfig' => '

The authorization configuration details for the Amazon FSx for Windows File Server file system.

', ], ], 'FSxWindowsFileServerVolumeConfiguration' => [ 'base' => '

This parameter is specified when you\'re using Amazon FSx for Windows File Server file system for task storage.

For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Volume$fsxWindowsFileServerVolumeConfiguration' => '

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

', ], ], 'Failure' => [ 'base' => '

A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Failures$member' => NULL, ], ], 'Failures' => [ 'base' => NULL, 'refs' => [ 'DeleteTaskDefinitionsResponse$failures' => '

Any failures associated with the call.

', 'DescribeCapacityProvidersResponse$failures' => '

Any failures associated with the call.

', 'DescribeClustersResponse$failures' => '

Any failures associated with the call.

', 'DescribeContainerInstancesResponse$failures' => '

Any failures associated with the call.

', 'DescribeServicesResponse$failures' => '

Any failures associated with the call.

', 'DescribeTaskSetsResponse$failures' => '

Any failures associated with the call.

', 'DescribeTasksResponse$failures' => '

Any failures associated with the call.

', 'GetTaskProtectionResponse$failures' => '

Any failures associated with the call.

', 'RunTaskResponse$failures' => '

Any failures associated with the call.

', 'StartTaskResponse$failures' => '

Any failures associated with the call.

', 'UpdateContainerInstancesStateResponse$failures' => '

Any failures associated with the call.

', 'UpdateTaskProtectionResponse$failures' => '

Any failures associated with the call.

', ], ], 'FirelensConfiguration' => [ 'base' => '

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'ContainerDefinition$firelensConfiguration' => '

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

', ], ], 'FirelensConfigurationOptionsMap' => [ 'base' => NULL, 'refs' => [ 'FirelensConfiguration$options' => '

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

', ], ], 'FirelensConfigurationType' => [ 'base' => NULL, 'refs' => [ 'FirelensConfiguration$type' => '

The log router to use. The valid values are fluentd or fluentbit.

', ], ], 'GetTaskProtectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTaskProtectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GpuIds' => [ 'base' => NULL, 'refs' => [ 'Container$gpuIds' => '

The IDs of each GPU assigned to the container.

', ], ], 'HealthCheck' => [ 'base' => '

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image\'s Dockerfile). This configuration maps to the HEALTHCHECK parameter of docker run.

The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.

You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.

The health check is designed to make sure that your containers survive agent restarts, upgrades, or temporary unavailability.

The following describes the possible healthStatus values for a container:

  • HEALTHY-The container health check has passed successfully.

  • UNHEALTHY-The container health check has failed.

  • UNKNOWN-The container health check is being evaluated, there\'s no container health check defined, or Amazon ECS doesn\'t have the health status of the container.

The following describes the possible healthStatus values based on the container health checker status of essential containers in the task with the following priority order (high to low):

  • UNHEALTHY-One or more essential containers have failed their health check.

  • UNKNOWN-Any essential container running within the task is in an UNKNOWN state and no other essential containers have an UNHEALTHY state.

  • HEALTHY-All essential containers within the task have passed their health checks.

Consider the following task health example with 2 containers.

  • If Container1 is UNHEALTHY and Container2 is UNKNOWN, the task health is UNHEALTHY.

  • If Container1 is UNHEALTHY and Container2 is HEALTHY, the task health is UNHEALTHY.

  • If Container1 is HEALTHY and Container2 is UNKNOWN, the task health is UNKNOWN.

  • If Container1 is HEALTHY and Container2 is HEALTHY, the task health is HEALTHY.

Consider the following task health example with 3 containers.

  • If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3 is UNKNOWN, the task health is UNHEALTHY.

  • If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3 is HEALTHY, the task health is UNHEALTHY.

  • If Container1 is UNHEALTHY and Container2 is HEALTHY, and Container3 is HEALTHY, the task health is UNHEALTHY.

  • If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is HEALTHY, the task health is UNKNOWN.

  • If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is UNKNOWN, the task health is UNKNOWN.

  • If Container1 is HEALTHY and Container2 is HEALTHY, and Container3 is HEALTHY, the task health is HEALTHY.

If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.

The following are notes about container health check support:

  • When the Amazon ECS agent cannot connect to the Amazon ECS service, the service reports the container as UNHEALTHY.

  • The health check statuses are the "last heard from" response from the Amazon ECS agent. There are no assumptions made about the status of the container health checks.

  • Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS container agent.

  • Container health checks are supported for Fargate tasks if you\'re using platform version 1.1.0 or greater. For more information, see Fargate platform versions.

  • Container health checks aren\'t supported for tasks that are part of a service that\'s configured to use a Classic Load Balancer.

', 'refs' => [ 'ContainerDefinition$healthCheck' => '

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

', ], ], 'HealthStatus' => [ 'base' => NULL, 'refs' => [ 'Container$healthStatus' => '

The health status of the container. If health checks aren\'t configured for this container in its task definition, then it reports the health status as UNKNOWN.

', 'Task$healthStatus' => '

The health status for the task. It\'s determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

The Amazon ECS container agent doesn\'t monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image\'s Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

', ], ], 'HostEntry' => [ 'base' => '

Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.

', 'refs' => [ 'HostEntryList$member' => NULL, ], ], 'HostEntryList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$extraHosts' => '

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

This parameter isn\'t supported for Windows containers or tasks that use the awsvpc network mode.

', ], ], 'HostVolumeProperties' => [ 'base' => '

Details on a container instance bind mount host volume.

', 'refs' => [ 'Volume$host' => '

This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it\'s stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn\'t guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can\'t mount directories on a different drive, and mount point can\'t be across drives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

', ], ], 'InferenceAccelerator' => [ 'base' => '

Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'InferenceAccelerators$member' => NULL, ], ], 'InferenceAcceleratorOverride' => [ 'base' => '

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'InferenceAcceleratorOverrides$member' => NULL, ], ], 'InferenceAcceleratorOverrides' => [ 'base' => NULL, 'refs' => [ 'TaskOverride$inferenceAcceleratorOverrides' => '

The Elastic Inference accelerator override for the task.

', ], ], 'InferenceAccelerators' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$inferenceAccelerators' => '

The Elastic Inference accelerators to use for the containers in the task.

', 'Task$inferenceAccelerators' => '

The Elastic Inference accelerator that\'s associated with the task.

', 'TaskDefinition$inferenceAccelerators' => '

The Elastic Inference accelerator that\'s associated with the task.

', ], ], 'InstanceHealthCheckResult' => [ 'base' => '

An object representing the result of a container instance health status check.

', 'refs' => [ 'InstanceHealthCheckResultList$member' => NULL, ], ], 'InstanceHealthCheckResultList' => [ 'base' => NULL, 'refs' => [ 'ContainerInstanceHealthStatus$details' => '

An array of objects representing the details of the container instance health status.

', ], ], 'InstanceHealthCheckState' => [ 'base' => NULL, 'refs' => [ 'ContainerInstanceHealthStatus$overallStatus' => '

The overall health status of the container instance. This is an aggregate status of all container instance health checks.

', 'InstanceHealthCheckResult$status' => '

The container instance health status.

', ], ], 'InstanceHealthCheckType' => [ 'base' => NULL, 'refs' => [ 'InstanceHealthCheckResult$type' => '

The type of container instance health status that was verified.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Cluster$registeredContainerInstancesCount' => '

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

', 'Cluster$runningTasksCount' => '

The number of tasks in the cluster that are in the RUNNING state.

', 'Cluster$pendingTasksCount' => '

The number of tasks in the cluster that are in the PENDING state.

', 'Cluster$activeServicesCount' => '

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

', 'ContainerDefinition$cpu' => '

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that\'s the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn\'t required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.

  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that\'s described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.

', 'ContainerInstance$runningTasksCount' => '

The number of tasks on the container instance that have a desired status (desiredStatus) of RUNNING.

', 'ContainerInstance$pendingTasksCount' => '

The number of tasks on the container instance that are in the PENDING status.

', 'Deployment$desiredCount' => '

The most recent desired count of tasks that was specified for the service to deploy or maintain.

', 'Deployment$pendingCount' => '

The number of tasks in the deployment that are in the PENDING status.

', 'Deployment$runningCount' => '

The number of tasks in the deployment that are in the RUNNING status.

', 'Deployment$failedTasks' => '

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can\'t launch the task, the task doesn\'t transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

', 'EphemeralStorage$sizeInGiB' => '

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

', 'ListAccountSettingsRequest$maxResults' => '

The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn\'t used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

', 'Resource$integerValue' => '

When the integerValue type is set, the value of the resource must be an integer.

', 'Service$desiredCount' => '

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

', 'Service$runningCount' => '

The number of tasks in the cluster that are in the RUNNING state.

', 'Service$pendingCount' => '

The number of tasks in the cluster that are in the PENDING state.

', 'TaskDefinition$revision' => '

The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.

', 'TaskSet$computedDesiredCount' => '

The computed desired count for the task set. This is calculated by multiplying the service\'s desiredCount by the task set\'s scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

', 'TaskSet$pendingCount' => '

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it\'s restarted after being in the STOPPED state.

', 'TaskSet$runningCount' => '

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

', 'Tmpfs$size' => '

The maximum size (in MiB) of the tmpfs volume.

', 'Ulimit$softLimit' => '

The soft limit for the ulimit type.

', 'Ulimit$hardLimit' => '

The hard limit for the ulimit type.

', ], ], 'InvalidParameterException' => [ 'base' => '

The specified parameter isn\'t valid. Review the available parameters for the API request.

', 'refs' => [], ], 'IpcMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$ipcMode' => '

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

  • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

  • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on Fargate.

', 'TaskDefinition$ipcMode' => '

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

  • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

  • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on Fargate.

', ], ], 'KernelCapabilities' => [ 'base' => '

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page.

', 'refs' => [ 'LinuxParameters$capabilities' => '

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.

', ], ], 'KeyValuePair' => [ 'base' => '

A key-value pair object.

', 'refs' => [ 'AttachmentDetails$member' => NULL, 'EnvironmentVariables$member' => NULL, 'ProxyConfigurationProperties$member' => NULL, 'Statistics$member' => NULL, ], ], 'LaunchType' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$launchType' => '

The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

', 'CreateTaskSetRequest$launchType' => '

The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

', 'Deployment$launchType' => '

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'ListServicesRequest$launchType' => '

The launch type to use when filtering the ListServices results.

', 'ListTasksRequest$launchType' => '

The launch type to use when filtering the ListTasks results.

', 'RunTaskRequest$launchType' => '

The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

', 'Service$launchType' => '

The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

', 'Task$launchType' => '

The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

', 'TaskSet$launchType' => '

The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

', ], ], 'LimitExceededException' => [ 'base' => '

The limit for the resource was exceeded.

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

The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.

', 'refs' => [ 'ContainerDefinition$linuxParameters' => '

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

', ], ], 'ListAccountSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccountSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesByNamespaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesByNamespaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'LoadBalancer' => [ 'base' => '

The load balancer configuration to use with a service or task set.

When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers.

We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration.

A service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'LoadBalancers$member' => NULL, ], ], 'LoadBalancers' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$loadBalancers' => '

A load balancer object representing the load balancers to use with your service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

If the service uses the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service uses the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY, and it associates one target group with it. Then, it also associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that you can use to perform validation tests with Lambda functions before routing production traffic to it.

If you use the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group that\'s specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that\'s specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren\'t supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. This is because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

', 'CreateTaskSetRequest$loadBalancers' => '

A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

', 'Service$loadBalancers' => '

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

', 'TaskSet$loadBalancers' => '

Details on a load balancer that are used with a task set.

', 'UpdateServiceRequest$loadBalancers' => '

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using CreateDeployment through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

For services that use the external deployment controller, you can add, update, or remove load balancers by using CreateTaskSet. Note that multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

You can remove existing loadBalancers by passing an empty list.

', ], ], 'LogConfiguration' => [ 'base' => '

The log configuration for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .

By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Understand the following when specifying a log configuration for your containers.

  • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.

    For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

    For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

  • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.

  • For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

  • For tasks that are on Fargate, because you don\'t have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

', 'refs' => [ 'ContainerDefinition$logConfiguration' => '

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

', 'ServiceConnectConfiguration$logConfiguration' => NULL, ], ], 'LogConfigurationOptionsMap' => [ 'base' => NULL, 'refs' => [ 'LogConfiguration$options' => '

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', ], ], 'LogDriver' => [ 'base' => NULL, 'refs' => [ 'LogConfiguration$logDriver' => '

The log driver to use for the container.

For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that isn\'t listed, you can fork the Amazon ECS container agent project that\'s available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don\'t currently provide support for running modified copies of this software.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$version' => '

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you\'re replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

', 'Resource$longValue' => '

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

', 'Task$version' => '

The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

', ], ], 'ManagedAgent' => [ 'base' => '

Details about the managed agent status for the container.

', 'refs' => [ 'ManagedAgents$member' => NULL, ], ], 'ManagedAgentName' => [ 'base' => NULL, 'refs' => [ 'ManagedAgent$name' => '

The name of the managed agent. When the execute command feature is turned on, the managed agent name is ExecuteCommandAgent.

', 'ManagedAgentStateChange$managedAgentName' => '

The name of the managed agent.

', ], ], 'ManagedAgentStateChange' => [ 'base' => '

An object representing a change in state for a managed agent.

', 'refs' => [ 'ManagedAgentStateChanges$member' => NULL, ], ], 'ManagedAgentStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$managedAgents' => '

The details for the managed agent that\'s associated with the task.

', ], ], 'ManagedAgents' => [ 'base' => NULL, 'refs' => [ 'Container$managedAgents' => '

The details of any Amazon ECS managed agents associated with the container.

', ], ], 'ManagedScaling' => [ 'base' => '

The managed scaling settings for the Auto Scaling group capacity provider.

When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.

If managed scaling is off, the user must manage the scaling of the Auto Scaling group.

', 'refs' => [ 'AutoScalingGroupProvider$managedScaling' => '

The managed scaling settings for the Auto Scaling group capacity provider.

', 'AutoScalingGroupProviderUpdate$managedScaling' => '

The managed scaling settings for the Auto Scaling group capacity provider.

', ], ], 'ManagedScalingInstanceWarmupPeriod' => [ 'base' => NULL, 'refs' => [ 'ManagedScaling$instanceWarmupPeriod' => '

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.

', ], ], 'ManagedScalingStatus' => [ 'base' => NULL, 'refs' => [ 'ManagedScaling$status' => '

Determines whether to use managed scaling for the capacity provider.

', ], ], 'ManagedScalingStepSize' => [ 'base' => NULL, 'refs' => [ 'ManagedScaling$minimumScalingStepSize' => '

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

', 'ManagedScaling$maximumScalingStepSize' => '

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of 10000 is used.

', ], ], 'ManagedScalingTargetCapacity' => [ 'base' => NULL, 'refs' => [ 'ManagedScaling$targetCapacity' => '

The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a targetCapacity of 90. The default value of 100 percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.

', ], ], 'ManagedTerminationProtection' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroupProvider$managedTerminationProtection' => '

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn\'t work.

When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is off, your Amazon EC2 instances aren\'t protected from termination when the Auto Scaling group scales in.

', 'AutoScalingGroupProviderUpdate$managedTerminationProtection' => '

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn\'t work.

When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is off, your Amazon EC2 instances aren\'t protected from termination when the Auto Scaling group scales in.

', ], ], 'MissingVersionException' => [ 'base' => '

Amazon ECS can\'t determine the current version of the Amazon ECS container agent on the container instance and doesn\'t have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn\'t use our version information.

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

The details for a volume mount point that\'s used in a container definition.

', 'refs' => [ 'MountPointList$member' => NULL, ], ], 'MountPointList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$mountPoints' => '

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can\'t mount directories on a different drive, and mount point can\'t be across drives.

', ], ], 'NamespaceNotFoundException' => [ 'base' => '

The specified namespace wasn\'t found.

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

Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

', 'refs' => [ 'NetworkBindings$member' => NULL, ], ], 'NetworkBindings' => [ 'base' => NULL, 'refs' => [ 'Container$networkBindings' => '

The network bindings associated with the container.

', 'ContainerStateChange$networkBindings' => '

Any network bindings that are associated with the container.

', 'SubmitContainerStateChangeRequest$networkBindings' => '

The network bindings of the container.

', ], ], 'NetworkConfiguration' => [ 'base' => '

The network configuration for a task or service.

', 'refs' => [ 'CreateServiceRequest$networkConfiguration' => '

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn\'t supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

', 'CreateTaskSetRequest$networkConfiguration' => '

An object representing the network configuration for a task set.

', 'Deployment$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'RunTaskRequest$networkConfiguration' => '

The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn\'t supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

', 'Service$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'StartTaskRequest$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'TaskSet$networkConfiguration' => '

The network configuration for the task set.

', 'UpdateServiceRequest$networkConfiguration' => '

An object representing the network configuration for the service.

', ], ], 'NetworkInterface' => [ 'base' => '

An object representing the elastic network interface for tasks that use the awsvpc network mode.

', 'refs' => [ 'NetworkInterfaces$member' => NULL, ], ], 'NetworkInterfaces' => [ 'base' => NULL, 'refs' => [ 'Container$networkInterfaces' => '

The network interfaces associated with the container.

', ], ], 'NetworkMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$networkMode' => '

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

', 'TaskDefinition$networkMode' => '

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

', ], ], 'NoUpdateAvailableException' => [ 'base' => '

There\'s no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it\'s so old that there\'s no update path to the current version.

', 'refs' => [], ], 'OSFamily' => [ 'base' => NULL, 'refs' => [ 'RuntimePlatform$operatingSystemFamily' => '

The operating system.

', ], ], 'PidMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$pidMode' => '

The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, there\'s a heightened risk of undesired process namespace exposure. For more information, see Docker security.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn\'t supported for Windows containers on Fargate.

', 'TaskDefinition$pidMode' => '

The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, there\'s a heightened risk of undesired process namespace exposure. For more information, see Docker security.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn\'t supported for Windows containers on Fargate.

', ], ], 'PlacementConstraint' => [ 'base' => '

An object representing a constraint on task placement. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.

If you\'re using the Fargate launch type, task placement constraints aren\'t supported.

', 'refs' => [ 'PlacementConstraints$member' => NULL, ], ], 'PlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'PlacementConstraint$type' => '

The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

', ], ], 'PlacementConstraints' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$placementConstraints' => '

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

', 'RunTaskRequest$placementConstraints' => '

An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).

', 'Service$placementConstraints' => '

The placement constraints for the tasks in the service.

', 'UpdateServiceRequest$placementConstraints' => '

An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

', ], ], 'PlacementStrategies' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$placementStrategy' => '

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.

', 'RunTaskRequest$placementStrategy' => '

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.

', 'Service$placementStrategy' => '

The placement strategy that determines how tasks for the service are placed.

', 'UpdateServiceRequest$placementStrategy' => '

The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules for each service.

', ], ], 'PlacementStrategy' => [ 'base' => '

The task placement strategy for a task or service. For more information, see Task placement strategies in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'PlacementStrategies$member' => NULL, ], ], 'PlacementStrategyType' => [ 'base' => NULL, 'refs' => [ 'PlacementStrategy$type' => '

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that\'s specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

', ], ], 'PlatformDevice' => [ 'base' => '

The devices that are available on the container instance. The only supported device type is a GPU.

', 'refs' => [ 'PlatformDevices$member' => NULL, ], ], 'PlatformDeviceType' => [ 'base' => NULL, 'refs' => [ 'PlatformDevice$type' => '

The type of device that\'s available on the container instance. The only supported value is GPU.

', ], ], 'PlatformDevices' => [ 'base' => NULL, 'refs' => [ 'RegisterContainerInstanceRequest$platformDevices' => '

The devices that are available on the container instance. The only supported device type is a GPU.

', ], ], 'PlatformTaskDefinitionIncompatibilityException' => [ 'base' => '

The specified platform version doesn\'t satisfy the required capabilities of the task definition.

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

The specified platform version doesn\'t exist.

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

Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Most fields of this parameter (containerPort, hostPort, protocol) maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run . If the network mode of a task definition is set to host, host ports must either be undefined or match the container port in the port mapping.

You can\'t expose the same container port for multiple protocols. If you attempt this, an error is returned.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

', 'refs' => [ 'PortMappingList$member' => NULL, ], ], 'PortMappingList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$portMappings' => '

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There\'s no loopback for port mappings on Windows, so you can\'t access a container\'s mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can\'t specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

', ], ], 'PortNumber' => [ 'base' => NULL, 'refs' => [ 'ServiceConnectClientAlias$port' => '

The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'ServiceConnectService$ingressPortOverride' => '

The port number for the Service Connect proxy to listen on.

Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.

In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.

', ], ], 'PropagateTags' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren\'t propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

The default is NONE.

', 'RunTaskRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren\'t propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

', 'Service$propagateTags' => '

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren\'t propagated.

', 'StartTaskRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren\'t propagated.

', 'UpdateServiceRequest$propagateTags' => '

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren\'t propagated.

Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

', ], ], 'ProtectedTask' => [ 'base' => '

An object representing the protection status details for a task. You can set the protection status with the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection API.

', 'refs' => [ 'ProtectedTasks$member' => NULL, ], ], 'ProtectedTasks' => [ 'base' => NULL, 'refs' => [ 'GetTaskProtectionResponse$protectedTasks' => '

A list of tasks with the following information.

  • taskArn: The task ARN.

  • protectionEnabled: The protection status of the task. If scale-in protection is turned on for a task, the value is true. Otherwise, it is false.

  • expirationDate: The epoch time when protection for the task will expire.

', 'UpdateTaskProtectionResponse$protectedTasks' => '

A list of tasks with the following information.

  • taskArn: The task ARN.

  • protectionEnabled: The protection status of the task. If scale-in protection is turned on for a task, the value is true. Otherwise, it is false.

  • expirationDate: The epoch time when protection for the task will expire.

', ], ], 'ProxyConfiguration' => [ 'base' => '

The configuration details for the App Mesh proxy.

For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI

', 'refs' => [ 'RegisterTaskDefinitionRequest$proxyConfiguration' => '

The configuration details for the App Mesh proxy.

For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$proxyConfiguration' => '

The configuration details for the App Mesh proxy.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ProxyConfigurationProperties' => [ 'base' => NULL, 'refs' => [ 'ProxyConfiguration$properties' => '

The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.

  • IgnoredUID - (Required) The user ID (UID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.

  • IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID is specified, this field can be empty.

  • AppPorts - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort.

  • ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to.

  • ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to.

  • EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

  • EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

', ], ], 'ProxyConfigurationType' => [ 'base' => NULL, 'refs' => [ 'ProxyConfiguration$type' => '

The proxy type. The only supported value is APPMESH.

', ], ], 'PutAccountSettingDefaultRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingDefaultResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutClusterCapacityProvidersRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutClusterCapacityProvidersResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RepositoryCredentials' => [ 'base' => '

The repository credentials for private registry authentication.

', 'refs' => [ 'ContainerDefinition$repositoryCredentials' => '

The private repository authentication credentials to use.

', ], ], 'RequiresAttributes' => [ 'base' => NULL, 'refs' => [ 'TaskDefinition$requiresAttributes' => '

The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

This parameter isn\'t supported for tasks run on Fargate.

', ], ], 'Resource' => [ 'base' => '

Describes the resources available for a container instance.

', 'refs' => [ 'Resources$member' => NULL, ], ], 'ResourceIds' => [ 'base' => NULL, 'refs' => [ 'ConflictException$resourceIds' => '

The existing task ARNs which are already associated with the clientToken.

', ], ], 'ResourceInUseException' => [ 'base' => '

The specified resource is in-use and can\'t be removed.

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

The specified resource wasn\'t found.

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

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide

', 'refs' => [ 'ResourceRequirements$member' => NULL, ], ], 'ResourceRequirements' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$resourceRequirements' => '

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

', 'ContainerOverride$resourceRequirements' => '

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceRequirement$type' => '

The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.

', ], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$remainingResources' => '

For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn\'t already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that\'s not specified here is available for new tasks.

', 'ContainerInstance$registeredResources' => '

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

', 'RegisterContainerInstanceRequest$totalResources' => '

The resources available on the instance.

', ], ], 'RunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'RuntimePlatform' => [ 'base' => '

Information about the platform for the Amazon ECS service or task.

For more information about RuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'RegisterTaskDefinitionRequest$runtimePlatform' => '

The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.

When you specify a task definition in a service, this value must match the runtimePlatform value of the service.

', 'TaskDefinition$runtimePlatform' => '

The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

When you specify a task in a service, this value must match the runtimePlatform value of the service.

', ], ], 'Scale' => [ 'base' => '

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

', 'refs' => [ 'CreateTaskSetRequest$scale' => '

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

', 'TaskSet$scale' => '

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

', 'UpdateTaskSetRequest$scale' => '

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

', ], ], 'ScaleUnit' => [ 'base' => NULL, 'refs' => [ 'Scale$unit' => '

The unit of measure for the scale value.

', ], ], 'SchedulingStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$schedulingStrategy' => '

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

  • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.

  • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don\'t meet the placement constraints. When you\'re using this strategy, you don\'t need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

    Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don\'t support the DAEMON scheduling strategy.
', 'ListServicesRequest$schedulingStrategy' => '

The scheduling strategy to use when filtering the ListServices results.

', 'Service$schedulingStrategy' => '

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available.

  • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

  • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don\'t meet the placement constraints.

    Fargate tasks don\'t support the DAEMON scheduling strategy.
', ], ], 'Scope' => [ 'base' => NULL, 'refs' => [ 'DockerVolumeConfiguration$scope' => '

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

', ], ], 'Secret' => [ 'base' => '

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

  • To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.

  • To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'SecretList$member' => NULL, ], ], 'SecretList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$secrets' => '

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

', 'LogConfiguration$secretOptions' => '

The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

', ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'Session$tokenValue' => '

An encrypted token value containing session and caller information. It\'s used to authenticate the connection to the container.

', ], ], 'ServerException' => [ 'base' => '

These errors are usually caused by a server issue.

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

Details on a service within a cluster.

', 'refs' => [ 'CreateServiceResponse$service' => '

The full description of your service following the create call.

A service will return either a capacityProviderStrategy or launchType parameter, but not both, depending where one was specified when it was created.

If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.

if the service uses the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.

', 'DeleteServiceResponse$service' => '

The full description of the deleted service.

', 'Services$member' => NULL, 'UpdateServiceResponse$service' => '

The full description of your service following the update call.

', ], ], 'ServiceConnectClientAlias' => [ 'base' => '

Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can use to connect to this service.

Each name and port mapping must be unique within the namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'ServiceConnectClientAliasList$member' => NULL, ], ], 'ServiceConnectClientAliasList' => [ 'base' => NULL, 'refs' => [ 'ServiceConnectService$clientAliases' => '

The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.

Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.

Each name and port mapping must be unique within the namespace.

For each ServiceConnectService, you must provide at least one clientAlias with one port.

', ], ], 'ServiceConnectConfiguration' => [ 'base' => '

The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'CreateServiceRequest$serviceConnectConfiguration' => '

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'Deployment$serviceConnectConfiguration' => '

The details of the Service Connect configuration that\'s used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'UpdateServiceRequest$serviceConnectConfiguration' => '

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ServiceConnectService' => [ 'base' => '

The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'ServiceConnectServiceList$member' => NULL, ], ], 'ServiceConnectServiceList' => [ 'base' => NULL, 'refs' => [ 'ServiceConnectConfiguration$services' => '

The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

This field is not required for a "client" Amazon ECS service that\'s a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that\'s attached to the service or by other means.

An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

', ], ], 'ServiceConnectServiceResource' => [ 'base' => '

The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name. The data is stored in Cloud Map as part of the Service Connect configuration for each discovery name of this Amazon ECS service.

A task can resolve the dnsName for each of the clientAliases of a service. However a task can\'t resolve the discovery names. If you want to connect to a service, refer to the ServiceConnectConfiguration of that service for the list of clientAliases that you can use.

', 'refs' => [ 'ServiceConnectServiceResourceList$member' => NULL, ], ], 'ServiceConnectServiceResourceList' => [ 'base' => NULL, 'refs' => [ 'Deployment$serviceConnectResources' => '

The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

', ], ], 'ServiceEvent' => [ 'base' => '

The details for an event that\'s associated with a service.

', 'refs' => [ 'ServiceEvents$member' => NULL, ], ], 'ServiceEvents' => [ 'base' => NULL, 'refs' => [ 'Service$events' => '

The event stream for your service. A maximum of 100 of the latest events are displayed.

', ], ], 'ServiceField' => [ 'base' => NULL, 'refs' => [ 'ServiceFieldList$member' => NULL, ], ], 'ServiceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesRequest$include' => '

Determines whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren\'t included in the response.

', ], ], 'ServiceNotActiveException' => [ 'base' => '

The specified service isn\'t active. You can\'t update a service that\'s inactive. If you have previously deleted a service, you can re-create it with CreateService.

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

The specified service wasn\'t found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

', 'refs' => [], ], 'ServiceRegistries' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$serviceRegistries' => '

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries for each service isn\'t supported.

', 'CreateTaskSetRequest$serviceRegistries' => '

The details of the service discovery registries to assign to this task set. For more information, see Service discovery.

', 'Service$serviceRegistries' => '

The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

', 'TaskSet$serviceRegistries' => '

The details for the service discovery registries to assign to this task set. For more information, see Service discovery.

', 'UpdateServiceRequest$serviceRegistries' => '

The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

You can remove existing serviceRegistries by passing an empty list.

', ], ], 'ServiceRegistry' => [ 'base' => '

The details for the service registry.

Each service may be associated with one service registry. Multiple service registries for each service are not supported.

When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.

', 'refs' => [ 'ServiceRegistries$member' => NULL, ], ], 'Services' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$services' => '

The list of services described.

', ], ], 'Session' => [ 'base' => '

The details for the execute command session.

', 'refs' => [ 'ExecuteCommandResponse$session' => '

The details of the SSM session that was created for this instance of execute-command.

', ], ], 'Setting' => [ 'base' => '

The current account setting for a resource.

', 'refs' => [ 'DeleteAccountSettingResponse$setting' => '

The account setting for the specified principal ARN.

', 'PutAccountSettingDefaultResponse$setting' => '

The current setting for a resource.

', 'PutAccountSettingResponse$setting' => '

The current account setting for a resource.

', 'Settings$member' => NULL, ], ], 'SettingName' => [ 'base' => NULL, 'refs' => [ 'DeleteAccountSettingRequest$name' => '

The resource name to disable the account setting for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.

', 'ListAccountSettingsRequest$name' => '

The name of the account setting you want to list the settings for.

', 'PutAccountSettingDefaultRequest$name' => '

The resource name for which to modify the account setting. If you specify serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the ENI limit for your Amazon ECS container instances is affected. If you specify containerInsights, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify tagResourceAuthorization, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to required maintenance is affected.

When you specify fargateFIPSMode for the name and enabled for the value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more information about FIPS-140 compliance with Fargate, see Amazon Web Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon Elastic Container Service Developer Guide.

When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to set the wait time to retire a Fargate task to the default. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

', 'PutAccountSettingRequest$name' => '

The Amazon ECS resource name for which to modify the account setting. If you specify serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If you specify containerInsights, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify fargateFIPSMode, Fargate FIPS 140 compliance is affected. If you specify tagResourceAuthorization, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify fargateTaskRetirementWaitPeriod, the wait time to retire a Fargate task is affected.

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

', 'Setting$name' => '

The Amazon ECS resource name.

', ], ], 'SettingType' => [ 'base' => NULL, 'refs' => [ 'Setting$type' => '

Indicates whether Amazon Web Services manages the account setting, or if the user manages it.

aws_managed account settings are read-only, as Amazon Web Services manages such on the customer\'s behalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services manages.

', ], ], 'Settings' => [ 'base' => NULL, 'refs' => [ 'ListAccountSettingsResponse$settings' => '

The account settings for the resource.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$sort' => '

The order to sort the results in. Valid values are ASC and DESC. By default, (ASC) task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.

', ], ], 'StabilityStatus' => [ 'base' => NULL, 'refs' => [ 'TaskSet$stabilityStatus' => '

The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks that are running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions aren\'t met, the stability status returns STABILIZING.

', ], ], 'StartTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistics' => [ 'base' => NULL, 'refs' => [ 'Cluster$statistics' => '

Additional information about your clusters that are separated by launch type. They include the following:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

', ], ], 'StopTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Attachment$id' => '

The unique identifier for the attachment.

', 'Attachment$type' => '

The type of the attachment, such as ElasticNetworkInterface.

', 'Attachment$status' => '

The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.

', 'AttachmentStateChange$attachmentArn' => '

The Amazon Resource Name (ARN) of the attachment.

', 'AttachmentStateChange$status' => '

The status of the attachment.

', 'Attribute$name' => '

The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\\), or periods (.).

', 'Attribute$value' => '

The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\\), colons (:), or spaces. The value can\'t start or end with a space.

', 'Attribute$targetId' => '

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

', 'AutoScalingGroupProvider$autoScalingGroupArn' => '

The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.

', 'CapacityProvider$capacityProviderArn' => '

The Amazon Resource Name (ARN) that identifies the capacity provider.

', 'CapacityProvider$name' => '

The name of the capacity provider.

', 'CapacityProvider$updateStatusReason' => '

The update status reason. This provides further details about the update status for the capacity provider.

', 'CapacityProviderStrategyItem$capacityProvider' => '

The short name of the capacity provider.

', 'ClientException$message' => NULL, 'Cluster$clusterArn' => '

The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

', 'Cluster$clusterName' => '

A user-generated string that you use to identify your cluster.

', 'Cluster$status' => '

The status of the cluster. The following are the possible states that are returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don\'t recommend that you rely on INACTIVE clusters persisting.

', 'Cluster$attachmentsStatus' => '

The status of the capacity providers associated with the cluster. The following are the states that are returned.

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

', 'ClusterServiceConnectDefaults$namespace' => '

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don\'t specify a Service Connect configuration, this namespace is used.

', 'ClusterServiceConnectDefaultsRequest$namespace' => '

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that\'s used when you create a service and don\'t specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can\'t include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren\'t used by Service Connect.

If you update the cluster with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.

', 'ClusterSetting$value' => '

The value to set for the cluster setting. The supported values are enabled and disabled.

If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

', 'Container$containerArn' => '

The Amazon Resource Name (ARN) of the container.

', 'Container$taskArn' => '

The ARN of the task.

', 'Container$name' => '

The name of the container.

', 'Container$image' => '

The image used for the container.

', 'Container$imageDigest' => '

The container image manifest digest.

', 'Container$runtimeId' => '

The ID of the Docker container.

', 'Container$lastStatus' => '

The last known status of the container.

', 'Container$reason' => '

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

', 'Container$cpu' => '

The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

', 'Container$memory' => '

The hard limit (in MiB) of memory set for the container.

', 'Container$memoryReservation' => '

The soft limit (in MiB) of memory set for the container.

', 'ContainerDefinition$name' => '

The name of a container. If you\'re linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

', 'ContainerDefinition$image' => '

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren\'t propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

', 'ContainerDefinition$hostname' => '

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

The hostname parameter is not supported if you\'re using the awsvpc network mode.

', 'ContainerDefinition$user' => '

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

When running tasks using the host network mode, don\'t run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

', 'ContainerDefinition$workingDirectory' => '

The working directory to run commands inside the container in. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

', 'ContainerDependency$containerName' => '

The name of a container.

', 'ContainerInstance$containerInstanceArn' => '

The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

', 'ContainerInstance$ec2InstanceId' => '

The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

', 'ContainerInstance$capacityProviderName' => '

The capacity provider that\'s associated with the container instance.

', 'ContainerInstance$status' => '

The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren\'t placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

', 'ContainerInstance$statusReason' => '

The reason that the container instance reached its current status.

', 'ContainerOverride$name' => '

The name of the container that receives the override. This parameter is required if any override is specified.

', 'ContainerStateChange$containerName' => '

The name of the container.

', 'ContainerStateChange$imageDigest' => '

The container image SHA 256 digest.

', 'ContainerStateChange$runtimeId' => '

The ID of the Docker container.

', 'ContainerStateChange$reason' => '

The reason for the state change.

', 'ContainerStateChange$status' => '

The status of the container.

', 'CreateCapacityProviderRequest$name' => '

The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can\'t be prefixed with "aws", "ecs", or "fargate".

', 'CreateClusterRequest$clusterName' => '

The name of your cluster. If you don\'t specify a name for your cluster, you create a cluster that\'s named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

', 'CreateServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.

', 'CreateServiceRequest$serviceName' => '

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

', 'CreateServiceRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn\'t specified, the latest ACTIVE revision is used.

A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.

For more information about deployment types, see Amazon ECS deployment types.

', 'CreateServiceRequest$clientToken' => '

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

', 'CreateServiceRequest$platformVersion' => '

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn\'t specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

', 'CreateServiceRequest$role' => '

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn\'t use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don\'t specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

', 'CreateTaskSetRequest$service' => '

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

', 'CreateTaskSetRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

', 'CreateTaskSetRequest$externalId' => '

An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided value.

', 'CreateTaskSetRequest$taskDefinition' => '

The task definition for the tasks in the task set to use. If a revision isn\'t specified, the latest ACTIVE revision is used.

', 'CreateTaskSetRequest$platformVersion' => '

The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn\'t specified, the LATEST platform version is used.

', 'CreateTaskSetRequest$clientToken' => '

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

', 'DeleteAccountSettingRequest$principalArn' => '

The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

', 'DeleteAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

', 'DeleteCapacityProviderRequest$capacityProvider' => '

The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.

', 'DeleteClusterRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

', 'DeleteServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

', 'DeleteServiceRequest$service' => '

The name of the service to delete.

', 'DeleteTaskSetRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.

', 'DeleteTaskSetRequest$service' => '

The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.

', 'DeleteTaskSetRequest$taskSet' => '

The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

', 'Deployment$id' => '

The ID of the deployment.

', 'Deployment$status' => '

The status of the deployment. The following describes each state.

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

', 'Deployment$taskDefinition' => '

The most recent task definition that was specified for the tasks in the service to use.

', 'Deployment$platformVersion' => '

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn\'t specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Deployment$platformFamily' => '

The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

', 'Deployment$rolloutStateReason' => '

A description of the rollout state of a deployment.

', 'DeregisterContainerInstanceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

', 'DeregisterContainerInstanceRequest$containerInstance' => '

The container instance ID or full ARN of the container instance to deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

', 'DeregisterTaskDefinitionRequest$taskDefinition' => '

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

', 'DescribeCapacityProvidersRequest$nextToken' => '

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'DescribeCapacityProvidersResponse$nextToken' => '

The nextToken value to include in a future DescribeCapacityProviders request. When the results of a DescribeCapacityProviders request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'DescribeContainerInstancesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

', 'DescribeServicesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.

', 'DescribeTaskDefinitionRequest$taskDefinition' => '

The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

', 'DescribeTaskSetsRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

', 'DescribeTaskSetsRequest$service' => '

The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

', 'DescribeTasksRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

', 'Device$hostPath' => '

The path for the device on the host container instance.

', 'Device$containerPath' => '

The path inside the container at which to expose the host device.

', 'DiscoverPollEndpointRequest$containerInstance' => '

The container instance ID or full ARN of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

', 'DiscoverPollEndpointRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.

', 'DiscoverPollEndpointResponse$endpoint' => '

The endpoint for the Amazon ECS agent to poll.

', 'DiscoverPollEndpointResponse$telemetryEndpoint' => '

The telemetry endpoint for the Amazon ECS agent.

', 'DiscoverPollEndpointResponse$serviceConnectEndpoint' => '

The endpoint for the Amazon ECS agent to poll for Service Connect configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'DockerLabelsMap$key' => NULL, 'DockerLabelsMap$value' => NULL, 'DockerVolumeConfiguration$driver' => '

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

', 'EFSAuthorizationConfig$accessPointId' => '

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

', 'EFSVolumeConfiguration$fileSystemId' => '

The Amazon EFS file system ID to use.

', 'EFSVolumeConfiguration$rootDirectory' => '

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

', 'EnvironmentFile$value' => '

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

', 'ExecuteCommandConfiguration$kmsKeyId' => '

Specify an Key Management Service key ID to encrypt the data between the local client and the container.

', 'ExecuteCommandLogConfiguration$cloudWatchLogGroupName' => '

The name of the CloudWatch log group to send logs to.

The CloudWatch log group must already be created.

', 'ExecuteCommandLogConfiguration$s3BucketName' => '

The name of the S3 bucket to send logs to.

The S3 bucket must already be created.

', 'ExecuteCommandLogConfiguration$s3KeyPrefix' => '

An optional folder in the S3 bucket to place logs in.

', 'ExecuteCommandRequest$cluster' => '

The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.

', 'ExecuteCommandRequest$container' => '

The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.

', 'ExecuteCommandRequest$command' => '

The command to run on the container.

', 'ExecuteCommandRequest$task' => '

The Amazon Resource Name (ARN) or ID of the task the container is part of.

', 'ExecuteCommandResponse$clusterArn' => '

The Amazon Resource Name (ARN) of the cluster.

', 'ExecuteCommandResponse$containerArn' => '

The Amazon Resource Name (ARN) of the container.

', 'ExecuteCommandResponse$containerName' => '

The name of the container.

', 'ExecuteCommandResponse$taskArn' => '

The Amazon Resource Name (ARN) of the task.

', 'FSxWindowsFileServerAuthorizationConfig$credentialsParameter' => '

The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.

', 'FSxWindowsFileServerAuthorizationConfig$domain' => '

A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.

', 'FSxWindowsFileServerVolumeConfiguration$fileSystemId' => '

The Amazon FSx for Windows File Server file system ID to use.

', 'FSxWindowsFileServerVolumeConfiguration$rootDirectory' => '

The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.

', 'Failure$arn' => '

The Amazon Resource Name (ARN) of the failed resource.

', 'Failure$reason' => '

The reason for the failure.

', 'Failure$detail' => '

The details of the failure.

', 'FirelensConfigurationOptionsMap$key' => NULL, 'FirelensConfigurationOptionsMap$value' => NULL, 'GetTaskProtectionRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

', 'GpuIds$member' => NULL, 'HostEntry$hostname' => '

The hostname to use in the /etc/hosts entry.

', 'HostEntry$ipAddress' => '

The IP address to use in the /etc/hosts entry.

', 'HostVolumeProperties$sourcePath' => '

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that\'s presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value doesn\'t exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you\'re using the Fargate launch type, the sourcePath parameter is not supported.

', 'InferenceAccelerator$deviceName' => '

The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.

', 'InferenceAccelerator$deviceType' => '

The Elastic Inference accelerator type to use.

', 'InferenceAcceleratorOverride$deviceName' => '

The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

', 'InferenceAcceleratorOverride$deviceType' => '

The Elastic Inference accelerator type to use.

', 'KeyValuePair$name' => '

The name of the key-value pair. For environment variables, this is the name of the environment variable.

', 'KeyValuePair$value' => '

The value of the key-value pair. For environment variables, this is the value of the environment variable.

', 'ListAccountSettingsRequest$value' => '

The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

', 'ListAccountSettingsRequest$principalArn' => '

The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Federated users assume the account setting of the root user and can\'t have explicit account settings set for them.

', 'ListAccountSettingsRequest$nextToken' => '

The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it\'s possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListAccountSettingsResponse$nextToken' => '

The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

', 'ListAttributesRequest$attributeName' => '

The name of the attribute to filter the results with.

', 'ListAttributesRequest$attributeValue' => '

The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.

', 'ListAttributesRequest$nextToken' => '

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it\'s possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListAttributesResponse$nextToken' => '

The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListClustersRequest$nextToken' => '

The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it\'s possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListClustersResponse$nextToken' => '

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListContainerInstancesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

', 'ListContainerInstancesRequest$filter' => '

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'ListContainerInstancesRequest$nextToken' => '

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it\'s possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListContainerInstancesResponse$nextToken' => '

The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListServicesByNamespaceRequest$namespace' => '

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'ListServicesByNamespaceRequest$nextToken' => '

The nextToken value that\'s returned from a ListServicesByNamespace request. It indicates that more results are available to fulfill the request and further calls are needed. If maxResults is returned, it is possible the number of results is less than maxResults.

', 'ListServicesByNamespaceResponse$nextToken' => '

The nextToken value to include in a future ListServicesByNamespace request. When the results of a ListServicesByNamespace request exceed maxResults, this value can be used to retrieve the next page of results. When there are no more results to return, this value is null.

', 'ListServicesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

', 'ListServicesRequest$nextToken' => '

The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListServicesResponse$nextToken' => '

The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTagsForResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

', 'ListTaskDefinitionFamiliesRequest$familyPrefix' => '

The familyPrefix is a string that\'s used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

', 'ListTaskDefinitionFamiliesRequest$nextToken' => '

The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTaskDefinitionFamiliesResponse$nextToken' => '

The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTaskDefinitionsRequest$familyPrefix' => '

The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

', 'ListTaskDefinitionsRequest$nextToken' => '

The nextToken value returned from a ListTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTaskDefinitionsResponse$nextToken' => '

The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTasksRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

', 'ListTasksRequest$containerInstance' => '

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

', 'ListTasksRequest$family' => '

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

', 'ListTasksRequest$nextToken' => '

The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it\'s possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTasksRequest$startedBy' => '

The startedBy value to filter the task results with. Specifying a startedBy value limits the results to tasks that were started with that value.

When you specify startedBy as the filter, it must be the only filter that you use.

', 'ListTasksRequest$serviceName' => '

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

', 'ListTasksResponse$nextToken' => '

The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'LoadBalancer$targetGroupArn' => '

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you\'re required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service\'s task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

', 'LoadBalancer$loadBalancerName' => '

The name of the load balancer to associate with the Amazon ECS service or task set.

If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

', 'LoadBalancer$containerName' => '

The name of the container (as it appears in a container definition) to associate with the load balancer.

', 'LogConfigurationOptionsMap$key' => NULL, 'LogConfigurationOptionsMap$value' => NULL, 'ManagedAgent$reason' => '

The reason for why the managed agent is in the state it is in.

', 'ManagedAgent$lastStatus' => '

The last known status of the managed agent.

', 'ManagedAgentStateChange$containerName' => '

The name of the container that\'s associated with the managed agent.

', 'ManagedAgentStateChange$status' => '

The status of the managed agent.

', 'ManagedAgentStateChange$reason' => '

The reason for the status of the managed agent.

', 'MountPoint$sourceVolume' => '

The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

', 'MountPoint$containerPath' => '

The path on the container to mount the host volume at.

', 'NetworkBinding$bindIP' => '

The IP address that the container is bound to on the container instance.

', 'NetworkBinding$containerPortRange' => '

The port number range on the container that\'s bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

  • You must use either the bridge network mode or the awsvpc network mode.

  • This parameter is available for both the EC2 and Fargate launch types.

  • This parameter is available for both the Linux and Windows operating systems.

  • The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package

  • You can specify a maximum of 100 port ranges per container.

  • You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

    • For containers in a task with the awsvpc network mode, the hostPortRange is set to the same value as the containerPortRange. This is a static mapping strategy.

    • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.

  • The containerPortRange valid values are between 1 and 65535.

  • A port can only be included in one port mapping per container.

  • You cannot specify overlapping port ranges.

  • The first port in the range must be less than last port in the range.

  • Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

    For more information, see Issue #11185 on the Github website.

    For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

', 'NetworkBinding$hostPortRange' => '

The port number range on the host that\'s used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.

', 'NetworkInterface$attachmentId' => '

The attachment ID for the network interface.

', 'NetworkInterface$privateIpv4Address' => '

The private IPv4 address for the network interface.

', 'NetworkInterface$ipv6Address' => '

The private IPv6 address for the network interface.

', 'PlacementConstraint$expression' => '

A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can\'t specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

', 'PlacementStrategy$field' => '

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that\'s applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

', 'PlatformDevice$id' => '

The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.

', 'PortMapping$name' => '

The name that\'s used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the serviceConnectConfiguration of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can\'t start with a hyphen.

For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'PortMapping$containerPortRange' => '

The port number range on the container that\'s bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

  • You must use either the bridge network mode or the awsvpc network mode.

  • This parameter is available for both the EC2 and Fargate launch types.

  • This parameter is available for both the Linux and Windows operating systems.

  • The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package

  • You can specify a maximum of 100 port ranges per container.

  • You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

    • For containers in a task with the awsvpc network mode, the hostPortRange is set to the same value as the containerPortRange. This is a static mapping strategy.

    • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.

  • The containerPortRange valid values are between 1 and 65535.

  • A port can only be included in one port mapping per container.

  • You cannot specify overlapping port ranges.

  • The first port in the range must be less than last port in the range.

  • Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

    For more information, see Issue #11185 on the Github website.

    For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

', 'ProtectedTask$taskArn' => '

The task ARN.

', 'ProxyConfiguration$containerName' => '

The name of the container that will serve as the App Mesh proxy.

', 'PutAccountSettingDefaultRequest$value' => '

The account setting value for the specified principal ARN. Accepted values are enabled, disabled, on, and off.

When you specify fargateTaskRetirementWaitPeriod for the name, the following are the valid values:

  • 0 - Amazon Web Services sends the notification, and immediately retires the affected tasks.

  • 7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.

  • 14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.

', 'PutAccountSettingRequest$value' => '

The account setting value for the specified principal ARN. Accepted values are enabled, disabled, on, and off.

When you specify fargateTaskRetirementWaitPeriod for the name, the following are the valid values:

  • 0 - Amazon Web Services sends the notification, and immediately retires the affected tasks.

  • 7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.

  • 14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.

', 'PutAccountSettingRequest$principalArn' => '

The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it modifies the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

You must use the root user when you set the Fargate wait time (fargateTaskRetirementWaitPeriod).

Federated users assume the account setting of the root user and can\'t have explicit account settings set for them.

', 'PutAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.

', 'PutClusterCapacityProvidersRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don\'t specify a cluster, the default cluster is assumed.

', 'RegisterContainerInstanceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.

', 'RegisterContainerInstanceRequest$instanceIdentityDocument' => '

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

', 'RegisterContainerInstanceRequest$instanceIdentityDocumentSignature' => '

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

', 'RegisterContainerInstanceRequest$containerInstanceArn' => '

The ARN of the container instance (if it was previously registered).

', 'RegisterTaskDefinitionRequest$family' => '

You must specify a family for a task definition. You can use it track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

', 'RegisterTaskDefinitionRequest$taskRoleArn' => '

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

', 'RegisterTaskDefinitionRequest$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

', 'RegisterTaskDefinitionRequest$cpu' => '

The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, 1024) or as a string using vCPUs (for example, 1 vCPU or 1 vcpu) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If you\'re using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you do not specify a value, the parameter is ignored.

If you\'re using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

  • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

    This option requires Linux platform 1.4.0 or later.

  • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

    This option requires Linux platform 1.4.0 or later.

', 'RegisterTaskDefinitionRequest$memory' => '

The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB (for example ,1024) or as a string using GB (for example, 1GB or 1 GB) in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If using the EC2 launch type, this field is optional.

If using the Fargate launch type, this field is required and you must use one of the following values. This determines your range of supported values for the cpu parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

    This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

    This option requires Linux platform 1.4.0 or later.

', 'RepositoryCredentials$credentialsParameter' => '

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you\'re launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.

', 'Resource$name' => '

The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

', 'Resource$type' => '

The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.

', 'ResourceIds$member' => NULL, 'ResourceRequirement$value' => '

The value for the specified resource type.

If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that\'s reserved for all containers in a task can\'t exceed the number of available GPUs on the container instance that the task is launched on.

If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

', 'RunTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.

', 'RunTaskRequest$group' => '

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

', 'RunTaskRequest$platformVersion' => '

The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn\'t specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

', 'RunTaskRequest$referenceId' => '

The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.

', 'RunTaskRequest$startedBy' => '

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 128 letters (uppercase and lowercase), numbers, hyphens (-), and underscores (_) are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'RunTaskRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run. If a revision isn\'t specified, the latest ACTIVE revision is used.

When you create a policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.

The full ARN value must match the value that you specified as the Resource of the principal\'s permissions policy.

When you specify the policy resource as the latest task definition version (by setting the Resource in the policy to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName), then set this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.

When you specify the policy resource as a specific task definition version (by setting the Resource in the policy to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1 or arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*), then set this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1.

For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.

', 'RunTaskRequest$clientToken' => '

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.

', 'Secret$name' => '

The name of the secret.

', 'Secret$valueFrom' => '

The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.

If the SSM Parameter Store parameter exists in the same Region as the task you\'re launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

', 'ServerException$message' => NULL, 'Service$serviceArn' => '

The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

', 'Service$serviceName' => '

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.

', 'Service$clusterArn' => '

The Amazon Resource Name (ARN) of the cluster that hosts the service.

', 'Service$status' => '

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

', 'Service$platformVersion' => '

The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn\'t specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Service$platformFamily' => '

The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX).

', 'Service$taskDefinition' => '

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

', 'Service$roleArn' => '

The ARN of the IAM role that\'s associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

', 'Service$createdBy' => '

The principal that created the service.

', 'ServiceConnectClientAlias$dnsName' => '

The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn\'t need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can\'t start with a hyphen.

If this parameter isn\'t specified, the default value of discoveryName.namespace is used. If the discoveryName isn\'t specified, the port mapping name from the task definition is used in portName.namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'ServiceConnectConfiguration$namespace' => '

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn\'t affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.

', 'ServiceConnectService$portName' => '

The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.

', 'ServiceConnectService$discoveryName' => '

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can\'t start with a hyphen.

If the discoveryName isn\'t specified, the port mapping name from the task definition is used in portName.namespace.

', 'ServiceConnectServiceResource$discoveryName' => '

The discovery name of this Service Connect resource.

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can\'t start with a hyphen.

If the discoveryName isn\'t specified, the port mapping name from the task definition is used in portName.namespace.

', 'ServiceConnectServiceResource$discoveryArn' => '

The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can\'t ensure connectivity outside of Amazon ECS.

', 'ServiceEvent$id' => '

The ID string for the event.

', 'ServiceEvent$message' => '

The event message.

', 'ServiceRegistry$registryArn' => '

The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

', 'ServiceRegistry$containerName' => '

The container name value to be used for your service discovery service. It\'s already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can\'t specify both.

', 'Session$sessionId' => '

The ID of the execute command session.

', 'Session$streamUrl' => '

A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.

', 'Setting$value' => '

Determines whether the account setting is on or off for the specified resource.

', 'Setting$principalArn' => '

The ARN of the principal. It can be a user, role, or the root user. If this field is omitted, the authenticated user is assumed.

', 'StartTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster where to start your task. If you do not specify a cluster, the default cluster is assumed.

', 'StartTaskRequest$group' => '

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

', 'StartTaskRequest$referenceId' => '

The reference ID to use for the task.

', 'StartTaskRequest$startedBy' => '

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens (-), and underscores (_) are allowed.

If a task is started by an Amazon ECS service, the startedBy parameter contains the deployment ID of the service that starts it.

', 'StartTaskRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to start. If a revision isn\'t specified, the latest ACTIVE revision is used.

', 'StopTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

', 'StopTaskRequest$task' => '

The task ID of the task to stop.

', 'StopTaskRequest$reason' => '

An optional message specified when a task is stopped. For example, if you\'re using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubmitAttachmentStateChangesRequest$cluster' => '

The short name or full ARN of the cluster that hosts the container instance the attachment belongs to.

', 'SubmitAttachmentStateChangesResponse$acknowledgment' => '

Acknowledgement of the state change.

', 'SubmitContainerStateChangeRequest$cluster' => '

The short name or full ARN of the cluster that hosts the container.

', 'SubmitContainerStateChangeRequest$task' => '

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

', 'SubmitContainerStateChangeRequest$containerName' => '

The name of the container.

', 'SubmitContainerStateChangeRequest$runtimeId' => '

The ID of the Docker container.

', 'SubmitContainerStateChangeRequest$status' => '

The status of the state change request.

', 'SubmitContainerStateChangeRequest$reason' => '

The reason for the state change request.

', 'SubmitContainerStateChangeResponse$acknowledgment' => '

Acknowledgement of the state change.

', 'SubmitTaskStateChangeRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

', 'SubmitTaskStateChangeRequest$task' => '

The task ID or full ARN of the task in the state change request.

', 'SubmitTaskStateChangeRequest$status' => '

The status of the state change request.

', 'SubmitTaskStateChangeRequest$reason' => '

The reason for the state change request.

', 'SubmitTaskStateChangeResponse$acknowledgment' => '

Acknowledgement of the state change.

', 'SystemControl$namespace' => '

The namespaced kernel parameter to set a value for.

', 'SystemControl$value' => '

The namespaced kernel parameter to set a value for.

Valid IPC namespace values: "kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced", and Sysctls that start with "fs.mqueue.*"

Valid network namespace values: Sysctls that start with "net.*"

All of these values are supported by Fargate.

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.

', 'Task$availabilityZone' => '

The Availability Zone for the task.

', 'Task$capacityProviderName' => '

The capacity provider that\'s associated with the task.

', 'Task$clusterArn' => '

The ARN of the cluster that hosts the task.

', 'Task$containerInstanceArn' => '

The ARN of the container instances that host the task.

', 'Task$cpu' => '

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

  • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

    This option requires Linux platform 1.4.0 or later.

  • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

    This option requires Linux platform 1.4.0 or later.

', 'Task$desiredStatus' => '

The desired status of the task. For more information, see Task Lifecycle.

', 'Task$group' => '

The name of the task group that\'s associated with the task.

', 'Task$lastStatus' => '

The last known status for the task. For more information, see Task Lifecycle.

', 'Task$memory' => '

The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it\'s expressed as a string using GB (for example, 1GB or 1 GB), it\'s converted to an integer indicating the MiB when the task definition is registered.

If you use the EC2 launch type, this field is optional.

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

    This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

    This option requires Linux platform 1.4.0 or later.

', 'Task$platformVersion' => '

The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn\'t specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Task$platformFamily' => '

The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

', 'Task$startedBy' => '

The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

', 'Task$stoppedReason' => '

The reason that the task was stopped.

', 'Task$taskArn' => '

The Amazon Resource Name (ARN) of the task.

', 'Task$taskDefinitionArn' => '

The ARN of the task definition that creates the task.

', 'TaskDefinition$taskDefinitionArn' => '

The full Amazon Resource Name (ARN) of the task definition.

', 'TaskDefinition$family' => '

The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.

A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

', 'TaskDefinition$taskRoleArn' => '

The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$cpu' => '

The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

  • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

    This option requires Linux platform 1.4.0 or later.

  • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

    This option requires Linux platform 1.4.0 or later.

', 'TaskDefinition$memory' => '

The amount (in MiB) of memory used by the task.

If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.

If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the cpu parameter.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

    This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

    This option requires Linux platform 1.4.0 or later.

', 'TaskDefinition$registeredBy' => '

The principal that registered the task definition.

', 'TaskDefinitionPlacementConstraint$expression' => '

A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

', 'TaskOverride$cpu' => '

The CPU override for the task.

', 'TaskOverride$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

', 'TaskOverride$memory' => '

The memory override for the task.

', 'TaskOverride$taskRoleArn' => '

The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.

', 'TaskSet$id' => '

The ID of the task set.

', 'TaskSet$taskSetArn' => '

The Amazon Resource Name (ARN) of the task set.

', 'TaskSet$serviceArn' => '

The Amazon Resource Name (ARN) of the service the task set exists in.

', 'TaskSet$clusterArn' => '

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

', 'TaskSet$startedBy' => '

The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn\'t used.

', 'TaskSet$externalId' => '

The external ID associated with the task set.

If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

', 'TaskSet$status' => '

The status of the task set. The following describes each state.

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set isn\'t serving production traffic.

DRAINING

The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.

', 'TaskSet$taskDefinition' => '

The task definition that the task set is using.

', 'TaskSet$platformVersion' => '

The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

', 'TaskSet$platformFamily' => '

The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks in the set must have the same value.

', 'Tmpfs$containerPath' => '

The absolute file path where the tmpfs volume is to be mounted.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.

', 'UpdateCapacityProviderRequest$name' => '

The name of the capacity provider to update.

', 'UpdateClusterRequest$cluster' => '

The name of the cluster to modify the settings for.

', 'UpdateClusterSettingsRequest$cluster' => '

The name of the cluster to modify the settings for.

', 'UpdateContainerAgentRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateContainerAgentRequest$containerInstance' => '

The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.

', 'UpdateContainerInstancesStateRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateServicePrimaryTaskSetRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

', 'UpdateServicePrimaryTaskSetRequest$service' => '

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

', 'UpdateServicePrimaryTaskSetRequest$primaryTaskSet' => '

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

', 'UpdateServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateServiceRequest$service' => '

The name of the service to update.

', 'UpdateServiceRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

', 'UpdateServiceRequest$platformVersion' => '

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'UpdateTaskProtectionRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

', 'UpdateTaskSetRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found in.

', 'UpdateTaskSetRequest$service' => '

The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.

', 'UpdateTaskSetRequest$taskSet' => '

The short name or full Amazon Resource Name (ARN) of the task set to update.

', 'VersionInfo$agentVersion' => '

The version number of the Amazon ECS container agent.

', 'VersionInfo$agentHash' => '

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

', 'VersionInfo$dockerVersion' => '

The Docker version that\'s running on the container instance.

', 'Volume$name' => '

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

This is required wwhen you use an Amazon EFS volume.

', 'VolumeFrom$sourceContainer' => '

The name of another container within the same task definition to mount volumes from.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'AwsVpcConfiguration$subnets' => '

The IDs of the subnets associated with the task or service. There\'s a limit of 16 subnets that can be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

', 'AwsVpcConfiguration$securityGroups' => '

The IDs of the security groups associated with the task or service. If you don\'t specify a security group, the default security group for the VPC is used. There\'s a limit of 5 security groups that can be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

', 'Cluster$capacityProviders' => '

The capacity providers associated with the cluster.

', 'ContainerDefinition$links' => '

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

', 'ContainerDefinition$entryPoint' => '

Early versions of the Amazon ECS container agent don\'t properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that\'s passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

', 'ContainerDefinition$command' => '

The command that\'s passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.

', 'ContainerDefinition$dnsServers' => '

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$dnsSearchDomains' => '

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$dockerSecurityOptions' => '

A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn\'t valid for containers in tasks using the Fargate launch type.

For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.

For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

', 'ContainerDefinition$credentialSpecs' => '

A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the dockerSecurityOptions. The maximum number of ARNs is 1.

There are two formats for each ARN.

credentialspecdomainless:MyARN

You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.

Each task that runs on any container instance can join different domains.

You can use this format without joining the container instance to a domain.

credentialspec:MyARN

You use credentialspec:MyARN to provide a CredSpec for a single domain.

You must join the container instance to the domain before you start any tasks that use this task definition.

In both formats, replace MyARN with the ARN in SSM or Amazon S3.

If you provide a credentialspecdomainless:MyARN, the credspec must provide a ARN in Secrets Manager for a secret containing the username, password, and the domain to connect to. For better security, the instance isn\'t joined to the domain for domainless authentication. Other applications on the instance can\'t use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers.

', 'ContainerOverride$command' => '

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

', 'CreateClusterRequest$capacityProviders' => '

The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

', 'DeleteTaskDefinitionsRequest$taskDefinitions' => '

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to delete. You must specify a revision.

You can specify up to 10 task definitions as a comma separated list.

', 'DeploymentAlarms$alarmNames' => '

One or more CloudWatch alarm names. Use a "," to separate the alarms.

', 'DescribeCapacityProvidersRequest$capacityProviders' => '

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

', 'DescribeClustersRequest$clusters' => '

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

', 'DescribeContainerInstancesRequest$containerInstances' => '

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

', 'DescribeServicesRequest$services' => '

A list of services to describe. You may specify up to 10 services to describe in a single operation.

', 'DescribeTaskSetsRequest$taskSets' => '

The ID or full Amazon Resource Name (ARN) of task sets to describe.

', 'DescribeTasksRequest$tasks' => '

A list of up to 100 task IDs or full ARN entries.

', 'GetTaskProtectionRequest$tasks' => '

A list of up to 100 task IDs or full ARN entries.

', 'HealthCheck$command' => '

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to run the command arguments directly, or CMD-SHELL to run the command with the container\'s default shell.

When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.

[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

You don\'t include the double quotes and brackets when you use the Amazon Web Services Management Console.

CMD-SHELL, curl -f http://localhost/ || exit 1

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

', 'KernelCapabilities$add' => '

The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

Tasks launched on Fargate only support adding the SYS_PTRACE kernel capability.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

', 'KernelCapabilities$drop' => '

The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

', 'ListClustersResponse$clusterArns' => '

The list of full Amazon Resource Name (ARN) entries for each cluster that\'s associated with your account.

', 'ListContainerInstancesResponse$containerInstanceArns' => '

The list of container instances with full ARN entries for each container instance associated with the specified cluster.

', 'ListServicesByNamespaceResponse$serviceArns' => '

The list of full ARN entries for each service that\'s associated with the specified namespace.

', 'ListServicesResponse$serviceArns' => '

The list of full ARN entries for each service that\'s associated with the specified cluster.

', 'ListTaskDefinitionFamiliesResponse$families' => '

The list of task definition family names that match the ListTaskDefinitionFamilies request.

', 'ListTaskDefinitionsResponse$taskDefinitionArns' => '

The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.

', 'ListTasksResponse$taskArns' => '

The list of task ARN entries for the ListTasks request.

', 'PutClusterCapacityProvidersRequest$capacityProviders' => '

The name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

', 'Resource$stringSetValue' => '

When the stringSetValue type is set, the value of the resource must be a string type.

', 'StartTaskRequest$containerInstances' => '

The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.

', 'Tmpfs$mountOptions' => '

The list of tmpfs volume mount options.

Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"

', 'UpdateContainerInstancesStateRequest$containerInstances' => '

A list of up to 10 container instance IDs or full ARN entries.

', 'UpdateTaskProtectionRequest$tasks' => '

A list of up to 10 task IDs or full ARN entries.

', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'DockerVolumeConfiguration$driverOpts' => '

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

', 'DockerVolumeConfiguration$labels' => '

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

', ], ], 'SubmitAttachmentStateChangesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitAttachmentStateChangesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubmitContainerStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitContainerStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'SystemControl' => [ 'base' => '

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

We don\'t recommend that you specify network-related systemControls parameters for multiple containers in a single task. This task also uses either the awsvpc or host network mode. It does it for the following reasons.

  • For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that\'s started last determines which systemControls take effect.

  • For tasks that use the host network mode, the systemControls parameter applies to the container instance\'s kernel parameter and that of all containers of any tasks running on that container instance.

', 'refs' => [ 'SystemControls$member' => NULL, ], ], 'SystemControls' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$systemControls' => '

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain longer lived connections.

We don\'t recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that\'s started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance\'s namespaced kernel parameters as well as the containers.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn\'t supported for Windows containers on Fargate.

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

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

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

The keys of the tags to be removed.

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

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CapacityProvider$tags' => '

The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'Cluster$tags' => '

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'ContainerInstance$tags' => '

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'CreateCapacityProviderRequest$tags' => '

The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'CreateClusterRequest$tags' => '

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'CreateServiceRequest$tags' => '

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'CreateTaskSetRequest$tags' => '

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'DescribeTaskDefinitionResponse$tags' => '

The metadata that\'s applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'ListTagsForResourceResponse$tags' => '

The tags for the resource.

', 'RegisterContainerInstanceRequest$tags' => '

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'RegisterTaskDefinitionRequest$tags' => '

The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'RegisterTaskDefinitionResponse$tags' => '

The list of tags associated with the task definition.

', 'RunTaskRequest$tags' => '

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'Service$tags' => '

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'StartTaskRequest$tags' => '

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'TagResourceRequest$tags' => '

The tags to add to the resource. A tag is an array of key-value pairs.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'Task$tags' => '

The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'TaskSet$tags' => '

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', ], ], 'TargetNotConnectedException' => [ 'base' => '

The execute command cannot run. This error can be caused by any of the following configuration issues:

  • Incorrect IAM permissions

  • The SSM agent is not installed or is not running

  • There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems Manager Session Manager

For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in the Amazon Elastic Container Service Developer Guide.

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

The specified target wasn\'t found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

', 'refs' => [], ], 'TargetType' => [ 'base' => NULL, 'refs' => [ 'Attribute$targetType' => '

The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

', 'ListAttributesRequest$targetType' => '

The type of the target to list attributes with.

', ], ], 'Task' => [ 'base' => '

Details on a task in a cluster.

', 'refs' => [ 'StopTaskResponse$task' => '

The task that was stopped.

', 'Tasks$member' => NULL, ], ], 'TaskDefinition' => [ 'base' => '

The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

', 'refs' => [ 'DeregisterTaskDefinitionResponse$taskDefinition' => '

The full description of the deregistered task.

', 'DescribeTaskDefinitionResponse$taskDefinition' => '

The full task definition description.

', 'RegisterTaskDefinitionResponse$taskDefinition' => '

The full description of the registered task definition.

', 'TaskDefinitionList$member' => NULL, ], ], 'TaskDefinitionFamilyStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionFamiliesRequest$status' => '

The task definition family status to filter the ListTaskDefinitionFamilies results with. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

', ], ], 'TaskDefinitionField' => [ 'base' => NULL, 'refs' => [ 'TaskDefinitionFieldList$member' => NULL, ], ], 'TaskDefinitionFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTaskDefinitionRequest$include' => '

Determines whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren\'t included in the response.

', ], ], 'TaskDefinitionList' => [ 'base' => NULL, 'refs' => [ 'DeleteTaskDefinitionsResponse$taskDefinitions' => '

The list of deleted task definitions.

', ], ], 'TaskDefinitionPlacementConstraint' => [ 'base' => '

The constraint on task placement in the task definition. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.

Task placement constraints aren\'t supported for tasks run on Fargate.

', 'refs' => [ 'TaskDefinitionPlacementConstraints$member' => NULL, ], ], 'TaskDefinitionPlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'TaskDefinitionPlacementConstraint$type' => '

The type of constraint. The MemberOf constraint restricts selection to be from a group of valid candidates.

', ], ], 'TaskDefinitionPlacementConstraints' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$placementConstraints' => '

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

', 'TaskDefinition$placementConstraints' => '

An array of placement constraint objects to use for tasks.

This parameter isn\'t supported for tasks run on Fargate.

', ], ], 'TaskDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$status' => '

The task definition status to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

', 'TaskDefinition$status' => '

The status of the task definition.

', ], ], 'TaskField' => [ 'base' => NULL, 'refs' => [ 'TaskFieldList$member' => NULL, ], ], 'TaskFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksRequest$include' => '

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren\'t included in the response.

', ], ], 'TaskOverride' => [ 'base' => '

The overrides that are associated with a task.

', 'refs' => [ 'RunTaskRequest$overrides' => '

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that\'s specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

', 'StartTaskRequest$overrides' => '

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it receives. You can override the default command for a container (that\'s specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

', 'Task$overrides' => '

One or more container overrides.

', ], ], 'TaskSet' => [ 'base' => '

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

', 'refs' => [ 'CreateTaskSetResponse$taskSet' => '

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. A task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

', 'DeleteTaskSetResponse$taskSet' => '

Details about the task set.

', 'TaskSets$member' => NULL, 'UpdateServicePrimaryTaskSetResponse$taskSet' => '

The details about the task set.

', 'UpdateTaskSetResponse$taskSet' => '

Details about the task set.

', ], ], 'TaskSetField' => [ 'base' => NULL, 'refs' => [ 'TaskSetFieldList$member' => NULL, ], ], 'TaskSetFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTaskSetsRequest$include' => '

Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren\'t included in the response.

', ], ], 'TaskSetNotFoundException' => [ 'base' => '

The specified task set wasn\'t found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

', 'refs' => [], ], 'TaskSets' => [ 'base' => NULL, 'refs' => [ 'DescribeTaskSetsResponse$taskSets' => '

The list of task sets described.

', 'Service$taskSets' => '

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

', ], ], 'TaskStopCode' => [ 'base' => NULL, 'refs' => [ 'Task$stopCode' => '

The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

For more information about stop code, see Stopped tasks error codes in the Amazon ECS User Guide.

The following are valid values:

  • TaskFailedToStart

  • EssentialContainerExited

  • UserInitiated

  • TerminationNotice

  • ServiceSchedulerInitiated

  • SpotInterruption

', ], ], 'Tasks' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksResponse$tasks' => '

The list of tasks.

', 'RunTaskResponse$tasks' => '

A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.

', 'StartTaskResponse$tasks' => '

A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$registeredAt' => '

The Unix timestamp for the time when the container instance was registered.

', 'Deployment$createdAt' => '

The Unix timestamp for the time when the service deployment was created.

', 'Deployment$updatedAt' => '

The Unix timestamp for the time when the service deployment was last updated.

', 'InstanceHealthCheckResult$lastUpdated' => '

The Unix timestamp for when the container instance health status was last updated.

', 'InstanceHealthCheckResult$lastStatusChange' => '

The Unix timestamp for when the container instance health status last changed.

', 'ManagedAgent$lastStartedAt' => '

The Unix timestamp for the time when the managed agent was last started.

', 'ProtectedTask$expirationDate' => '

The epoch time when protection for the task will expire.

', 'Service$createdAt' => '

The Unix timestamp for the time when the service was created.

', 'ServiceEvent$createdAt' => '

The Unix timestamp for the time when the event was triggered.

', 'SubmitTaskStateChangeRequest$pullStartedAt' => '

The Unix timestamp for the time when the container image pull started.

', 'SubmitTaskStateChangeRequest$pullStoppedAt' => '

The Unix timestamp for the time when the container image pull completed.

', 'SubmitTaskStateChangeRequest$executionStoppedAt' => '

The Unix timestamp for the time when the task execution stopped.

', 'Task$connectivityAt' => '

The Unix timestamp for the time when the task last went into CONNECTED status.

', 'Task$createdAt' => '

The Unix timestamp for the time when the task was created. More specifically, it\'s for the time when the task entered the PENDING state.

', 'Task$executionStoppedAt' => '

The Unix timestamp for the time when the task execution stopped.

', 'Task$pullStartedAt' => '

The Unix timestamp for the time when the container image pull began.

', 'Task$pullStoppedAt' => '

The Unix timestamp for the time when the container image pull completed.

', 'Task$startedAt' => '

The Unix timestamp for the time when the task started. More specifically, it\'s for the time when the task transitioned from the PENDING state to the RUNNING state.

', 'Task$stoppedAt' => '

The Unix timestamp for the time when the task was stopped. More specifically, it\'s for the time when the task transitioned from the RUNNING state to the STOPPED state.

', 'Task$stoppingAt' => '

The Unix timestamp for the time when the task stops. More specifically, it\'s for the time when the task transitions from the RUNNING state to STOPPING.

', 'TaskDefinition$registeredAt' => '

The Unix timestamp for the time when the task definition was registered.

', 'TaskDefinition$deregisteredAt' => '

The Unix timestamp for the time when the task definition was deregistered.

', 'TaskSet$createdAt' => '

The Unix timestamp for the time when the task set was created.

', 'TaskSet$updatedAt' => '

The Unix timestamp for the time when the task set was last updated.

', 'TaskSet$stabilityStatusAt' => '

The Unix timestamp for the time when the task set stability status was retrieved.

', ], ], 'Tmpfs' => [ 'base' => '

The container path, mount options, and size of the tmpfs mount.

', 'refs' => [ 'TmpfsList$member' => NULL, ], ], 'TmpfsList' => [ 'base' => NULL, 'refs' => [ 'LinuxParameters$tmpfs' => '

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

If you\'re using tasks that use the Fargate launch type, the tmpfs parameter isn\'t supported.

', ], ], 'TransportProtocol' => [ 'base' => NULL, 'refs' => [ 'NetworkBinding$protocol' => '

The protocol used for the network binding.

', 'PortMapping$protocol' => '

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp. protocol is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.

', ], ], 'Ulimit' => [ 'base' => '

The ulimit settings to pass to the container.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 4096.

You can specify the ulimit settings for a container in a task definition.

', 'refs' => [ 'UlimitList$member' => NULL, ], ], 'UlimitList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ulimits' => '

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

This parameter is not supported for Windows containers.

', ], ], 'UlimitName' => [ 'base' => NULL, 'refs' => [ 'Ulimit$name' => '

The type of the ulimit.

', ], ], 'UnsupportedFeatureException' => [ 'base' => '

The specified task isn\'t supported in this Region.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCapacityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCapacityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInProgressException' => [ 'base' => '

There\'s already a current Amazon ECS container agent update in progress on the container instance that\'s specified. If the container agent becomes disconnected while it\'s in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

', 'refs' => [], ], 'UpdateServicePrimaryTaskSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServicePrimaryTaskSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskProtectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskProtectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'VersionInfo' => [ 'base' => '

The Docker and Amazon ECS container agent version information about a container instance.

', 'refs' => [ 'ContainerInstance$versionInfo' => '

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

', 'RegisterContainerInstanceRequest$versionInfo' => '

The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

', ], ], 'Volume' => [ 'base' => '

A data volume that\'s used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

', 'refs' => [ 'VolumeList$member' => NULL, ], ], 'VolumeFrom' => [ 'base' => '

Details on a data volume from another container in the same task definition.

', 'refs' => [ 'VolumeFromList$member' => NULL, ], ], 'VolumeFromList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$volumesFrom' => '

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.

', ], ], 'VolumeList' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$volumes' => '

A list of volume definitions in JSON format that containers in your task might use.

', 'TaskDefinition$volumes' => '

The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

The host and sourcePath parameters aren\'t supported for tasks run on Fargate.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon Elastic Container Service

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that\'s managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.

Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don\'t need to operate your own cluster management and configuration management systems. You also don\'t need to worry about scaling your management infrastructure.

', 'operations' => [ 'CreateCapacityProvider' => '

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.

', 'CreateCluster' => '

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn\'t have permissions to create the service-linked role, it isn\'t created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

', 'CreateService' => '

Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

Tasks for services that don\'t use a load balancer are considered healthy if they\'re in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they\'re in the RUNNING state and are reported as healthy by the load balancer.

There are two service scheduler strategies available:

  • REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

  • DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don\'t meet the placement constraints. When using this strategy, you don\'t need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they\'re in the RUNNING state, tasks for services that don\'t use a load balancer are considered healthy . If they\'re in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren\'t used. This is the case even if they\'re currently visible when describing your service.

When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren\'t controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide.

', 'CreateTaskSet' => '

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

You can create a maximum of 5 tasks sets for a deployment.

', 'DeleteAccountSetting' => '

Disables an account setting for a specified user, role, or the root user for an account.

', 'DeleteAttributes' => '

Deletes one or more custom attributes from an Amazon ECS resource.

', 'DeleteCapacityProvider' => '

Deletes the specified capacity provider.

The FARGATE and FARGATE_SPOT capacity providers are reserved and can\'t be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.

Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service\'s capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren\'t associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

', 'DeleteCluster' => '

Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don\'t recommend that you rely on INACTIVE clusters persisting.

You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

', 'DeleteService' => '

Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you can\'t delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to either STOPPING or STOPPED status, the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.

If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.

', 'DeleteTaskDefinitions' => '

Deletes one or more task definitions.

You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.

When you delete a task definition revision, it is immediately transitions from the INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS task definition revision continue to run without disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision can still scale up or down by modifying the service\'s desired count.

You can\'t use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new services. You also can\'t update an existing service to reference a DELETE_IN_PROGRESS task definition revision.

A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and services have been terminated.

When you delete all INACTIVE task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.

', 'DeleteTaskSet' => '

Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

', 'DeregisterContainerInstance' => '

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it doesn\'t terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren\'t automatically deregistered when terminated).

', 'DeregisterTaskDefinition' => '

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service\'s desired count. If you want to delete a task definition revision, you must first deregister the task definition revision.

You can\'t use an INACTIVE task definition to run new tasks or create new services, and you can\'t update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.

At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future. We don\'t recommend that you rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.

', 'DescribeCapacityProviders' => '

Describes one or more of your capacity providers.

', 'DescribeClusters' => '

Describes one or more of your clusters.

', 'DescribeContainerInstances' => '

Describes one or more container instances. Returns metadata about each container instance requested.

', 'DescribeServices' => '

Describes the specified services running in your cluster.

', 'DescribeTaskDefinition' => '

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

You can only describe INACTIVE task definitions while an active task or service references them.

', 'DescribeTaskSets' => '

Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

', 'DescribeTasks' => '

Describes a specified task or tasks.

Currently, stopped tasks appear in the returned results for at least one hour.

If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.

', 'DiscoverPollEndpoint' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon ECS agent to poll for updates.

', 'ExecuteCommand' => '

Runs a command remotely on a container within a task.

If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an AccessDeniedException when there is a mismatch between the condition key value and the corresponding parameter value.

For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.

', 'GetTaskProtection' => '

Retrieves the protection status of tasks in an Amazon ECS service.

', 'ListAccountSettings' => '

Lists the account settings for a specified principal.

', 'ListAttributes' => '

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

', 'ListClusters' => '

Returns a list of existing clusters.

', 'ListContainerInstances' => '

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'ListServices' => '

Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.

', 'ListServicesByNamespace' => '

This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, ListServices can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'ListTagsForResource' => '

List the tags for an Amazon ECS resource.

', 'ListTaskDefinitionFamilies' => '

Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.

You can filter out task definition families that don\'t contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

', 'ListTaskDefinitions' => '

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

', 'ListTasks' => '

Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.

Recently stopped tasks might appear in the returned results.

', 'PutAccountSetting' => '

Modifies an account setting. Account settings are set on a per-Region basis.

If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.

When you specify serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.

When you specify awsvpcTrunking, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.

When you specify containerInsights, the default setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If containerInsights is turned on, any new clusters that are created will have Container Insights turned on unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.

Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide.

When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

', 'PutAccountSettingDefault' => '

Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.

', 'PutAttributes' => '

Create or update an attribute on an Amazon ECS resource. If the attribute doesn\'t exist, it\'s created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

', 'PutClusterCapacityProviders' => '

Modifies the available capacity providers and the default capacity provider strategy for a cluster.

You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it\'s not being used by any existing tasks.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster\'s default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining a default strategy.

', 'RegisterContainerInstance' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.

', 'RegisterTaskDefinition' => '

Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the policy that\'s associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

', 'RunTask' => '

Starts a new task using the specified task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.

To manage eventual consistency, you can do the following:

  • Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.

  • Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.

', 'StartTask' => '

Starts a new task from the specified task definition on the specified container instance or instances.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

', 'StopTask' => '

Stops a running task. Any tags associated with the task will be deleted.

When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.

The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

', 'SubmitAttachmentStateChanges' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that an attachment changed states.

', 'SubmitContainerStateChange' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a container changed states.

', 'SubmitTaskStateChange' => '

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

', 'TagResource' => '

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren\'t specified in the request parameters, they aren\'t changed. When a resource is deleted, the tags that are associated with that resource are deleted as well.

', 'UntagResource' => '

Deletes specified tags from a resource.

', 'UpdateCapacityProvider' => '

Modifies the parameters for a capacity provider.

', 'UpdateCluster' => '

Updates the cluster.

', 'UpdateClusterSettings' => '

Modifies the settings to use for a cluster.

', 'UpdateContainerAgent' => '

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn\'t interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.

The UpdateContainerAgent API isn\'t supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This updates the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

Agent updates with the UpdateContainerAgent API operation do not apply to Windows container instances. We recommend that you launch new container instances to update the agent version in your Windows clusters.

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

', 'UpdateContainerInstancesState' => '

Modifies the status of an Amazon ECS container instance.

Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

A container instance can\'t be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service\'s deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can\'t remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they\'re in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they\'re in the RUNNING state and are reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can\'t start until the draining tasks have stopped.

Any PENDING or RUNNING tasks that do not belong to a service aren\'t affected. You must wait for them to finish or stop them manually.

A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.

When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.

', 'UpdateService' => '

Modifies the parameters of a service.

For services using the rolling update (ECS) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration.

For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference.

For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service\'s deployment configuration) to determine the deployment strategy.

If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you don\'t need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don\'t use a load balancer are considered healthy if they\'re in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they\'re in the RUNNING state and are reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout. After this, SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic.

  • Determine which of the container instances in your cluster can support your service\'s task definition. For example, they have the required CPU, memory, ports, and container instance attributes.

  • By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy.

    • Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.

    • Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

  • Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.

  • Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.

You must have a service-linked role when you update any of the following service properties:

  • loadBalancers,

  • serviceRegistries

For more information about the role see the CreateService request parameter role .

', 'UpdateServicePrimaryTaskSet' => '

Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

', 'UpdateTaskProtection' => '

Updates the protection status of a task. You can set protectionEnabled to true to protect your task from termination during scale-in events from Service Autoscaling or deployments.

Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the protectionEnabled property making the task eligible for termination by a subsequent scale-in event.

You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes (48 hours). To specify the custom expiration period, set the expiresInMinutes property. The expiresInMinutes property is always reset when you invoke this operation for a task that already has protectionEnabled set to true. You can keep extending the protection expiration period of a task by invoking this operation repeatedly.

To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .

This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation for a standalone task will result in an TASK_NOT_VALID failure. For more information, see API failure reasons.

If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.

', 'UpdateTaskSet' => '

Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

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

You don\'t have authorization to perform the requested action.

', 'refs' => [], ], 'AgentUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentUpdateStatus' => '

The status of the most recent agent update. If an update wasn\'t ever requested, this value is NULL.

', ], ], 'ApplicationProtocol' => [ 'base' => NULL, 'refs' => [ 'PortMapping$appProtocol' => '

The application protocol that\'s used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.

If you don\'t set a value for this parameter, then TCP is used. However, Amazon ECS doesn\'t add protocol-specific telemetry for TCP.

appProtocol is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', ], ], 'AssignPublicIp' => [ 'base' => NULL, 'refs' => [ 'AwsVpcConfiguration$assignPublicIp' => '

Whether the task\'s elastic network interface receives a public IP address. The default value is DISABLED.

', ], ], 'Attachment' => [ 'base' => '

An object representing a container instance or task attachment.

', 'refs' => [ 'Attachments$member' => NULL, ], ], 'AttachmentDetails' => [ 'base' => NULL, 'refs' => [ 'Attachment$details' => '

Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

', ], ], 'AttachmentStateChange' => [ 'base' => '

An object representing a change in state for a task attachment.

', 'refs' => [ 'AttachmentStateChanges$member' => NULL, ], ], 'AttachmentStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitAttachmentStateChangesRequest$attachments' => '

Any attachments associated with the state change request.

', 'SubmitTaskStateChangeRequest$attachments' => '

Any attachments associated with the state change request.

', ], ], 'Attachments' => [ 'base' => NULL, 'refs' => [ 'Cluster$attachments' => '

The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.

', 'ContainerInstance$attachments' => '

The resources attached to a container instance, such as an elastic network interface.

', 'Task$attachments' => '

The Elastic Network Adapter that\'s associated with the task if the task uses the awsvpc network mode.

', ], ], 'Attribute' => [ 'base' => '

An attribute is a name-value pair that\'s associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Attributes$member' => NULL, 'RequiresAttributes$member' => NULL, ], ], 'AttributeLimitExceededException' => [ 'base' => '

You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

', 'refs' => [], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attributes' => '

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

', 'DeleteAttributesRequest$attributes' => '

The attributes to delete from your resource. You can specify up to 10 attributes for each request. For custom attributes, specify the attribute name and target ID, but don\'t specify the value. If you specify the target ID using the short form, you must also specify the target type.

', 'DeleteAttributesResponse$attributes' => '

A list of attribute objects that were successfully deleted from your resource.

', 'ListAttributesResponse$attributes' => '

A list of attribute objects that meet the criteria of the request.

', 'PutAttributesRequest$attributes' => '

The attributes to apply to your resource. You can specify up to 10 custom attributes for each resource. You can specify up to 10 attributes in a single call.

', 'PutAttributesResponse$attributes' => '

The attributes applied to your resource.

', 'RegisterContainerInstanceRequest$attributes' => '

The container instance attributes that this container instance supports.

', 'Task$attributes' => '

The attributes of the task

', ], ], 'AutoScalingGroupProvider' => [ 'base' => '

The details of the Auto Scaling group for the capacity provider.

', 'refs' => [ 'CapacityProvider$autoScalingGroupProvider' => '

The Auto Scaling group settings for the capacity provider.

', 'CreateCapacityProviderRequest$autoScalingGroupProvider' => '

The details of the Auto Scaling group for the capacity provider.

', ], ], 'AutoScalingGroupProviderUpdate' => [ 'base' => '

The details of the Auto Scaling group capacity provider to update.

', 'refs' => [ 'UpdateCapacityProviderRequest$autoScalingGroupProvider' => '

An object that represent the parameters to update for the Auto Scaling group capacity provider.

', ], ], 'AwsVpcConfiguration' => [ 'base' => '

An object representing the networking details for a task or service.

', 'refs' => [ 'NetworkConfiguration$awsvpcConfiguration' => '

The VPC subnets and security groups that are associated with a task.

All specified subnets and security groups must be from the same VPC.

', ], ], 'BlockedException' => [ 'base' => '

Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentConnected' => '

This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.

', 'CreateServiceRequest$enableECSManagedTags' => '

Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide.

When you use Amazon ECS managed tags, you need to set the propagateTags request parameter.

', 'CreateServiceRequest$enableExecuteCommand' => '

Determines whether the execute command functionality is turned on for the service. If true, this enables execute command functionality on all containers in the service tasks.

', 'DeploymentAlarms$enable' => '

Determines whether to use the CloudWatch alarm option in the service deployment process.

', 'DeploymentAlarms$rollback' => '

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

', 'DeploymentCircuitBreaker$enable' => '

Determines whether to use the deployment circuit breaker logic for the service.

', 'DeploymentCircuitBreaker$rollback' => '

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

', 'ExecuteCommandLogConfiguration$cloudWatchEncryptionEnabled' => '

Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.

', 'ExecuteCommandLogConfiguration$s3EncryptionEnabled' => '

Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

', 'ExecuteCommandRequest$interactive' => '

Use this flag to run your command in interactive mode.

', 'ExecuteCommandResponse$interactive' => '

Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify true for this value.

', 'ListAccountSettingsRequest$effectiveSettings' => '

Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they\'re set. Otherwise, no account settings are returned.

', 'ProtectedTask$protectionEnabled' => '

The protection status of the task. If scale-in protection is on for a task, the value is true. Otherwise, it is false.

', 'RunTaskRequest$enableECSManagedTags' => '

Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'RunTaskRequest$enableExecuteCommand' => '

Determines whether to use the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

If true, then the task definition must have a task role, or you must provide one as an override.

', 'Service$enableECSManagedTags' => '

Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'Service$enableExecuteCommand' => '

Determines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.

', 'ServiceConnectConfiguration$enabled' => '

Specifies whether to use Service Connect with this service.

', 'StartTaskRequest$enableECSManagedTags' => '

Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

', 'StartTaskRequest$enableExecuteCommand' => '

Whether or not the execute command functionality is turned on for the task. If true, this turns on the execute command functionality on all containers in the task.

', 'Task$enableExecuteCommand' => '

Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

', 'UpdateServiceRequest$forceNewDeployment' => '

Determines whether to force a new deployment of the service. By default, deployments aren\'t forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service\'s tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

', 'UpdateTaskProtectionRequest$protectionEnabled' => '

Specify true to mark a task for protection and false to unset protection, making it eligible for termination.

', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$essential' => '

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn\'t affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that\'s composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

', 'ContainerDefinition$disableNetworking' => '

When this parameter is true, networking is off within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$privileged' => '

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on Fargate.

', 'ContainerDefinition$readonlyRootFilesystem' => '

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$interactive' => '

When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.

', 'ContainerDefinition$pseudoTerminal' => '

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.

', 'DeleteServiceRequest$force' => '

If true, allows you to delete a service even if it wasn\'t scaled down to zero tasks. It\'s only necessary to use this if the service uses the REPLICA scheduling strategy.

', 'DeleteTaskSetRequest$force' => '

If true, you can delete a task set even if it hasn\'t been scaled down to zero.

', 'DeregisterContainerInstanceRequest$force' => '

Forces the container instance to be deregistered. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they\'re orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

', 'DockerVolumeConfiguration$autoprovision' => '

If this value is true, the Docker volume is created if it doesn\'t already exist.

This field is only used if the scope is shared.

', 'LinuxParameters$initProcessEnabled' => '

Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', 'MountPoint$readOnly' => '

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

', 'UpdateServiceRequest$enableExecuteCommand' => '

If true, this enables execute command functionality on all task containers.

If you do not want to override the value that was set when the service was created, you can set this to null when performing this action.

', 'UpdateServiceRequest$enableECSManagedTags' => '

Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

', 'VolumeFrom$readOnly' => '

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

', ], ], 'BoxedInteger' => [ 'base' => NULL, 'refs' => [ 'Container$exitCode' => '

The exit code returned from the container.

', 'ContainerDefinition$memory' => '

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don\'t specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don\'t specify less than 4 MiB of memory for your containers.

', 'ContainerDefinition$memoryReservation' => '

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don\'t specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don\'t specify less than 4 MiB of memory for your containers.

', 'ContainerDefinition$startTimeout' => '

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it doesn\'t reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a STOPPED state.

When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it\'s enforced independently from this start timeout value.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.

  • Windows platform version 1.0.0 or later.

For tasks using the EC2 launch type, your container instances require at least version 1.26.0 of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you\'re using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

The valid values are 2-120 seconds.

', 'ContainerDefinition$stopTimeout' => '

Time duration (in seconds) to wait before the container is forcefully killed if it doesn\'t exit normally on its own.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.

  • Windows platform version 1.0.0 or later.

The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.

For tasks that use the EC2 launch type, if the stopTimeout parameter isn\'t specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you\'re using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

The valid values are 2-120 seconds.

', 'ContainerOverride$cpu' => '

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

', 'ContainerOverride$memory' => '

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

', 'ContainerOverride$memoryReservation' => '

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

', 'ContainerStateChange$exitCode' => '

The exit code for the container, if the state change is a result of the container exiting.

', 'CreateServiceRequest$desiredCount' => '

The number of instantiations of the specified task definition to place and keep running in your service.

This is required if schedulingStrategy is REPLICA or isn\'t specified. If schedulingStrategy is DAEMON then this isn\'t required.

', 'CreateServiceRequest$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don\'t specify a health check grace period value, the default value of 0 is used.

If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in the task definition health check parameters. For more information, see Health check.

If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

', 'DeploymentConfiguration$maximumPercent' => '

If a service is using the rolling update (ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service\'s tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent value for a service using the REPLICA service scheduler is 200%.

If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

', 'DeploymentConfiguration$minimumHealthyPercent' => '

If a service is using the rolling update (ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service\'s tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.

For services that do not use a load balancer, the following should be noted:

  • A service is considered healthy if all essential containers within the tasks in the service pass their health checks.

  • If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.

  • If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.

For services are that do use a load balancer, the following should be noted:

  • If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

  • If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

', 'DescribeCapacityProvidersRequest$maxResults' => '

The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

', 'EFSVolumeConfiguration$transitEncryptionPort' => '

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

', 'HealthCheck$interval' => '

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

', 'HealthCheck$timeout' => '

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

', 'HealthCheck$retries' => '

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

', 'HealthCheck$startPeriod' => '

The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the startPeriod is off.

If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

', 'LinuxParameters$sharedMemorySize' => '

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

', 'LinuxParameters$maxSwap' => '

The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.

If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.

If you\'re using tasks that use the Fargate launch type, the maxSwap parameter isn\'t supported.

If you\'re using tasks on Amazon Linux 2023 the swappiness parameter isn\'t supported.

', 'LinuxParameters$swappiness' => '

This allows you to tune a container\'s memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.

If you\'re using tasks that use the Fargate launch type, the swappiness parameter isn\'t supported.

If you\'re using tasks on Amazon Linux 2023 the swappiness parameter isn\'t supported.

', 'ListAttributesRequest$maxResults' => '

The maximum number of cluster results that ListAttributes returned in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

', 'ListClustersRequest$maxResults' => '

The maximum number of cluster results that ListClusters returned in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListClusters returns up to 100 results and a nextToken value if applicable.

', 'ListContainerInstancesRequest$maxResults' => '

The maximum number of container instance results that ListContainerInstances returned in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

', 'ListServicesByNamespaceRequest$maxResults' => '

The maximum number of service results that ListServicesByNamespace returns in paginated output. When this parameter is used, ListServicesByNamespace only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServicesByNamespace request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.

', 'ListServicesRequest$maxResults' => '

The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListServices returns up to 10 results and a nextToken value if applicable.

', 'ListTaskDefinitionFamiliesRequest$maxResults' => '

The maximum number of task definition family results that ListTaskDefinitionFamilies returned in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

', 'ListTaskDefinitionsRequest$maxResults' => '

The maximum number of task definition results that ListTaskDefinitions returned in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

', 'ListTasksRequest$maxResults' => '

The maximum number of task results that ListTasks returned in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn\'t used, then ListTasks returns up to 100 results and a nextToken value if applicable.

', 'LoadBalancer$containerPort' => '

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they\'re launched on must allow ingress traffic on the hostPort of the port mapping.

', 'NetworkBinding$containerPort' => '

The port number on the container that\'s used with the network binding.

', 'NetworkBinding$hostPort' => '

The port number on the host that\'s used with the network binding.

', 'PortMapping$containerPort' => '

The port number on the container that\'s bound to the user-specified or automatically assigned host port.

If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.

If you use containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

', 'PortMapping$hostPort' => '

The port number on the container instance to reserve for your container.

If you specify a containerPortRange, leave this field empty and the value of the hostPort is set as follows:

  • For containers in a task with the awsvpc network mode, the hostPort is set to the same value as the containerPort. This is a static mapping strategy.

  • For containers in a task with the bridge network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.

If you use containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

If you use containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren\'t included in the 100 reserved ports quota.

', 'RunTaskRequest$count' => '

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.

', 'Service$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

', 'ServiceRegistry$port' => '

The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.

', 'ServiceRegistry$containerPort' => '

The port value to be used for your service discovery service. It\'s already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can\'t specify both.

', 'SubmitContainerStateChangeRequest$exitCode' => '

The exit code that\'s returned for the state change request.

', 'UpdateServiceRequest$desiredCount' => '

The number of instantiations of the task to place and keep running in your service.

', 'UpdateServiceRequest$healthCheckGracePeriodSeconds' => '

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

', 'UpdateTaskProtectionRequest$expiresInMinutes' => '

If you set protectionEnabled to true, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, protectionEnabled will be reset to false.

If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).

', ], ], 'CPUArchitecture' => [ 'base' => NULL, 'refs' => [ 'RuntimePlatform$cpuArchitecture' => '

The CPU architecture.

You can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.

', ], ], 'CapacityProvider' => [ 'base' => '

The details for a capacity provider.

', 'refs' => [ 'CapacityProviders$member' => NULL, 'CreateCapacityProviderResponse$capacityProvider' => '

The full description of the new capacity provider.

', 'DeleteCapacityProviderResponse$capacityProvider' => '

The details of the capacity provider.

', 'UpdateCapacityProviderResponse$capacityProvider' => '

Details about the capacity provider.

', ], ], 'CapacityProviderField' => [ 'base' => NULL, 'refs' => [ 'CapacityProviderFieldList$member' => NULL, ], ], 'CapacityProviderFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeCapacityProvidersRequest$include' => '

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren\'t included in the response.

', ], ], 'CapacityProviderStatus' => [ 'base' => NULL, 'refs' => [ 'CapacityProvider$status' => '

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

', ], ], 'CapacityProviderStrategy' => [ 'base' => NULL, 'refs' => [ 'Cluster$defaultCapacityProviderStrategy' => '

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

', 'CreateClusterRequest$defaultCapacityProviderStrategy' => '

The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.

If a default capacity provider strategy isn\'t defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.

', 'CreateServiceRequest$capacityProviderStrategy' => '

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

', 'CreateTaskSetRequest$capacityProviderStrategy' => '

The capacity provider strategy to use for the task set.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

', 'Deployment$capacityProviderStrategy' => '

The capacity provider strategy that the deployment is using.

', 'PutClusterCapacityProvidersRequest$defaultCapacityProviderStrategy' => '

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

', 'RunTaskRequest$capacityProviderStrategy' => '

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

A capacity provider strategy may contain a maximum of 6 capacity providers.

', 'Service$capacityProviderStrategy' => '

The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

', 'TaskSet$capacityProviderStrategy' => '

The capacity provider strategy that are associated with the task set.

', 'UpdateServiceRequest$capacityProviderStrategy' => '

The capacity provider strategy to update the service to use.

if the service uses the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that\'s not the default capacity provider strategy, the service can\'t be updated to use the cluster\'s default capacity provider strategy.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

', ], ], 'CapacityProviderStrategyItem' => [ 'base' => '

The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask or CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.

Only capacity providers that are already associated with a cluster and have an ACTIVE or UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.

A capacity provider strategy may contain a maximum of 6 capacity providers.

', 'refs' => [ 'CapacityProviderStrategy$member' => NULL, ], ], 'CapacityProviderStrategyItemBase' => [ 'base' => NULL, 'refs' => [ 'CapacityProviderStrategyItem$base' => '

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

', ], ], 'CapacityProviderStrategyItemWeight' => [ 'base' => NULL, 'refs' => [ 'CapacityProviderStrategyItem$weight' => '

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can\'t be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that\'s run using capacityProviderA, four tasks would use capacityProviderB.

', ], ], 'CapacityProviderUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'CapacityProvider$updateStatus' => '

The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS

The capacity provider is in the process of being deleted.

DELETE_COMPLETE

The capacity provider was successfully deleted and has an INACTIVE status.

DELETE_FAILED

The capacity provider can\'t be deleted. The update status reason provides further details about why the delete failed.

', ], ], 'CapacityProviders' => [ 'base' => NULL, 'refs' => [ 'DescribeCapacityProvidersResponse$capacityProviders' => '

The list of capacity providers.

', ], ], 'ClientException' => [ 'base' => '

These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn\'t have permissions to use the action or resource. Or, it might be specifying an identifier that isn\'t valid.

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

A regional grouping of one or more container instances where you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$cluster' => '

The full description of your new cluster.

', 'DeleteClusterResponse$cluster' => '

The full description of the deleted cluster.

', 'PutClusterCapacityProvidersResponse$cluster' => '

Details about the cluster.

', 'UpdateClusterResponse$cluster' => '

Details about the cluster.

', 'UpdateClusterSettingsResponse$cluster' => '

Details about the cluster

', ], ], 'ClusterConfiguration' => [ 'base' => '

The execute command configuration for the cluster.

', 'refs' => [ 'Cluster$configuration' => '

The execute command configuration for the cluster.

', 'CreateClusterRequest$configuration' => '

The execute command configuration for the cluster.

', 'UpdateClusterRequest$configuration' => '

The execute command configuration for the cluster.

', ], ], 'ClusterContainsContainerInstancesException' => [ 'base' => '

You can\'t delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

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

You can\'t delete a cluster that contains services. First, update the service to reduce its desired task count to 0, and then delete the service. For more information, see UpdateService and DeleteService.

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

You can\'t delete a cluster that has active tasks.

', 'refs' => [], ], 'ClusterField' => [ 'base' => NULL, 'refs' => [ 'ClusterFieldList$member' => NULL, ], ], 'ClusterFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersRequest$include' => '

Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn\'t included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

If SETTINGS is specified, the settings for the cluster are included.

If CONFIGURATIONS is specified, the configuration for the cluster is included.

If STATISTICS is specified, the task and service count is included, separated by launch type.

If TAGS is specified, the metadata tags associated with the cluster are included.

', ], ], 'ClusterNotFoundException' => [ 'base' => '

The specified cluster wasn\'t found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

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

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Cluster$serviceConnectDefaults' => '

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ClusterServiceConnectDefaultsRequest' => [ 'base' => '

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'CreateClusterRequest$serviceConnectDefaults' => '

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'UpdateClusterRequest$serviceConnectDefaults' => '

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ClusterSetting' => [ 'base' => '

The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.

', 'refs' => [ 'ClusterSettings$member' => NULL, ], ], 'ClusterSettingName' => [ 'base' => NULL, 'refs' => [ 'ClusterSetting$name' => '

The name of the cluster setting. The value is containerInsights .

', ], ], 'ClusterSettings' => [ 'base' => NULL, 'refs' => [ 'Cluster$settings' => '

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster.

', 'CreateClusterRequest$settings' => '

The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

', 'UpdateClusterRequest$settings' => '

The cluster settings for your cluster.

', 'UpdateClusterSettingsRequest$settings' => '

The setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Currently, if you delete an existing cluster that does not have Container Insights turned on, and then create a new cluster with the same name with Container Insights tuned on, Container Insights will not actually be turned on. If you want to preserve the same name for your existing cluster and turn on Container Insights, you must wait 7 days before you can re-create it.

', ], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$clusters' => '

The list of clusters.

', ], ], 'Compatibility' => [ 'base' => NULL, 'refs' => [ 'CompatibilityList$member' => NULL, ], ], 'CompatibilityList' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$requiresCompatibilities' => '

The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn\'t validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.

', 'TaskDefinition$compatibilities' => '

The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$requiresCompatibilities' => '

The task launch types the task definition was validated against. The valid values are EC2, FARGATE, and EXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

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

The RunTask request could not be processed due to conflicts. The provided clientToken is already in use with a different RunTask request. The resourceIds are the existing task ARNs which are already associated with the clientToken.

To fix this issue:

  • Run RunTask with a unique clientToken.

  • Run RunTask with the clientToken and the original set of parameters

', 'refs' => [], ], 'Connectivity' => [ 'base' => NULL, 'refs' => [ 'Task$connectivity' => '

The connectivity status of a task.

', ], ], 'Container' => [ 'base' => '

A Docker container that\'s part of a task.

', 'refs' => [ 'Containers$member' => NULL, ], ], 'ContainerCondition' => [ 'base' => NULL, 'refs' => [ 'ContainerDependency$condition' => '

The dependency condition of the container. The following are the available conditions and their behavior:

  • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

  • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can\'t be set on an essential container.

  • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can\'t be set on an essential container.

  • HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

', ], ], 'ContainerDefinition' => [ 'base' => '

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

', 'refs' => [ 'ContainerDefinitions$member' => NULL, ], ], 'ContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$containerDefinitions' => '

A list of container definitions in JSON format that describe the different containers that make up your task.

', 'TaskDefinition$containerDefinitions' => '

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ContainerDependencies' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$dependsOn' => '

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you\'re using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.

  • Windows platform version 1.0.0 or later.

', ], ], 'ContainerDependency' => [ 'base' => '

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you\'re using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks that use the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.

  • Windows platform version 1.0.0 or later.

', 'refs' => [ 'ContainerDependencies$member' => NULL, ], ], 'ContainerInstance' => [ 'base' => '

An Amazon EC2 or External instance that\'s running the Amazon ECS agent and has been registered with a cluster.

', 'refs' => [ 'ContainerInstances$member' => NULL, 'DeregisterContainerInstanceResponse$containerInstance' => '

The container instance that was deregistered.

', 'RegisterContainerInstanceResponse$containerInstance' => '

The container instance that was registered.

', 'UpdateContainerAgentResponse$containerInstance' => '

The container instance that the container agent was updated for.

', ], ], 'ContainerInstanceField' => [ 'base' => NULL, 'refs' => [ 'ContainerInstanceFieldList$member' => NULL, ], ], 'ContainerInstanceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesRequest$include' => '

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren\'t included in the response.

', ], ], 'ContainerInstanceHealthStatus' => [ 'base' => '

An object representing the health status of the container instance.

', 'refs' => [ 'ContainerInstance$healthStatus' => '

An object representing the health status of the container instance.

', ], ], 'ContainerInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'ListContainerInstancesRequest$status' => '

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don\'t specify this parameter, the default is to include container instances set to all states other than INACTIVE.

', 'UpdateContainerInstancesStateRequest$status' => '

The container instance state to update the container instance with. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but can\'t update the container instance state.

', ], ], 'ContainerInstances' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesResponse$containerInstances' => '

The list of container instances.

', 'UpdateContainerInstancesStateResponse$containerInstances' => '

The list of container instances.

', ], ], 'ContainerOverride' => [ 'base' => '

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For more information, see Retrieve secrets through environment variables in the Amazon ECS Developer Guide.

', 'refs' => [ 'ContainerOverrides$member' => NULL, ], ], 'ContainerOverrides' => [ 'base' => NULL, 'refs' => [ 'TaskOverride$containerOverrides' => '

One or more container overrides that are sent to a task.

', ], ], 'ContainerStateChange' => [ 'base' => '

An object that represents a change in state for a container.

', 'refs' => [ 'ContainerStateChanges$member' => NULL, ], ], 'ContainerStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$containers' => '

Any containers that\'s associated with the state change request.

', ], ], 'Containers' => [ 'base' => NULL, 'refs' => [ 'Task$containers' => '

The containers that\'s associated with the task.

', ], ], 'CreateCapacityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCapacityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTaskSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTaskSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCapacityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCapacityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'Deployment' => [ 'base' => '

The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.

', 'refs' => [ 'Deployments$member' => NULL, ], ], 'DeploymentAlarms' => [ 'base' => '

One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.

You can only use the DeploymentAlarms method to detect failures when the DeploymentController is set to ECS (rolling update).

For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .

', 'refs' => [ 'DeploymentConfiguration$alarms' => '

Information about the CloudWatch alarms.

', ], ], 'DeploymentCircuitBreaker' => [ 'base' => '

The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can\'t reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide.

For more information about API failure reasons, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'DeploymentConfiguration$deploymentCircuitBreaker' => '

The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can\'t reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide

', ], ], 'DeploymentConfiguration' => [ 'base' => '

Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.

', 'refs' => [ 'CreateServiceRequest$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', 'Service$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', 'UpdateServiceRequest$deploymentConfiguration' => '

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

', ], ], 'DeploymentController' => [ 'base' => '

The deployment controller to use for the service. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'CreateServiceRequest$deploymentController' => '

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

', 'Service$deploymentController' => '

The deployment controller type the service is using.

', ], ], 'DeploymentControllerType' => [ 'base' => NULL, 'refs' => [ 'DeploymentController$type' => '

The deployment controller type to use.

There are three deployment controller types available:

ECS

The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.

CODE_DEPLOY

The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.

EXTERNAL

The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

', ], ], 'DeploymentRolloutState' => [ 'base' => NULL, 'refs' => [ 'Deployment$rolloutState' => '

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren\'t behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a FAILED state. A deployment in FAILED state doesn\'t launch any new tasks. For more information, see DeploymentCircuitBreaker.

', ], ], 'Deployments' => [ 'base' => NULL, 'refs' => [ 'Service$deployments' => '

The current state of deployments for the service.

', ], ], 'DeregisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCapacityProvidersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCapacityProvidersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskSetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskSetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DesiredStatus' => [ 'base' => NULL, 'refs' => [ 'ListTasksRequest$desiredStatus' => '

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren\'t starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this doesn\'t return any results. Amazon ECS never sets the desired status of a task to that value (only a task\'s lastStatus may have a value of PENDING).

', ], ], 'Device' => [ 'base' => '

An object representing a container instance host device.

', 'refs' => [ 'DevicesList$member' => NULL, ], ], 'DeviceCgroupPermission' => [ 'base' => NULL, 'refs' => [ 'DeviceCgroupPermissions$member' => NULL, ], ], 'DeviceCgroupPermissions' => [ 'base' => NULL, 'refs' => [ 'Device$permissions' => '

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

', ], ], 'DevicesList' => [ 'base' => NULL, 'refs' => [ 'LinuxParameters$devices' => '

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

If you\'re using tasks that use the Fargate launch type, the devices parameter isn\'t supported.

', ], ], 'DiscoverPollEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DiscoverPollEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DockerLabelsMap' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$dockerLabels' => '

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', ], ], 'DockerVolumeConfiguration' => [ 'base' => '

This parameter is specified when you\'re using Docker volumes. Docker volumes are only supported when you\'re using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

', 'refs' => [ 'Volume$dockerVolumeConfiguration' => '

This parameter is specified when you use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren\'t supported by tasks run on Fargate.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'Resource$doubleValue' => '

When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

', 'Scale$value' => '

The value, specified as a percent total of a service\'s desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.

', ], ], 'EFSAuthorizationConfig' => [ 'base' => '

The authorization configuration details for the Amazon EFS file system.

', 'refs' => [ 'EFSVolumeConfiguration$authorizationConfig' => '

The authorization configuration details for the Amazon EFS file system.

', ], ], 'EFSAuthorizationConfigIAM' => [ 'base' => NULL, 'refs' => [ 'EFSAuthorizationConfig$iam' => '

Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.

', ], ], 'EFSTransitEncryption' => [ 'base' => NULL, 'refs' => [ 'EFSVolumeConfiguration$transitEncryption' => '

Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

', ], ], 'EFSVolumeConfiguration' => [ 'base' => '

This parameter is specified when you\'re using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Volume$efsVolumeConfiguration' => '

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

', ], ], 'EnvironmentFile' => [ 'base' => '

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they\'re processed from the top down. We recommend that you use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.

You must use the following platforms for the Fargate launch type:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

Consider the following when using the Fargate launch type:

  • The file is handled like a native Docker env-file.

  • There is no support for shell escape handling.

  • The container entry point interperts the VARIABLE values.

', 'refs' => [ 'EnvironmentFiles$member' => NULL, ], ], 'EnvironmentFileType' => [ 'base' => NULL, 'refs' => [ 'EnvironmentFile$type' => '

The file type to use. The only supported value is s3.

', ], ], 'EnvironmentFiles' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$environmentFiles' => '

A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file contains an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they\'re processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

', 'ContainerOverride$environmentFiles' => '

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

', ], ], 'EnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$environment' => '

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We don\'t recommend that you use plaintext environment variables for sensitive information, such as credential data.

', 'ContainerOverride$environment' => '

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

', ], ], 'EphemeralStorage' => [ 'base' => '

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

For tasks using the Fargate launch type, the task requires the following platforms:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

', 'refs' => [ 'RegisterTaskDefinitionRequest$ephemeralStorage' => '

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

For tasks using the Fargate launch type, the task requires the following platforms:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

', 'Task$ephemeralStorage' => '

The ephemeral storage settings for the task.

', 'TaskDefinition$ephemeralStorage' => '

The ephemeral storage settings to use for tasks run with the task definition.

', 'TaskOverride$ephemeralStorage' => '

The ephemeral storage setting override for the task.

This parameter is only supported for tasks hosted on Fargate that use the following platform versions:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

', ], ], 'ExecuteCommandConfiguration' => [ 'base' => '

The details of the execute command configuration.

', 'refs' => [ 'ClusterConfiguration$executeCommandConfiguration' => '

The details of the execute command configuration.

', ], ], 'ExecuteCommandLogConfiguration' => [ 'base' => '

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.

', 'refs' => [ 'ExecuteCommandConfiguration$logConfiguration' => '

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

', ], ], 'ExecuteCommandLogging' => [ 'base' => NULL, 'refs' => [ 'ExecuteCommandConfiguration$logging' => '

The log setting to use for redirecting logs for your execute command results. The following log settings are available.

  • NONE: The execute command session is not logged.

  • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won\'t be logged.

  • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

', ], ], 'ExecuteCommandRequest' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteCommandResponse' => [ 'base' => NULL, 'refs' => [], ], 'FSxWindowsFileServerAuthorizationConfig' => [ 'base' => '

The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API Reference.

For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'FSxWindowsFileServerVolumeConfiguration$authorizationConfig' => '

The authorization configuration details for the Amazon FSx for Windows File Server file system.

', ], ], 'FSxWindowsFileServerVolumeConfiguration' => [ 'base' => '

This parameter is specified when you\'re using Amazon FSx for Windows File Server file system for task storage.

For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Volume$fsxWindowsFileServerVolumeConfiguration' => '

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

', ], ], 'Failure' => [ 'base' => '

A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'Failures$member' => NULL, ], ], 'Failures' => [ 'base' => NULL, 'refs' => [ 'DeleteTaskDefinitionsResponse$failures' => '

Any failures associated with the call.

', 'DescribeCapacityProvidersResponse$failures' => '

Any failures associated with the call.

', 'DescribeClustersResponse$failures' => '

Any failures associated with the call.

', 'DescribeContainerInstancesResponse$failures' => '

Any failures associated with the call.

', 'DescribeServicesResponse$failures' => '

Any failures associated with the call.

', 'DescribeTaskSetsResponse$failures' => '

Any failures associated with the call.

', 'DescribeTasksResponse$failures' => '

Any failures associated with the call.

', 'GetTaskProtectionResponse$failures' => '

Any failures associated with the call.

', 'RunTaskResponse$failures' => '

Any failures associated with the call.

', 'StartTaskResponse$failures' => '

Any failures associated with the call.

', 'UpdateContainerInstancesStateResponse$failures' => '

Any failures associated with the call.

', 'UpdateTaskProtectionResponse$failures' => '

Any failures associated with the call.

', ], ], 'FirelensConfiguration' => [ 'base' => '

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'ContainerDefinition$firelensConfiguration' => '

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

', ], ], 'FirelensConfigurationOptionsMap' => [ 'base' => NULL, 'refs' => [ 'FirelensConfiguration$options' => '

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

', ], ], 'FirelensConfigurationType' => [ 'base' => NULL, 'refs' => [ 'FirelensConfiguration$type' => '

The log router to use. The valid values are fluentd or fluentbit.

', ], ], 'GetTaskProtectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTaskProtectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GpuIds' => [ 'base' => NULL, 'refs' => [ 'Container$gpuIds' => '

The IDs of each GPU assigned to the container.

', ], ], 'HealthCheck' => [ 'base' => '

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image\'s Dockerfile). This configuration maps to the HEALTHCHECK parameter of docker run.

The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.

You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.

The health check is designed to make sure that your containers survive agent restarts, upgrades, or temporary unavailability.

The following describes the possible healthStatus values for a container:

  • HEALTHY-The container health check has passed successfully.

  • UNHEALTHY-The container health check has failed.

  • UNKNOWN-The container health check is being evaluated, there\'s no container health check defined, or Amazon ECS doesn\'t have the health status of the container.

The following describes the possible healthStatus values based on the container health checker status of essential containers in the task with the following priority order (high to low):

  • UNHEALTHY-One or more essential containers have failed their health check.

  • UNKNOWN-Any essential container running within the task is in an UNKNOWN state and no other essential containers have an UNHEALTHY state.

  • HEALTHY-All essential containers within the task have passed their health checks.

Consider the following task health example with 2 containers.

  • If Container1 is UNHEALTHY and Container2 is UNKNOWN, the task health is UNHEALTHY.

  • If Container1 is UNHEALTHY and Container2 is HEALTHY, the task health is UNHEALTHY.

  • If Container1 is HEALTHY and Container2 is UNKNOWN, the task health is UNKNOWN.

  • If Container1 is HEALTHY and Container2 is HEALTHY, the task health is HEALTHY.

Consider the following task health example with 3 containers.

  • If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3 is UNKNOWN, the task health is UNHEALTHY.

  • If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3 is HEALTHY, the task health is UNHEALTHY.

  • If Container1 is UNHEALTHY and Container2 is HEALTHY, and Container3 is HEALTHY, the task health is UNHEALTHY.

  • If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is HEALTHY, the task health is UNKNOWN.

  • If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is UNKNOWN, the task health is UNKNOWN.

  • If Container1 is HEALTHY and Container2 is HEALTHY, and Container3 is HEALTHY, the task health is HEALTHY.

If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.

The following are notes about container health check support:

  • When the Amazon ECS agent cannot connect to the Amazon ECS service, the service reports the container as UNHEALTHY.

  • The health check statuses are the "last heard from" response from the Amazon ECS agent. There are no assumptions made about the status of the container health checks.

  • Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS container agent.

  • Container health checks are supported for Fargate tasks if you\'re using platform version 1.1.0 or greater. For more information, see Fargate platform versions.

  • Container health checks aren\'t supported for tasks that are part of a service that\'s configured to use a Classic Load Balancer.

', 'refs' => [ 'ContainerDefinition$healthCheck' => '

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

', ], ], 'HealthStatus' => [ 'base' => NULL, 'refs' => [ 'Container$healthStatus' => '

The health status of the container. If health checks aren\'t configured for this container in its task definition, then it reports the health status as UNKNOWN.

', 'Task$healthStatus' => '

The health status for the task. It\'s determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

The Amazon ECS container agent doesn\'t monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image\'s Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

', ], ], 'HostEntry' => [ 'base' => '

Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.

', 'refs' => [ 'HostEntryList$member' => NULL, ], ], 'HostEntryList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$extraHosts' => '

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

This parameter isn\'t supported for Windows containers or tasks that use the awsvpc network mode.

', ], ], 'HostVolumeProperties' => [ 'base' => '

Details on a container instance bind mount host volume.

', 'refs' => [ 'Volume$host' => '

This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it\'s stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn\'t guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can\'t mount directories on a different drive, and mount point can\'t be across drives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

', ], ], 'InferenceAccelerator' => [ 'base' => '

Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'InferenceAccelerators$member' => NULL, ], ], 'InferenceAcceleratorOverride' => [ 'base' => '

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'InferenceAcceleratorOverrides$member' => NULL, ], ], 'InferenceAcceleratorOverrides' => [ 'base' => NULL, 'refs' => [ 'TaskOverride$inferenceAcceleratorOverrides' => '

The Elastic Inference accelerator override for the task.

', ], ], 'InferenceAccelerators' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$inferenceAccelerators' => '

The Elastic Inference accelerators to use for the containers in the task.

', 'Task$inferenceAccelerators' => '

The Elastic Inference accelerator that\'s associated with the task.

', 'TaskDefinition$inferenceAccelerators' => '

The Elastic Inference accelerator that\'s associated with the task.

', ], ], 'InstanceHealthCheckResult' => [ 'base' => '

An object representing the result of a container instance health status check.

', 'refs' => [ 'InstanceHealthCheckResultList$member' => NULL, ], ], 'InstanceHealthCheckResultList' => [ 'base' => NULL, 'refs' => [ 'ContainerInstanceHealthStatus$details' => '

An array of objects representing the details of the container instance health status.

', ], ], 'InstanceHealthCheckState' => [ 'base' => NULL, 'refs' => [ 'ContainerInstanceHealthStatus$overallStatus' => '

The overall health status of the container instance. This is an aggregate status of all container instance health checks.

', 'InstanceHealthCheckResult$status' => '

The container instance health status.

', ], ], 'InstanceHealthCheckType' => [ 'base' => NULL, 'refs' => [ 'InstanceHealthCheckResult$type' => '

The type of container instance health status that was verified.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Cluster$registeredContainerInstancesCount' => '

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

', 'Cluster$runningTasksCount' => '

The number of tasks in the cluster that are in the RUNNING state.

', 'Cluster$pendingTasksCount' => '

The number of tasks in the cluster that are in the PENDING state.

', 'Cluster$activeServicesCount' => '

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

', 'ContainerDefinition$cpu' => '

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that\'s the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn\'t required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.

  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that\'s described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.

', 'ContainerInstance$runningTasksCount' => '

The number of tasks on the container instance that have a desired status (desiredStatus) of RUNNING.

', 'ContainerInstance$pendingTasksCount' => '

The number of tasks on the container instance that are in the PENDING status.

', 'Deployment$desiredCount' => '

The most recent desired count of tasks that was specified for the service to deploy or maintain.

', 'Deployment$pendingCount' => '

The number of tasks in the deployment that are in the PENDING status.

', 'Deployment$runningCount' => '

The number of tasks in the deployment that are in the RUNNING status.

', 'Deployment$failedTasks' => '

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can\'t launch the task, the task doesn\'t transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

', 'EphemeralStorage$sizeInGiB' => '

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

', 'ListAccountSettingsRequest$maxResults' => '

The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn\'t used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

', 'Resource$integerValue' => '

When the integerValue type is set, the value of the resource must be an integer.

', 'Service$desiredCount' => '

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

', 'Service$runningCount' => '

The number of tasks in the cluster that are in the RUNNING state.

', 'Service$pendingCount' => '

The number of tasks in the cluster that are in the PENDING state.

', 'TaskDefinition$revision' => '

The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.

', 'TaskSet$computedDesiredCount' => '

The computed desired count for the task set. This is calculated by multiplying the service\'s desiredCount by the task set\'s scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

', 'TaskSet$pendingCount' => '

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it\'s restarted after being in the STOPPED state.

', 'TaskSet$runningCount' => '

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

', 'Tmpfs$size' => '

The maximum size (in MiB) of the tmpfs volume.

', 'Ulimit$softLimit' => '

The soft limit for the ulimit type.

', 'Ulimit$hardLimit' => '

The hard limit for the ulimit type.

', ], ], 'InvalidParameterException' => [ 'base' => '

The specified parameter isn\'t valid. Review the available parameters for the API request.

', 'refs' => [], ], 'IpcMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$ipcMode' => '

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

  • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

  • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on Fargate.

', 'TaskDefinition$ipcMode' => '

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

  • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

  • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on Fargate.

', ], ], 'KernelCapabilities' => [ 'base' => '

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page.

', 'refs' => [ 'LinuxParameters$capabilities' => '

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.

', ], ], 'KeyValuePair' => [ 'base' => '

A key-value pair object.

', 'refs' => [ 'AttachmentDetails$member' => NULL, 'EnvironmentVariables$member' => NULL, 'ProxyConfigurationProperties$member' => NULL, 'Statistics$member' => NULL, ], ], 'LaunchType' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$launchType' => '

The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

', 'CreateTaskSetRequest$launchType' => '

The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

', 'Deployment$launchType' => '

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

', 'ListServicesRequest$launchType' => '

The launch type to use when filtering the ListServices results.

', 'ListTasksRequest$launchType' => '

The launch type to use when filtering the ListTasks results.

', 'RunTaskRequest$launchType' => '

The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

', 'Service$launchType' => '

The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

', 'Task$launchType' => '

The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

', 'TaskSet$launchType' => '

The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

', ], ], 'LimitExceededException' => [ 'base' => '

The limit for the resource was exceeded.

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

The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.

', 'refs' => [ 'ContainerDefinition$linuxParameters' => '

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

', ], ], 'ListAccountSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccountSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesByNamespaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesByNamespaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'LoadBalancer' => [ 'base' => '

The load balancer configuration to use with a service or task set.

When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers.

We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration.

A service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'LoadBalancers$member' => NULL, ], ], 'LoadBalancers' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$loadBalancers' => '

A load balancer object representing the load balancers to use with your service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

If the service uses the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service uses the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY, and it associates one target group with it. Then, it also associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that you can use to perform validation tests with Lambda functions before routing production traffic to it.

If you use the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group that\'s specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that\'s specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren\'t supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. This is because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

', 'CreateTaskSetRequest$loadBalancers' => '

A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

', 'Service$loadBalancers' => '

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

', 'TaskSet$loadBalancers' => '

Details on a load balancer that are used with a task set.

', 'UpdateServiceRequest$loadBalancers' => '

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using CreateDeployment through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

For services that use the external deployment controller, you can add, update, or remove load balancers by using CreateTaskSet. Note that multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

You can remove existing loadBalancers by passing an empty list.

', ], ], 'LogConfiguration' => [ 'base' => '

The log configuration for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .

By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Understand the following when specifying a log configuration for your containers.

  • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.

    For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

    For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

  • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.

  • For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

  • For tasks that are on Fargate, because you don\'t have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

', 'refs' => [ 'ContainerDefinition$logConfiguration' => '

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

', 'ServiceConnectConfiguration$logConfiguration' => NULL, ], ], 'LogConfigurationOptionsMap' => [ 'base' => NULL, 'refs' => [ 'LogConfiguration$options' => '

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

', ], ], 'LogDriver' => [ 'base' => NULL, 'refs' => [ 'LogConfiguration$logDriver' => '

The log driver to use for the container.

For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that isn\'t listed, you can fork the Amazon ECS container agent project that\'s available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don\'t currently provide support for running modified copies of this software.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$version' => '

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you\'re replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

', 'Resource$longValue' => '

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

', 'Task$version' => '

The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

', ], ], 'ManagedAgent' => [ 'base' => '

Details about the managed agent status for the container.

', 'refs' => [ 'ManagedAgents$member' => NULL, ], ], 'ManagedAgentName' => [ 'base' => NULL, 'refs' => [ 'ManagedAgent$name' => '

The name of the managed agent. When the execute command feature is turned on, the managed agent name is ExecuteCommandAgent.

', 'ManagedAgentStateChange$managedAgentName' => '

The name of the managed agent.

', ], ], 'ManagedAgentStateChange' => [ 'base' => '

An object representing a change in state for a managed agent.

', 'refs' => [ 'ManagedAgentStateChanges$member' => NULL, ], ], 'ManagedAgentStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$managedAgents' => '

The details for the managed agent that\'s associated with the task.

', ], ], 'ManagedAgents' => [ 'base' => NULL, 'refs' => [ 'Container$managedAgents' => '

The details of any Amazon ECS managed agents associated with the container.

', ], ], 'ManagedDraining' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroupProvider$managedDraining' => '

The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.

The default is ENABLED.

', 'AutoScalingGroupProviderUpdate$managedDraining' => '

The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.

The default is ENABLED.

', ], ], 'ManagedScaling' => [ 'base' => '

The managed scaling settings for the Auto Scaling group capacity provider.

When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.

If managed scaling is off, the user must manage the scaling of the Auto Scaling group.

', 'refs' => [ 'AutoScalingGroupProvider$managedScaling' => '

The managed scaling settings for the Auto Scaling group capacity provider.

', 'AutoScalingGroupProviderUpdate$managedScaling' => '

The managed scaling settings for the Auto Scaling group capacity provider.

', ], ], 'ManagedScalingInstanceWarmupPeriod' => [ 'base' => NULL, 'refs' => [ 'ManagedScaling$instanceWarmupPeriod' => '

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.

', ], ], 'ManagedScalingStatus' => [ 'base' => NULL, 'refs' => [ 'ManagedScaling$status' => '

Determines whether to use managed scaling for the capacity provider.

', ], ], 'ManagedScalingStepSize' => [ 'base' => NULL, 'refs' => [ 'ManagedScaling$minimumScalingStepSize' => '

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

', 'ManagedScaling$maximumScalingStepSize' => '

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of 10000 is used.

', ], ], 'ManagedScalingTargetCapacity' => [ 'base' => NULL, 'refs' => [ 'ManagedScaling$targetCapacity' => '

The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a targetCapacity of 90. The default value of 100 percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.

', ], ], 'ManagedTerminationProtection' => [ 'base' => NULL, 'refs' => [ 'AutoScalingGroupProvider$managedTerminationProtection' => '

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn\'t work.

When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is off, your Amazon EC2 instances aren\'t protected from termination when the Auto Scaling group scales in.

', 'AutoScalingGroupProviderUpdate$managedTerminationProtection' => '

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn\'t work.

When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is off, your Amazon EC2 instances aren\'t protected from termination when the Auto Scaling group scales in.

', ], ], 'MissingVersionException' => [ 'base' => '

Amazon ECS can\'t determine the current version of the Amazon ECS container agent on the container instance and doesn\'t have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn\'t use our version information.

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

The details for a volume mount point that\'s used in a container definition.

', 'refs' => [ 'MountPointList$member' => NULL, ], ], 'MountPointList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$mountPoints' => '

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can\'t mount directories on a different drive, and mount point can\'t be across drives.

', ], ], 'NamespaceNotFoundException' => [ 'base' => '

The specified namespace wasn\'t found.

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

Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

', 'refs' => [ 'NetworkBindings$member' => NULL, ], ], 'NetworkBindings' => [ 'base' => NULL, 'refs' => [ 'Container$networkBindings' => '

The network bindings associated with the container.

', 'ContainerStateChange$networkBindings' => '

Any network bindings that are associated with the container.

', 'SubmitContainerStateChangeRequest$networkBindings' => '

The network bindings of the container.

', ], ], 'NetworkConfiguration' => [ 'base' => '

The network configuration for a task or service.

', 'refs' => [ 'CreateServiceRequest$networkConfiguration' => '

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn\'t supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

', 'CreateTaskSetRequest$networkConfiguration' => '

An object representing the network configuration for a task set.

', 'Deployment$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'RunTaskRequest$networkConfiguration' => '

The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn\'t supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

', 'Service$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'StartTaskRequest$networkConfiguration' => '

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

', 'TaskSet$networkConfiguration' => '

The network configuration for the task set.

', 'UpdateServiceRequest$networkConfiguration' => '

An object representing the network configuration for the service.

', ], ], 'NetworkInterface' => [ 'base' => '

An object representing the elastic network interface for tasks that use the awsvpc network mode.

', 'refs' => [ 'NetworkInterfaces$member' => NULL, ], ], 'NetworkInterfaces' => [ 'base' => NULL, 'refs' => [ 'Container$networkInterfaces' => '

The network interfaces associated with the container.

', ], ], 'NetworkMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$networkMode' => '

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

', 'TaskDefinition$networkMode' => '

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

', ], ], 'NoUpdateAvailableException' => [ 'base' => '

There\'s no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it\'s so old that there\'s no update path to the current version.

', 'refs' => [], ], 'OSFamily' => [ 'base' => NULL, 'refs' => [ 'RuntimePlatform$operatingSystemFamily' => '

The operating system.

', ], ], 'PidMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$pidMode' => '

The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, there\'s a heightened risk of undesired process namespace exposure. For more information, see Docker security.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn\'t supported for Windows containers on Fargate.

', 'TaskDefinition$pidMode' => '

The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, there\'s a heightened risk of undesired process namespace exposure. For more information, see Docker security.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn\'t supported for Windows containers on Fargate.

', ], ], 'PlacementConstraint' => [ 'base' => '

An object representing a constraint on task placement. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.

If you\'re using the Fargate launch type, task placement constraints aren\'t supported.

', 'refs' => [ 'PlacementConstraints$member' => NULL, ], ], 'PlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'PlacementConstraint$type' => '

The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

', ], ], 'PlacementConstraints' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$placementConstraints' => '

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

', 'RunTaskRequest$placementConstraints' => '

An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).

', 'Service$placementConstraints' => '

The placement constraints for the tasks in the service.

', 'UpdateServiceRequest$placementConstraints' => '

An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

', ], ], 'PlacementStrategies' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$placementStrategy' => '

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.

', 'RunTaskRequest$placementStrategy' => '

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.

', 'Service$placementStrategy' => '

The placement strategy that determines how tasks for the service are placed.

', 'UpdateServiceRequest$placementStrategy' => '

The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules for each service.

', ], ], 'PlacementStrategy' => [ 'base' => '

The task placement strategy for a task or service. For more information, see Task placement strategies in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'PlacementStrategies$member' => NULL, ], ], 'PlacementStrategyType' => [ 'base' => NULL, 'refs' => [ 'PlacementStrategy$type' => '

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that\'s specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

', ], ], 'PlatformDevice' => [ 'base' => '

The devices that are available on the container instance. The only supported device type is a GPU.

', 'refs' => [ 'PlatformDevices$member' => NULL, ], ], 'PlatformDeviceType' => [ 'base' => NULL, 'refs' => [ 'PlatformDevice$type' => '

The type of device that\'s available on the container instance. The only supported value is GPU.

', ], ], 'PlatformDevices' => [ 'base' => NULL, 'refs' => [ 'RegisterContainerInstanceRequest$platformDevices' => '

The devices that are available on the container instance. The only supported device type is a GPU.

', ], ], 'PlatformTaskDefinitionIncompatibilityException' => [ 'base' => '

The specified platform version doesn\'t satisfy the required capabilities of the task definition.

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

The specified platform version doesn\'t exist.

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

Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Most fields of this parameter (containerPort, hostPort, protocol) maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run . If the network mode of a task definition is set to host, host ports must either be undefined or match the container port in the port mapping.

You can\'t expose the same container port for multiple protocols. If you attempt this, an error is returned.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

', 'refs' => [ 'PortMappingList$member' => NULL, ], ], 'PortMappingList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$portMappings' => '

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There\'s no loopback for port mappings on Windows, so you can\'t access a container\'s mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can\'t specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

', ], ], 'PortNumber' => [ 'base' => NULL, 'refs' => [ 'ServiceConnectClientAlias$port' => '

The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'ServiceConnectService$ingressPortOverride' => '

The port number for the Service Connect proxy to listen on.

Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.

In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.

', ], ], 'PropagateTags' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren\'t propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

The default is NONE.

', 'RunTaskRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren\'t propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

', 'Service$propagateTags' => '

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren\'t propagated.

', 'StartTaskRequest$propagateTags' => '

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren\'t propagated.

', 'UpdateServiceRequest$propagateTags' => '

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren\'t propagated.

Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

', ], ], 'ProtectedTask' => [ 'base' => '

An object representing the protection status details for a task. You can set the protection status with the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection API.

', 'refs' => [ 'ProtectedTasks$member' => NULL, ], ], 'ProtectedTasks' => [ 'base' => NULL, 'refs' => [ 'GetTaskProtectionResponse$protectedTasks' => '

A list of tasks with the following information.

  • taskArn: The task ARN.

  • protectionEnabled: The protection status of the task. If scale-in protection is turned on for a task, the value is true. Otherwise, it is false.

  • expirationDate: The epoch time when protection for the task will expire.

', 'UpdateTaskProtectionResponse$protectedTasks' => '

A list of tasks with the following information.

  • taskArn: The task ARN.

  • protectionEnabled: The protection status of the task. If scale-in protection is turned on for a task, the value is true. Otherwise, it is false.

  • expirationDate: The epoch time when protection for the task will expire.

', ], ], 'ProxyConfiguration' => [ 'base' => '

The configuration details for the App Mesh proxy.

For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI

', 'refs' => [ 'RegisterTaskDefinitionRequest$proxyConfiguration' => '

The configuration details for the App Mesh proxy.

For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$proxyConfiguration' => '

The configuration details for the App Mesh proxy.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ProxyConfigurationProperties' => [ 'base' => NULL, 'refs' => [ 'ProxyConfiguration$properties' => '

The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.

  • IgnoredUID - (Required) The user ID (UID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.

  • IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID is specified, this field can be empty.

  • AppPorts - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort.

  • ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to.

  • ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to.

  • EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

  • EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

', ], ], 'ProxyConfigurationType' => [ 'base' => NULL, 'refs' => [ 'ProxyConfiguration$type' => '

The proxy type. The only supported value is APPMESH.

', ], ], 'PutAccountSettingDefaultRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingDefaultResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutClusterCapacityProvidersRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutClusterCapacityProvidersResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RepositoryCredentials' => [ 'base' => '

The repository credentials for private registry authentication.

', 'refs' => [ 'ContainerDefinition$repositoryCredentials' => '

The private repository authentication credentials to use.

', ], ], 'RequiresAttributes' => [ 'base' => NULL, 'refs' => [ 'TaskDefinition$requiresAttributes' => '

The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

This parameter isn\'t supported for tasks run on Fargate.

', ], ], 'Resource' => [ 'base' => '

Describes the resources available for a container instance.

', 'refs' => [ 'Resources$member' => NULL, ], ], 'ResourceIds' => [ 'base' => NULL, 'refs' => [ 'ConflictException$resourceIds' => '

The existing task ARNs which are already associated with the clientToken.

', ], ], 'ResourceInUseException' => [ 'base' => '

The specified resource is in-use and can\'t be removed.

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

The specified resource wasn\'t found.

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

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide

', 'refs' => [ 'ResourceRequirements$member' => NULL, ], ], 'ResourceRequirements' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$resourceRequirements' => '

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

', 'ContainerOverride$resourceRequirements' => '

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceRequirement$type' => '

The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.

', ], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$remainingResources' => '

For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn\'t already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that\'s not specified here is available for new tasks.

', 'ContainerInstance$registeredResources' => '

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

', 'RegisterContainerInstanceRequest$totalResources' => '

The resources available on the instance.

', ], ], 'RunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'RuntimePlatform' => [ 'base' => '

Information about the platform for the Amazon ECS service or task.

For more information about RuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'RegisterTaskDefinitionRequest$runtimePlatform' => '

The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.

When you specify a task definition in a service, this value must match the runtimePlatform value of the service.

', 'TaskDefinition$runtimePlatform' => '

The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

When you specify a task in a service, this value must match the runtimePlatform value of the service.

', ], ], 'Scale' => [ 'base' => '

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

', 'refs' => [ 'CreateTaskSetRequest$scale' => '

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

', 'TaskSet$scale' => '

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

', 'UpdateTaskSetRequest$scale' => '

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

', ], ], 'ScaleUnit' => [ 'base' => NULL, 'refs' => [ 'Scale$unit' => '

The unit of measure for the scale value.

', ], ], 'SchedulingStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$schedulingStrategy' => '

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

  • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.

  • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don\'t meet the placement constraints. When you\'re using this strategy, you don\'t need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

    Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don\'t support the DAEMON scheduling strategy.
', 'ListServicesRequest$schedulingStrategy' => '

The scheduling strategy to use when filtering the ListServices results.

', 'Service$schedulingStrategy' => '

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available.

  • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

  • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don\'t meet the placement constraints.

    Fargate tasks don\'t support the DAEMON scheduling strategy.
', ], ], 'Scope' => [ 'base' => NULL, 'refs' => [ 'DockerVolumeConfiguration$scope' => '

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

', ], ], 'Secret' => [ 'base' => '

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

  • To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.

  • To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'SecretList$member' => NULL, ], ], 'SecretList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$secrets' => '

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

', 'LogConfiguration$secretOptions' => '

The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

', ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'Session$tokenValue' => '

An encrypted token value containing session and caller information. It\'s used to authenticate the connection to the container.

', ], ], 'ServerException' => [ 'base' => '

These errors are usually caused by a server issue.

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

Details on a service within a cluster.

', 'refs' => [ 'CreateServiceResponse$service' => '

The full description of your service following the create call.

A service will return either a capacityProviderStrategy or launchType parameter, but not both, depending where one was specified when it was created.

If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.

if the service uses the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.

', 'DeleteServiceResponse$service' => '

The full description of the deleted service.

', 'Services$member' => NULL, 'UpdateServiceResponse$service' => '

The full description of your service following the update call.

', ], ], 'ServiceConnectClientAlias' => [ 'base' => '

Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can use to connect to this service.

Each name and port mapping must be unique within the namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'ServiceConnectClientAliasList$member' => NULL, ], ], 'ServiceConnectClientAliasList' => [ 'base' => NULL, 'refs' => [ 'ServiceConnectService$clientAliases' => '

The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.

Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.

Each name and port mapping must be unique within the namespace.

For each ServiceConnectService, you must provide at least one clientAlias with one port.

', ], ], 'ServiceConnectConfiguration' => [ 'base' => '

The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'CreateServiceRequest$serviceConnectConfiguration' => '

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'Deployment$serviceConnectConfiguration' => '

The details of the Service Connect configuration that\'s used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'UpdateServiceRequest$serviceConnectConfiguration' => '

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', ], ], 'ServiceConnectService' => [ 'base' => '

The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'refs' => [ 'ServiceConnectServiceList$member' => NULL, ], ], 'ServiceConnectServiceList' => [ 'base' => NULL, 'refs' => [ 'ServiceConnectConfiguration$services' => '

The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

This field is not required for a "client" Amazon ECS service that\'s a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that\'s attached to the service or by other means.

An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

', ], ], 'ServiceConnectServiceResource' => [ 'base' => '

The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name. The data is stored in Cloud Map as part of the Service Connect configuration for each discovery name of this Amazon ECS service.

A task can resolve the dnsName for each of the clientAliases of a service. However a task can\'t resolve the discovery names. If you want to connect to a service, refer to the ServiceConnectConfiguration of that service for the list of clientAliases that you can use.

', 'refs' => [ 'ServiceConnectServiceResourceList$member' => NULL, ], ], 'ServiceConnectServiceResourceList' => [ 'base' => NULL, 'refs' => [ 'Deployment$serviceConnectResources' => '

The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

', ], ], 'ServiceEvent' => [ 'base' => '

The details for an event that\'s associated with a service.

', 'refs' => [ 'ServiceEvents$member' => NULL, ], ], 'ServiceEvents' => [ 'base' => NULL, 'refs' => [ 'Service$events' => '

The event stream for your service. A maximum of 100 of the latest events are displayed.

', ], ], 'ServiceField' => [ 'base' => NULL, 'refs' => [ 'ServiceFieldList$member' => NULL, ], ], 'ServiceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesRequest$include' => '

Determines whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren\'t included in the response.

', ], ], 'ServiceNotActiveException' => [ 'base' => '

The specified service isn\'t active. You can\'t update a service that\'s inactive. If you have previously deleted a service, you can re-create it with CreateService.

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

The specified service wasn\'t found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

', 'refs' => [], ], 'ServiceRegistries' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$serviceRegistries' => '

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries for each service isn\'t supported.

', 'CreateTaskSetRequest$serviceRegistries' => '

The details of the service discovery registries to assign to this task set. For more information, see Service discovery.

', 'Service$serviceRegistries' => '

The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

', 'TaskSet$serviceRegistries' => '

The details for the service discovery registries to assign to this task set. For more information, see Service discovery.

', 'UpdateServiceRequest$serviceRegistries' => '

The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

You can remove existing serviceRegistries by passing an empty list.

', ], ], 'ServiceRegistry' => [ 'base' => '

The details for the service registry.

Each service may be associated with one service registry. Multiple service registries for each service are not supported.

When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.

', 'refs' => [ 'ServiceRegistries$member' => NULL, ], ], 'Services' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$services' => '

The list of services described.

', ], ], 'Session' => [ 'base' => '

The details for the execute command session.

', 'refs' => [ 'ExecuteCommandResponse$session' => '

The details of the SSM session that was created for this instance of execute-command.

', ], ], 'Setting' => [ 'base' => '

The current account setting for a resource.

', 'refs' => [ 'DeleteAccountSettingResponse$setting' => '

The account setting for the specified principal ARN.

', 'PutAccountSettingDefaultResponse$setting' => '

The current setting for a resource.

', 'PutAccountSettingResponse$setting' => '

The current account setting for a resource.

', 'Settings$member' => NULL, ], ], 'SettingName' => [ 'base' => NULL, 'refs' => [ 'DeleteAccountSettingRequest$name' => '

The resource name to disable the account setting for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.

', 'ListAccountSettingsRequest$name' => '

The name of the account setting you want to list the settings for.

', 'PutAccountSettingDefaultRequest$name' => '

The resource name for which to modify the account setting. If you specify serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the ENI limit for your Amazon ECS container instances is affected. If you specify containerInsights, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify tagResourceAuthorization, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to required maintenance is affected.

When you specify fargateFIPSMode for the name and enabled for the value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more information about FIPS-140 compliance with Fargate, see Amazon Web Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon Elastic Container Service Developer Guide.

When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to set the wait time to retire a Fargate task to the default. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

', 'PutAccountSettingRequest$name' => '

The Amazon ECS resource name for which to modify the account setting. If you specify serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If you specify containerInsights, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify fargateFIPSMode, Fargate FIPS 140 compliance is affected. If you specify tagResourceAuthorization, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify fargateTaskRetirementWaitPeriod, the wait time to retire a Fargate task is affected.

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

', 'Setting$name' => '

The Amazon ECS resource name.

', ], ], 'SettingType' => [ 'base' => NULL, 'refs' => [ 'Setting$type' => '

Indicates whether Amazon Web Services manages the account setting, or if the user manages it.

aws_managed account settings are read-only, as Amazon Web Services manages such on the customer\'s behalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services manages.

', ], ], 'Settings' => [ 'base' => NULL, 'refs' => [ 'ListAccountSettingsResponse$settings' => '

The account settings for the resource.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$sort' => '

The order to sort the results in. Valid values are ASC and DESC. By default, (ASC) task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.

', ], ], 'StabilityStatus' => [ 'base' => NULL, 'refs' => [ 'TaskSet$stabilityStatus' => '

The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks that are running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions aren\'t met, the stability status returns STABILIZING.

', ], ], 'StartTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistics' => [ 'base' => NULL, 'refs' => [ 'Cluster$statistics' => '

Additional information about your clusters that are separated by launch type. They include the following:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

', ], ], 'StopTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Attachment$id' => '

The unique identifier for the attachment.

', 'Attachment$type' => '

The type of the attachment, such as ElasticNetworkInterface.

', 'Attachment$status' => '

The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.

', 'AttachmentStateChange$attachmentArn' => '

The Amazon Resource Name (ARN) of the attachment.

', 'AttachmentStateChange$status' => '

The status of the attachment.

', 'Attribute$name' => '

The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\\), or periods (.).

', 'Attribute$value' => '

The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\\), colons (:), or spaces. The value can\'t start or end with a space.

', 'Attribute$targetId' => '

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

', 'AutoScalingGroupProvider$autoScalingGroupArn' => '

The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.

', 'CapacityProvider$capacityProviderArn' => '

The Amazon Resource Name (ARN) that identifies the capacity provider.

', 'CapacityProvider$name' => '

The name of the capacity provider.

', 'CapacityProvider$updateStatusReason' => '

The update status reason. This provides further details about the update status for the capacity provider.

', 'CapacityProviderStrategyItem$capacityProvider' => '

The short name of the capacity provider.

', 'ClientException$message' => '

Message that describes the cause of the exception.

', 'Cluster$clusterArn' => '

The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

', 'Cluster$clusterName' => '

A user-generated string that you use to identify your cluster.

', 'Cluster$status' => '

The status of the cluster. The following are the possible states that are returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don\'t recommend that you rely on INACTIVE clusters persisting.

', 'Cluster$attachmentsStatus' => '

The status of the capacity providers associated with the cluster. The following are the states that are returned.

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

', 'ClusterServiceConnectDefaults$namespace' => '

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don\'t specify a Service Connect configuration, this namespace is used.

', 'ClusterServiceConnectDefaultsRequest$namespace' => '

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that\'s used when you create a service and don\'t specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can\'t include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren\'t used by Service Connect.

If you update the cluster with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.

', 'ClusterSetting$value' => '

The value to set for the cluster setting. The supported values are enabled and disabled.

If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

', 'Container$containerArn' => '

The Amazon Resource Name (ARN) of the container.

', 'Container$taskArn' => '

The ARN of the task.

', 'Container$name' => '

The name of the container.

', 'Container$image' => '

The image used for the container.

', 'Container$imageDigest' => '

The container image manifest digest.

', 'Container$runtimeId' => '

The ID of the Docker container.

', 'Container$lastStatus' => '

The last known status of the container.

', 'Container$reason' => '

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

', 'Container$cpu' => '

The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

', 'Container$memory' => '

The hard limit (in MiB) of memory set for the container.

', 'Container$memoryReservation' => '

The soft limit (in MiB) of memory set for the container.

', 'ContainerDefinition$name' => '

The name of a container. If you\'re linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

', 'ContainerDefinition$image' => '

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren\'t propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

', 'ContainerDefinition$hostname' => '

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

The hostname parameter is not supported if you\'re using the awsvpc network mode.

', 'ContainerDefinition$user' => '

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

When running tasks using the host network mode, don\'t run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

', 'ContainerDefinition$workingDirectory' => '

The working directory to run commands inside the container in. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

', 'ContainerDependency$containerName' => '

The name of a container.

', 'ContainerInstance$containerInstanceArn' => '

The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

', 'ContainerInstance$ec2InstanceId' => '

The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

', 'ContainerInstance$capacityProviderName' => '

The capacity provider that\'s associated with the container instance.

', 'ContainerInstance$status' => '

The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren\'t placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

', 'ContainerInstance$statusReason' => '

The reason that the container instance reached its current status.

', 'ContainerOverride$name' => '

The name of the container that receives the override. This parameter is required if any override is specified.

', 'ContainerStateChange$containerName' => '

The name of the container.

', 'ContainerStateChange$imageDigest' => '

The container image SHA 256 digest.

', 'ContainerStateChange$runtimeId' => '

The ID of the Docker container.

', 'ContainerStateChange$reason' => '

The reason for the state change.

', 'ContainerStateChange$status' => '

The status of the container.

', 'CreateCapacityProviderRequest$name' => '

The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can\'t be prefixed with "aws", "ecs", or "fargate".

', 'CreateClusterRequest$clusterName' => '

The name of your cluster. If you don\'t specify a name for your cluster, you create a cluster that\'s named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

', 'CreateServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.

', 'CreateServiceRequest$serviceName' => '

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

', 'CreateServiceRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn\'t specified, the latest ACTIVE revision is used.

A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.

For more information about deployment types, see Amazon ECS deployment types.

', 'CreateServiceRequest$clientToken' => '

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

', 'CreateServiceRequest$platformVersion' => '

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn\'t specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

', 'CreateServiceRequest$role' => '

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn\'t use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don\'t specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

', 'CreateTaskSetRequest$service' => '

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

', 'CreateTaskSetRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

', 'CreateTaskSetRequest$externalId' => '

An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided value.

', 'CreateTaskSetRequest$taskDefinition' => '

The task definition for the tasks in the task set to use. If a revision isn\'t specified, the latest ACTIVE revision is used.

', 'CreateTaskSetRequest$platformVersion' => '

The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn\'t specified, the LATEST platform version is used.

', 'CreateTaskSetRequest$clientToken' => '

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

', 'DeleteAccountSettingRequest$principalArn' => '

The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

', 'DeleteAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

', 'DeleteCapacityProviderRequest$capacityProvider' => '

The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.

', 'DeleteClusterRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

', 'DeleteServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

', 'DeleteServiceRequest$service' => '

The name of the service to delete.

', 'DeleteTaskSetRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.

', 'DeleteTaskSetRequest$service' => '

The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.

', 'DeleteTaskSetRequest$taskSet' => '

The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

', 'Deployment$id' => '

The ID of the deployment.

', 'Deployment$status' => '

The status of the deployment. The following describes each state.

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

', 'Deployment$taskDefinition' => '

The most recent task definition that was specified for the tasks in the service to use.

', 'Deployment$platformVersion' => '

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn\'t specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Deployment$platformFamily' => '

The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

', 'Deployment$rolloutStateReason' => '

A description of the rollout state of a deployment.

', 'DeregisterContainerInstanceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

', 'DeregisterContainerInstanceRequest$containerInstance' => '

The container instance ID or full ARN of the container instance to deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

', 'DeregisterTaskDefinitionRequest$taskDefinition' => '

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

', 'DescribeCapacityProvidersRequest$nextToken' => '

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'DescribeCapacityProvidersResponse$nextToken' => '

The nextToken value to include in a future DescribeCapacityProviders request. When the results of a DescribeCapacityProviders request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'DescribeContainerInstancesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

', 'DescribeServicesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.

', 'DescribeTaskDefinitionRequest$taskDefinition' => '

The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

', 'DescribeTaskSetsRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

', 'DescribeTaskSetsRequest$service' => '

The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

', 'DescribeTasksRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

', 'Device$hostPath' => '

The path for the device on the host container instance.

', 'Device$containerPath' => '

The path inside the container at which to expose the host device.

', 'DiscoverPollEndpointRequest$containerInstance' => '

The container instance ID or full ARN of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

', 'DiscoverPollEndpointRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.

', 'DiscoverPollEndpointResponse$endpoint' => '

The endpoint for the Amazon ECS agent to poll.

', 'DiscoverPollEndpointResponse$telemetryEndpoint' => '

The telemetry endpoint for the Amazon ECS agent.

', 'DiscoverPollEndpointResponse$serviceConnectEndpoint' => '

The endpoint for the Amazon ECS agent to poll for Service Connect configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'DockerLabelsMap$key' => NULL, 'DockerLabelsMap$value' => NULL, 'DockerVolumeConfiguration$driver' => '

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

', 'EFSAuthorizationConfig$accessPointId' => '

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

', 'EFSVolumeConfiguration$fileSystemId' => '

The Amazon EFS file system ID to use.

', 'EFSVolumeConfiguration$rootDirectory' => '

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

', 'EnvironmentFile$value' => '

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

', 'ExecuteCommandConfiguration$kmsKeyId' => '

Specify an Key Management Service key ID to encrypt the data between the local client and the container.

', 'ExecuteCommandLogConfiguration$cloudWatchLogGroupName' => '

The name of the CloudWatch log group to send logs to.

The CloudWatch log group must already be created.

', 'ExecuteCommandLogConfiguration$s3BucketName' => '

The name of the S3 bucket to send logs to.

The S3 bucket must already be created.

', 'ExecuteCommandLogConfiguration$s3KeyPrefix' => '

An optional folder in the S3 bucket to place logs in.

', 'ExecuteCommandRequest$cluster' => '

The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.

', 'ExecuteCommandRequest$container' => '

The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.

', 'ExecuteCommandRequest$command' => '

The command to run on the container.

', 'ExecuteCommandRequest$task' => '

The Amazon Resource Name (ARN) or ID of the task the container is part of.

', 'ExecuteCommandResponse$clusterArn' => '

The Amazon Resource Name (ARN) of the cluster.

', 'ExecuteCommandResponse$containerArn' => '

The Amazon Resource Name (ARN) of the container.

', 'ExecuteCommandResponse$containerName' => '

The name of the container.

', 'ExecuteCommandResponse$taskArn' => '

The Amazon Resource Name (ARN) of the task.

', 'FSxWindowsFileServerAuthorizationConfig$credentialsParameter' => '

The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.

', 'FSxWindowsFileServerAuthorizationConfig$domain' => '

A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.

', 'FSxWindowsFileServerVolumeConfiguration$fileSystemId' => '

The Amazon FSx for Windows File Server file system ID to use.

', 'FSxWindowsFileServerVolumeConfiguration$rootDirectory' => '

The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.

', 'Failure$arn' => '

The Amazon Resource Name (ARN) of the failed resource.

', 'Failure$reason' => '

The reason for the failure.

', 'Failure$detail' => '

The details of the failure.

', 'FirelensConfigurationOptionsMap$key' => NULL, 'FirelensConfigurationOptionsMap$value' => NULL, 'GetTaskProtectionRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

', 'GpuIds$member' => NULL, 'HostEntry$hostname' => '

The hostname to use in the /etc/hosts entry.

', 'HostEntry$ipAddress' => '

The IP address to use in the /etc/hosts entry.

', 'HostVolumeProperties$sourcePath' => '

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that\'s presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value doesn\'t exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you\'re using the Fargate launch type, the sourcePath parameter is not supported.

', 'InferenceAccelerator$deviceName' => '

The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.

', 'InferenceAccelerator$deviceType' => '

The Elastic Inference accelerator type to use.

', 'InferenceAcceleratorOverride$deviceName' => '

The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

', 'InferenceAcceleratorOverride$deviceType' => '

The Elastic Inference accelerator type to use.

', 'KeyValuePair$name' => '

The name of the key-value pair. For environment variables, this is the name of the environment variable.

', 'KeyValuePair$value' => '

The value of the key-value pair. For environment variables, this is the value of the environment variable.

', 'ListAccountSettingsRequest$value' => '

The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

', 'ListAccountSettingsRequest$principalArn' => '

The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Federated users assume the account setting of the root user and can\'t have explicit account settings set for them.

', 'ListAccountSettingsRequest$nextToken' => '

The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it\'s possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListAccountSettingsResponse$nextToken' => '

The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

', 'ListAttributesRequest$attributeName' => '

The name of the attribute to filter the results with.

', 'ListAttributesRequest$attributeValue' => '

The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.

', 'ListAttributesRequest$nextToken' => '

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it\'s possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListAttributesResponse$nextToken' => '

The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListClustersRequest$nextToken' => '

The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it\'s possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListClustersResponse$nextToken' => '

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListContainerInstancesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

', 'ListContainerInstancesRequest$filter' => '

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

', 'ListContainerInstancesRequest$nextToken' => '

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it\'s possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListContainerInstancesResponse$nextToken' => '

The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListServicesByNamespaceRequest$namespace' => '

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'ListServicesByNamespaceRequest$nextToken' => '

The nextToken value that\'s returned from a ListServicesByNamespace request. It indicates that more results are available to fulfill the request and further calls are needed. If maxResults is returned, it is possible the number of results is less than maxResults.

', 'ListServicesByNamespaceResponse$nextToken' => '

The nextToken value to include in a future ListServicesByNamespace request. When the results of a ListServicesByNamespace request exceed maxResults, this value can be used to retrieve the next page of results. When there are no more results to return, this value is null.

', 'ListServicesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

', 'ListServicesRequest$nextToken' => '

The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListServicesResponse$nextToken' => '

The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTagsForResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

', 'ListTaskDefinitionFamiliesRequest$familyPrefix' => '

The familyPrefix is a string that\'s used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

', 'ListTaskDefinitionFamiliesRequest$nextToken' => '

The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTaskDefinitionFamiliesResponse$nextToken' => '

The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTaskDefinitionsRequest$familyPrefix' => '

The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

', 'ListTaskDefinitionsRequest$nextToken' => '

The nextToken value returned from a ListTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTaskDefinitionsResponse$nextToken' => '

The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'ListTasksRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

', 'ListTasksRequest$containerInstance' => '

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

', 'ListTasksRequest$family' => '

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

', 'ListTasksRequest$nextToken' => '

The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it\'s possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

', 'ListTasksRequest$startedBy' => '

The startedBy value to filter the task results with. Specifying a startedBy value limits the results to tasks that were started with that value.

When you specify startedBy as the filter, it must be the only filter that you use.

', 'ListTasksRequest$serviceName' => '

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

', 'ListTasksResponse$nextToken' => '

The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

', 'LoadBalancer$targetGroupArn' => '

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you\'re required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service\'s task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

', 'LoadBalancer$loadBalancerName' => '

The name of the load balancer to associate with the Amazon ECS service or task set.

If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

', 'LoadBalancer$containerName' => '

The name of the container (as it appears in a container definition) to associate with the load balancer.

', 'LogConfigurationOptionsMap$key' => NULL, 'LogConfigurationOptionsMap$value' => NULL, 'ManagedAgent$reason' => '

The reason for why the managed agent is in the state it is in.

', 'ManagedAgent$lastStatus' => '

The last known status of the managed agent.

', 'ManagedAgentStateChange$containerName' => '

The name of the container that\'s associated with the managed agent.

', 'ManagedAgentStateChange$status' => '

The status of the managed agent.

', 'ManagedAgentStateChange$reason' => '

The reason for the status of the managed agent.

', 'MountPoint$sourceVolume' => '

The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

', 'MountPoint$containerPath' => '

The path on the container to mount the host volume at.

', 'NetworkBinding$bindIP' => '

The IP address that the container is bound to on the container instance.

', 'NetworkBinding$containerPortRange' => '

The port number range on the container that\'s bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

  • You must use either the bridge network mode or the awsvpc network mode.

  • This parameter is available for both the EC2 and Fargate launch types.

  • This parameter is available for both the Linux and Windows operating systems.

  • The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package

  • You can specify a maximum of 100 port ranges per container.

  • You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

    • For containers in a task with the awsvpc network mode, the hostPortRange is set to the same value as the containerPortRange. This is a static mapping strategy.

    • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.

  • The containerPortRange valid values are between 1 and 65535.

  • A port can only be included in one port mapping per container.

  • You cannot specify overlapping port ranges.

  • The first port in the range must be less than last port in the range.

  • Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

    For more information, see Issue #11185 on the Github website.

    For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

', 'NetworkBinding$hostPortRange' => '

The port number range on the host that\'s used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.

', 'NetworkInterface$attachmentId' => '

The attachment ID for the network interface.

', 'NetworkInterface$privateIpv4Address' => '

The private IPv4 address for the network interface.

', 'NetworkInterface$ipv6Address' => '

The private IPv6 address for the network interface.

', 'PlacementConstraint$expression' => '

A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can\'t specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

', 'PlacementStrategy$field' => '

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that\'s applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

', 'PlatformDevice$id' => '

The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.

', 'PortMapping$name' => '

The name that\'s used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the serviceConnectConfiguration of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can\'t start with a hyphen.

For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'PortMapping$containerPortRange' => '

The port number range on the container that\'s bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

  • You must use either the bridge network mode or the awsvpc network mode.

  • This parameter is available for both the EC2 and Fargate launch types.

  • This parameter is available for both the Linux and Windows operating systems.

  • The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package

  • You can specify a maximum of 100 port ranges per container.

  • You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

    • For containers in a task with the awsvpc network mode, the hostPortRange is set to the same value as the containerPortRange. This is a static mapping strategy.

    • For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.

  • The containerPortRange valid values are between 1 and 65535.

  • A port can only be included in one port mapping per container.

  • You cannot specify overlapping port ranges.

  • The first port in the range must be less than last port in the range.

  • Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

    For more information, see Issue #11185 on the Github website.

    For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

', 'ProtectedTask$taskArn' => '

The task ARN.

', 'ProxyConfiguration$containerName' => '

The name of the container that will serve as the App Mesh proxy.

', 'PutAccountSettingDefaultRequest$value' => '

The account setting value for the specified principal ARN. Accepted values are enabled, disabled, on, and off.

When you specify fargateTaskRetirementWaitPeriod for the name, the following are the valid values:

  • 0 - Amazon Web Services sends the notification, and immediately retires the affected tasks.

  • 7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.

  • 14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.

', 'PutAccountSettingRequest$value' => '

The account setting value for the specified principal ARN. Accepted values are enabled, disabled, on, and off.

When you specify fargateTaskRetirementWaitPeriod for the name, the following are the valid values:

  • 0 - Amazon Web Services sends the notification, and immediately retires the affected tasks.

  • 7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.

  • 14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.

', 'PutAccountSettingRequest$principalArn' => '

The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it modifies the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

You must use the root user when you set the Fargate wait time (fargateTaskRetirementWaitPeriod).

Federated users assume the account setting of the root user and can\'t have explicit account settings set for them.

', 'PutAttributesRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.

', 'PutClusterCapacityProvidersRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don\'t specify a cluster, the default cluster is assumed.

', 'RegisterContainerInstanceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.

', 'RegisterContainerInstanceRequest$instanceIdentityDocument' => '

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

', 'RegisterContainerInstanceRequest$instanceIdentityDocumentSignature' => '

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

', 'RegisterContainerInstanceRequest$containerInstanceArn' => '

The ARN of the container instance (if it was previously registered).

', 'RegisterTaskDefinitionRequest$family' => '

You must specify a family for a task definition. You can use it track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

', 'RegisterTaskDefinitionRequest$taskRoleArn' => '

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

', 'RegisterTaskDefinitionRequest$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

', 'RegisterTaskDefinitionRequest$cpu' => '

The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, 1024) or as a string using vCPUs (for example, 1 vCPU or 1 vcpu) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If you\'re using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you do not specify a value, the parameter is ignored.

If you\'re using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

  • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

    This option requires Linux platform 1.4.0 or later.

  • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

    This option requires Linux platform 1.4.0 or later.

', 'RegisterTaskDefinitionRequest$memory' => '

The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB (for example ,1024) or as a string using GB (for example, 1GB or 1 GB) in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If using the EC2 launch type, this field is optional.

If using the Fargate launch type, this field is required and you must use one of the following values. This determines your range of supported values for the cpu parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

    This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

    This option requires Linux platform 1.4.0 or later.

', 'RepositoryCredentials$credentialsParameter' => '

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you\'re launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.

', 'Resource$name' => '

The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

', 'Resource$type' => '

The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.

', 'ResourceIds$member' => NULL, 'ResourceRequirement$value' => '

The value for the specified resource type.

If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that\'s reserved for all containers in a task can\'t exceed the number of available GPUs on the container instance that the task is launched on.

If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

', 'RunTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.

', 'RunTaskRequest$group' => '

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

', 'RunTaskRequest$platformVersion' => '

The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn\'t specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

', 'RunTaskRequest$referenceId' => '

The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.

', 'RunTaskRequest$startedBy' => '

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 128 letters (uppercase and lowercase), numbers, hyphens (-), and underscores (_) are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

', 'RunTaskRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run. If a revision isn\'t specified, the latest ACTIVE revision is used.

When you create a policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.

The full ARN value must match the value that you specified as the Resource of the principal\'s permissions policy.

When you specify the policy resource as the latest task definition version (by setting the Resource in the policy to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName), then set this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.

When you specify the policy resource as a specific task definition version (by setting the Resource in the policy to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1 or arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*), then set this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1.

For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.

', 'RunTaskRequest$clientToken' => '

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.

', 'Secret$name' => '

The name of the secret.

', 'Secret$valueFrom' => '

The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.

If the SSM Parameter Store parameter exists in the same Region as the task you\'re launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

', 'ServerException$message' => '

Message that describes the cause of the exception.

', 'Service$serviceArn' => '

The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

', 'Service$serviceName' => '

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.

', 'Service$clusterArn' => '

The Amazon Resource Name (ARN) of the cluster that hosts the service.

', 'Service$status' => '

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

', 'Service$platformVersion' => '

The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn\'t specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Service$platformFamily' => '

The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX).

', 'Service$taskDefinition' => '

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

', 'Service$roleArn' => '

The ARN of the IAM role that\'s associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

', 'Service$createdBy' => '

The principal that created the service.

', 'ServiceConnectClientAlias$dnsName' => '

The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn\'t need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can\'t start with a hyphen.

If this parameter isn\'t specified, the default value of discoveryName.namespace is used. If the discoveryName isn\'t specified, the port mapping name from the task definition is used in portName.namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

', 'ServiceConnectConfiguration$namespace' => '

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn\'t affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.

', 'ServiceConnectService$portName' => '

The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.

', 'ServiceConnectService$discoveryName' => '

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can\'t start with a hyphen.

If the discoveryName isn\'t specified, the port mapping name from the task definition is used in portName.namespace.

', 'ServiceConnectServiceResource$discoveryName' => '

The discovery name of this Service Connect resource.

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can\'t start with a hyphen.

If the discoveryName isn\'t specified, the port mapping name from the task definition is used in portName.namespace.

', 'ServiceConnectServiceResource$discoveryArn' => '

The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can\'t ensure connectivity outside of Amazon ECS.

', 'ServiceEvent$id' => '

The ID string for the event.

', 'ServiceEvent$message' => '

The event message.

', 'ServiceRegistry$registryArn' => '

The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

', 'ServiceRegistry$containerName' => '

The container name value to be used for your service discovery service. It\'s already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can\'t specify both.

', 'Session$sessionId' => '

The ID of the execute command session.

', 'Session$streamUrl' => '

A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.

', 'Setting$value' => '

Determines whether the account setting is on or off for the specified resource.

', 'Setting$principalArn' => '

The ARN of the principal. It can be a user, role, or the root user. If this field is omitted, the authenticated user is assumed.

', 'StartTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster where to start your task. If you do not specify a cluster, the default cluster is assumed.

', 'StartTaskRequest$group' => '

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

', 'StartTaskRequest$referenceId' => '

The reference ID to use for the task.

', 'StartTaskRequest$startedBy' => '

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens (-), and underscores (_) are allowed.

If a task is started by an Amazon ECS service, the startedBy parameter contains the deployment ID of the service that starts it.

', 'StartTaskRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to start. If a revision isn\'t specified, the latest ACTIVE revision is used.

', 'StopTaskRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

', 'StopTaskRequest$task' => '

The task ID of the task to stop.

', 'StopTaskRequest$reason' => '

An optional message specified when a task is stopped. For example, if you\'re using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubmitAttachmentStateChangesRequest$cluster' => '

The short name or full ARN of the cluster that hosts the container instance the attachment belongs to.

', 'SubmitAttachmentStateChangesResponse$acknowledgment' => '

Acknowledgement of the state change.

', 'SubmitContainerStateChangeRequest$cluster' => '

The short name or full ARN of the cluster that hosts the container.

', 'SubmitContainerStateChangeRequest$task' => '

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

', 'SubmitContainerStateChangeRequest$containerName' => '

The name of the container.

', 'SubmitContainerStateChangeRequest$runtimeId' => '

The ID of the Docker container.

', 'SubmitContainerStateChangeRequest$status' => '

The status of the state change request.

', 'SubmitContainerStateChangeRequest$reason' => '

The reason for the state change request.

', 'SubmitContainerStateChangeResponse$acknowledgment' => '

Acknowledgement of the state change.

', 'SubmitTaskStateChangeRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

', 'SubmitTaskStateChangeRequest$task' => '

The task ID or full ARN of the task in the state change request.

', 'SubmitTaskStateChangeRequest$status' => '

The status of the state change request.

', 'SubmitTaskStateChangeRequest$reason' => '

The reason for the state change request.

', 'SubmitTaskStateChangeResponse$acknowledgment' => '

Acknowledgement of the state change.

', 'SystemControl$namespace' => '

The namespaced kernel parameter to set a value for.

', 'SystemControl$value' => '

The namespaced kernel parameter to set a value for.

Valid IPC namespace values: "kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced", and Sysctls that start with "fs.mqueue.*"

Valid network namespace values: Sysctls that start with "net.*"

All of these values are supported by Fargate.

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.

', 'Task$availabilityZone' => '

The Availability Zone for the task.

', 'Task$capacityProviderName' => '

The capacity provider that\'s associated with the task.

', 'Task$clusterArn' => '

The ARN of the cluster that hosts the task.

', 'Task$containerInstanceArn' => '

The ARN of the container instances that host the task.

', 'Task$cpu' => '

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

  • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

    This option requires Linux platform 1.4.0 or later.

  • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

    This option requires Linux platform 1.4.0 or later.

', 'Task$desiredStatus' => '

The desired status of the task. For more information, see Task Lifecycle.

', 'Task$group' => '

The name of the task group that\'s associated with the task.

', 'Task$lastStatus' => '

The last known status for the task. For more information, see Task Lifecycle.

', 'Task$memory' => '

The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it\'s expressed as a string using GB (for example, 1GB or 1 GB), it\'s converted to an integer indicating the MiB when the task definition is registered.

If you use the EC2 launch type, this field is optional.

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

    This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

    This option requires Linux platform 1.4.0 or later.

', 'Task$platformVersion' => '

The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn\'t specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'Task$platformFamily' => '

The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

', 'Task$startedBy' => '

The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

', 'Task$stoppedReason' => '

The reason that the task was stopped.

', 'Task$taskArn' => '

The Amazon Resource Name (ARN) of the task.

', 'Task$taskDefinitionArn' => '

The ARN of the task definition that creates the task.

', 'TaskDefinition$taskDefinitionArn' => '

The full Amazon Resource Name (ARN) of the task definition.

', 'TaskDefinition$family' => '

The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.

A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

', 'TaskDefinition$taskRoleArn' => '

The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

', 'TaskDefinition$cpu' => '

The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

  • 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

  • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

    This option requires Linux platform 1.4.0 or later.

  • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

    This option requires Linux platform 1.4.0 or later.

', 'TaskDefinition$memory' => '

The amount (in MiB) of memory used by the task.

If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.

If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the cpu parameter.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

    This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

    This option requires Linux platform 1.4.0 or later.

', 'TaskDefinition$registeredBy' => '

The principal that registered the task definition.

', 'TaskDefinitionPlacementConstraint$expression' => '

A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

', 'TaskOverride$cpu' => '

The CPU override for the task.

', 'TaskOverride$executionRoleArn' => '

The Amazon Resource Name (ARN) of the task execution role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

', 'TaskOverride$memory' => '

The memory override for the task.

', 'TaskOverride$taskRoleArn' => '

The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.

', 'TaskSet$id' => '

The ID of the task set.

', 'TaskSet$taskSetArn' => '

The Amazon Resource Name (ARN) of the task set.

', 'TaskSet$serviceArn' => '

The Amazon Resource Name (ARN) of the service the task set exists in.

', 'TaskSet$clusterArn' => '

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

', 'TaskSet$startedBy' => '

The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn\'t used.

', 'TaskSet$externalId' => '

The external ID associated with the task set.

If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

', 'TaskSet$status' => '

The status of the task set. The following describes each state.

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set isn\'t serving production traffic.

DRAINING

The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.

', 'TaskSet$taskDefinition' => '

The task definition that the task set is using.

', 'TaskSet$platformVersion' => '

The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

', 'TaskSet$platformFamily' => '

The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks in the set must have the same value.

', 'Tmpfs$containerPath' => '

The absolute file path where the tmpfs volume is to be mounted.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.

', 'UpdateCapacityProviderRequest$name' => '

The name of the capacity provider to update.

', 'UpdateClusterRequest$cluster' => '

The name of the cluster to modify the settings for.

', 'UpdateClusterSettingsRequest$cluster' => '

The name of the cluster to modify the settings for.

', 'UpdateContainerAgentRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateContainerAgentRequest$containerInstance' => '

The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.

', 'UpdateContainerInstancesStateRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateServicePrimaryTaskSetRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

', 'UpdateServicePrimaryTaskSetRequest$service' => '

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

', 'UpdateServicePrimaryTaskSetRequest$primaryTaskSet' => '

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

', 'UpdateServiceRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on. If you do not specify a cluster, the default cluster is assumed.

', 'UpdateServiceRequest$service' => '

The name of the service to update.

', 'UpdateServiceRequest$taskDefinition' => '

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

', 'UpdateServiceRequest$platformVersion' => '

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

', 'UpdateTaskProtectionRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

', 'UpdateTaskSetRequest$cluster' => '

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found in.

', 'UpdateTaskSetRequest$service' => '

The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.

', 'UpdateTaskSetRequest$taskSet' => '

The short name or full Amazon Resource Name (ARN) of the task set to update.

', 'VersionInfo$agentVersion' => '

The version number of the Amazon ECS container agent.

', 'VersionInfo$agentHash' => '

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

', 'VersionInfo$dockerVersion' => '

The Docker version that\'s running on the container instance.

', 'Volume$name' => '

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

This is required wwhen you use an Amazon EFS volume.

', 'VolumeFrom$sourceContainer' => '

The name of another container within the same task definition to mount volumes from.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'AwsVpcConfiguration$subnets' => '

The IDs of the subnets associated with the task or service. There\'s a limit of 16 subnets that can be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

', 'AwsVpcConfiguration$securityGroups' => '

The IDs of the security groups associated with the task or service. If you don\'t specify a security group, the default security group for the VPC is used. There\'s a limit of 5 security groups that can be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

', 'Cluster$capacityProviders' => '

The capacity providers associated with the cluster.

', 'ContainerDefinition$links' => '

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

', 'ContainerDefinition$entryPoint' => '

Early versions of the Amazon ECS container agent don\'t properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that\'s passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

', 'ContainerDefinition$command' => '

The command that\'s passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.

', 'ContainerDefinition$dnsServers' => '

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$dnsSearchDomains' => '

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.

This parameter is not supported for Windows containers.

', 'ContainerDefinition$dockerSecurityOptions' => '

A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn\'t valid for containers in tasks using the Fargate launch type.

For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.

For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

For more information about valid values, see Docker Run Security Configuration.

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

', 'ContainerDefinition$credentialSpecs' => '

A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the dockerSecurityOptions. The maximum number of ARNs is 1.

There are two formats for each ARN.

credentialspecdomainless:MyARN

You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.

Each task that runs on any container instance can join different domains.

You can use this format without joining the container instance to a domain.

credentialspec:MyARN

You use credentialspec:MyARN to provide a CredSpec for a single domain.

You must join the container instance to the domain before you start any tasks that use this task definition.

In both formats, replace MyARN with the ARN in SSM or Amazon S3.

If you provide a credentialspecdomainless:MyARN, the credspec must provide a ARN in Secrets Manager for a secret containing the username, password, and the domain to connect to. For better security, the instance isn\'t joined to the domain for domainless authentication. Other applications on the instance can\'t use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers.

', 'ContainerOverride$command' => '

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

', 'CreateClusterRequest$capacityProviders' => '

The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

', 'DeleteTaskDefinitionsRequest$taskDefinitions' => '

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to delete. You must specify a revision.

You can specify up to 10 task definitions as a comma separated list.

', 'DeploymentAlarms$alarmNames' => '

One or more CloudWatch alarm names. Use a "," to separate the alarms.

', 'DescribeCapacityProvidersRequest$capacityProviders' => '

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

', 'DescribeClustersRequest$clusters' => '

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

', 'DescribeContainerInstancesRequest$containerInstances' => '

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

', 'DescribeServicesRequest$services' => '

A list of services to describe. You may specify up to 10 services to describe in a single operation.

', 'DescribeTaskSetsRequest$taskSets' => '

The ID or full Amazon Resource Name (ARN) of task sets to describe.

', 'DescribeTasksRequest$tasks' => '

A list of up to 100 task IDs or full ARN entries.

', 'GetTaskProtectionRequest$tasks' => '

A list of up to 100 task IDs or full ARN entries.

', 'HealthCheck$command' => '

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to run the command arguments directly, or CMD-SHELL to run the command with the container\'s default shell.

When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.

[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

You don\'t include the double quotes and brackets when you use the Amazon Web Services Management Console.

CMD-SHELL, curl -f http://localhost/ || exit 1

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

', 'KernelCapabilities$add' => '

The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

Tasks launched on Fargate only support adding the SYS_PTRACE kernel capability.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

', 'KernelCapabilities$drop' => '

The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"

', 'ListClustersResponse$clusterArns' => '

The list of full Amazon Resource Name (ARN) entries for each cluster that\'s associated with your account.

', 'ListContainerInstancesResponse$containerInstanceArns' => '

The list of container instances with full ARN entries for each container instance associated with the specified cluster.

', 'ListServicesByNamespaceResponse$serviceArns' => '

The list of full ARN entries for each service that\'s associated with the specified namespace.

', 'ListServicesResponse$serviceArns' => '

The list of full ARN entries for each service that\'s associated with the specified cluster.

', 'ListTaskDefinitionFamiliesResponse$families' => '

The list of task definition family names that match the ListTaskDefinitionFamilies request.

', 'ListTaskDefinitionsResponse$taskDefinitionArns' => '

The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.

', 'ListTasksResponse$taskArns' => '

The list of task ARN entries for the ListTasks request.

', 'PutClusterCapacityProvidersRequest$capacityProviders' => '

The name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

', 'Resource$stringSetValue' => '

When the stringSetValue type is set, the value of the resource must be a string type.

', 'StartTaskRequest$containerInstances' => '

The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.

', 'Tmpfs$mountOptions' => '

The list of tmpfs volume mount options.

Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"

', 'UpdateContainerInstancesStateRequest$containerInstances' => '

A list of up to 10 container instance IDs or full ARN entries.

', 'UpdateTaskProtectionRequest$tasks' => '

A list of up to 10 task IDs or full ARN entries.

', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'DockerVolumeConfiguration$driverOpts' => '

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

', 'DockerVolumeConfiguration$labels' => '

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

', ], ], 'SubmitAttachmentStateChangesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitAttachmentStateChangesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubmitContainerStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitContainerStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitTaskStateChangeResponse' => [ 'base' => NULL, 'refs' => [], ], 'SystemControl' => [ 'base' => '

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

We don\'t recommend that you specify network-related systemControls parameters for multiple containers in a single task. This task also uses either the awsvpc or host network mode. It does it for the following reasons.

  • For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that\'s started last determines which systemControls take effect.

  • For tasks that use the host network mode, the systemControls parameter applies to the container instance\'s kernel parameter and that of all containers of any tasks running on that container instance.

', 'refs' => [ 'SystemControls$member' => NULL, ], ], 'SystemControls' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$systemControls' => '

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain longer lived connections.

We don\'t recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that\'s started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance\'s namespaced kernel parameters as well as the containers.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn\'t supported for Windows containers on Fargate.

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

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

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

The keys of the tags to be removed.

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

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CapacityProvider$tags' => '

The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'Cluster$tags' => '

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'ContainerInstance$tags' => '

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'CreateCapacityProviderRequest$tags' => '

The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'CreateClusterRequest$tags' => '

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'CreateServiceRequest$tags' => '

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'CreateTaskSetRequest$tags' => '

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'DescribeTaskDefinitionResponse$tags' => '

The metadata that\'s applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'ListTagsForResourceResponse$tags' => '

The tags for the resource.

', 'RegisterContainerInstanceRequest$tags' => '

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'RegisterTaskDefinitionRequest$tags' => '

The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'RegisterTaskDefinitionResponse$tags' => '

The list of tags associated with the task definition.

', 'RunTaskRequest$tags' => '

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'Service$tags' => '

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'StartTaskRequest$tags' => '

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'TagResourceRequest$tags' => '

The tags to add to the resource. A tag is an array of key-value pairs.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'Task$tags' => '

The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', 'TaskSet$tags' => '

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

', ], ], 'TargetNotConnectedException' => [ 'base' => '

The execute command cannot run. This error can be caused by any of the following configuration issues:

  • Incorrect IAM permissions

  • The SSM agent is not installed or is not running

  • There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems Manager Session Manager

For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in the Amazon Elastic Container Service Developer Guide.

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

The specified target wasn\'t found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

', 'refs' => [], ], 'TargetType' => [ 'base' => NULL, 'refs' => [ 'Attribute$targetType' => '

The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

', 'ListAttributesRequest$targetType' => '

The type of the target to list attributes with.

', ], ], 'Task' => [ 'base' => '

Details on a task in a cluster.

', 'refs' => [ 'StopTaskResponse$task' => '

The task that was stopped.

', 'Tasks$member' => NULL, ], ], 'TaskDefinition' => [ 'base' => '

The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

', 'refs' => [ 'DeregisterTaskDefinitionResponse$taskDefinition' => '

The full description of the deregistered task.

', 'DescribeTaskDefinitionResponse$taskDefinition' => '

The full task definition description.

', 'RegisterTaskDefinitionResponse$taskDefinition' => '

The full description of the registered task definition.

', 'TaskDefinitionList$member' => NULL, ], ], 'TaskDefinitionFamilyStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionFamiliesRequest$status' => '

The task definition family status to filter the ListTaskDefinitionFamilies results with. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

', ], ], 'TaskDefinitionField' => [ 'base' => NULL, 'refs' => [ 'TaskDefinitionFieldList$member' => NULL, ], ], 'TaskDefinitionFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTaskDefinitionRequest$include' => '

Determines whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren\'t included in the response.

', ], ], 'TaskDefinitionList' => [ 'base' => NULL, 'refs' => [ 'DeleteTaskDefinitionsResponse$taskDefinitions' => '

The list of deleted task definitions.

', ], ], 'TaskDefinitionPlacementConstraint' => [ 'base' => '

The constraint on task placement in the task definition. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.

Task placement constraints aren\'t supported for tasks run on Fargate.

', 'refs' => [ 'TaskDefinitionPlacementConstraints$member' => NULL, ], ], 'TaskDefinitionPlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'TaskDefinitionPlacementConstraint$type' => '

The type of constraint. The MemberOf constraint restricts selection to be from a group of valid candidates.

', ], ], 'TaskDefinitionPlacementConstraints' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$placementConstraints' => '

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

', 'TaskDefinition$placementConstraints' => '

An array of placement constraint objects to use for tasks.

This parameter isn\'t supported for tasks run on Fargate.

', ], ], 'TaskDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$status' => '

The task definition status to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

', 'TaskDefinition$status' => '

The status of the task definition.

', ], ], 'TaskField' => [ 'base' => NULL, 'refs' => [ 'TaskFieldList$member' => NULL, ], ], 'TaskFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksRequest$include' => '

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren\'t included in the response.

', ], ], 'TaskOverride' => [ 'base' => '

The overrides that are associated with a task.

', 'refs' => [ 'RunTaskRequest$overrides' => '

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that\'s specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

', 'StartTaskRequest$overrides' => '

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it receives. You can override the default command for a container (that\'s specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

', 'Task$overrides' => '

One or more container overrides.

', ], ], 'TaskSet' => [ 'base' => '

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

', 'refs' => [ 'CreateTaskSetResponse$taskSet' => '

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. A task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

', 'DeleteTaskSetResponse$taskSet' => '

Details about the task set.

', 'TaskSets$member' => NULL, 'UpdateServicePrimaryTaskSetResponse$taskSet' => '

The details about the task set.

', 'UpdateTaskSetResponse$taskSet' => '

Details about the task set.

', ], ], 'TaskSetField' => [ 'base' => NULL, 'refs' => [ 'TaskSetFieldList$member' => NULL, ], ], 'TaskSetFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTaskSetsRequest$include' => '

Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren\'t included in the response.

', ], ], 'TaskSetNotFoundException' => [ 'base' => '

The specified task set wasn\'t found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

', 'refs' => [], ], 'TaskSets' => [ 'base' => NULL, 'refs' => [ 'DescribeTaskSetsResponse$taskSets' => '

The list of task sets described.

', 'Service$taskSets' => '

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

', ], ], 'TaskStopCode' => [ 'base' => NULL, 'refs' => [ 'Task$stopCode' => '

The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

For more information about stop code, see Stopped tasks error codes in the Amazon ECS User Guide.

The following are valid values:

  • TaskFailedToStart

  • EssentialContainerExited

  • UserInitiated

  • TerminationNotice

  • ServiceSchedulerInitiated

  • SpotInterruption

', ], ], 'Tasks' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksResponse$tasks' => '

The list of tasks.

', 'RunTaskResponse$tasks' => '

A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.

', 'StartTaskResponse$tasks' => '

A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$registeredAt' => '

The Unix timestamp for the time when the container instance was registered.

', 'Deployment$createdAt' => '

The Unix timestamp for the time when the service deployment was created.

', 'Deployment$updatedAt' => '

The Unix timestamp for the time when the service deployment was last updated.

', 'InstanceHealthCheckResult$lastUpdated' => '

The Unix timestamp for when the container instance health status was last updated.

', 'InstanceHealthCheckResult$lastStatusChange' => '

The Unix timestamp for when the container instance health status last changed.

', 'ManagedAgent$lastStartedAt' => '

The Unix timestamp for the time when the managed agent was last started.

', 'ProtectedTask$expirationDate' => '

The epoch time when protection for the task will expire.

', 'Service$createdAt' => '

The Unix timestamp for the time when the service was created.

', 'ServiceEvent$createdAt' => '

The Unix timestamp for the time when the event was triggered.

', 'SubmitTaskStateChangeRequest$pullStartedAt' => '

The Unix timestamp for the time when the container image pull started.

', 'SubmitTaskStateChangeRequest$pullStoppedAt' => '

The Unix timestamp for the time when the container image pull completed.

', 'SubmitTaskStateChangeRequest$executionStoppedAt' => '

The Unix timestamp for the time when the task execution stopped.

', 'Task$connectivityAt' => '

The Unix timestamp for the time when the task last went into CONNECTED status.

', 'Task$createdAt' => '

The Unix timestamp for the time when the task was created. More specifically, it\'s for the time when the task entered the PENDING state.

', 'Task$executionStoppedAt' => '

The Unix timestamp for the time when the task execution stopped.

', 'Task$pullStartedAt' => '

The Unix timestamp for the time when the container image pull began.

', 'Task$pullStoppedAt' => '

The Unix timestamp for the time when the container image pull completed.

', 'Task$startedAt' => '

The Unix timestamp for the time when the task started. More specifically, it\'s for the time when the task transitioned from the PENDING state to the RUNNING state.

', 'Task$stoppedAt' => '

The Unix timestamp for the time when the task was stopped. More specifically, it\'s for the time when the task transitioned from the RUNNING state to the STOPPED state.

', 'Task$stoppingAt' => '

The Unix timestamp for the time when the task stops. More specifically, it\'s for the time when the task transitions from the RUNNING state to STOPPING.

', 'TaskDefinition$registeredAt' => '

The Unix timestamp for the time when the task definition was registered.

', 'TaskDefinition$deregisteredAt' => '

The Unix timestamp for the time when the task definition was deregistered.

', 'TaskSet$createdAt' => '

The Unix timestamp for the time when the task set was created.

', 'TaskSet$updatedAt' => '

The Unix timestamp for the time when the task set was last updated.

', 'TaskSet$stabilityStatusAt' => '

The Unix timestamp for the time when the task set stability status was retrieved.

', ], ], 'Tmpfs' => [ 'base' => '

The container path, mount options, and size of the tmpfs mount.

', 'refs' => [ 'TmpfsList$member' => NULL, ], ], 'TmpfsList' => [ 'base' => NULL, 'refs' => [ 'LinuxParameters$tmpfs' => '

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

If you\'re using tasks that use the Fargate launch type, the tmpfs parameter isn\'t supported.

', ], ], 'TransportProtocol' => [ 'base' => NULL, 'refs' => [ 'NetworkBinding$protocol' => '

The protocol used for the network binding.

', 'PortMapping$protocol' => '

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp. protocol is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.

', ], ], 'Ulimit' => [ 'base' => '

The ulimit settings to pass to the container.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 4096.

You can specify the ulimit settings for a container in a task definition.

', 'refs' => [ 'UlimitList$member' => NULL, ], ], 'UlimitList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ulimits' => '

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 4096.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'

This parameter is not supported for Windows containers.

', ], ], 'UlimitName' => [ 'base' => NULL, 'refs' => [ 'Ulimit$name' => '

The type of the ulimit.

', ], ], 'UnsupportedFeatureException' => [ 'base' => '

The specified task isn\'t supported in this Region.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCapacityProviderRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCapacityProviderResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInProgressException' => [ 'base' => '

There\'s already a current Amazon ECS container agent update in progress on the container instance that\'s specified. If the container agent becomes disconnected while it\'s in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

', 'refs' => [], ], 'UpdateServicePrimaryTaskSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServicePrimaryTaskSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskProtectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskProtectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'VersionInfo' => [ 'base' => '

The Docker and Amazon ECS container agent version information about a container instance.

', 'refs' => [ 'ContainerInstance$versionInfo' => '

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

', 'RegisterContainerInstanceRequest$versionInfo' => '

The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

', ], ], 'Volume' => [ 'base' => '

A data volume that\'s used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

', 'refs' => [ 'VolumeList$member' => NULL, ], ], 'VolumeFrom' => [ 'base' => '

Details on a data volume from another container in the same task definition.

', 'refs' => [ 'VolumeFromList$member' => NULL, ], ], 'VolumeFromList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$volumesFrom' => '

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.

', ], ], 'VolumeList' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$volumes' => '

A list of volume definitions in JSON format that containers in your task might use.

', 'TaskDefinition$volumes' => '

The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

The host and sourcePath parameters aren\'t supported for tasks run on Fargate.

', ], ], ],]; diff --git a/src/data/es/2015-01-01/api-2.json b/src/data/es/2015-01-01/api-2.json index b9a9c9eeeb..fa22438d79 100644 --- a/src/data/es/2015-01-01/api-2.json +++ b/src/data/es/2015-01-01/api-2.json @@ -3001,7 +3001,8 @@ "type":"string", "enum":[ "Policy-Min-TLS-1-0-2019-07", - "Policy-Min-TLS-1-2-2019-07" + "Policy-Min-TLS-1-2-2019-07", + "Policy-Min-TLS-1-2-PFS-2023-10" ] }, "Tag":{ diff --git a/src/data/es/2015-01-01/api-2.json.php b/src/data/es/2015-01-01/api-2.json.php index 3c889737b5..93a794540f 100644 --- a/src/data/es/2015-01-01/api-2.json.php +++ b/src/data/es/2015-01-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2015-01-01', 'endpointPrefix' => 'es', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon Elasticsearch Service', 'serviceId' => 'Elasticsearch Service', 'signatureVersion' => 'v4', 'uid' => 'es-2015-01-01', ], 'operations' => [ 'AcceptInboundCrossClusterSearchConnection' => [ 'name' => 'AcceptInboundCrossClusterSearchConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept', ], 'input' => [ 'shape' => 'AcceptInboundCrossClusterSearchConnectionRequest', ], 'output' => [ 'shape' => 'AcceptInboundCrossClusterSearchConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/tags', ], 'input' => [ 'shape' => 'AddTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'AssociatePackage' => [ 'name' => 'AssociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-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' => '/2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess', ], 'input' => [ 'shape' => 'AuthorizeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'AuthorizeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'CancelElasticsearchServiceSoftwareUpdate' => [ 'name' => 'CancelElasticsearchServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/serviceSoftwareUpdate/cancel', ], 'input' => [ 'shape' => 'CancelElasticsearchServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'CancelElasticsearchServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateElasticsearchDomain' => [ 'name' => 'CreateElasticsearchDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/domain', ], 'input' => [ 'shape' => 'CreateElasticsearchDomainRequest', ], 'output' => [ 'shape' => 'CreateElasticsearchDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateOutboundCrossClusterSearchConnection' => [ 'name' => 'CreateOutboundCrossClusterSearchConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/ccs/outboundConnection', ], 'input' => [ 'shape' => 'CreateOutboundCrossClusterSearchConnectionRequest', ], 'output' => [ 'shape' => 'CreateOutboundCrossClusterSearchConnectionResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'CreatePackage' => [ 'name' => 'CreatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-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' => '/2015-01-01/es/vpcEndpoints', ], 'input' => [ 'shape' => 'CreateVpcEndpointRequest', ], 'output' => [ 'shape' => 'CreateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DeleteElasticsearchDomain' => [ 'name' => 'DeleteElasticsearchDomain', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-01-01/es/domain/{DomainName}', ], 'input' => [ 'shape' => 'DeleteElasticsearchDomainRequest', ], 'output' => [ 'shape' => 'DeleteElasticsearchDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteElasticsearchServiceRole' => [ 'name' => 'DeleteElasticsearchServiceRole', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-01-01/es/role', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteInboundCrossClusterSearchConnection' => [ 'name' => 'DeleteInboundCrossClusterSearchConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-01-01/es/ccs/inboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteInboundCrossClusterSearchConnectionRequest', ], 'output' => [ 'shape' => 'DeleteInboundCrossClusterSearchConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeleteOutboundCrossClusterSearchConnection' => [ 'name' => 'DeleteOutboundCrossClusterSearchConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-01-01/es/ccs/outboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteOutboundCrossClusterSearchConnectionRequest', ], 'output' => [ 'shape' => 'DeleteOutboundCrossClusterSearchConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeletePackage' => [ 'name' => 'DeletePackage', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-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' => '/2015-01-01/es/vpcEndpoints/{VpcEndpointId}', ], 'input' => [ 'shape' => 'DeleteVpcEndpointRequest', ], 'output' => [ 'shape' => 'DeleteVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'DescribeDomainAutoTunes' => [ 'name' => 'DescribeDomainAutoTunes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/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' => '/2015-01-01/es/domain/{DomainName}/progress', ], 'input' => [ 'shape' => 'DescribeDomainChangeProgressRequest', ], 'output' => [ 'shape' => 'DescribeDomainChangeProgressResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeElasticsearchDomain' => [ 'name' => 'DescribeElasticsearchDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/domain/{DomainName}', ], 'input' => [ 'shape' => 'DescribeElasticsearchDomainRequest', ], 'output' => [ 'shape' => 'DescribeElasticsearchDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeElasticsearchDomainConfig' => [ 'name' => 'DescribeElasticsearchDomainConfig', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'DescribeElasticsearchDomainConfigRequest', ], 'output' => [ 'shape' => 'DescribeElasticsearchDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeElasticsearchDomains' => [ 'name' => 'DescribeElasticsearchDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/domain-info', ], 'input' => [ 'shape' => 'DescribeElasticsearchDomainsRequest', ], 'output' => [ 'shape' => 'DescribeElasticsearchDomainsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeElasticsearchInstanceTypeLimits' => [ 'name' => 'DescribeElasticsearchInstanceTypeLimits', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}', ], 'input' => [ 'shape' => 'DescribeElasticsearchInstanceTypeLimitsRequest', ], 'output' => [ 'shape' => 'DescribeElasticsearchInstanceTypeLimitsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeInboundCrossClusterSearchConnections' => [ 'name' => 'DescribeInboundCrossClusterSearchConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/ccs/inboundConnection/search', ], 'input' => [ 'shape' => 'DescribeInboundCrossClusterSearchConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeInboundCrossClusterSearchConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeOutboundCrossClusterSearchConnections' => [ 'name' => 'DescribeOutboundCrossClusterSearchConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/ccs/outboundConnection/search', ], 'input' => [ 'shape' => 'DescribeOutboundCrossClusterSearchConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeOutboundCrossClusterSearchConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribePackages' => [ 'name' => 'DescribePackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/packages/describe', ], 'input' => [ 'shape' => 'DescribePackagesRequest', ], 'output' => [ 'shape' => 'DescribePackagesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeReservedElasticsearchInstanceOfferings' => [ 'name' => 'DescribeReservedElasticsearchInstanceOfferings', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/reservedInstanceOfferings', ], 'input' => [ 'shape' => 'DescribeReservedElasticsearchInstanceOfferingsRequest', ], 'output' => [ 'shape' => 'DescribeReservedElasticsearchInstanceOfferingsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], ], ], 'DescribeReservedElasticsearchInstances' => [ 'name' => 'DescribeReservedElasticsearchInstances', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/reservedInstances', ], 'input' => [ 'shape' => 'DescribeReservedElasticsearchInstancesRequest', ], 'output' => [ 'shape' => 'DescribeReservedElasticsearchInstancesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeVpcEndpoints' => [ 'name' => 'DescribeVpcEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/vpcEndpoints/describe', ], 'input' => [ 'shape' => 'DescribeVpcEndpointsRequest', ], 'output' => [ 'shape' => 'DescribeVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DissociatePackage' => [ 'name' => 'DissociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-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', ], ], ], 'GetCompatibleElasticsearchVersions' => [ 'name' => 'GetCompatibleElasticsearchVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/compatibleVersions', ], 'input' => [ 'shape' => 'GetCompatibleElasticsearchVersionsRequest', ], 'output' => [ 'shape' => 'GetCompatibleElasticsearchVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'GetPackageVersionHistory' => [ 'name' => 'GetPackageVersionHistory', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-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' => '/2015-01-01/es/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' => '/2015-01-01/es/upgradeDomain/{DomainName}/status', ], 'input' => [ 'shape' => 'GetUpgradeStatusRequest', ], 'output' => [ 'shape' => 'GetUpgradeStatusResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListDomainNames' => [ 'name' => 'ListDomainNames', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/domain', ], 'input' => [ 'shape' => 'ListDomainNamesRequest', ], 'output' => [ 'shape' => 'ListDomainNamesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListDomainsForPackage' => [ 'name' => 'ListDomainsForPackage', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/packages/{PackageID}/domains', ], 'input' => [ 'shape' => 'ListDomainsForPackageRequest', ], 'output' => [ 'shape' => 'ListDomainsForPackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListElasticsearchInstanceTypes' => [ 'name' => 'ListElasticsearchInstanceTypes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/instanceTypes/{ElasticsearchVersion}', ], 'input' => [ 'shape' => 'ListElasticsearchInstanceTypesRequest', ], 'output' => [ 'shape' => 'ListElasticsearchInstanceTypesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListElasticsearchVersions' => [ 'name' => 'ListElasticsearchVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/versions', ], 'input' => [ 'shape' => 'ListElasticsearchVersionsRequest', ], 'output' => [ 'shape' => 'ListElasticsearchVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackagesForDomain' => [ 'name' => 'ListPackagesForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/domain/{DomainName}/packages', ], 'input' => [ 'shape' => 'ListPackagesForDomainRequest', ], 'output' => [ 'shape' => 'ListPackagesForDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/tags/', ], 'input' => [ 'shape' => 'ListTagsRequest', ], 'output' => [ 'shape' => 'ListTagsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListVpcEndpointAccess' => [ 'name' => 'ListVpcEndpointAccess', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/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' => '/2015-01-01/es/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'ListVpcEndpointsForDomain' => [ 'name' => 'ListVpcEndpointsForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/domain/{DomainName}/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsForDomainRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsForDomainResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'BaseException', ], ], ], 'PurchaseReservedElasticsearchInstanceOffering' => [ 'name' => 'PurchaseReservedElasticsearchInstanceOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/purchaseReservedInstanceOffering', ], 'input' => [ 'shape' => 'PurchaseReservedElasticsearchInstanceOfferingRequest', ], 'output' => [ 'shape' => 'PurchaseReservedElasticsearchInstanceOfferingResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RejectInboundCrossClusterSearchConnection' => [ 'name' => 'RejectInboundCrossClusterSearchConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject', ], 'input' => [ 'shape' => 'RejectInboundCrossClusterSearchConnectionRequest', ], 'output' => [ 'shape' => 'RejectInboundCrossClusterSearchConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'RemoveTags' => [ 'name' => 'RemoveTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/tags-removal', ], 'input' => [ 'shape' => 'RemoveTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RevokeVpcEndpointAccess' => [ 'name' => 'RevokeVpcEndpointAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess', ], 'input' => [ 'shape' => 'RevokeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'RevokeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'StartElasticsearchServiceSoftwareUpdate' => [ 'name' => 'StartElasticsearchServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/serviceSoftwareUpdate/start', ], 'input' => [ 'shape' => 'StartElasticsearchServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'StartElasticsearchServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateElasticsearchDomainConfig' => [ 'name' => 'UpdateElasticsearchDomainConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'UpdateElasticsearchDomainConfigRequest', ], 'output' => [ 'shape' => 'UpdateElasticsearchDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdatePackage' => [ 'name' => 'UpdatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/packages/update', ], 'input' => [ 'shape' => 'UpdatePackageRequest', ], 'output' => [ 'shape' => 'UpdatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateVpcEndpoint' => [ 'name' => 'UpdateVpcEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/vpcEndpoints/update', ], 'input' => [ 'shape' => 'UpdateVpcEndpointRequest', ], 'output' => [ 'shape' => 'UpdateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'BaseException', ], ], ], 'UpgradeElasticsearchDomain' => [ 'name' => 'UpgradeElasticsearchDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/upgradeDomain', ], 'input' => [ 'shape' => 'UpgradeElasticsearchDomainRequest', ], 'output' => [ 'shape' => 'UpgradeElasticsearchDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], ], 'shapes' => [ 'ARN' => [ 'type' => 'string', ], 'AWSAccount' => [ 'type' => 'string', 'pattern' => '^[0-9]+$', ], 'AcceptInboundCrossClusterSearchConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'CrossClusterSearchConnectionId', ], 'members' => [ 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'AcceptInboundCrossClusterSearchConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnection' => [ 'shape' => 'InboundCrossClusterSearchConnection', ], ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccessPoliciesStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'PolicyDocument', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AddTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagList', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'AdditionalLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'AdditionalLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalLimit', ], ], 'AdvancedOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'AdvancedOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AdvancedSecurityOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsOutput', ], 'AnonymousAuthDisableDate' => [ 'shape' => 'DisableTimestamp', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'MasterUserOptions' => [ 'shape' => 'MasterUserOptions', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsInput', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedSecurityOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AssociatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'DomainName', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'AssociatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetails' => [ 'shape' => 'DomainPackageDetails', ], ], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Account', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Account' => [ 'shape' => 'AWSAccount', ], ], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'type' => 'structure', 'required' => [ 'AuthorizedPrincipal', ], 'members' => [ 'AuthorizedPrincipal' => [ 'shape' => 'AuthorizedPrincipal', ], ], ], 'AuthorizedPrincipal' => [ 'type' => 'structure', 'members' => [ 'PrincipalType' => [ 'shape' => 'PrincipalType', ], 'Principal' => [ 'shape' => 'String', ], ], ], 'AuthorizedPrincipalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthorizedPrincipal', ], ], 'AutoTune' => [ 'type' => 'structure', 'members' => [ 'AutoTuneType' => [ 'shape' => 'AutoTuneType', ], 'AutoTuneDetails' => [ 'shape' => 'AutoTuneDetails', ], ], ], 'AutoTuneDate' => [ 'type' => 'timestamp', ], 'AutoTuneDesiredState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'AutoTuneDetails' => [ 'type' => 'structure', 'members' => [ 'ScheduledAutoTuneDetails' => [ 'shape' => 'ScheduledAutoTuneDetails', ], ], ], 'AutoTuneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTune', ], ], 'AutoTuneMaintenanceSchedule' => [ 'type' => 'structure', 'members' => [ 'StartAt' => [ 'shape' => 'StartAt', ], 'Duration' => [ 'shape' => 'Duration', ], 'CronExpressionForRecurrence' => [ 'shape' => 'String', ], ], ], 'AutoTuneMaintenanceScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTuneMaintenanceSchedule', ], 'max' => 100, ], 'AutoTuneOptions' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'RollbackOnDisable' => [ 'shape' => 'RollbackOnDisable', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], ], ], 'AutoTuneOptionsInput' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], ], ], 'AutoTuneOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'AutoTuneState', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], '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', ], ], 'BackendRole' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'BaseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'CancelElasticsearchServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], ], ], 'CancelElasticsearchServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'ChangeProgressDetails' => [ 'type' => 'structure', 'members' => [ 'ChangeId' => [ 'shape' => 'GUID', ], 'Message' => [ 'shape' => 'Message', ], ], ], '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', ], ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CloudWatchLogsLogGroupArn' => [ 'type' => 'string', ], '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, ], 'CompatibleElasticsearchVersionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompatibleVersionsMap', ], ], 'CompatibleVersionsMap' => [ 'type' => 'structure', 'members' => [ 'SourceVersion' => [ 'shape' => 'ElasticsearchVersionString', ], 'TargetVersions' => [ 'shape' => 'ElasticsearchVersionList', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConnectionAlias' => [ 'type' => 'string', 'max' => 20, ], 'CreateElasticsearchDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'ElasticsearchVersion' => [ 'shape' => 'ElasticsearchVersionString', ], 'ElasticsearchClusterConfig' => [ 'shape' => 'ElasticsearchClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], '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', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsInput', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'CreateElasticsearchDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'ElasticsearchDomainStatus', ], ], ], 'CreateOutboundCrossClusterSearchConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'SourceDomainInfo', 'DestinationDomainInfo', 'ConnectionAlias', ], 'members' => [ 'SourceDomainInfo' => [ 'shape' => 'DomainInformation', ], 'DestinationDomainInfo' => [ 'shape' => 'DomainInformation', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], ], ], 'CreateOutboundCrossClusterSearchConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'SourceDomainInfo' => [ 'shape' => 'DomainInformation', ], 'DestinationDomainInfo' => [ 'shape' => 'DomainInformation', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionStatus' => [ 'shape' => 'OutboundCrossClusterSearchConnectionStatus', ], 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', ], ], ], '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', ], 'CrossClusterSearchConnectionId' => [ 'type' => 'string', ], 'CrossClusterSearchConnectionStatusMessage' => [ 'type' => 'string', ], 'DeleteElasticsearchDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DeleteElasticsearchDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'ElasticsearchDomainStatus', ], ], ], 'DeleteInboundCrossClusterSearchConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'CrossClusterSearchConnectionId', ], 'members' => [ 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteInboundCrossClusterSearchConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnection' => [ 'shape' => 'InboundCrossClusterSearchConnection', ], ], ], 'DeleteOutboundCrossClusterSearchConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'CrossClusterSearchConnectionId', ], 'members' => [ 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteOutboundCrossClusterSearchConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnection' => [ 'shape' => 'OutboundCrossClusterSearchConnection', ], ], ], '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', ], ], ], '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', ], ], ], 'DescribeElasticsearchDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeElasticsearchDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'ElasticsearchDomainConfig', ], ], ], 'DescribeElasticsearchDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeElasticsearchDomainResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatus', ], 'members' => [ 'DomainStatus' => [ 'shape' => 'ElasticsearchDomainStatus', ], ], ], 'DescribeElasticsearchDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'DomainNames', ], 'members' => [ 'DomainNames' => [ 'shape' => 'DomainNameList', ], ], ], 'DescribeElasticsearchDomainsResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatusList', ], 'members' => [ 'DomainStatusList' => [ 'shape' => 'ElasticsearchDomainStatusList', ], ], ], 'DescribeElasticsearchInstanceTypeLimitsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'ElasticsearchVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'InstanceType' => [ 'shape' => 'ESPartitionInstanceType', 'location' => 'uri', 'locationName' => 'InstanceType', ], 'ElasticsearchVersion' => [ 'shape' => 'ElasticsearchVersionString', 'location' => 'uri', 'locationName' => 'ElasticsearchVersion', ], ], ], 'DescribeElasticsearchInstanceTypeLimitsResponse' => [ 'type' => 'structure', 'members' => [ 'LimitsByRole' => [ 'shape' => 'LimitsByRole', ], ], ], 'DescribeInboundCrossClusterSearchConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeInboundCrossClusterSearchConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnections' => [ 'shape' => 'InboundCrossClusterSearchConnections', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOutboundCrossClusterSearchConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOutboundCrossClusterSearchConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnections' => [ 'shape' => 'OutboundCrossClusterSearchConnections', ], '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', ], ], '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', ], ], ], 'DescribeReservedElasticsearchInstanceOfferingsRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedElasticsearchInstanceOfferingId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'offeringId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedElasticsearchInstanceOfferingsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ReservedElasticsearchInstanceOfferings' => [ 'shape' => 'ReservedElasticsearchInstanceOfferingList', ], ], ], 'DescribeReservedElasticsearchInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedElasticsearchInstanceId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'reservationId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedElasticsearchInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', ], 'ReservedElasticsearchInstances' => [ 'shape' => 'ReservedElasticsearchInstanceList', ], ], ], '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\\-]+', ], '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', ], ], ], 'DomainId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DomainInfo' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'EngineType' => [ 'shape' => 'EngineType', ], ], ], 'DomainInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainInfo', ], ], 'DomainInformation' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'OwnerId' => [ 'shape' => 'OwnerId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Region' => [ 'shape' => 'Region', ], ], ], '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', ], ], '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', ], ], 'Double' => [ 'type' => 'double', ], 'DryRun' => [ 'type' => 'boolean', ], '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', ], ], ], 'ESPartitionInstanceType' => [ 'type' => 'string', 'enum' => [ 'm3.medium.elasticsearch', 'm3.large.elasticsearch', 'm3.xlarge.elasticsearch', 'm3.2xlarge.elasticsearch', 'm4.large.elasticsearch', 'm4.xlarge.elasticsearch', 'm4.2xlarge.elasticsearch', 'm4.4xlarge.elasticsearch', 'm4.10xlarge.elasticsearch', 'm5.large.elasticsearch', 'm5.xlarge.elasticsearch', 'm5.2xlarge.elasticsearch', 'm5.4xlarge.elasticsearch', 'm5.12xlarge.elasticsearch', 'r5.large.elasticsearch', 'r5.xlarge.elasticsearch', 'r5.2xlarge.elasticsearch', 'r5.4xlarge.elasticsearch', 'r5.12xlarge.elasticsearch', 'c5.large.elasticsearch', 'c5.xlarge.elasticsearch', 'c5.2xlarge.elasticsearch', 'c5.4xlarge.elasticsearch', 'c5.9xlarge.elasticsearch', 'c5.18xlarge.elasticsearch', 'ultrawarm1.medium.elasticsearch', 'ultrawarm1.large.elasticsearch', 't2.micro.elasticsearch', 't2.small.elasticsearch', 't2.medium.elasticsearch', 'r3.large.elasticsearch', 'r3.xlarge.elasticsearch', 'r3.2xlarge.elasticsearch', 'r3.4xlarge.elasticsearch', 'r3.8xlarge.elasticsearch', 'i2.xlarge.elasticsearch', 'i2.2xlarge.elasticsearch', 'd2.xlarge.elasticsearch', 'd2.2xlarge.elasticsearch', 'd2.4xlarge.elasticsearch', 'd2.8xlarge.elasticsearch', 'c4.large.elasticsearch', 'c4.xlarge.elasticsearch', 'c4.2xlarge.elasticsearch', 'c4.4xlarge.elasticsearch', 'c4.8xlarge.elasticsearch', 'r4.large.elasticsearch', 'r4.xlarge.elasticsearch', 'r4.2xlarge.elasticsearch', 'r4.4xlarge.elasticsearch', 'r4.8xlarge.elasticsearch', 'r4.16xlarge.elasticsearch', 'i3.large.elasticsearch', 'i3.xlarge.elasticsearch', 'i3.2xlarge.elasticsearch', 'i3.4xlarge.elasticsearch', 'i3.8xlarge.elasticsearch', 'i3.16xlarge.elasticsearch', ], ], 'ESWarmPartitionInstanceType' => [ 'type' => 'string', 'enum' => [ 'ultrawarm1.medium.elasticsearch', 'ultrawarm1.large.elasticsearch', ], ], 'ElasticsearchClusterConfig' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'ESPartitionInstanceType', ], 'InstanceCount' => [ 'shape' => 'IntegerClass', ], 'DedicatedMasterEnabled' => [ 'shape' => 'Boolean', ], 'ZoneAwarenessEnabled' => [ 'shape' => 'Boolean', ], 'ZoneAwarenessConfig' => [ 'shape' => 'ZoneAwarenessConfig', ], 'DedicatedMasterType' => [ 'shape' => 'ESPartitionInstanceType', ], 'DedicatedMasterCount' => [ 'shape' => 'IntegerClass', ], 'WarmEnabled' => [ 'shape' => 'Boolean', ], 'WarmType' => [ 'shape' => 'ESWarmPartitionInstanceType', ], 'WarmCount' => [ 'shape' => 'IntegerClass', ], 'ColdStorageOptions' => [ 'shape' => 'ColdStorageOptions', ], ], ], 'ElasticsearchClusterConfigStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'ElasticsearchClusterConfig', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'ElasticsearchDomainConfig' => [ 'type' => 'structure', 'members' => [ 'ElasticsearchVersion' => [ 'shape' => 'ElasticsearchVersionStatus', ], 'ElasticsearchClusterConfig' => [ 'shape' => 'ElasticsearchClusterConfigStatus', ], 'EBSOptions' => [ 'shape' => 'EBSOptionsStatus', ], 'AccessPolicies' => [ 'shape' => 'AccessPoliciesStatus', ], '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', ], ], ], 'ElasticsearchDomainStatus' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'DomainName', 'ARN', 'ElasticsearchClusterConfig', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'ARN' => [ 'shape' => 'ARN', ], 'Created' => [ 'shape' => 'Boolean', ], 'Deleted' => [ 'shape' => 'Boolean', ], 'Endpoint' => [ 'shape' => 'ServiceUrl', ], 'Endpoints' => [ 'shape' => 'EndpointsMap', ], 'Processing' => [ 'shape' => 'Boolean', ], 'UpgradeProcessing' => [ 'shape' => 'Boolean', ], 'ElasticsearchVersion' => [ 'shape' => 'ElasticsearchVersionString', ], 'ElasticsearchClusterConfig' => [ 'shape' => 'ElasticsearchClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], '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', ], ], ], 'ElasticsearchDomainStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ElasticsearchDomainStatus', ], ], 'ElasticsearchInstanceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ESPartitionInstanceType', ], ], 'ElasticsearchVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ElasticsearchVersionString', ], ], 'ElasticsearchVersionStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'ElasticsearchVersionString', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'ElasticsearchVersionString' => [ 'type' => 'string', 'pattern' => '^[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$|^OS_[0-9]{1,2}\\.[0-9]{1,2}$', ], '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', ], ], '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', 'pattern' => '\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}', ], 'GetCompatibleElasticsearchVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], ], ], 'GetCompatibleElasticsearchVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'CompatibleElasticsearchVersions' => [ 'shape' => 'CompatibleElasticsearchVersionsList', ], ], ], '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', ], ], ], 'IdentityPoolId' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+:[0-9a-f-]+', ], 'InboundCrossClusterSearchConnection' => [ 'type' => 'structure', 'members' => [ 'SourceDomainInfo' => [ 'shape' => 'DomainInformation', ], 'DestinationDomainInfo' => [ 'shape' => 'DomainInformation', ], 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', ], 'ConnectionStatus' => [ 'shape' => 'InboundCrossClusterSearchConnectionStatus', ], ], ], 'InboundCrossClusterSearchConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'InboundCrossClusterSearchConnectionStatusCode', ], 'Message' => [ 'shape' => 'CrossClusterSearchConnectionStatusMessage', ], ], ], 'InboundCrossClusterSearchConnectionStatusCode' => [ 'type' => 'string', 'enum' => [ 'PENDING_ACCEPTANCE', 'APPROVED', 'REJECTING', 'REJECTED', 'DELETING', 'DELETED', ], ], 'InboundCrossClusterSearchConnections' => [ 'type' => 'list', 'member' => [ 'shape' => 'InboundCrossClusterSearchConnection', ], ], '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', ], 'Integer' => [ 'type' => 'integer', ], 'IntegerClass' => [ 'type' => 'integer', ], 'InternalException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'InvalidPaginationTokenException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidTypeException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'Issue' => [ 'type' => 'string', ], 'Issues' => [ 'type' => 'list', 'member' => [ 'shape' => 'Issue', ], ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], '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', ], ], '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', ], ], ], 'ListElasticsearchInstanceTypesRequest' => [ 'type' => 'structure', 'required' => [ 'ElasticsearchVersion', ], 'members' => [ 'ElasticsearchVersion' => [ 'shape' => 'ElasticsearchVersionString', 'location' => 'uri', 'locationName' => 'ElasticsearchVersion', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListElasticsearchInstanceTypesResponse' => [ 'type' => 'structure', 'members' => [ 'ElasticsearchInstanceTypes' => [ 'shape' => 'ElasticsearchInstanceTypeList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListElasticsearchVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListElasticsearchVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ElasticsearchVersions' => [ 'shape' => 'ElasticsearchVersionList', ], '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', ], ], ], 'ListTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'arn', ], ], ], 'ListTagsResponse' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], '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', ], ], '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', ], 'NextToken' => [ 'type' => 'string', ], 'NodeToNodeEncryptionOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'NonEmptyString' => [ 'type' => 'string', 'min' => 1, ], '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', ], ], ], 'OutboundCrossClusterSearchConnection' => [ 'type' => 'structure', 'members' => [ 'SourceDomainInfo' => [ 'shape' => 'DomainInformation', ], 'DestinationDomainInfo' => [ 'shape' => 'DomainInformation', ], 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionStatus' => [ 'shape' => 'OutboundCrossClusterSearchConnectionStatus', ], ], ], 'OutboundCrossClusterSearchConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'OutboundCrossClusterSearchConnectionStatusCode', ], 'Message' => [ 'shape' => 'CrossClusterSearchConnectionStatusMessage', ], ], ], 'OutboundCrossClusterSearchConnectionStatusCode' => [ 'type' => 'string', 'enum' => [ 'PENDING_ACCEPTANCE', 'VALIDATING', 'VALIDATION_FAILED', 'PROVISIONING', 'ACTIVE', 'REJECTED', 'DELETING', 'DELETED', ], ], 'OutboundCrossClusterSearchConnections' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutboundCrossClusterSearchConnection', ], ], 'OverallChangeStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'PROCESSING', 'COMPLETED', 'FAILED', ], ], 'OwnerId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, ], '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', ], ], ], 'PackageDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageDetails', ], ], 'PackageID' => [ 'type' => 'string', ], 'PackageName' => [ 'type' => 'string', 'max' => 28, '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', ], ], 'PackageVersion' => [ 'type' => 'string', ], 'PackageVersionHistory' => [ 'type' => 'structure', 'members' => [ 'PackageVersion' => [ 'shape' => 'PackageVersion', ], 'CommitMessage' => [ 'shape' => 'CommitMessage', ], 'CreatedAt' => [ 'shape' => 'CreatedAt', ], ], ], 'PackageVersionHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageVersionHistory', ], ], 'Password' => [ 'type' => 'string', 'min' => 8, 'sensitive' => true, ], 'PolicyDocument' => [ 'type' => 'string', ], 'PrincipalType' => [ 'type' => 'string', 'enum' => [ 'AWS_ACCOUNT', 'AWS_SERVICE', ], ], 'PurchaseReservedElasticsearchInstanceOfferingRequest' => [ 'type' => 'structure', 'required' => [ 'ReservedElasticsearchInstanceOfferingId', 'ReservationName', ], 'members' => [ 'ReservedElasticsearchInstanceOfferingId' => [ 'shape' => 'GUID', ], 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'InstanceCount' => [ 'shape' => 'InstanceCount', ], ], ], 'PurchaseReservedElasticsearchInstanceOfferingResponse' => [ 'type' => 'structure', 'members' => [ 'ReservedElasticsearchInstanceId' => [ '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', ], 'RejectInboundCrossClusterSearchConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'CrossClusterSearchConnectionId', ], 'members' => [ 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'RejectInboundCrossClusterSearchConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnection' => [ 'shape' => 'InboundCrossClusterSearchConnection', ], ], ], 'RemoveTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagKeys', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagKeys' => [ 'shape' => 'StringList', ], ], ], 'ReservationToken' => [ 'type' => 'string', 'max' => 64, 'min' => 5, ], 'ReservedElasticsearchInstance' => [ 'type' => 'structure', 'members' => [ 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'ReservedElasticsearchInstanceId' => [ 'shape' => 'GUID', ], 'ReservedElasticsearchInstanceOfferingId' => [ 'shape' => 'String', ], 'ElasticsearchInstanceType' => [ 'shape' => 'ESPartitionInstanceType', ], 'StartTime' => [ 'shape' => 'UpdateTimestamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'ElasticsearchInstanceCount' => [ 'shape' => 'Integer', ], 'State' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedElasticsearchInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedElasticsearchInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedElasticsearchInstance', ], ], 'ReservedElasticsearchInstanceOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedElasticsearchInstanceOfferingId' => [ 'shape' => 'GUID', ], 'ElasticsearchInstanceType' => [ 'shape' => 'ESPartitionInstanceType', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedElasticsearchInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedElasticsearchInstanceOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedElasticsearchInstanceOffering', ], ], 'ReservedElasticsearchInstancePaymentOption' => [ '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, ], 'RollbackOnDisable' => [ 'type' => 'string', 'enum' => [ 'NO_ROLLBACK', 'DEFAULT_ROLLBACK', ], ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, ], 'S3Key' => [ 'type' => 'string', ], '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', ], ], ], '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', ], ], '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', ], 'SnapshotOptions' => [ 'type' => 'structure', 'members' => [ 'AutomatedSnapshotStartHour' => [ 'shape' => 'IntegerClass', ], ], ], 'SnapshotOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'SnapshotOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'StartAt' => [ 'type' => 'timestamp', ], 'StartElasticsearchServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], ], ], 'StartElasticsearchServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'StartTimestamp' => [ 'type' => 'timestamp', ], 'StorageSubTypeName' => [ 'type' => 'string', ], 'StorageType' => [ 'type' => 'structure', 'members' => [ 'StorageTypeName' => [ 'shape' => 'StorageTypeName', ], 'StorageSubTypeName' => [ 'shape' => 'StorageSubTypeName', ], 'StorageTypeLimits' => [ 'shape' => 'StorageTypeLimitList', ], ], ], 'StorageTypeLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'StorageTypeLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageTypeLimit', ], ], 'StorageTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageType', ], ], 'StorageTypeName' => [ 'type' => 'string', ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'TLSSecurityPolicy' => [ 'type' => 'string', 'enum' => [ 'Policy-Min-TLS-1-0-2019-07', 'Policy-Min-TLS-1-2-2019-07', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TimeUnit' => [ 'type' => 'string', 'enum' => [ 'HOURS', ], ], 'TotalNumberOfStages' => [ 'type' => 'integer', ], 'UIntValue' => [ 'type' => 'integer', 'min' => 0, ], 'UpdateElasticsearchDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ElasticsearchClusterConfig' => [ 'shape' => 'ElasticsearchClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCOptions', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsInput', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptions', ], 'DryRun' => [ 'shape' => 'DryRun', ], ], ], 'UpdateElasticsearchDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'ElasticsearchDomainConfig', ], 'DryRunResults' => [ 'shape' => 'DryRunResults', ], ], ], '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', ], ], ], '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', ], ], ], 'UpgradeElasticsearchDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'TargetVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'ElasticsearchVersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], ], ], 'UpgradeElasticsearchDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'ElasticsearchVersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], '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', 'min' => 1, '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, ], 'ValueStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString', ], 'min' => 1, ], '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', ], ], 'ZoneAwarenessConfig' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneCount' => [ 'shape' => 'IntegerClass', ], ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2015-01-01', 'endpointPrefix' => 'es', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon Elasticsearch Service', 'serviceId' => 'Elasticsearch Service', 'signatureVersion' => 'v4', 'uid' => 'es-2015-01-01', ], 'operations' => [ 'AcceptInboundCrossClusterSearchConnection' => [ 'name' => 'AcceptInboundCrossClusterSearchConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept', ], 'input' => [ 'shape' => 'AcceptInboundCrossClusterSearchConnectionRequest', ], 'output' => [ 'shape' => 'AcceptInboundCrossClusterSearchConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/tags', ], 'input' => [ 'shape' => 'AddTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'AssociatePackage' => [ 'name' => 'AssociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-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' => '/2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess', ], 'input' => [ 'shape' => 'AuthorizeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'AuthorizeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'CancelElasticsearchServiceSoftwareUpdate' => [ 'name' => 'CancelElasticsearchServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/serviceSoftwareUpdate/cancel', ], 'input' => [ 'shape' => 'CancelElasticsearchServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'CancelElasticsearchServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateElasticsearchDomain' => [ 'name' => 'CreateElasticsearchDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/domain', ], 'input' => [ 'shape' => 'CreateElasticsearchDomainRequest', ], 'output' => [ 'shape' => 'CreateElasticsearchDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateOutboundCrossClusterSearchConnection' => [ 'name' => 'CreateOutboundCrossClusterSearchConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/ccs/outboundConnection', ], 'input' => [ 'shape' => 'CreateOutboundCrossClusterSearchConnectionRequest', ], 'output' => [ 'shape' => 'CreateOutboundCrossClusterSearchConnectionResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'CreatePackage' => [ 'name' => 'CreatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-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' => '/2015-01-01/es/vpcEndpoints', ], 'input' => [ 'shape' => 'CreateVpcEndpointRequest', ], 'output' => [ 'shape' => 'CreateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DeleteElasticsearchDomain' => [ 'name' => 'DeleteElasticsearchDomain', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-01-01/es/domain/{DomainName}', ], 'input' => [ 'shape' => 'DeleteElasticsearchDomainRequest', ], 'output' => [ 'shape' => 'DeleteElasticsearchDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteElasticsearchServiceRole' => [ 'name' => 'DeleteElasticsearchServiceRole', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-01-01/es/role', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteInboundCrossClusterSearchConnection' => [ 'name' => 'DeleteInboundCrossClusterSearchConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-01-01/es/ccs/inboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteInboundCrossClusterSearchConnectionRequest', ], 'output' => [ 'shape' => 'DeleteInboundCrossClusterSearchConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeleteOutboundCrossClusterSearchConnection' => [ 'name' => 'DeleteOutboundCrossClusterSearchConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-01-01/es/ccs/outboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteOutboundCrossClusterSearchConnectionRequest', ], 'output' => [ 'shape' => 'DeleteOutboundCrossClusterSearchConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeletePackage' => [ 'name' => 'DeletePackage', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2015-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' => '/2015-01-01/es/vpcEndpoints/{VpcEndpointId}', ], 'input' => [ 'shape' => 'DeleteVpcEndpointRequest', ], 'output' => [ 'shape' => 'DeleteVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'DescribeDomainAutoTunes' => [ 'name' => 'DescribeDomainAutoTunes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/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' => '/2015-01-01/es/domain/{DomainName}/progress', ], 'input' => [ 'shape' => 'DescribeDomainChangeProgressRequest', ], 'output' => [ 'shape' => 'DescribeDomainChangeProgressResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeElasticsearchDomain' => [ 'name' => 'DescribeElasticsearchDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/domain/{DomainName}', ], 'input' => [ 'shape' => 'DescribeElasticsearchDomainRequest', ], 'output' => [ 'shape' => 'DescribeElasticsearchDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeElasticsearchDomainConfig' => [ 'name' => 'DescribeElasticsearchDomainConfig', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'DescribeElasticsearchDomainConfigRequest', ], 'output' => [ 'shape' => 'DescribeElasticsearchDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeElasticsearchDomains' => [ 'name' => 'DescribeElasticsearchDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/domain-info', ], 'input' => [ 'shape' => 'DescribeElasticsearchDomainsRequest', ], 'output' => [ 'shape' => 'DescribeElasticsearchDomainsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeElasticsearchInstanceTypeLimits' => [ 'name' => 'DescribeElasticsearchInstanceTypeLimits', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}', ], 'input' => [ 'shape' => 'DescribeElasticsearchInstanceTypeLimitsRequest', ], 'output' => [ 'shape' => 'DescribeElasticsearchInstanceTypeLimitsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeInboundCrossClusterSearchConnections' => [ 'name' => 'DescribeInboundCrossClusterSearchConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/ccs/inboundConnection/search', ], 'input' => [ 'shape' => 'DescribeInboundCrossClusterSearchConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeInboundCrossClusterSearchConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeOutboundCrossClusterSearchConnections' => [ 'name' => 'DescribeOutboundCrossClusterSearchConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/ccs/outboundConnection/search', ], 'input' => [ 'shape' => 'DescribeOutboundCrossClusterSearchConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeOutboundCrossClusterSearchConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribePackages' => [ 'name' => 'DescribePackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/packages/describe', ], 'input' => [ 'shape' => 'DescribePackagesRequest', ], 'output' => [ 'shape' => 'DescribePackagesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeReservedElasticsearchInstanceOfferings' => [ 'name' => 'DescribeReservedElasticsearchInstanceOfferings', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/reservedInstanceOfferings', ], 'input' => [ 'shape' => 'DescribeReservedElasticsearchInstanceOfferingsRequest', ], 'output' => [ 'shape' => 'DescribeReservedElasticsearchInstanceOfferingsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], ], ], 'DescribeReservedElasticsearchInstances' => [ 'name' => 'DescribeReservedElasticsearchInstances', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/reservedInstances', ], 'input' => [ 'shape' => 'DescribeReservedElasticsearchInstancesRequest', ], 'output' => [ 'shape' => 'DescribeReservedElasticsearchInstancesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeVpcEndpoints' => [ 'name' => 'DescribeVpcEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/vpcEndpoints/describe', ], 'input' => [ 'shape' => 'DescribeVpcEndpointsRequest', ], 'output' => [ 'shape' => 'DescribeVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DissociatePackage' => [ 'name' => 'DissociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-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', ], ], ], 'GetCompatibleElasticsearchVersions' => [ 'name' => 'GetCompatibleElasticsearchVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/compatibleVersions', ], 'input' => [ 'shape' => 'GetCompatibleElasticsearchVersionsRequest', ], 'output' => [ 'shape' => 'GetCompatibleElasticsearchVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'GetPackageVersionHistory' => [ 'name' => 'GetPackageVersionHistory', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-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' => '/2015-01-01/es/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' => '/2015-01-01/es/upgradeDomain/{DomainName}/status', ], 'input' => [ 'shape' => 'GetUpgradeStatusRequest', ], 'output' => [ 'shape' => 'GetUpgradeStatusResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListDomainNames' => [ 'name' => 'ListDomainNames', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/domain', ], 'input' => [ 'shape' => 'ListDomainNamesRequest', ], 'output' => [ 'shape' => 'ListDomainNamesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListDomainsForPackage' => [ 'name' => 'ListDomainsForPackage', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/packages/{PackageID}/domains', ], 'input' => [ 'shape' => 'ListDomainsForPackageRequest', ], 'output' => [ 'shape' => 'ListDomainsForPackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListElasticsearchInstanceTypes' => [ 'name' => 'ListElasticsearchInstanceTypes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/instanceTypes/{ElasticsearchVersion}', ], 'input' => [ 'shape' => 'ListElasticsearchInstanceTypesRequest', ], 'output' => [ 'shape' => 'ListElasticsearchInstanceTypesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListElasticsearchVersions' => [ 'name' => 'ListElasticsearchVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/versions', ], 'input' => [ 'shape' => 'ListElasticsearchVersionsRequest', ], 'output' => [ 'shape' => 'ListElasticsearchVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackagesForDomain' => [ 'name' => 'ListPackagesForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/domain/{DomainName}/packages', ], 'input' => [ 'shape' => 'ListPackagesForDomainRequest', ], 'output' => [ 'shape' => 'ListPackagesForDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/tags/', ], 'input' => [ 'shape' => 'ListTagsRequest', ], 'output' => [ 'shape' => 'ListTagsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListVpcEndpointAccess' => [ 'name' => 'ListVpcEndpointAccess', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/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' => '/2015-01-01/es/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'ListVpcEndpointsForDomain' => [ 'name' => 'ListVpcEndpointsForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2015-01-01/es/domain/{DomainName}/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsForDomainRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsForDomainResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'BaseException', ], ], ], 'PurchaseReservedElasticsearchInstanceOffering' => [ 'name' => 'PurchaseReservedElasticsearchInstanceOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/purchaseReservedInstanceOffering', ], 'input' => [ 'shape' => 'PurchaseReservedElasticsearchInstanceOfferingRequest', ], 'output' => [ 'shape' => 'PurchaseReservedElasticsearchInstanceOfferingResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RejectInboundCrossClusterSearchConnection' => [ 'name' => 'RejectInboundCrossClusterSearchConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject', ], 'input' => [ 'shape' => 'RejectInboundCrossClusterSearchConnectionRequest', ], 'output' => [ 'shape' => 'RejectInboundCrossClusterSearchConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'RemoveTags' => [ 'name' => 'RemoveTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/tags-removal', ], 'input' => [ 'shape' => 'RemoveTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RevokeVpcEndpointAccess' => [ 'name' => 'RevokeVpcEndpointAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess', ], 'input' => [ 'shape' => 'RevokeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'RevokeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'StartElasticsearchServiceSoftwareUpdate' => [ 'name' => 'StartElasticsearchServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/serviceSoftwareUpdate/start', ], 'input' => [ 'shape' => 'StartElasticsearchServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'StartElasticsearchServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateElasticsearchDomainConfig' => [ 'name' => 'UpdateElasticsearchDomainConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'UpdateElasticsearchDomainConfigRequest', ], 'output' => [ 'shape' => 'UpdateElasticsearchDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdatePackage' => [ 'name' => 'UpdatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/packages/update', ], 'input' => [ 'shape' => 'UpdatePackageRequest', ], 'output' => [ 'shape' => 'UpdatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateVpcEndpoint' => [ 'name' => 'UpdateVpcEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/vpcEndpoints/update', ], 'input' => [ 'shape' => 'UpdateVpcEndpointRequest', ], 'output' => [ 'shape' => 'UpdateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'BaseException', ], ], ], 'UpgradeElasticsearchDomain' => [ 'name' => 'UpgradeElasticsearchDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2015-01-01/es/upgradeDomain', ], 'input' => [ 'shape' => 'UpgradeElasticsearchDomainRequest', ], 'output' => [ 'shape' => 'UpgradeElasticsearchDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], ], 'shapes' => [ 'ARN' => [ 'type' => 'string', ], 'AWSAccount' => [ 'type' => 'string', 'pattern' => '^[0-9]+$', ], 'AcceptInboundCrossClusterSearchConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'CrossClusterSearchConnectionId', ], 'members' => [ 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'AcceptInboundCrossClusterSearchConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnection' => [ 'shape' => 'InboundCrossClusterSearchConnection', ], ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccessPoliciesStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'PolicyDocument', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AddTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagList', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'AdditionalLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'AdditionalLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalLimit', ], ], 'AdvancedOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'AdvancedOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AdvancedSecurityOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsOutput', ], 'AnonymousAuthDisableDate' => [ 'shape' => 'DisableTimestamp', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'MasterUserOptions' => [ 'shape' => 'MasterUserOptions', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsInput', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedSecurityOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AssociatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'DomainName', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'AssociatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetails' => [ 'shape' => 'DomainPackageDetails', ], ], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Account', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Account' => [ 'shape' => 'AWSAccount', ], ], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'type' => 'structure', 'required' => [ 'AuthorizedPrincipal', ], 'members' => [ 'AuthorizedPrincipal' => [ 'shape' => 'AuthorizedPrincipal', ], ], ], 'AuthorizedPrincipal' => [ 'type' => 'structure', 'members' => [ 'PrincipalType' => [ 'shape' => 'PrincipalType', ], 'Principal' => [ 'shape' => 'String', ], ], ], 'AuthorizedPrincipalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthorizedPrincipal', ], ], 'AutoTune' => [ 'type' => 'structure', 'members' => [ 'AutoTuneType' => [ 'shape' => 'AutoTuneType', ], 'AutoTuneDetails' => [ 'shape' => 'AutoTuneDetails', ], ], ], 'AutoTuneDate' => [ 'type' => 'timestamp', ], 'AutoTuneDesiredState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'AutoTuneDetails' => [ 'type' => 'structure', 'members' => [ 'ScheduledAutoTuneDetails' => [ 'shape' => 'ScheduledAutoTuneDetails', ], ], ], 'AutoTuneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTune', ], ], 'AutoTuneMaintenanceSchedule' => [ 'type' => 'structure', 'members' => [ 'StartAt' => [ 'shape' => 'StartAt', ], 'Duration' => [ 'shape' => 'Duration', ], 'CronExpressionForRecurrence' => [ 'shape' => 'String', ], ], ], 'AutoTuneMaintenanceScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTuneMaintenanceSchedule', ], 'max' => 100, ], 'AutoTuneOptions' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'RollbackOnDisable' => [ 'shape' => 'RollbackOnDisable', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], ], ], 'AutoTuneOptionsInput' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], ], ], 'AutoTuneOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'AutoTuneState', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], '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', ], ], 'BackendRole' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'BaseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'CancelElasticsearchServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], ], ], 'CancelElasticsearchServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'ChangeProgressDetails' => [ 'type' => 'structure', 'members' => [ 'ChangeId' => [ 'shape' => 'GUID', ], 'Message' => [ 'shape' => 'Message', ], ], ], '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', ], ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CloudWatchLogsLogGroupArn' => [ 'type' => 'string', ], '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, ], 'CompatibleElasticsearchVersionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompatibleVersionsMap', ], ], 'CompatibleVersionsMap' => [ 'type' => 'structure', 'members' => [ 'SourceVersion' => [ 'shape' => 'ElasticsearchVersionString', ], 'TargetVersions' => [ 'shape' => 'ElasticsearchVersionList', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConnectionAlias' => [ 'type' => 'string', 'max' => 20, ], 'CreateElasticsearchDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'ElasticsearchVersion' => [ 'shape' => 'ElasticsearchVersionString', ], 'ElasticsearchClusterConfig' => [ 'shape' => 'ElasticsearchClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], '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', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsInput', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'CreateElasticsearchDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'ElasticsearchDomainStatus', ], ], ], 'CreateOutboundCrossClusterSearchConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'SourceDomainInfo', 'DestinationDomainInfo', 'ConnectionAlias', ], 'members' => [ 'SourceDomainInfo' => [ 'shape' => 'DomainInformation', ], 'DestinationDomainInfo' => [ 'shape' => 'DomainInformation', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], ], ], 'CreateOutboundCrossClusterSearchConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'SourceDomainInfo' => [ 'shape' => 'DomainInformation', ], 'DestinationDomainInfo' => [ 'shape' => 'DomainInformation', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionStatus' => [ 'shape' => 'OutboundCrossClusterSearchConnectionStatus', ], 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', ], ], ], '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', ], 'CrossClusterSearchConnectionId' => [ 'type' => 'string', ], 'CrossClusterSearchConnectionStatusMessage' => [ 'type' => 'string', ], 'DeleteElasticsearchDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DeleteElasticsearchDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'ElasticsearchDomainStatus', ], ], ], 'DeleteInboundCrossClusterSearchConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'CrossClusterSearchConnectionId', ], 'members' => [ 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteInboundCrossClusterSearchConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnection' => [ 'shape' => 'InboundCrossClusterSearchConnection', ], ], ], 'DeleteOutboundCrossClusterSearchConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'CrossClusterSearchConnectionId', ], 'members' => [ 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteOutboundCrossClusterSearchConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnection' => [ 'shape' => 'OutboundCrossClusterSearchConnection', ], ], ], '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', ], ], ], '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', ], ], ], 'DescribeElasticsearchDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeElasticsearchDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'ElasticsearchDomainConfig', ], ], ], 'DescribeElasticsearchDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeElasticsearchDomainResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatus', ], 'members' => [ 'DomainStatus' => [ 'shape' => 'ElasticsearchDomainStatus', ], ], ], 'DescribeElasticsearchDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'DomainNames', ], 'members' => [ 'DomainNames' => [ 'shape' => 'DomainNameList', ], ], ], 'DescribeElasticsearchDomainsResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatusList', ], 'members' => [ 'DomainStatusList' => [ 'shape' => 'ElasticsearchDomainStatusList', ], ], ], 'DescribeElasticsearchInstanceTypeLimitsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'ElasticsearchVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'InstanceType' => [ 'shape' => 'ESPartitionInstanceType', 'location' => 'uri', 'locationName' => 'InstanceType', ], 'ElasticsearchVersion' => [ 'shape' => 'ElasticsearchVersionString', 'location' => 'uri', 'locationName' => 'ElasticsearchVersion', ], ], ], 'DescribeElasticsearchInstanceTypeLimitsResponse' => [ 'type' => 'structure', 'members' => [ 'LimitsByRole' => [ 'shape' => 'LimitsByRole', ], ], ], 'DescribeInboundCrossClusterSearchConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeInboundCrossClusterSearchConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnections' => [ 'shape' => 'InboundCrossClusterSearchConnections', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOutboundCrossClusterSearchConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOutboundCrossClusterSearchConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnections' => [ 'shape' => 'OutboundCrossClusterSearchConnections', ], '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', ], ], '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', ], ], ], 'DescribeReservedElasticsearchInstanceOfferingsRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedElasticsearchInstanceOfferingId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'offeringId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedElasticsearchInstanceOfferingsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ReservedElasticsearchInstanceOfferings' => [ 'shape' => 'ReservedElasticsearchInstanceOfferingList', ], ], ], 'DescribeReservedElasticsearchInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedElasticsearchInstanceId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'reservationId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedElasticsearchInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', ], 'ReservedElasticsearchInstances' => [ 'shape' => 'ReservedElasticsearchInstanceList', ], ], ], '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\\-]+', ], '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', ], ], ], 'DomainId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'DomainInfo' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'EngineType' => [ 'shape' => 'EngineType', ], ], ], 'DomainInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainInfo', ], ], 'DomainInformation' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'OwnerId' => [ 'shape' => 'OwnerId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Region' => [ 'shape' => 'Region', ], ], ], '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', ], ], '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', ], ], 'Double' => [ 'type' => 'double', ], 'DryRun' => [ 'type' => 'boolean', ], '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', ], ], ], 'ESPartitionInstanceType' => [ 'type' => 'string', 'enum' => [ 'm3.medium.elasticsearch', 'm3.large.elasticsearch', 'm3.xlarge.elasticsearch', 'm3.2xlarge.elasticsearch', 'm4.large.elasticsearch', 'm4.xlarge.elasticsearch', 'm4.2xlarge.elasticsearch', 'm4.4xlarge.elasticsearch', 'm4.10xlarge.elasticsearch', 'm5.large.elasticsearch', 'm5.xlarge.elasticsearch', 'm5.2xlarge.elasticsearch', 'm5.4xlarge.elasticsearch', 'm5.12xlarge.elasticsearch', 'r5.large.elasticsearch', 'r5.xlarge.elasticsearch', 'r5.2xlarge.elasticsearch', 'r5.4xlarge.elasticsearch', 'r5.12xlarge.elasticsearch', 'c5.large.elasticsearch', 'c5.xlarge.elasticsearch', 'c5.2xlarge.elasticsearch', 'c5.4xlarge.elasticsearch', 'c5.9xlarge.elasticsearch', 'c5.18xlarge.elasticsearch', 'ultrawarm1.medium.elasticsearch', 'ultrawarm1.large.elasticsearch', 't2.micro.elasticsearch', 't2.small.elasticsearch', 't2.medium.elasticsearch', 'r3.large.elasticsearch', 'r3.xlarge.elasticsearch', 'r3.2xlarge.elasticsearch', 'r3.4xlarge.elasticsearch', 'r3.8xlarge.elasticsearch', 'i2.xlarge.elasticsearch', 'i2.2xlarge.elasticsearch', 'd2.xlarge.elasticsearch', 'd2.2xlarge.elasticsearch', 'd2.4xlarge.elasticsearch', 'd2.8xlarge.elasticsearch', 'c4.large.elasticsearch', 'c4.xlarge.elasticsearch', 'c4.2xlarge.elasticsearch', 'c4.4xlarge.elasticsearch', 'c4.8xlarge.elasticsearch', 'r4.large.elasticsearch', 'r4.xlarge.elasticsearch', 'r4.2xlarge.elasticsearch', 'r4.4xlarge.elasticsearch', 'r4.8xlarge.elasticsearch', 'r4.16xlarge.elasticsearch', 'i3.large.elasticsearch', 'i3.xlarge.elasticsearch', 'i3.2xlarge.elasticsearch', 'i3.4xlarge.elasticsearch', 'i3.8xlarge.elasticsearch', 'i3.16xlarge.elasticsearch', ], ], 'ESWarmPartitionInstanceType' => [ 'type' => 'string', 'enum' => [ 'ultrawarm1.medium.elasticsearch', 'ultrawarm1.large.elasticsearch', ], ], 'ElasticsearchClusterConfig' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'ESPartitionInstanceType', ], 'InstanceCount' => [ 'shape' => 'IntegerClass', ], 'DedicatedMasterEnabled' => [ 'shape' => 'Boolean', ], 'ZoneAwarenessEnabled' => [ 'shape' => 'Boolean', ], 'ZoneAwarenessConfig' => [ 'shape' => 'ZoneAwarenessConfig', ], 'DedicatedMasterType' => [ 'shape' => 'ESPartitionInstanceType', ], 'DedicatedMasterCount' => [ 'shape' => 'IntegerClass', ], 'WarmEnabled' => [ 'shape' => 'Boolean', ], 'WarmType' => [ 'shape' => 'ESWarmPartitionInstanceType', ], 'WarmCount' => [ 'shape' => 'IntegerClass', ], 'ColdStorageOptions' => [ 'shape' => 'ColdStorageOptions', ], ], ], 'ElasticsearchClusterConfigStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'ElasticsearchClusterConfig', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'ElasticsearchDomainConfig' => [ 'type' => 'structure', 'members' => [ 'ElasticsearchVersion' => [ 'shape' => 'ElasticsearchVersionStatus', ], 'ElasticsearchClusterConfig' => [ 'shape' => 'ElasticsearchClusterConfigStatus', ], 'EBSOptions' => [ 'shape' => 'EBSOptionsStatus', ], 'AccessPolicies' => [ 'shape' => 'AccessPoliciesStatus', ], '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', ], ], ], 'ElasticsearchDomainStatus' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'DomainName', 'ARN', 'ElasticsearchClusterConfig', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'ARN' => [ 'shape' => 'ARN', ], 'Created' => [ 'shape' => 'Boolean', ], 'Deleted' => [ 'shape' => 'Boolean', ], 'Endpoint' => [ 'shape' => 'ServiceUrl', ], 'Endpoints' => [ 'shape' => 'EndpointsMap', ], 'Processing' => [ 'shape' => 'Boolean', ], 'UpgradeProcessing' => [ 'shape' => 'Boolean', ], 'ElasticsearchVersion' => [ 'shape' => 'ElasticsearchVersionString', ], 'ElasticsearchClusterConfig' => [ 'shape' => 'ElasticsearchClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], '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', ], ], ], 'ElasticsearchDomainStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ElasticsearchDomainStatus', ], ], 'ElasticsearchInstanceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ESPartitionInstanceType', ], ], 'ElasticsearchVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ElasticsearchVersionString', ], ], 'ElasticsearchVersionStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'ElasticsearchVersionString', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'ElasticsearchVersionString' => [ 'type' => 'string', 'pattern' => '^[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$|^OS_[0-9]{1,2}\\.[0-9]{1,2}$', ], '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', ], ], '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', 'pattern' => '\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}', ], 'GetCompatibleElasticsearchVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], ], ], 'GetCompatibleElasticsearchVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'CompatibleElasticsearchVersions' => [ 'shape' => 'CompatibleElasticsearchVersionsList', ], ], ], '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', ], ], ], 'IdentityPoolId' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+:[0-9a-f-]+', ], 'InboundCrossClusterSearchConnection' => [ 'type' => 'structure', 'members' => [ 'SourceDomainInfo' => [ 'shape' => 'DomainInformation', ], 'DestinationDomainInfo' => [ 'shape' => 'DomainInformation', ], 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', ], 'ConnectionStatus' => [ 'shape' => 'InboundCrossClusterSearchConnectionStatus', ], ], ], 'InboundCrossClusterSearchConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'InboundCrossClusterSearchConnectionStatusCode', ], 'Message' => [ 'shape' => 'CrossClusterSearchConnectionStatusMessage', ], ], ], 'InboundCrossClusterSearchConnectionStatusCode' => [ 'type' => 'string', 'enum' => [ 'PENDING_ACCEPTANCE', 'APPROVED', 'REJECTING', 'REJECTED', 'DELETING', 'DELETED', ], ], 'InboundCrossClusterSearchConnections' => [ 'type' => 'list', 'member' => [ 'shape' => 'InboundCrossClusterSearchConnection', ], ], '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', ], 'Integer' => [ 'type' => 'integer', ], 'IntegerClass' => [ 'type' => 'integer', ], 'InternalException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'InvalidPaginationTokenException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidTypeException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'Issue' => [ 'type' => 'string', ], 'Issues' => [ 'type' => 'list', 'member' => [ 'shape' => 'Issue', ], ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], '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', ], ], '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', ], ], ], 'ListElasticsearchInstanceTypesRequest' => [ 'type' => 'structure', 'required' => [ 'ElasticsearchVersion', ], 'members' => [ 'ElasticsearchVersion' => [ 'shape' => 'ElasticsearchVersionString', 'location' => 'uri', 'locationName' => 'ElasticsearchVersion', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListElasticsearchInstanceTypesResponse' => [ 'type' => 'structure', 'members' => [ 'ElasticsearchInstanceTypes' => [ 'shape' => 'ElasticsearchInstanceTypeList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListElasticsearchVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListElasticsearchVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ElasticsearchVersions' => [ 'shape' => 'ElasticsearchVersionList', ], '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', ], ], ], 'ListTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'arn', ], ], ], 'ListTagsResponse' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], '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', ], ], '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', ], 'NextToken' => [ 'type' => 'string', ], 'NodeToNodeEncryptionOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'NonEmptyString' => [ 'type' => 'string', 'min' => 1, ], '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', ], ], ], 'OutboundCrossClusterSearchConnection' => [ 'type' => 'structure', 'members' => [ 'SourceDomainInfo' => [ 'shape' => 'DomainInformation', ], 'DestinationDomainInfo' => [ 'shape' => 'DomainInformation', ], 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionStatus' => [ 'shape' => 'OutboundCrossClusterSearchConnectionStatus', ], ], ], 'OutboundCrossClusterSearchConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'OutboundCrossClusterSearchConnectionStatusCode', ], 'Message' => [ 'shape' => 'CrossClusterSearchConnectionStatusMessage', ], ], ], 'OutboundCrossClusterSearchConnectionStatusCode' => [ 'type' => 'string', 'enum' => [ 'PENDING_ACCEPTANCE', 'VALIDATING', 'VALIDATION_FAILED', 'PROVISIONING', 'ACTIVE', 'REJECTED', 'DELETING', 'DELETED', ], ], 'OutboundCrossClusterSearchConnections' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutboundCrossClusterSearchConnection', ], ], 'OverallChangeStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'PROCESSING', 'COMPLETED', 'FAILED', ], ], 'OwnerId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, ], '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', ], ], ], 'PackageDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageDetails', ], ], 'PackageID' => [ 'type' => 'string', ], 'PackageName' => [ 'type' => 'string', 'max' => 28, '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', ], ], 'PackageVersion' => [ 'type' => 'string', ], 'PackageVersionHistory' => [ 'type' => 'structure', 'members' => [ 'PackageVersion' => [ 'shape' => 'PackageVersion', ], 'CommitMessage' => [ 'shape' => 'CommitMessage', ], 'CreatedAt' => [ 'shape' => 'CreatedAt', ], ], ], 'PackageVersionHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PackageVersionHistory', ], ], 'Password' => [ 'type' => 'string', 'min' => 8, 'sensitive' => true, ], 'PolicyDocument' => [ 'type' => 'string', ], 'PrincipalType' => [ 'type' => 'string', 'enum' => [ 'AWS_ACCOUNT', 'AWS_SERVICE', ], ], 'PurchaseReservedElasticsearchInstanceOfferingRequest' => [ 'type' => 'structure', 'required' => [ 'ReservedElasticsearchInstanceOfferingId', 'ReservationName', ], 'members' => [ 'ReservedElasticsearchInstanceOfferingId' => [ 'shape' => 'GUID', ], 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'InstanceCount' => [ 'shape' => 'InstanceCount', ], ], ], 'PurchaseReservedElasticsearchInstanceOfferingResponse' => [ 'type' => 'structure', 'members' => [ 'ReservedElasticsearchInstanceId' => [ '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', ], 'RejectInboundCrossClusterSearchConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'CrossClusterSearchConnectionId', ], 'members' => [ 'CrossClusterSearchConnectionId' => [ 'shape' => 'CrossClusterSearchConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'RejectInboundCrossClusterSearchConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'CrossClusterSearchConnection' => [ 'shape' => 'InboundCrossClusterSearchConnection', ], ], ], 'RemoveTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagKeys', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagKeys' => [ 'shape' => 'StringList', ], ], ], 'ReservationToken' => [ 'type' => 'string', 'max' => 64, 'min' => 5, ], 'ReservedElasticsearchInstance' => [ 'type' => 'structure', 'members' => [ 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'ReservedElasticsearchInstanceId' => [ 'shape' => 'GUID', ], 'ReservedElasticsearchInstanceOfferingId' => [ 'shape' => 'String', ], 'ElasticsearchInstanceType' => [ 'shape' => 'ESPartitionInstanceType', ], 'StartTime' => [ 'shape' => 'UpdateTimestamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'ElasticsearchInstanceCount' => [ 'shape' => 'Integer', ], 'State' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedElasticsearchInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedElasticsearchInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedElasticsearchInstance', ], ], 'ReservedElasticsearchInstanceOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedElasticsearchInstanceOfferingId' => [ 'shape' => 'GUID', ], 'ElasticsearchInstanceType' => [ 'shape' => 'ESPartitionInstanceType', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedElasticsearchInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedElasticsearchInstanceOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedElasticsearchInstanceOffering', ], ], 'ReservedElasticsearchInstancePaymentOption' => [ '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, ], 'RollbackOnDisable' => [ 'type' => 'string', 'enum' => [ 'NO_ROLLBACK', 'DEFAULT_ROLLBACK', ], ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, ], 'S3Key' => [ 'type' => 'string', ], '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', ], ], ], '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', ], ], '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', ], 'SnapshotOptions' => [ 'type' => 'structure', 'members' => [ 'AutomatedSnapshotStartHour' => [ 'shape' => 'IntegerClass', ], ], ], 'SnapshotOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'SnapshotOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'StartAt' => [ 'type' => 'timestamp', ], 'StartElasticsearchServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], ], ], 'StartElasticsearchServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'StartTimestamp' => [ 'type' => 'timestamp', ], 'StorageSubTypeName' => [ 'type' => 'string', ], 'StorageType' => [ 'type' => 'structure', 'members' => [ 'StorageTypeName' => [ 'shape' => 'StorageTypeName', ], 'StorageSubTypeName' => [ 'shape' => 'StorageSubTypeName', ], 'StorageTypeLimits' => [ 'shape' => 'StorageTypeLimitList', ], ], ], 'StorageTypeLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'StorageTypeLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageTypeLimit', ], ], 'StorageTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageType', ], ], 'StorageTypeName' => [ 'type' => 'string', ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'TLSSecurityPolicy' => [ 'type' => 'string', 'enum' => [ 'Policy-Min-TLS-1-0-2019-07', 'Policy-Min-TLS-1-2-2019-07', 'Policy-Min-TLS-1-2-PFS-2023-10', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TimeUnit' => [ 'type' => 'string', 'enum' => [ 'HOURS', ], ], 'TotalNumberOfStages' => [ 'type' => 'integer', ], 'UIntValue' => [ 'type' => 'integer', 'min' => 0, ], 'UpdateElasticsearchDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ElasticsearchClusterConfig' => [ 'shape' => 'ElasticsearchClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCOptions', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsInput', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptions', ], 'DryRun' => [ 'shape' => 'DryRun', ], ], ], 'UpdateElasticsearchDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'ElasticsearchDomainConfig', ], 'DryRunResults' => [ 'shape' => 'DryRunResults', ], ], ], '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', ], ], ], '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', ], ], ], 'UpgradeElasticsearchDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'TargetVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'ElasticsearchVersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], ], ], 'UpgradeElasticsearchDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'ElasticsearchVersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], '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', 'min' => 1, '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, ], 'ValueStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString', ], 'min' => 1, ], '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', ], ], 'ZoneAwarenessConfig' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneCount' => [ 'shape' => 'IntegerClass', ], ], ], ],]; diff --git a/src/data/es/2015-01-01/docs-2.json b/src/data/es/2015-01-01/docs-2.json index 81b421d7a6..e029b54f61 100644 --- a/src/data/es/2015-01-01/docs-2.json +++ b/src/data/es/2015-01-01/docs-2.json @@ -1978,7 +1978,7 @@ "TLSSecurityPolicy": { "base": null, "refs": { - "DomainEndpointOptions$TLSSecurityPolicy": "

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It can be one of the following values:

  • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
  • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2

" + "DomainEndpointOptions$TLSSecurityPolicy": "

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It 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

" } }, "Tag": { diff --git a/src/data/es/2015-01-01/docs-2.json.php b/src/data/es/2015-01-01/docs-2.json.php index cd29b138cd..de477f681b 100644 --- a/src/data/es/2015-01-01/docs-2.json.php +++ b/src/data/es/2015-01-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.

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 Regions and Endpoints.

', 'operations' => [ 'AcceptInboundCrossClusterSearchConnection' => '

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

', 'AddTags' => '

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

', 'AssociatePackage' => '

Associates a package with an Amazon ES domain.

', 'AuthorizeVpcEndpointAccess' => '

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'CancelElasticsearchServiceSoftwareUpdate' => '

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

', 'CreateElasticsearchDomain' => '

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

', 'CreateOutboundCrossClusterSearchConnection' => '

Creates a new cross-cluster search connection from a source domain to a destination domain.

', 'CreatePackage' => '

Create a package for use with Amazon ES domains.

', 'CreateVpcEndpoint' => '

Creates an Amazon OpenSearch Service-managed VPC endpoint.

', 'DeleteElasticsearchDomain' => '

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

', 'DeleteElasticsearchServiceRole' => '

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.

', 'DeleteInboundCrossClusterSearchConnection' => '

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

', 'DeleteOutboundCrossClusterSearchConnection' => '

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

', 'DeletePackage' => '

Delete the package.

', 'DeleteVpcEndpoint' => '

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'DescribeDomainAutoTunes' => '

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

', 'DescribeDomainChangeProgress' => '

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

', 'DescribeElasticsearchDomain' => '

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

', 'DescribeElasticsearchDomainConfig' => '

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

', 'DescribeElasticsearchDomains' => '

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

', 'DescribeElasticsearchInstanceTypeLimits' => '

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

', 'DescribeInboundCrossClusterSearchConnections' => '

Lists all the inbound cross-cluster search connections for a destination domain.

', 'DescribeOutboundCrossClusterSearchConnections' => '

Lists all the outbound cross-cluster search connections for a source domain.

', 'DescribePackages' => '

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

', 'DescribeReservedElasticsearchInstanceOfferings' => '

Lists available reserved Elasticsearch instance offerings.

', 'DescribeReservedElasticsearchInstances' => '

Returns information about reserved Elasticsearch instances for this account.

', 'DescribeVpcEndpoints' => '

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

', 'DissociatePackage' => '

Dissociates a package from the Amazon ES domain.

', 'GetCompatibleElasticsearchVersions' => '

Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.

', 'GetPackageVersionHistory' => '

Returns a list of versions of the package, along with their creation time and commit message.

', 'GetUpgradeHistory' => '

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

', 'GetUpgradeStatus' => '

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

', 'ListDomainNames' => '

Returns the name of all Elasticsearch domains owned by the current user\'s account.

', 'ListDomainsForPackage' => '

Lists all Amazon ES domains associated with the package.

', 'ListElasticsearchInstanceTypes' => '

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

', 'ListElasticsearchVersions' => '

List all supported Elasticsearch versions

', 'ListPackagesForDomain' => '

Lists all packages associated with the Amazon ES domain.

', 'ListTags' => '

Returns all tags for the given Elasticsearch domain.

', 'ListVpcEndpointAccess' => '

Retrieves information about each 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 account and Region.

', 'ListVpcEndpointsForDomain' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

', 'PurchaseReservedElasticsearchInstanceOffering' => '

Allows you to purchase reserved Elasticsearch instances.

', 'RejectInboundCrossClusterSearchConnection' => '

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

', 'RemoveTags' => '

Removes the specified set of tags from the specified Elasticsearch domain.

', 'RevokeVpcEndpointAccess' => '

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

', 'StartElasticsearchServiceSoftwareUpdate' => '

Schedules a service software update for an Amazon ES domain.

', 'UpdateElasticsearchDomainConfig' => '

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

', 'UpdatePackage' => '

Updates a package for use with Amazon ES domains.

', 'UpdateVpcEndpoint' => '

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'UpgradeElasticsearchDomain' => '

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

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

The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

', 'refs' => [ 'AddTagsRequest$ARN' => '

Specify the ARN for which you want to add the tags.

', 'DomainEndpointOptions$CustomEndpointCertificateArn' => '

Specify ACM certificate ARN for your custom endpoint.

', 'ElasticsearchDomainStatus$ARN' => '

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

', 'ListTagsRequest$ARN' => '

Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.

', 'MasterUserOptions$MasterUserARN' => '

ARN for the master user (if IAM is enabled).

', 'RemoveTagsRequest$ARN' => '

Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.

', ], ], 'AWSAccount' => [ 'base' => NULL, 'refs' => [ 'AuthorizeVpcEndpointAccessRequest$Account' => '

The account ID to grant access to.

', 'RevokeVpcEndpointAccessRequest$Account' => '

The account ID to revoke access from.

', 'VpcEndpoint$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'AcceptInboundCrossClusterSearchConnectionRequest' => [ 'base' => '

Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation.

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

The result of a AcceptInboundCrossClusterSearchConnection operation. Contains details of accepted inbound connection.

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

An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

The configured access rules for the domain\'s document and search endpoints, and the current status of those rules.

', 'refs' => [ 'ElasticsearchDomainConfig$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', ], ], 'AddTagsRequest' => [ 'base' => '

Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.

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

List of limits that are specific to a given InstanceType and for each of it\'s InstanceRole .

', 'refs' => [ 'AdditionalLimitList$member' => NULL, ], ], 'AdditionalLimitList' => [ 'base' => NULL, 'refs' => [ 'Limits$AdditionalLimits' => '

List of additional limits that are specific to a given InstanceType and for each of it\'s InstanceRole .

', ], ], 'AdvancedOptions' => [ 'base' => '

Exposes select native Elasticsearch configuration values from elasticsearch.yml. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
  • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

', 'refs' => [ 'AdvancedOptionsStatus$Options' => '

Specifies the status of advanced options for the specified Elasticsearch domain.

', 'CreateElasticsearchDomainRequest$AdvancedOptions' => '

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

', 'ElasticsearchDomainStatus$AdvancedOptions' => '

Specifies the status of the AdvancedOptions

', 'UpdateElasticsearchDomainConfigRequest$AdvancedOptions' => '

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

', ], ], 'AdvancedOptionsStatus' => [ 'base' => '

Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
  • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

', 'refs' => [ 'ElasticsearchDomainConfig$AdvancedOptions' => '

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

', ], ], 'AdvancedSecurityOptions' => [ 'base' => '

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.

', 'refs' => [ 'AdvancedSecurityOptionsStatus$Options' => '

Specifies advanced security options for the specified Elasticsearch domain.

', 'ElasticsearchDomainStatus$AdvancedSecurityOptions' => '

The current status of the Elasticsearch domain\'s advanced security options.

', ], ], 'AdvancedSecurityOptionsInput' => [ 'base' => '

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

', 'refs' => [ 'CreateElasticsearchDomainRequest$AdvancedSecurityOptions' => '

Specifies advanced security options.

', 'UpdateElasticsearchDomainConfigRequest$AdvancedSecurityOptions' => '

Specifies advanced security options.

', ], ], 'AdvancedSecurityOptionsStatus' => [ 'base' => '

Specifies the status of advanced security options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$AdvancedSecurityOptions' => '

Specifies AdvancedSecurityOptions for the domain.

', ], ], 'AssociatePackageRequest' => [ 'base' => '

Container for request parameters to AssociatePackage operation.

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

Container for response returned by AssociatePackage operation.

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

Container for request parameters to the AuthorizeVpcEndpointAccess operation. Specifies the account to be permitted to manage VPC endpoints against the domain.

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

Container for response parameters to the AuthorizeVpcEndpointAccess operation. Contains the account ID and the type of the account being authorized to access the VPC endpoint.

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

Information about an 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 account or service that was provided access to the domain.

', 'AuthorizedPrincipalList$member' => NULL, ], ], 'AuthorizedPrincipalList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointAccessResponse$AuthorizedPrincipalList' => '

List of AuthorizedPrincipal describing the details of the permissions to manage VPC endpoints against the specified domain.

', ], ], 'AutoTune' => [ 'base' => '

Specifies Auto-Tune type and Auto-Tune action details.

', 'refs' => [ 'AutoTuneList$member' => NULL, ], ], 'AutoTuneDate' => [ 'base' => '

Specifies timestamp for the Auto-Tune action scheduled for the domain.

', 'refs' => [ 'ScheduledAutoTuneDetails$Date' => '

Specifies timestamp for the Auto-Tune action scheduled for the domain.

', ], ], 'AutoTuneDesiredState' => [ 'base' => '

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

', 'refs' => [ 'AutoTuneOptions$DesiredState' => '

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

', 'AutoTuneOptionsInput$DesiredState' => '

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

', ], ], 'AutoTuneDetails' => [ 'base' => '

Specifies details of the Auto-Tune action. See the Developer Guide for more information.

', 'refs' => [ 'AutoTune$AutoTuneDetails' => '

Specifies details of the Auto-Tune action. See the Developer Guide for more information.

', ], ], 'AutoTuneList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainAutoTunesResponse$AutoTunes' => '

Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.

', ], ], 'AutoTuneMaintenanceSchedule' => [ 'base' => '

Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.

', 'refs' => [ 'AutoTuneMaintenanceScheduleList$member' => NULL, ], ], 'AutoTuneMaintenanceScheduleList' => [ 'base' => NULL, 'refs' => [ 'AutoTuneOptions$MaintenanceSchedules' => '

Specifies list of maitenance schedules. See the Developer Guide for more information.

', 'AutoTuneOptionsInput$MaintenanceSchedules' => '

Specifies list of maitenance schedules. See the Developer Guide for more information.

', ], ], 'AutoTuneOptions' => [ 'base' => '

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

', 'refs' => [ 'AutoTuneOptionsStatus$Options' => '

Specifies Auto-Tune options for the specified Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$AutoTuneOptions' => '

Specifies Auto-Tune options.

', ], ], 'AutoTuneOptionsInput' => [ 'base' => '

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

', 'refs' => [ 'CreateElasticsearchDomainRequest$AutoTuneOptions' => '

Specifies Auto-Tune options.

', ], ], 'AutoTuneOptionsOutput' => [ 'base' => '

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

', 'refs' => [ 'ElasticsearchDomainStatus$AutoTuneOptions' => '

The current status of the Elasticsearch domain\'s Auto-Tune options.

', ], ], 'AutoTuneOptionsStatus' => [ 'base' => '

Specifies the status of Auto-Tune options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$AutoTuneOptions' => '

Specifies AutoTuneOptions for the domain.

', ], ], 'AutoTuneState' => [ 'base' => '

Specifies the Auto-Tune state for the Elasticsearch domain. For valid states see the Developer Guide.

', 'refs' => [ 'AutoTuneOptionsOutput$State' => '

Specifies the AutoTuneState for the Elasticsearch domain.

', 'AutoTuneStatus$State' => '

Specifies the AutoTuneState for the Elasticsearch domain.

', ], ], 'AutoTuneStatus' => [ 'base' => '

Provides the current status of the Auto-Tune options.

', 'refs' => [ 'AutoTuneOptionsStatus$Status' => '

Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.

', ], ], 'AutoTuneType' => [ 'base' => '

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

', 'refs' => [ 'AutoTune$AutoTuneType' => '

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

', ], ], 'BackendRole' => [ 'base' => NULL, 'refs' => [ 'SAMLOptionsInput$MasterBackendRole' => '

The backend role to which 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 advanced security is enabled.

', 'AdvancedSecurityOptions$InternalUserDatabaseEnabled' => '

True if the internal user database is enabled.

', 'AdvancedSecurityOptions$AnonymousAuthEnabled' => '

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

', 'AdvancedSecurityOptionsInput$Enabled' => '

True if advanced security is enabled.

', 'AdvancedSecurityOptionsInput$InternalUserDatabaseEnabled' => '

True if the internal user database is enabled.

', 'AdvancedSecurityOptionsInput$AnonymousAuthEnabled' => '

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

', 'AutoTuneStatus$PendingDeletion' => '

Indicates whether the Elasticsearch domain is being deleted.

', 'CognitoOptions$Enabled' => '

Specifies the option to enable Cognito for Kibana authentication.

', 'ColdStorageOptions$Enabled' => '

Enable cold storage option. Accepted values true or false

', 'DomainEndpointOptions$EnforceHTTPS' => '

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

', 'DomainEndpointOptions$CustomEndpointEnabled' => '

Specify if custom endpoint should be enabled for the Elasticsearch domain.

', 'EBSOptions$EBSEnabled' => '

Specifies whether EBS-based storage is enabled.

', 'ElasticsearchClusterConfig$DedicatedMasterEnabled' => '

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

', 'ElasticsearchClusterConfig$ZoneAwarenessEnabled' => '

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

', 'ElasticsearchClusterConfig$WarmEnabled' => '

True to enable warm storage.

', 'ElasticsearchDomainStatus$Created' => '

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

', 'ElasticsearchDomainStatus$Deleted' => '

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

', 'ElasticsearchDomainStatus$Processing' => '

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

', 'ElasticsearchDomainStatus$UpgradeProcessing' => '

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

', 'EncryptionAtRestOptions$Enabled' => '

Specifies the option to enable Encryption At Rest.

', 'LogPublishingOption$Enabled' => '

Specifies whether given log publishing option is enabled or not.

', 'NodeToNodeEncryptionOptions$Enabled' => '

Specify true to enable node-to-node encryption.

', 'OptionStatus$PendingDeletion' => '

Indicates whether the Elasticsearch domain is being deleted.

', 'SAMLOptionsInput$Enabled' => '

True if SAML is enabled.

', 'SAMLOptionsOutput$Enabled' => '

True if SAML is enabled.

', 'ServiceSoftwareOptions$UpdateAvailable' => '

True if you are able to update you service software version. False if you are not able to update your service software version.

', 'ServiceSoftwareOptions$Cancellable' => '

True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

', 'ServiceSoftwareOptions$OptionalDeployment' => '

True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.

', 'UpgradeElasticsearchDomainRequest$PerformCheckOnly' => '

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

', 'UpgradeElasticsearchDomainResponse$PerformCheckOnly' => '

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

', ], ], 'CancelElasticsearchServiceSoftwareUpdateRequest' => [ 'base' => '

Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.

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

The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

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

Specifies change details of the domain configuration change.

', 'refs' => [ 'ElasticsearchDomainConfig$ChangeProgressDetails' => '

Specifies change details of the domain configuration change.

', 'ElasticsearchDomainStatus$ChangeProgressDetails' => '

Specifies change details of the domain configuration change.

', 'UpgradeElasticsearchDomainResponse$ChangeProgressDetails' => NULL, ], ], 'ChangeProgressStage' => [ 'base' => '

A progress stage details of a specific domain configuration change.

', '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 specific progress stage.

', ], ], 'ChangeProgressStageStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => '

The overall status of a specific progress stage.

', ], ], 'ChangeProgressStatusDetails' => [ 'base' => '

The progress details of a specific domain configuration change.

', 'refs' => [ 'DescribeDomainChangeProgressResponse$ChangeProgressStatus' => '

Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.

', ], ], '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 which log needs to be published.

', 'refs' => [ 'LogPublishingOption$CloudWatchLogsLogGroupArn' => NULL, ], ], 'CognitoOptions' => [ 'base' => '

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

', 'refs' => [ 'CognitoOptionsStatus$Options' => '

Specifies the Cognito options for the specified Elasticsearch domain.

', 'CreateElasticsearchDomainRequest$CognitoOptions' => '

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

', 'ElasticsearchDomainStatus$CognitoOptions' => '

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

', 'UpdateElasticsearchDomainConfigRequest$CognitoOptions' => '

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

', ], ], 'CognitoOptionsStatus' => [ 'base' => '

Status of the Cognito options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$CognitoOptions' => '

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

', ], ], 'ColdStorageOptions' => [ 'base' => '

Specifies the configuration for cold storage options such as enabled

', 'refs' => [ 'ElasticsearchClusterConfig$ColdStorageOptions' => '

Specifies the ColdStorageOptions config for Elasticsearch Domain

', ], ], 'CommitMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionHistory$CommitMessage' => '

A message associated with the version.

', 'UpdatePackageRequest$CommitMessage' => '

An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.

', ], ], 'CompatibleElasticsearchVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetCompatibleElasticsearchVersionsResponse$CompatibleElasticsearchVersions' => '

A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.

', ], ], 'CompatibleVersionsMap' => [ 'base' => '

A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.

', 'refs' => [ 'CompatibleElasticsearchVersionsList$member' => NULL, ], ], 'ConflictException' => [ 'base' => '

An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

', 'refs' => [], ], 'ConnectionAlias' => [ 'base' => NULL, 'refs' => [ 'CreateOutboundCrossClusterSearchConnectionRequest$ConnectionAlias' => '

Specifies the connection alias that will be used by the customer for this connection.

', 'CreateOutboundCrossClusterSearchConnectionResponse$ConnectionAlias' => '

Specifies the connection alias provided during the create connection request.

', 'OutboundCrossClusterSearchConnection$ConnectionAlias' => '

Specifies the connection alias for the outbound cross-cluster search connection.

', ], ], 'CreateElasticsearchDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateElasticsearchDomainResponse' => [ 'base' => '

The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.

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

Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation.

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

The result of a CreateOutboundCrossClusterSearchConnection request. Contains the details of the newly created cross-cluster search connection.

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

Container for request parameters to CreatePackage operation.

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

Container for response returned by CreatePackage operation.

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

Container for the parameters to the CreateVpcEndpointRequest operation.

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

Container for response parameters to the CreateVpcEndpoint operation. Contains the configuration and status of the VPC Endpoint being created.

', 'refs' => [], ], 'CreatedAt' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$CreatedAt' => '

Timestamp which tells creation date of the package.

', 'PackageVersionHistory$CreatedAt' => '

Timestamp which tells creation time of the package version.

', ], ], 'CrossClusterSearchConnectionId' => [ 'base' => NULL, 'refs' => [ 'AcceptInboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

The id of the inbound connection that you want to accept.

', 'CreateOutboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnectionId' => '

Unique id for the created outbound connection, which is used for subsequent operations on connection.

', 'DeleteInboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

The id of the inbound connection that you want to permanently delete.

', 'DeleteOutboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

The id of the outbound connection that you want to permanently delete.

', 'InboundCrossClusterSearchConnection$CrossClusterSearchConnectionId' => '

Specifies the connection id for the inbound cross-cluster search connection.

', 'OutboundCrossClusterSearchConnection$CrossClusterSearchConnectionId' => '

Specifies the connection id for the outbound cross-cluster search connection.

', 'RejectInboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

The id of the inbound connection that you want to reject.

', ], ], 'CrossClusterSearchConnectionStatusMessage' => [ 'base' => NULL, 'refs' => [ 'InboundCrossClusterSearchConnectionStatus$Message' => '

Specifies verbose information for the inbound connection status.

', 'OutboundCrossClusterSearchConnectionStatus$Message' => '

Specifies verbose information for the outbound connection status.

', ], ], 'DeleteElasticsearchDomainRequest' => [ 'base' => '

Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.

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

The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.

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

Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation.

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

The result of a DeleteInboundCrossClusterSearchConnection operation. Contains details of deleted inbound connection.

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

Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation.

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

The result of a DeleteOutboundCrossClusterSearchConnection operation. Contains details of deleted outbound connection.

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

Container for request parameters to DeletePackage operation.

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

Container for response parameters to DeletePackage operation.

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

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

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

Container for response parameters to the DeleteVpcEndpoint operation. Contains the summarized detail of the VPC Endpoint being deleted.

', 'refs' => [], ], 'DeploymentCloseDateTimeStamp' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$AutomatedUpdateDate' => '

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. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

', ], ], 'DeploymentType' => [ 'base' => NULL, 'refs' => [ 'DryRunResults$DeploymentType' => '

Specifies the deployment mechanism through which the update shall be applied on the domain. Possible responses are Blue/Green (The update will require a blue/green deployment.) DynamicUpdate (The update can be applied in-place without a Blue/Green deployment required.) Undetermined (The domain is undergoing an update which needs to complete before the deployment type can be predicted.) None (The configuration change matches the current configuration and will not result in any update.)

', ], ], 'DescribeDomainAutoTunesRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainAutoTunes operation.

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

The result of DescribeDomainAutoTunes request. See the Developer Guide for more information.

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

Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the domain name and optional change specific identity for which you want progress information.

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

The result of a DescribeDomainChangeProgress request. Contains the progress information of the requested domain change.

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

Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.

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

The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.

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

Container for the parameters to the DescribeElasticsearchDomain operation.

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

The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.

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

Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

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

The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.

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

Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

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

Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation.

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

Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.

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

The result of a DescribeInboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.

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

Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.

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

The result of a DescribeOutboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.

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

Filter to apply in DescribePackage response.

', 'refs' => [ 'DescribePackagesFilterList$member' => NULL, ], ], 'DescribePackagesFilterList' => [ 'base' => '

A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.

', 'refs' => [ 'DescribePackagesRequest$Filters' => '

Only returns packages that match the DescribePackagesFilterList values.

', ], ], 'DescribePackagesFilterName' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Name' => '

Any field from PackageDetails.

', ], ], 'DescribePackagesFilterValue' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilterValues$member' => NULL, ], ], 'DescribePackagesFilterValues' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Value' => '

A non-empty list of values for the specified field.

', ], ], 'DescribePackagesRequest' => [ 'base' => '

Container for request parameters to DescribePackage operation.

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

Container for response returned by DescribePackages operation.

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

Container for parameters to DescribeReservedElasticsearchInstanceOfferings

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

Container for results from DescribeReservedElasticsearchInstanceOfferings

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

Container for parameters to DescribeReservedElasticsearchInstances

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

Container for results from DescribeReservedElasticsearchInstances

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

Container for request parameters to the DescribeVpcEndpoints operation. Specifies the list of VPC endpoints to be described.

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

Container for response parameters to the DescribeVpcEndpoints operation. Returns a list containing configuration details and status of the VPC Endpoints as well as a list containing error responses of the endpoints that could not be described

', 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Description' => '

The description of the progress stage.

', ], ], 'DisableTimestamp' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$AnonymousAuthDisableDate' => '

Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

', ], ], 'DisabledOperationException' => [ 'base' => '

An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

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

Container for request parameters to DissociatePackage operation.

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

Container for response returned by DissociatePackage operation.

', 'refs' => [], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$DomainArn' => '

The Amazon Resource Name (ARN) of the domain to grant access to.

', '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.

', ], ], 'DomainEndpointOptions' => [ 'base' => '

Options to configure endpoint for the Elasticsearch domain.

', 'refs' => [ 'CreateElasticsearchDomainRequest$DomainEndpointOptions' => '

Options to specify configuration that will be applied to the domain endpoint.

', 'DomainEndpointOptionsStatus$Options' => '

Options to configure endpoint for the Elasticsearch domain.

', 'ElasticsearchDomainStatus$DomainEndpointOptions' => '

The current status of the Elasticsearch domain\'s endpoint options.

', 'UpdateElasticsearchDomainConfigRequest$DomainEndpointOptions' => '

Options to specify configuration that will be applied to the domain endpoint.

', ], ], 'DomainEndpointOptionsStatus' => [ 'base' => '

The configured endpoint options for the domain and their current status.

', 'refs' => [ 'ElasticsearchDomainConfig$DomainEndpointOptions' => '

Specifies the DomainEndpointOptions for the Elasticsearch domain.

', ], ], 'DomainId' => [ 'base' => '

Unique identifier for an Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainStatus$DomainId' => '

The unique identifier for the specified Elasticsearch domain.

', ], ], 'DomainInfo' => [ 'base' => NULL, 'refs' => [ 'DomainInfoList$member' => NULL, ], ], 'DomainInfoList' => [ 'base' => '

Contains the list of Elasticsearch domain information.

', 'refs' => [ 'ListDomainNamesResponse$DomainNames' => '

List of domain names and respective engine types.

', ], ], 'DomainInformation' => [ 'base' => NULL, 'refs' => [ 'CreateOutboundCrossClusterSearchConnectionRequest$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'CreateOutboundCrossClusterSearchConnectionRequest$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', 'CreateOutboundCrossClusterSearchConnectionResponse$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'CreateOutboundCrossClusterSearchConnectionResponse$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', 'InboundCrossClusterSearchConnection$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'InboundCrossClusterSearchConnection$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', 'OutboundCrossClusterSearchConnection$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'OutboundCrossClusterSearchConnection$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', ], ], 'DomainName' => [ 'base' => '

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

', 'refs' => [ 'AssociatePackageRequest$DomainName' => '

Name of the domain that you want to associate the package with.

', 'AuthorizeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to provide access to.

', 'CancelElasticsearchServiceSoftwareUpdateRequest$DomainName' => '

The name of the domain that you want to stop the latest service software update on.

', 'CreateElasticsearchDomainRequest$DomainName' => '

The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

', 'DeleteElasticsearchDomainRequest$DomainName' => '

The name of the Elasticsearch domain that you want to permanently delete.

', 'DescribeDomainAutoTunesRequest$DomainName' => '

Specifies the domain name for which you want Auto-Tune action details.

', 'DescribeDomainChangeProgressRequest$DomainName' => '

The domain you want to get the progress information about.

', 'DescribeElasticsearchDomainConfigRequest$DomainName' => '

The Elasticsearch domain that you want to get information about.

', 'DescribeElasticsearchDomainRequest$DomainName' => '

The name of the Elasticsearch domain for which you want information.

', 'DescribeElasticsearchInstanceTypeLimitsRequest$DomainName' => '

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.

', 'DissociatePackageRequest$DomainName' => '

Name of the domain that you want to associate the package with.

', 'DomainInfo$DomainName' => '

Specifies the DomainName.

', 'DomainInformation$DomainName' => NULL, 'DomainNameList$member' => NULL, 'DomainPackageDetails$DomainName' => '

Name of the domain you\'ve associated a package with.

', 'ElasticsearchDomainStatus$DomainName' => '

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

', 'GetCompatibleElasticsearchVersionsRequest$DomainName' => NULL, 'GetUpgradeHistoryRequest$DomainName' => NULL, 'GetUpgradeStatusRequest$DomainName' => NULL, 'ListElasticsearchInstanceTypesRequest$DomainName' => '

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

', 'ListPackagesForDomainRequest$DomainName' => '

The name of the domain for which you want to list associated packages.

', 'ListVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to retrieve access information for.

', 'ListVpcEndpointsForDomainRequest$DomainName' => '

Name of the ElasticSearch domain whose VPC endpoints are to be listed.

', 'RevokeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain.

', 'StartElasticsearchServiceSoftwareUpdateRequest$DomainName' => '

The name of the domain that you want to update to the latest service software.

', 'UpdateElasticsearchDomainConfigRequest$DomainName' => '

The name of the Elasticsearch domain that you are updating.

', 'UpgradeElasticsearchDomainRequest$DomainName' => NULL, 'UpgradeElasticsearchDomainResponse$DomainName' => NULL, ], ], 'DomainNameFqdn' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$CustomEndpoint' => '

Specify the fully qualified domain for your custom endpoint.

', ], ], 'DomainNameList' => [ 'base' => '

A list of Elasticsearch domain names.

', 'refs' => [ 'DescribeElasticsearchDomainsRequest$DomainNames' => '

The Elasticsearch domains for which you want information.

', ], ], 'DomainPackageDetails' => [ 'base' => '

Information on a package that is associated with a domain.

', 'refs' => [ 'AssociatePackageResponse$DomainPackageDetails' => '

DomainPackageDetails

', 'DissociatePackageResponse$DomainPackageDetails' => '

DomainPackageDetails

', 'DomainPackageDetailsList$member' => NULL, ], ], 'DomainPackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsForPackageResponse$DomainPackageDetailsList' => '

List of DomainPackageDetails objects.

', 'ListPackagesForDomainResponse$DomainPackageDetailsList' => '

List of DomainPackageDetails objects.

', ], ], 'DomainPackageStatus' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$DomainPackageStatus' => '

State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$RecurringChargeAmount' => '

The monetary amount of the recurring charge.

', 'ReservedElasticsearchInstance$FixedPrice' => '

The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.

', 'ReservedElasticsearchInstance$UsagePrice' => '

The rate you are charged for each hour for the domain that is using this reserved instance.

', 'ReservedElasticsearchInstanceOffering$FixedPrice' => '

The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.

', 'ReservedElasticsearchInstanceOffering$UsagePrice' => '

The rate you are charged for each hour the domain that is using the offering is running.

', 'UpgradeStepItem$ProgressPercent' => '

The Floating point value representing progress percentage of a particular step.

', ], ], 'DryRun' => [ 'base' => NULL, 'refs' => [ 'UpdateElasticsearchDomainConfigRequest$DryRun' => '

This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

', ], ], 'DryRunResults' => [ 'base' => NULL, 'refs' => [ 'UpdateElasticsearchDomainConfigResponse$DryRunResults' => '

Contains result of DryRun.

', ], ], 'Duration' => [ 'base' => '

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

', 'refs' => [ 'AutoTuneMaintenanceSchedule$Duration' => '

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

', ], ], 'DurationValue' => [ 'base' => '

Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

', 'refs' => [ 'Duration$Value' => '

Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

', ], ], 'EBSOptions' => [ 'base' => '

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.

', 'refs' => [ 'CreateElasticsearchDomainRequest$EBSOptions' => '

Options to enable, disable and specify the type and size of EBS storage volumes.

', 'EBSOptionsStatus$Options' => '

Specifies the EBS options for the specified Elasticsearch domain.

', 'ElasticsearchDomainStatus$EBSOptions' => '

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

', 'UpdateElasticsearchDomainConfigRequest$EBSOptions' => '

Specify the type and size of the EBS volume that you want to use.

', ], ], 'EBSOptionsStatus' => [ 'base' => '

Status of the EBS options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$EBSOptions' => '

Specifies the EBSOptions for the Elasticsearch domain.

', ], ], 'ESPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'DescribeElasticsearchInstanceTypeLimitsRequest$InstanceType' => '

The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.

', 'ElasticsearchClusterConfig$InstanceType' => '

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

', 'ElasticsearchClusterConfig$DedicatedMasterType' => '

The instance type for a dedicated master node.

', 'ElasticsearchInstanceTypeList$member' => NULL, 'ReservedElasticsearchInstance$ElasticsearchInstanceType' => '

The Elasticsearch instance type offered by the reserved instance offering.

', 'ReservedElasticsearchInstanceOffering$ElasticsearchInstanceType' => '

The Elasticsearch instance type offered by the reserved instance offering.

', ], ], 'ESWarmPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ElasticsearchClusterConfig$WarmType' => '

The instance type for the Elasticsearch cluster\'s warm nodes.

', ], ], 'ElasticsearchClusterConfig' => [ 'base' => '

Specifies the configuration for the domain cluster, such as the type and number of instances.

', 'refs' => [ 'CreateElasticsearchDomainRequest$ElasticsearchClusterConfig' => '

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

', 'ElasticsearchClusterConfigStatus$Options' => '

Specifies the cluster configuration for the specified Elasticsearch domain.

', 'ElasticsearchDomainStatus$ElasticsearchClusterConfig' => '

The type and number of instances in the domain cluster.

', 'UpdateElasticsearchDomainConfigRequest$ElasticsearchClusterConfig' => '

The type and number of instances to instantiate for the domain cluster.

', ], ], 'ElasticsearchClusterConfigStatus' => [ 'base' => '

Specifies the configuration status for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$ElasticsearchClusterConfig' => '

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

', ], ], 'ElasticsearchDomainConfig' => [ 'base' => '

The configuration of an Elasticsearch domain.

', 'refs' => [ 'DescribeElasticsearchDomainConfigResponse$DomainConfig' => '

The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.

', 'UpdateElasticsearchDomainConfigResponse$DomainConfig' => '

The status of the updated Elasticsearch domain.

', ], ], 'ElasticsearchDomainStatus' => [ 'base' => '

The current status of an Elasticsearch domain.

', 'refs' => [ 'CreateElasticsearchDomainResponse$DomainStatus' => '

The status of the newly created Elasticsearch domain.

', 'DeleteElasticsearchDomainResponse$DomainStatus' => '

The status of the Elasticsearch domain being deleted.

', 'DescribeElasticsearchDomainResponse$DomainStatus' => '

The current status of the Elasticsearch domain.

', 'ElasticsearchDomainStatusList$member' => NULL, ], ], 'ElasticsearchDomainStatusList' => [ 'base' => '

A list that contains the status of each requested Elasticsearch domain.

', 'refs' => [ 'DescribeElasticsearchDomainsResponse$DomainStatusList' => '

The status of the domains requested in the DescribeElasticsearchDomains request.

', ], ], 'ElasticsearchInstanceTypeList' => [ 'base' => '

List of instance types supported by Amazon Elasticsearch service.

', 'refs' => [ 'ListElasticsearchInstanceTypesResponse$ElasticsearchInstanceTypes' => '

List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

', ], ], 'ElasticsearchVersionList' => [ 'base' => '

List of supported elastic search versions.

', 'refs' => [ 'CompatibleVersionsMap$TargetVersions' => NULL, 'ListElasticsearchVersionsResponse$ElasticsearchVersions' => NULL, ], ], 'ElasticsearchVersionStatus' => [ 'base' => '

Status of the Elasticsearch version options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$ElasticsearchVersion' => '

String of format X.Y to specify version for the Elasticsearch domain.

', ], ], 'ElasticsearchVersionString' => [ 'base' => NULL, 'refs' => [ 'CompatibleVersionsMap$SourceVersion' => '

The current version of Elasticsearch on which a domain is.

', 'CreateElasticsearchDomainRequest$ElasticsearchVersion' => '

String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

', 'DescribeElasticsearchInstanceTypeLimitsRequest$ElasticsearchVersion' => '

Version of Elasticsearch for which Limits are needed.

', 'ElasticsearchDomainStatus$ElasticsearchVersion' => NULL, 'ElasticsearchVersionList$member' => NULL, 'ElasticsearchVersionStatus$Options' => '

Specifies the Elasticsearch version for the specified Elasticsearch domain.

', 'ListElasticsearchInstanceTypesRequest$ElasticsearchVersion' => '

Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

', 'UpgradeElasticsearchDomainRequest$TargetVersion' => '

The version of Elasticsearch that you intend to upgrade the domain to.

', 'UpgradeElasticsearchDomainResponse$TargetVersion' => '

The version of Elasticsearch that you intend to upgrade the domain to.

', ], ], 'EncryptionAtRestOptions' => [ 'base' => '

Specifies the Encryption At Rest Options.

', 'refs' => [ 'CreateElasticsearchDomainRequest$EncryptionAtRestOptions' => '

Specifies the Encryption At Rest Options.

', 'ElasticsearchDomainStatus$EncryptionAtRestOptions' => '

Specifies the status of the EncryptionAtRestOptions.

', 'EncryptionAtRestOptionsStatus$Options' => '

Specifies the Encryption At Rest options for the specified Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$EncryptionAtRestOptions' => '

Specifies the Encryption At Rest Options.

', ], ], 'EncryptionAtRestOptionsStatus' => [ 'base' => '

Status of the Encryption At Rest options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$EncryptionAtRestOptions' => '

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

', ], ], 'Endpoint' => [ 'base' => NULL, 'refs' => [ 'VpcEndpoint$Endpoint' => '

The connection endpoint ID for connecting to the domain.

', ], ], 'EndpointsMap' => [ 'base' => NULL, 'refs' => [ 'ElasticsearchDomainStatus$Endpoints' => '

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: \'vpc\',\'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com\'.

', ], ], 'EngineType' => [ 'base' => NULL, 'refs' => [ 'DomainInfo$EngineType' => '

Specifies the EngineType of the domain.

', 'ListDomainNamesRequest$EngineType' => '

Optional parameter to filter the output by domain engine type. Acceptable values are \'Elasticsearch\' and \'OpenSearch\'.

', ], ], 'ErrorDetails' => [ 'base' => NULL, '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' => NULL, ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorType' => NULL, ], ], 'Filter' => [ 'base' => '

A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search 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' => [ 'DescribeInboundCrossClusterSearchConnectionsRequest$Filters' => '

A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are:

  • cross-cluster-search-connection-id
  • source-domain-info.domain-name
  • source-domain-info.owner-id
  • source-domain-info.region
  • destination-domain-info.domain-name

', 'DescribeOutboundCrossClusterSearchConnectionsRequest$Filters' => '

A list of filters used to match properties for outbound cross-cluster search connection. Available Filter names for this operation are:

  • cross-cluster-search-connection-id
  • destination-domain-info.domain-name
  • destination-domain-info.owner-id
  • destination-domain-info.region
  • source-domain-info.domain-name

', ], ], 'GUID' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$ChangeId' => '

The unique change identifier associated with a specific domain 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. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

', 'DescribeReservedElasticsearchInstanceOfferingsRequest$ReservedElasticsearchInstanceOfferingId' => '

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

', 'DescribeReservedElasticsearchInstancesRequest$ReservedElasticsearchInstanceId' => '

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

', 'PurchaseReservedElasticsearchInstanceOfferingRequest$ReservedElasticsearchInstanceOfferingId' => '

The ID of the reserved Elasticsearch instance offering to purchase.

', 'PurchaseReservedElasticsearchInstanceOfferingResponse$ReservedElasticsearchInstanceId' => '

Details of the reserved Elasticsearch instance which was purchased.

', 'ReservedElasticsearchInstance$ReservedElasticsearchInstanceId' => '

The unique identifier for the reservation.

', 'ReservedElasticsearchInstanceOffering$ReservedElasticsearchInstanceOfferingId' => '

The Elasticsearch reserved instance offering identifier.

', ], ], 'GetCompatibleElasticsearchVersionsRequest' => [ 'base' => '

Container for request parameters to GetCompatibleElasticsearchVersions operation.

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

Container for response returned by GetCompatibleElasticsearchVersions operation.

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

Container for request parameters to GetPackageVersionHistory operation.

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

Container for response returned by GetPackageVersionHistory operation.

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

Container for request parameters to GetUpgradeHistory operation.

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

Container for response returned by GetUpgradeHistory operation.

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

Container for request parameters to GetUpgradeStatus operation.

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

Container for response returned by GetUpgradeStatus operation.

', 'refs' => [], ], 'IdentityPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$IdentityPoolId' => '

Specifies the Cognito identity pool ID for Kibana authentication.

', ], ], 'InboundCrossClusterSearchConnection' => [ 'base' => '

Specifies details of an inbound connection.

', 'refs' => [ 'AcceptInboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.

', 'DeleteInboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.

', 'InboundCrossClusterSearchConnections$member' => NULL, 'RejectInboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the InboundCrossClusterSearchConnection of rejected inbound connection.

', ], ], 'InboundCrossClusterSearchConnectionStatus' => [ 'base' => '

Specifies the coonection status of an inbound cross-cluster search connection.

', 'refs' => [ 'InboundCrossClusterSearchConnection$ConnectionStatus' => '

Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.

', ], ], 'InboundCrossClusterSearchConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'InboundCrossClusterSearchConnectionStatus$StatusCode' => '

The state code for inbound connection. This can be one of the following:

  • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
  • APPROVED: Inbound connection is pending acceptance by destination domain owner.
  • 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 cannot be used further.
', ], ], 'InboundCrossClusterSearchConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundCrossClusterSearchConnectionsResponse$CrossClusterSearchConnections' => '

Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.

', ], ], 'InstanceCount' => [ 'base' => '

Specifies the number of EC2 instances in the Elasticsearch domain.

', 'refs' => [ 'PurchaseReservedElasticsearchInstanceOfferingRequest$InstanceCount' => '

The number of Elasticsearch instances to reserve.

', ], ], 'InstanceCountLimits' => [ 'base' => '

InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.

', 'refs' => [ 'InstanceLimits$InstanceCountLimits' => NULL, ], ], 'InstanceLimits' => [ 'base' => '

InstanceLimits represents the list of instance related attributes that are available for given InstanceType.

', 'refs' => [ 'Limits$InstanceLimits' => NULL, ], ], 'InstanceRole' => [ 'base' => NULL, 'refs' => [ 'LimitsByRole$key' => NULL, ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ReservedElasticsearchInstance$Duration' => '

The duration, in seconds, for which the Elasticsearch instance is reserved.

', 'ReservedElasticsearchInstance$ElasticsearchInstanceCount' => '

The number of Elasticsearch instances that have been reserved.

', 'ReservedElasticsearchInstanceOffering$Duration' => '

The duration, in seconds, for which the offering will reserve the Elasticsearch instance.

', ], ], 'IntegerClass' => [ 'base' => NULL, 'refs' => [ 'EBSOptions$VolumeSize' => '

Integer to specify the size of an EBS volume.

', 'EBSOptions$Iops' => '

Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

', 'EBSOptions$Throughput' => '

Specifies the Throughput for GP3 EBS volume (SSD).

', 'ElasticsearchClusterConfig$InstanceCount' => '

The number of instances in the specified domain cluster.

', 'ElasticsearchClusterConfig$DedicatedMasterCount' => '

Total number of dedicated master nodes, active and on standby, for the cluster.

', 'ElasticsearchClusterConfig$WarmCount' => '

The number of warm nodes in the cluster.

', 'SAMLOptionsInput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

', 'SAMLOptionsOutput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive.

', 'SnapshotOptions$AutomatedSnapshotStartHour' => '

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

', 'ZoneAwarenessConfig$AvailabilityZoneCount' => '

An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled

', ], ], 'InternalException' => [ 'base' => '

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

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

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

', 'refs' => [], ], 'Issue' => [ 'base' => NULL, 'refs' => [ 'Issues$member' => NULL, ], ], 'Issues' => [ 'base' => NULL, 'refs' => [ 'UpgradeStepItem$Issues' => '

A list of strings containing detailed information about the errors encountered in a particular step.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyId' => '

Specifies the KMS Key ID for Encryption At Rest options.

', ], ], 'LastUpdated' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$LastUpdated' => '

The last updated timestamp of the progress stage.

', 'DomainPackageDetails$LastUpdated' => '

Timestamp of the most-recent update to the association status.

', 'PackageDetails$LastUpdatedAt' => NULL, ], ], 'LimitExceededException' => [ 'base' => '

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

', 'refs' => [], ], 'LimitName' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitName' => '

Name of Additional Limit is specific to a given InstanceType and for each of it\'s InstanceRole etc.
Attributes and their details:

  • MaximumNumberOfDataNodesSupported
    • This attribute will be present in Master node only to specify how much data nodes upto which given ESPartitionInstanceType can support as master node.
  • MaximumNumberOfDataNodesWithoutMasterNode
    • This attribute will be present in Data node only to specify how much data nodes of given ESPartitionInstanceType upto which you don\'t need any master nodes to govern them.

', 'StorageTypeLimit$LimitName' => '

Name of storage limits that are applicable for given storage type. If StorageType is ebs, following storage options are applicable

  1. MinimumVolumeSize
    2. Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
  2. MaximumVolumeSize
    3. Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
  3. MaximumIops
    4. Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
  4. MinimumIops
    5. Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
  5. MaximumThroughput
    6. Maximum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.
  6. MinimumThroughput
    7. Minimum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.

', ], ], 'LimitValue' => [ 'base' => NULL, 'refs' => [ 'LimitValueList$member' => NULL, ], ], 'LimitValueList' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitValues' => '

Value for given AdditionalLimit$LimitName .

', 'StorageTypeLimit$LimitValues' => '

Values for the StorageTypeLimit$LimitName .

', ], ], 'Limits' => [ 'base' => '

Limits for given InstanceType and for each of it\'s role.
Limits contains following StorageTypes, InstanceLimits and AdditionalLimits

', 'refs' => [ 'LimitsByRole$value' => NULL, ], ], 'LimitsByRole' => [ 'base' => '

Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:

  • data: If the given InstanceType is used as data node
  • master: If the given InstanceType is used as master node
  • ultra_warm: If the given InstanceType is used as warm node

', 'refs' => [ 'DescribeElasticsearchInstanceTypeLimitsResponse$LimitsByRole' => NULL, ], ], 'ListDomainNamesRequest' => [ 'base' => '

Container for the parameters to the ListDomainNames operation.

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

The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

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

Container for request parameters to ListDomainsForPackage operation.

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

Container for response parameters to ListDomainsForPackage operation.

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

Container for the parameters to the ListElasticsearchInstanceTypes operation.

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

Container for the parameters returned by ListElasticsearchInstanceTypes operation.

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

Container for the parameters to the ListElasticsearchVersions operation.

Use MaxResults to control the maximum number of results to retrieve in a single call.

Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.

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

Container for the parameters for response received from ListElasticsearchVersions operation.

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

Container for request parameters to ListPackagesForDomain operation.

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

Container for response parameters to ListPackagesForDomain operation.

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

Container for the parameters to the ListTags operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached.

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

The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.

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

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint

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

Container for response parameters to the ListVpcEndpointAccess operation. Returns a list of accounts id and account type authorized to manage VPC endpoints.

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

Container for request parameters to the ListVpcEndpointsForDomain operation. Specifies the domain whose VPC endpoints will be listed.

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

Container for response parameters to the ListVpcEndpointsForDomain operation. Returns a list containing summarized details of the VPC endpoints.

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

Container for request parameters to the ListVpcEndpoints operation.

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

Container for response parameters to the ListVpcEndpoints operation. Returns a list containing summarized details of the VPC endpoints.

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

Log Publishing option that is set for given domain.
Attributes and their details:

  • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
  • Enabled: Whether the log publishing for given log type is enabled or not

', 'refs' => [ 'LogPublishingOptions$value' => NULL, ], ], 'LogPublishingOptions' => [ 'base' => NULL, 'refs' => [ 'CreateElasticsearchDomainRequest$LogPublishingOptions' => '

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

', 'ElasticsearchDomainStatus$LogPublishingOptions' => '

Log publishing options for the given domain.

', 'LogPublishingOptionsStatus$Options' => '

The log publishing options configured for the Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$LogPublishingOptions' => '

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

', ], ], 'LogPublishingOptionsStatus' => [ 'base' => '

The configured log publishing options for the domain and their current status.

', 'refs' => [ 'ElasticsearchDomainConfig$LogPublishingOptions' => '

Log publishing options for the given domain.

', ], ], 'LogType' => [ 'base' => '

Type of Log File, it can be one of the following:

  • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
  • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
  • ES_APPLICATION_LOGS: Elasticsearch 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 from the domain.

', 'refs' => [ 'LogPublishingOptions$key' => NULL, ], ], 'MasterUserOptions' => [ 'base' => '

Credentials for the master user: username and password, ARN, or both.

', 'refs' => [ 'AdvancedSecurityOptionsInput$MasterUserOptions' => '

Credentials for the master user: username and password, ARN, or both.

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

Set this value to limit the number of results returned.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$MaxResults' => '

Set this value to limit the number of results returned. If not specified, defaults to 100.

', 'DescribeInboundCrossClusterSearchConnectionsRequest$MaxResults' => '

Set this value to limit the number of results returned. If not specified, defaults to 100.

', 'DescribeOutboundCrossClusterSearchConnectionsRequest$MaxResults' => '

Set this value to limit the number of results returned. If not specified, defaults to 100.

', 'DescribePackagesRequest$MaxResults' => '

Limits results to a maximum number of packages.

', 'DescribeReservedElasticsearchInstanceOfferingsRequest$MaxResults' => '

Set this value to limit the number of results returned. If not specified, defaults to 100.

', 'DescribeReservedElasticsearchInstancesRequest$MaxResults' => '

Set this value to limit the number of results returned. If not specified, defaults to 100.

', 'GetPackageVersionHistoryRequest$MaxResults' => '

Limits results to a maximum number of versions.

', 'GetUpgradeHistoryRequest$MaxResults' => NULL, 'ListDomainsForPackageRequest$MaxResults' => '

Limits results to a maximum number of domains.

', 'ListElasticsearchInstanceTypesRequest$MaxResults' => '

Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

', 'ListElasticsearchVersionsRequest$MaxResults' => '

Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored.

', 'ListPackagesForDomainRequest$MaxResults' => '

Limits results to a maximum number of packages.

', ], ], 'MaximumInstanceCount' => [ 'base' => '

Maximum number of Instances that can be instantiated for given InstanceType.

', 'refs' => [ 'InstanceCountLimits$MaximumInstanceCount' => NULL, ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$Message' => '

Contains an optional message associated with the domain configuration change.

', 'DryRunResults$Message' => '

Contains an optional message associated with the DryRunResults.

', ], ], 'MinimumInstanceCount' => [ 'base' => '

Minimum number of Instances that can be instantiated for given InstanceType.

', 'refs' => [ 'InstanceCountLimits$MinimumInstanceCount' => NULL, ], ], 'NextToken' => [ 'base' => '

Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$NextToken' => '

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

', 'DescribeDomainAutoTunesResponse$NextToken' => '

Specifies an identifier to allow retrieval of paginated results.

', 'DescribeInboundCrossClusterSearchConnectionsRequest$NextToken' => '

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

', 'DescribeInboundCrossClusterSearchConnectionsResponse$NextToken' => '

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

', 'DescribeOutboundCrossClusterSearchConnectionsRequest$NextToken' => '

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

', 'DescribeOutboundCrossClusterSearchConnectionsResponse$NextToken' => '

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

', 'DescribePackagesRequest$NextToken' => '

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

', 'DescribeReservedElasticsearchInstanceOfferingsRequest$NextToken' => '

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

', 'DescribeReservedElasticsearchInstanceOfferingsResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'DescribeReservedElasticsearchInstancesRequest$NextToken' => '

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

', 'GetPackageVersionHistoryRequest$NextToken' => '

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

', 'GetUpgradeHistoryRequest$NextToken' => NULL, 'ListDomainsForPackageRequest$NextToken' => '

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

', 'ListElasticsearchInstanceTypesRequest$NextToken' => '

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

', 'ListElasticsearchInstanceTypesResponse$NextToken' => '

In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.

', 'ListElasticsearchVersionsRequest$NextToken' => NULL, 'ListElasticsearchVersionsResponse$NextToken' => NULL, 'ListPackagesForDomainRequest$NextToken' => '

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

', 'ListVpcEndpointAccessRequest$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'ListVpcEndpointAccessResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'ListVpcEndpointsForDomainRequest$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'ListVpcEndpointsForDomainResponse$NextToken' => '

Information about each endpoint associated with the domain.

', 'ListVpcEndpointsRequest$NextToken' => '

Identifier to allow retrieval of paginated results.

', 'ListVpcEndpointsResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', ], ], 'NodeToNodeEncryptionOptions' => [ 'base' => '

Specifies the node-to-node encryption options.

', 'refs' => [ 'CreateElasticsearchDomainRequest$NodeToNodeEncryptionOptions' => '

Specifies the NodeToNodeEncryptionOptions.

', 'ElasticsearchDomainStatus$NodeToNodeEncryptionOptions' => '

Specifies the status of the NodeToNodeEncryptionOptions.

', 'NodeToNodeEncryptionOptionsStatus$Options' => '

Specifies the node-to-node encryption options for the specified Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$NodeToNodeEncryptionOptions' => '

Specifies the NodeToNodeEncryptionOptions.

', ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'base' => '

Status of the node-to-node encryption options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$NodeToNodeEncryptionOptions' => '

Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

Specifies the name of the filter.

', 'ValueStringList$member' => NULL, ], ], 'OptionState' => [ 'base' => '

The state of a requested change. One of the following:

  • Processing: The request change is still in-process.
  • Active: The request change is processed and deployed to the Elasticsearch domain.
', 'refs' => [ 'OptionStatus$State' => '

Provides the OptionState for the Elasticsearch domain.

', ], ], 'OptionStatus' => [ 'base' => '

Provides the current status of the entity.

', 'refs' => [ 'AccessPoliciesStatus$Status' => '

The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that\'s included.

', 'AdvancedOptionsStatus$Status' => '

Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

', 'AdvancedSecurityOptionsStatus$Status' => '

Status of the advanced security options for the specified Elasticsearch domain.

', 'CognitoOptionsStatus$Status' => '

Specifies the status of the Cognito options for the specified Elasticsearch domain.

', 'DomainEndpointOptionsStatus$Status' => '

The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that\'s included.

', 'EBSOptionsStatus$Status' => '

Specifies the status of the EBS options for the specified Elasticsearch domain.

', 'ElasticsearchClusterConfigStatus$Status' => '

Specifies the status of the configuration for the specified Elasticsearch domain.

', 'ElasticsearchVersionStatus$Status' => '

Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

', 'EncryptionAtRestOptionsStatus$Status' => '

Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

', 'LogPublishingOptionsStatus$Status' => '

The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that\'s included.

', 'NodeToNodeEncryptionOptionsStatus$Status' => '

Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.

', 'SnapshotOptionsStatus$Status' => '

Specifies the status of a daily automated snapshot.

', 'VPCDerivedInfoStatus$Status' => '

Specifies the status of the VPC options for the specified Elasticsearch domain.

', ], ], 'OutboundCrossClusterSearchConnection' => [ 'base' => '

Specifies details of an outbound connection.

', 'refs' => [ 'DeleteOutboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.

', 'OutboundCrossClusterSearchConnections$member' => NULL, ], ], 'OutboundCrossClusterSearchConnectionStatus' => [ 'base' => '

Specifies the connection status of an outbound cross-cluster search connection.

', 'refs' => [ 'CreateOutboundCrossClusterSearchConnectionResponse$ConnectionStatus' => '

Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.

', 'OutboundCrossClusterSearchConnection$ConnectionStatus' => '

Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.

', ], ], 'OutboundCrossClusterSearchConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'OutboundCrossClusterSearchConnectionStatus$StatusCode' => '

The state code for outbound connection. This 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 destination domain owner.
  • PROVISIONING: Outbound connection request is in process.
  • ACTIVE: Outbound connection is active and ready to use.
  • REJECTED: Outbound connection request is rejected by destination domain owner.
  • DELETING: Outbound connection deletion is in progress.
  • DELETED: Outbound connection is deleted and cannot be used further.
', ], ], 'OutboundCrossClusterSearchConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeOutboundCrossClusterSearchConnectionsResponse$CrossClusterSearchConnections' => '

Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.

', ], ], 'OverallChangeStatus' => [ 'base' => '

The overall status value of the domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$Status' => '

The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED

', ], ], 'OwnerId' => [ 'base' => NULL, 'refs' => [ 'DomainInformation$OwnerId' => NULL, ], ], 'PackageDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageDescription' => '

Description of the package.

', 'PackageDetails$PackageDescription' => '

User-specified description of the package.

', 'UpdatePackageRequest$PackageDescription' => '

New description of the package.

', ], ], 'PackageDetails' => [ 'base' => '

Basic information about a package.

', 'refs' => [ 'CreatePackageResponse$PackageDetails' => '

Information about the package PackageDetails.

', 'DeletePackageResponse$PackageDetails' => '

PackageDetails

', 'PackageDetailsList$member' => NULL, 'UpdatePackageResponse$PackageDetails' => '

Information about the package PackageDetails.

', ], ], 'PackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesResponse$PackageDetailsList' => '

List of PackageDetails objects.

', ], ], 'PackageID' => [ 'base' => NULL, 'refs' => [ 'AssociatePackageRequest$PackageID' => '

Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

', 'DeletePackageRequest$PackageID' => '

Internal ID of the package that you want to delete. Use DescribePackages to find this value.

', 'DissociatePackageRequest$PackageID' => '

Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

', 'DomainPackageDetails$PackageID' => '

Internal ID of the package.

', 'GetPackageVersionHistoryRequest$PackageID' => '

Returns an audit history of versions of the package.

', 'GetPackageVersionHistoryResponse$PackageID' => NULL, 'ListDomainsForPackageRequest$PackageID' => '

The package for which to list domains.

', 'PackageDetails$PackageID' => '

Internal ID of the package.

', 'UpdatePackageRequest$PackageID' => '

Unique identifier for the package.

', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageName' => '

Unique identifier for the package.

', 'DomainPackageDetails$PackageName' => '

User specified name of the package.

', 'PackageDetails$PackageName' => '

User specified name of the package.

', ], ], 'PackageSource' => [ 'base' => '

The S3 location for importing the package specified as S3BucketName and S3Key

', 'refs' => [ 'CreatePackageRequest$PackageSource' => '

The customer S3 location PackageSource for importing the package.

', 'UpdatePackageRequest$PackageSource' => NULL, ], ], 'PackageStatus' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$PackageStatus' => '

Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED

', ], ], 'PackageType' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageType' => '

Type of package. Currently supports only TXT-DICTIONARY.

', 'DomainPackageDetails$PackageType' => '

Currently supports only TXT-DICTIONARY.

', 'PackageDetails$PackageType' => '

Currently supports only TXT-DICTIONARY.

', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$PackageVersion' => NULL, 'PackageDetails$AvailablePackageVersion' => NULL, 'PackageVersionHistory$PackageVersion' => '

Version of the package.

', ], ], 'PackageVersionHistory' => [ 'base' => '

Details of a package version.

', 'refs' => [ 'PackageVersionHistoryList$member' => NULL, ], ], 'PackageVersionHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionHistoryResponse$PackageVersionHistoryList' => '

List of PackageVersionHistory objects.

', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserPassword' => '

The master user\'s password, which is stored in the Amazon Elasticsearch Service domain\'s internal database.

', ], ], 'PolicyDocument' => [ 'base' => '

Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.

', 'refs' => [ 'AccessPoliciesStatus$Options' => '

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.

', 'CreateElasticsearchDomainRequest$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', 'ElasticsearchDomainStatus$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', 'UpdateElasticsearchDomainConfigRequest$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', ], ], 'PrincipalType' => [ 'base' => '

Specifies the type of AWS account permitted to manage VPC endpoints.:

  • AWS_ACCOUNT: Indicates that the account is owned by an AWS user.
  • AWS_SERVICE: Indicates the the account is owned by an AWS service.

', 'refs' => [ 'AuthorizedPrincipal$PrincipalType' => '

The type of principal.

', ], ], 'PurchaseReservedElasticsearchInstanceOfferingRequest' => [ 'base' => '

Container for parameters to PurchaseReservedElasticsearchInstanceOffering

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

Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.

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

Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.

', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedElasticsearchInstance$RecurringCharges' => '

The charge to your account regardless of whether you are creating any domains using the instance offering.

', 'ReservedElasticsearchInstanceOffering$RecurringCharges' => '

The charge to your account regardless of whether you are creating any domains using the instance offering.

', ], ], 'ReferencePath' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$ReferencePath' => '

The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'DomainInformation$Region' => NULL, ], ], 'RejectInboundCrossClusterSearchConnectionRequest' => [ 'base' => '

Container for the parameters to the RejectInboundCrossClusterSearchConnection operation.

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

The result of a RejectInboundCrossClusterSearchConnection operation. Contains details of rejected inbound connection.

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

Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.

', 'refs' => [], ], 'ReservationToken' => [ 'base' => NULL, 'refs' => [ 'PurchaseReservedElasticsearchInstanceOfferingRequest$ReservationName' => '

A customer-specified identifier to track this reservation.

', 'PurchaseReservedElasticsearchInstanceOfferingResponse$ReservationName' => '

The customer-specified identifier used to track this reservation.

', 'ReservedElasticsearchInstance$ReservationName' => '

The customer-specified identifier to track this reservation.

', ], ], 'ReservedElasticsearchInstance' => [ 'base' => '

Details of a reserved Elasticsearch instance.

', 'refs' => [ 'ReservedElasticsearchInstanceList$member' => NULL, ], ], 'ReservedElasticsearchInstanceList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedElasticsearchInstancesResponse$ReservedElasticsearchInstances' => '

List of reserved Elasticsearch instances.

', ], ], 'ReservedElasticsearchInstanceOffering' => [ 'base' => '

Details of a reserved Elasticsearch instance offering.

', 'refs' => [ 'ReservedElasticsearchInstanceOfferingList$member' => NULL, ], ], 'ReservedElasticsearchInstanceOfferingList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedElasticsearchInstanceOfferingsResponse$ReservedElasticsearchInstanceOfferings' => '

List of reserved Elasticsearch instance offerings

', ], ], 'ReservedElasticsearchInstancePaymentOption' => [ 'base' => NULL, 'refs' => [ 'ReservedElasticsearchInstance$PaymentOption' => '

The payment option as defined in the reserved Elasticsearch instance offering.

', 'ReservedElasticsearchInstanceOffering$PaymentOption' => '

Payment option for the reserved Elasticsearch instance offering

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

An exception for creating a resource that already exists. Gives http status code of 400.

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

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

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

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

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

Container for response parameters to the RevokeVpcEndpointAccess operation. The response body for this operation is empty.

', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$RoleArn' => '

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

', ], ], 'RollbackOnDisable' => [ 'base' => '

Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.

', 'refs' => [ 'AutoTuneOptions$RollbackOnDisable' => '

Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3BucketName' => '

Name of the bucket containing the package.

', ], ], '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 SAML Identity Provider.

', ], ], 'SAMLIdp' => [ 'base' => '

Specifies the SAML Identity Provider\'s information.

', 'refs' => [ 'SAMLOptionsInput$Idp' => '

Specifies 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' => '

Specifies the SAML application configuration for the domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$SAMLOptions' => '

Specifies the SAML application configuration for the domain.

', ], ], 'SAMLOptionsOutput' => [ 'base' => '

Describes the SAML application configured for the domain.

', 'refs' => [ 'AdvancedSecurityOptions$SAMLOptions' => '

Describes the SAML application configured for a domain.

', ], ], 'ScheduledAutoTuneActionType' => [ 'base' => '

Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

', 'refs' => [ 'ScheduledAutoTuneDetails$ActionType' => '

Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

', ], ], 'ScheduledAutoTuneDescription' => [ 'base' => '

Specifies Auto-Tune action description.

', 'refs' => [ 'ScheduledAutoTuneDetails$Action' => '

Specifies Auto-Tune action description.

', ], ], 'ScheduledAutoTuneDetails' => [ 'base' => '

Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.

', 'refs' => [ 'AutoTuneDetails$ScheduledAutoTuneDetails' => NULL, ], ], 'ScheduledAutoTuneSeverityType' => [ 'base' => '

Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.

', 'refs' => [ 'ScheduledAutoTuneDetails$Severity' => '

Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.

', ], ], 'ServiceSoftwareOptions' => [ 'base' => '

The current options of an Elasticsearch domain service software options.

', 'refs' => [ 'CancelElasticsearchServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

The current status of the Elasticsearch service software update.

', 'ElasticsearchDomainStatus$ServiceSoftwareOptions' => '

The current status of the Elasticsearch domain\'s service software.

', 'StartElasticsearchServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

The current status of the Elasticsearch service software update.

', ], ], 'ServiceUrl' => [ 'base' => '

The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com.

', 'refs' => [ 'ElasticsearchDomainStatus$Endpoint' => '

The Elasticsearch domain endpoint that you use to submit index and search requests.

', 'EndpointsMap$value' => NULL, ], ], 'SnapshotOptions' => [ 'base' => '

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

', 'refs' => [ 'CreateElasticsearchDomainRequest$SnapshotOptions' => '

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

', 'ElasticsearchDomainStatus$SnapshotOptions' => '

Specifies the status of the SnapshotOptions

', 'SnapshotOptionsStatus$Options' => '

Specifies the daily snapshot options specified for the Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$SnapshotOptions' => '

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

', ], ], 'SnapshotOptionsStatus' => [ 'base' => '

Status of a daily automated snapshot.

', 'refs' => [ 'ElasticsearchDomainConfig$SnapshotOptions' => '

Specifies the SnapshotOptions for the Elasticsearch domain.

', ], ], 'StartAt' => [ 'base' => NULL, 'refs' => [ 'AutoTuneMaintenanceSchedule$StartAt' => '

Specifies timestamp at which Auto-Tune maintenance schedule start.

', ], ], 'StartElasticsearchServiceSoftwareUpdateRequest' => [ 'base' => '

Container for the parameters to the StartElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.

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

The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

', 'refs' => [], ], 'StartTimestamp' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StartTimestamp' => '

UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.

', ], ], 'StorageSubTypeName' => [ 'base' => '

SubType of the given storage type. List of available sub-storage options: For "instance" storageType we wont have any storageSubType, in case of "ebs" storageType we will have following valid storageSubTypes

  1. standard
  2. gp2
  3. gp3
  4. io1
Refer VolumeType for more information regarding above EBS storage options.

', 'refs' => [ 'StorageType$StorageSubTypeName' => NULL, ], ], 'StorageType' => [ 'base' => '

StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.

', 'refs' => [ 'StorageTypeList$member' => NULL, ], ], 'StorageTypeLimit' => [ 'base' => '

Limits that are applicable for given storage type.

', 'refs' => [ 'StorageTypeLimitList$member' => NULL, ], ], 'StorageTypeLimitList' => [ 'base' => NULL, 'refs' => [ 'StorageType$StorageTypeLimits' => '

List of limits that are applicable for given storage type.

', ], ], 'StorageTypeList' => [ 'base' => NULL, 'refs' => [ 'Limits$StorageTypes' => '

StorageType represents the list of storage related types and attributes that are available for given InstanceType.

', ], ], 'StorageTypeName' => [ 'base' => '

Type of the storage. List of available storage options:

  1. instance
    2. Inbuilt storage available for the given Instance
  2. ebs
    3. Elastic block storage that would be attached to the given Instance

', 'refs' => [ 'StorageType$StorageTypeName' => NULL, ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AdvancedOptions$key' => NULL, 'AdvancedOptions$value' => NULL, 'AuthorizedPrincipal$Principal' => '

The IAM principal that is allowed access to the domain.

', 'AutoTuneMaintenanceSchedule$CronExpressionForRecurrence' => '

Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.

', 'AutoTuneOptionsOutput$ErrorMessage' => '

Specifies the error message while enabling or disabling the Auto-Tune.

', 'AutoTuneStatus$ErrorMessage' => '

Specifies the error message while enabling or disabling the Auto-Tune options.

', 'DescribePackagesResponse$NextToken' => NULL, 'DescribeReservedElasticsearchInstancesResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'EndpointsMap$key' => NULL, 'GetPackageVersionHistoryResponse$NextToken' => NULL, 'GetUpgradeHistoryResponse$NextToken' => '

Pagination token that needs to be supplied to the next call to get the next page of results

', 'ListDomainsForPackageResponse$NextToken' => NULL, 'ListPackagesForDomainResponse$NextToken' => '

Pagination token that needs to be supplied to the next call to get the next page of results.

', 'RecurringCharge$RecurringChargeFrequency' => '

The frequency of the recurring charge.

', 'ReservedElasticsearchInstance$ReservedElasticsearchInstanceOfferingId' => '

The offering identifier.

', 'ReservedElasticsearchInstance$CurrencyCode' => '

The currency code for the reserved Elasticsearch instance offering.

', 'ReservedElasticsearchInstance$State' => '

The state of the reserved Elasticsearch instance.

', 'ReservedElasticsearchInstanceOffering$CurrencyCode' => '

The currency code for the reserved Elasticsearch instance offering.

', 'SAMLOptionsInput$SubjectKey' => '

The key to use for matching the SAML Subject attribute.

', 'SAMLOptionsInput$RolesKey' => '

The key to use for matching the SAML Roles attribute.

', 'SAMLOptionsOutput$SubjectKey' => '

The key used for matching the SAML Subject attribute.

', 'SAMLOptionsOutput$RolesKey' => '

The key used for matching the SAML Roles attribute.

', 'ServiceSoftwareOptions$CurrentVersion' => '

The current service software version that is present on the domain.

', 'ServiceSoftwareOptions$NewVersion' => '

The new service software version if one is available.

', 'ServiceSoftwareOptions$Description' => '

The description of the UpdateStatus.

', 'StringList$member' => NULL, 'VPCDerivedInfo$VPCId' => '

The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

', 'VpcEndpointError$ErrorMessage' => '

A message describing the error.

', 'VpcEndpointSummary$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$PendingProperties' => '

The list of properties involved in the domain configuration change that are still in pending.

', 'ChangeProgressStatusDetails$CompletedProperties' => '

The list of properties involved in the domain configuration change that are completed.

', 'RemoveTagsRequest$TagKeys' => '

Specifies the TagKey list which you want to remove from the Elasticsearch domain.

', 'VPCDerivedInfo$SubnetIds' => '

Specifies the subnets for VPC endpoint.

', 'VPCDerivedInfo$AvailabilityZones' => '

The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

', 'VPCDerivedInfo$SecurityGroupIds' => '

Specifies the security groups for VPC endpoint.

', 'VPCOptions$SubnetIds' => '

Specifies the subnets for VPC endpoint.

', 'VPCOptions$SecurityGroupIds' => '

Specifies the security groups for VPC endpoint.

', ], ], 'TLSSecurityPolicy' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$TLSSecurityPolicy' => '

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It can be one of the following values:

  • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
  • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2

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

Specifies a key value pair for a resource tag.

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

A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

', 'refs' => [ 'Tag$Key' => '

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

', ], ], 'TagList' => [ 'base' => '

A list of Tag

', 'refs' => [ 'AddTagsRequest$TagList' => '

List of Tag that need to be added for the Elasticsearch domain.

', 'CreateElasticsearchDomainRequest$TagList' => '

A list of Tag added during domain creation.

', 'ListTagsResponse$TagList' => '

List of Tag for the requested Elasticsearch domain.

', ], ], 'TagValue' => [ 'base' => '

A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set.

', 'refs' => [ 'Tag$Value' => '

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

', ], ], 'TimeUnit' => [ 'base' => '

Specifies the unit of a maintenance schedule duration. Valid value is HOUR. See the Developer Guide for more information.

', 'refs' => [ 'Duration$Unit' => '

Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.

', ], ], 'TotalNumberOfStages' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$TotalNumberOfStages' => '

The total number of stages required for the configuration change.

', ], ], 'UIntValue' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$UpdateVersion' => '

Specifies the Auto-Tune options latest version.

', 'OptionStatus$UpdateVersion' => '

Specifies the latest version for the entity.

', ], ], 'UpdateElasticsearchDomainConfigRequest' => [ 'base' => '

Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

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

The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.

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

Container for request parameters to UpdatePackage operation.

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

Container for response returned by UpdatePackage operation.

', 'refs' => [], ], 'UpdateTimestamp' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$CreationDate' => '

Timestamp which tells Auto-Tune options creation date .

', 'AutoTuneStatus$UpdateDate' => '

Timestamp which tells Auto-Tune options last updated time.

', 'ChangeProgressStatusDetails$StartTime' => '

The time at which the configuration change is made on the domain.

', 'OptionStatus$CreationDate' => '

Timestamp which tells the creation date for the entity.

', 'OptionStatus$UpdateDate' => '

Timestamp which tells the last updated time for the entity.

', 'ReservedElasticsearchInstance$StartTime' => '

The time the reservation started.

', ], ], 'UpdateVpcEndpointRequest' => [ 'base' => '

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

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

Contains the configuration and status of the VPC endpoint being updated.

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

Container for request parameters to UpgradeElasticsearchDomain operation.

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

Container for response returned by UpgradeElasticsearchDomain operation.

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

History of the last 10 Upgrades and Upgrade Eligibility Checks.

', 'refs' => [ 'UpgradeHistoryList$member' => NULL, ], ], 'UpgradeHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeHistoryResponse$UpgradeHistories' => '

A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object.

', ], ], 'UpgradeName' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeName' => '

A string that describes the update briefly

', 'UpgradeHistory$UpgradeName' => '

A string that describes the update briefly

', ], ], 'UpgradeStatus' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$StepStatus' => '

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

', 'UpgradeHistory$UpgradeStatus' => '

The overall status of the update. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

', 'UpgradeStepItem$UpgradeStepStatus' => '

The status of a particular step during an upgrade. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

', ], ], 'UpgradeStep' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeStep' => '

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

', 'UpgradeStepItem$UpgradeStep' => '

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

', ], ], 'UpgradeStepItem' => [ 'base' => '

Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

', 'refs' => [ 'UpgradeStepsList$member' => NULL, ], ], 'UpgradeStepsList' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StepsList' => '

A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.

', ], ], 'UserPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$UserPoolId' => '

Specifies the Cognito user pool ID for Kibana authentication.

', ], ], 'Username' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserName' => '

The master user\'s username, which is stored in the Amazon Elasticsearch Service domain\'s internal database.

', 'SAMLOptionsInput$MasterUserName' => '

The SAML master username, which is stored in the Amazon Elasticsearch Service domain\'s internal database.

', ], ], 'VPCDerivedInfo' => [ 'base' => '

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

', 'refs' => [ 'ElasticsearchDomainStatus$VPCOptions' => '

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

', 'VPCDerivedInfoStatus$Options' => '

Specifies the VPC options for the specified Elasticsearch 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 the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$VPCOptions' => '

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

', ], ], 'VPCOptions' => [ 'base' => '

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

', 'refs' => [ 'CreateElasticsearchDomainRequest$VPCOptions' => '

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

', 'CreateVpcEndpointRequest$VpcOptions' => '

Options to specify the subnets and security groups for the endpoint.

', 'UpdateElasticsearchDomainConfigRequest$VPCOptions' => '

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

', 'UpdateVpcEndpointRequest$VpcOptions' => '

The security groups and/or subnets to add, remove, or modify.

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

An exception for missing / invalid input fields. Gives http status code of 400.

', 'refs' => [], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

Contains one or more values for the filter.

', ], ], 'VolumeType' => [ 'base' => '

The type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based Storagefor more information.

', 'refs' => [ 'EBSOptions$VolumeType' => '

Specifies the volume type for EBS-based storage.

', ], ], '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' => '

Specifies the error code of the failure encountered while describing the VPC endpoint:

  • ENDPOINT_NOT_FOUND: Indicates that the requested VPC endpoint does not exist.
  • SERVER_ERROR: Indicates the describe endpoint operation failed due to an internal server error.

', '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 to be deleted.

', 'UpdateVpcEndpointRequest$VpcEndpointId' => '

Unique identifier of the VPC endpoint to be updated.

', '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' => '

Specifies the current status of the VPC endpoint:

  • CREATING: Indicates that the VPC endpoint is currently being created.
  • CREATE_FAILED: Indicates that the VPC endpoint creation failed.
  • ACTIVE: Indicates that the VPC endpoint is currently active.
  • UPDATING: Indicates that the VPC endpoint is currently being updated.
  • UPDATE_FAILED: Indicates that the VPC endpoint update failed.
  • DELETING: Indicates that the VPC endpoint is currently being deleted.
  • DELETE_FAILED: Indicates that the VPC endpoint deletion failed.

', 'refs' => [ 'VpcEndpoint$Status' => '

The current status of the endpoint.

', 'VpcEndpointSummary$Status' => '

The current status of the endpoint.

', ], ], 'VpcEndpointSummary' => [ 'base' => '

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'DeleteVpcEndpointResponse$VpcEndpointSummary' => '

Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).

', 'VpcEndpointSummaryList$member' => NULL, ], ], 'VpcEndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointsForDomainResponse$VpcEndpointSummaryList' => '

Provides list of VpcEndpointSummary summarizing details of the VPC endpoints.

', 'ListVpcEndpointsResponse$VpcEndpointSummaryList' => '

Information about each endpoint.

', ], ], 'VpcEndpoints' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpoints' => '

Information about each requested VPC endpoint.

', ], ], 'ZoneAwarenessConfig' => [ 'base' => '

Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.

', 'refs' => [ 'ElasticsearchClusterConfig$ZoneAwarenessConfig' => '

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.

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 Regions and Endpoints.

', 'operations' => [ 'AcceptInboundCrossClusterSearchConnection' => '

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

', 'AddTags' => '

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

', 'AssociatePackage' => '

Associates a package with an Amazon ES domain.

', 'AuthorizeVpcEndpointAccess' => '

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'CancelElasticsearchServiceSoftwareUpdate' => '

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

', 'CreateElasticsearchDomain' => '

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

', 'CreateOutboundCrossClusterSearchConnection' => '

Creates a new cross-cluster search connection from a source domain to a destination domain.

', 'CreatePackage' => '

Create a package for use with Amazon ES domains.

', 'CreateVpcEndpoint' => '

Creates an Amazon OpenSearch Service-managed VPC endpoint.

', 'DeleteElasticsearchDomain' => '

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

', 'DeleteElasticsearchServiceRole' => '

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.

', 'DeleteInboundCrossClusterSearchConnection' => '

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

', 'DeleteOutboundCrossClusterSearchConnection' => '

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

', 'DeletePackage' => '

Delete the package.

', 'DeleteVpcEndpoint' => '

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'DescribeDomainAutoTunes' => '

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

', 'DescribeDomainChangeProgress' => '

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

', 'DescribeElasticsearchDomain' => '

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

', 'DescribeElasticsearchDomainConfig' => '

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

', 'DescribeElasticsearchDomains' => '

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

', 'DescribeElasticsearchInstanceTypeLimits' => '

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

', 'DescribeInboundCrossClusterSearchConnections' => '

Lists all the inbound cross-cluster search connections for a destination domain.

', 'DescribeOutboundCrossClusterSearchConnections' => '

Lists all the outbound cross-cluster search connections for a source domain.

', 'DescribePackages' => '

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

', 'DescribeReservedElasticsearchInstanceOfferings' => '

Lists available reserved Elasticsearch instance offerings.

', 'DescribeReservedElasticsearchInstances' => '

Returns information about reserved Elasticsearch instances for this account.

', 'DescribeVpcEndpoints' => '

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

', 'DissociatePackage' => '

Dissociates a package from the Amazon ES domain.

', 'GetCompatibleElasticsearchVersions' => '

Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.

', 'GetPackageVersionHistory' => '

Returns a list of versions of the package, along with their creation time and commit message.

', 'GetUpgradeHistory' => '

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

', 'GetUpgradeStatus' => '

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

', 'ListDomainNames' => '

Returns the name of all Elasticsearch domains owned by the current user\'s account.

', 'ListDomainsForPackage' => '

Lists all Amazon ES domains associated with the package.

', 'ListElasticsearchInstanceTypes' => '

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

', 'ListElasticsearchVersions' => '

List all supported Elasticsearch versions

', 'ListPackagesForDomain' => '

Lists all packages associated with the Amazon ES domain.

', 'ListTags' => '

Returns all tags for the given Elasticsearch domain.

', 'ListVpcEndpointAccess' => '

Retrieves information about each 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 account and Region.

', 'ListVpcEndpointsForDomain' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

', 'PurchaseReservedElasticsearchInstanceOffering' => '

Allows you to purchase reserved Elasticsearch instances.

', 'RejectInboundCrossClusterSearchConnection' => '

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

', 'RemoveTags' => '

Removes the specified set of tags from the specified Elasticsearch domain.

', 'RevokeVpcEndpointAccess' => '

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

', 'StartElasticsearchServiceSoftwareUpdate' => '

Schedules a service software update for an Amazon ES domain.

', 'UpdateElasticsearchDomainConfig' => '

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

', 'UpdatePackage' => '

Updates a package for use with Amazon ES domains.

', 'UpdateVpcEndpoint' => '

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'UpgradeElasticsearchDomain' => '

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

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

The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

', 'refs' => [ 'AddTagsRequest$ARN' => '

Specify the ARN for which you want to add the tags.

', 'DomainEndpointOptions$CustomEndpointCertificateArn' => '

Specify ACM certificate ARN for your custom endpoint.

', 'ElasticsearchDomainStatus$ARN' => '

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

', 'ListTagsRequest$ARN' => '

Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.

', 'MasterUserOptions$MasterUserARN' => '

ARN for the master user (if IAM is enabled).

', 'RemoveTagsRequest$ARN' => '

Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.

', ], ], 'AWSAccount' => [ 'base' => NULL, 'refs' => [ 'AuthorizeVpcEndpointAccessRequest$Account' => '

The account ID to grant access to.

', 'RevokeVpcEndpointAccessRequest$Account' => '

The account ID to revoke access from.

', 'VpcEndpoint$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'AcceptInboundCrossClusterSearchConnectionRequest' => [ 'base' => '

Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation.

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

The result of a AcceptInboundCrossClusterSearchConnection operation. Contains details of accepted inbound connection.

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

An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

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

The configured access rules for the domain\'s document and search endpoints, and the current status of those rules.

', 'refs' => [ 'ElasticsearchDomainConfig$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', ], ], 'AddTagsRequest' => [ 'base' => '

Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.

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

List of limits that are specific to a given InstanceType and for each of it\'s InstanceRole .

', 'refs' => [ 'AdditionalLimitList$member' => NULL, ], ], 'AdditionalLimitList' => [ 'base' => NULL, 'refs' => [ 'Limits$AdditionalLimits' => '

List of additional limits that are specific to a given InstanceType and for each of it\'s InstanceRole .

', ], ], 'AdvancedOptions' => [ 'base' => '

Exposes select native Elasticsearch configuration values from elasticsearch.yml. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
  • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

', 'refs' => [ 'AdvancedOptionsStatus$Options' => '

Specifies the status of advanced options for the specified Elasticsearch domain.

', 'CreateElasticsearchDomainRequest$AdvancedOptions' => '

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

', 'ElasticsearchDomainStatus$AdvancedOptions' => '

Specifies the status of the AdvancedOptions

', 'UpdateElasticsearchDomainConfigRequest$AdvancedOptions' => '

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

', ], ], 'AdvancedOptionsStatus' => [ 'base' => '

Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
  • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

', 'refs' => [ 'ElasticsearchDomainConfig$AdvancedOptions' => '

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

', ], ], 'AdvancedSecurityOptions' => [ 'base' => '

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.

', 'refs' => [ 'AdvancedSecurityOptionsStatus$Options' => '

Specifies advanced security options for the specified Elasticsearch domain.

', 'ElasticsearchDomainStatus$AdvancedSecurityOptions' => '

The current status of the Elasticsearch domain\'s advanced security options.

', ], ], 'AdvancedSecurityOptionsInput' => [ 'base' => '

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

', 'refs' => [ 'CreateElasticsearchDomainRequest$AdvancedSecurityOptions' => '

Specifies advanced security options.

', 'UpdateElasticsearchDomainConfigRequest$AdvancedSecurityOptions' => '

Specifies advanced security options.

', ], ], 'AdvancedSecurityOptionsStatus' => [ 'base' => '

Specifies the status of advanced security options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$AdvancedSecurityOptions' => '

Specifies AdvancedSecurityOptions for the domain.

', ], ], 'AssociatePackageRequest' => [ 'base' => '

Container for request parameters to AssociatePackage operation.

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

Container for response returned by AssociatePackage operation.

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

Container for request parameters to the AuthorizeVpcEndpointAccess operation. Specifies the account to be permitted to manage VPC endpoints against the domain.

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

Container for response parameters to the AuthorizeVpcEndpointAccess operation. Contains the account ID and the type of the account being authorized to access the VPC endpoint.

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

Information about an 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 account or service that was provided access to the domain.

', 'AuthorizedPrincipalList$member' => NULL, ], ], 'AuthorizedPrincipalList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointAccessResponse$AuthorizedPrincipalList' => '

List of AuthorizedPrincipal describing the details of the permissions to manage VPC endpoints against the specified domain.

', ], ], 'AutoTune' => [ 'base' => '

Specifies Auto-Tune type and Auto-Tune action details.

', 'refs' => [ 'AutoTuneList$member' => NULL, ], ], 'AutoTuneDate' => [ 'base' => '

Specifies timestamp for the Auto-Tune action scheduled for the domain.

', 'refs' => [ 'ScheduledAutoTuneDetails$Date' => '

Specifies timestamp for the Auto-Tune action scheduled for the domain.

', ], ], 'AutoTuneDesiredState' => [ 'base' => '

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

', 'refs' => [ 'AutoTuneOptions$DesiredState' => '

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

', 'AutoTuneOptionsInput$DesiredState' => '

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

', ], ], 'AutoTuneDetails' => [ 'base' => '

Specifies details of the Auto-Tune action. See the Developer Guide for more information.

', 'refs' => [ 'AutoTune$AutoTuneDetails' => '

Specifies details of the Auto-Tune action. See the Developer Guide for more information.

', ], ], 'AutoTuneList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainAutoTunesResponse$AutoTunes' => '

Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.

', ], ], 'AutoTuneMaintenanceSchedule' => [ 'base' => '

Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.

', 'refs' => [ 'AutoTuneMaintenanceScheduleList$member' => NULL, ], ], 'AutoTuneMaintenanceScheduleList' => [ 'base' => NULL, 'refs' => [ 'AutoTuneOptions$MaintenanceSchedules' => '

Specifies list of maitenance schedules. See the Developer Guide for more information.

', 'AutoTuneOptionsInput$MaintenanceSchedules' => '

Specifies list of maitenance schedules. See the Developer Guide for more information.

', ], ], 'AutoTuneOptions' => [ 'base' => '

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

', 'refs' => [ 'AutoTuneOptionsStatus$Options' => '

Specifies Auto-Tune options for the specified Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$AutoTuneOptions' => '

Specifies Auto-Tune options.

', ], ], 'AutoTuneOptionsInput' => [ 'base' => '

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

', 'refs' => [ 'CreateElasticsearchDomainRequest$AutoTuneOptions' => '

Specifies Auto-Tune options.

', ], ], 'AutoTuneOptionsOutput' => [ 'base' => '

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

', 'refs' => [ 'ElasticsearchDomainStatus$AutoTuneOptions' => '

The current status of the Elasticsearch domain\'s Auto-Tune options.

', ], ], 'AutoTuneOptionsStatus' => [ 'base' => '

Specifies the status of Auto-Tune options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$AutoTuneOptions' => '

Specifies AutoTuneOptions for the domain.

', ], ], 'AutoTuneState' => [ 'base' => '

Specifies the Auto-Tune state for the Elasticsearch domain. For valid states see the Developer Guide.

', 'refs' => [ 'AutoTuneOptionsOutput$State' => '

Specifies the AutoTuneState for the Elasticsearch domain.

', 'AutoTuneStatus$State' => '

Specifies the AutoTuneState for the Elasticsearch domain.

', ], ], 'AutoTuneStatus' => [ 'base' => '

Provides the current status of the Auto-Tune options.

', 'refs' => [ 'AutoTuneOptionsStatus$Status' => '

Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.

', ], ], 'AutoTuneType' => [ 'base' => '

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

', 'refs' => [ 'AutoTune$AutoTuneType' => '

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

', ], ], 'BackendRole' => [ 'base' => NULL, 'refs' => [ 'SAMLOptionsInput$MasterBackendRole' => '

The backend role to which 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 advanced security is enabled.

', 'AdvancedSecurityOptions$InternalUserDatabaseEnabled' => '

True if the internal user database is enabled.

', 'AdvancedSecurityOptions$AnonymousAuthEnabled' => '

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

', 'AdvancedSecurityOptionsInput$Enabled' => '

True if advanced security is enabled.

', 'AdvancedSecurityOptionsInput$InternalUserDatabaseEnabled' => '

True if the internal user database is enabled.

', 'AdvancedSecurityOptionsInput$AnonymousAuthEnabled' => '

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

', 'AutoTuneStatus$PendingDeletion' => '

Indicates whether the Elasticsearch domain is being deleted.

', 'CognitoOptions$Enabled' => '

Specifies the option to enable Cognito for Kibana authentication.

', 'ColdStorageOptions$Enabled' => '

Enable cold storage option. Accepted values true or false

', 'DomainEndpointOptions$EnforceHTTPS' => '

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

', 'DomainEndpointOptions$CustomEndpointEnabled' => '

Specify if custom endpoint should be enabled for the Elasticsearch domain.

', 'EBSOptions$EBSEnabled' => '

Specifies whether EBS-based storage is enabled.

', 'ElasticsearchClusterConfig$DedicatedMasterEnabled' => '

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

', 'ElasticsearchClusterConfig$ZoneAwarenessEnabled' => '

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

', 'ElasticsearchClusterConfig$WarmEnabled' => '

True to enable warm storage.

', 'ElasticsearchDomainStatus$Created' => '

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

', 'ElasticsearchDomainStatus$Deleted' => '

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

', 'ElasticsearchDomainStatus$Processing' => '

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

', 'ElasticsearchDomainStatus$UpgradeProcessing' => '

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

', 'EncryptionAtRestOptions$Enabled' => '

Specifies the option to enable Encryption At Rest.

', 'LogPublishingOption$Enabled' => '

Specifies whether given log publishing option is enabled or not.

', 'NodeToNodeEncryptionOptions$Enabled' => '

Specify true to enable node-to-node encryption.

', 'OptionStatus$PendingDeletion' => '

Indicates whether the Elasticsearch domain is being deleted.

', 'SAMLOptionsInput$Enabled' => '

True if SAML is enabled.

', 'SAMLOptionsOutput$Enabled' => '

True if SAML is enabled.

', 'ServiceSoftwareOptions$UpdateAvailable' => '

True if you are able to update you service software version. False if you are not able to update your service software version.

', 'ServiceSoftwareOptions$Cancellable' => '

True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

', 'ServiceSoftwareOptions$OptionalDeployment' => '

True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.

', 'UpgradeElasticsearchDomainRequest$PerformCheckOnly' => '

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

', 'UpgradeElasticsearchDomainResponse$PerformCheckOnly' => '

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

', ], ], 'CancelElasticsearchServiceSoftwareUpdateRequest' => [ 'base' => '

Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.

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

The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

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

Specifies change details of the domain configuration change.

', 'refs' => [ 'ElasticsearchDomainConfig$ChangeProgressDetails' => '

Specifies change details of the domain configuration change.

', 'ElasticsearchDomainStatus$ChangeProgressDetails' => '

Specifies change details of the domain configuration change.

', 'UpgradeElasticsearchDomainResponse$ChangeProgressDetails' => NULL, ], ], 'ChangeProgressStage' => [ 'base' => '

A progress stage details of a specific domain configuration change.

', '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 specific progress stage.

', ], ], 'ChangeProgressStageStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => '

The overall status of a specific progress stage.

', ], ], 'ChangeProgressStatusDetails' => [ 'base' => '

The progress details of a specific domain configuration change.

', 'refs' => [ 'DescribeDomainChangeProgressResponse$ChangeProgressStatus' => '

Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.

', ], ], '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 which log needs to be published.

', 'refs' => [ 'LogPublishingOption$CloudWatchLogsLogGroupArn' => NULL, ], ], 'CognitoOptions' => [ 'base' => '

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

', 'refs' => [ 'CognitoOptionsStatus$Options' => '

Specifies the Cognito options for the specified Elasticsearch domain.

', 'CreateElasticsearchDomainRequest$CognitoOptions' => '

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

', 'ElasticsearchDomainStatus$CognitoOptions' => '

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

', 'UpdateElasticsearchDomainConfigRequest$CognitoOptions' => '

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

', ], ], 'CognitoOptionsStatus' => [ 'base' => '

Status of the Cognito options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$CognitoOptions' => '

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

', ], ], 'ColdStorageOptions' => [ 'base' => '

Specifies the configuration for cold storage options such as enabled

', 'refs' => [ 'ElasticsearchClusterConfig$ColdStorageOptions' => '

Specifies the ColdStorageOptions config for Elasticsearch Domain

', ], ], 'CommitMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionHistory$CommitMessage' => '

A message associated with the version.

', 'UpdatePackageRequest$CommitMessage' => '

An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.

', ], ], 'CompatibleElasticsearchVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetCompatibleElasticsearchVersionsResponse$CompatibleElasticsearchVersions' => '

A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.

', ], ], 'CompatibleVersionsMap' => [ 'base' => '

A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.

', 'refs' => [ 'CompatibleElasticsearchVersionsList$member' => NULL, ], ], 'ConflictException' => [ 'base' => '

An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

', 'refs' => [], ], 'ConnectionAlias' => [ 'base' => NULL, 'refs' => [ 'CreateOutboundCrossClusterSearchConnectionRequest$ConnectionAlias' => '

Specifies the connection alias that will be used by the customer for this connection.

', 'CreateOutboundCrossClusterSearchConnectionResponse$ConnectionAlias' => '

Specifies the connection alias provided during the create connection request.

', 'OutboundCrossClusterSearchConnection$ConnectionAlias' => '

Specifies the connection alias for the outbound cross-cluster search connection.

', ], ], 'CreateElasticsearchDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateElasticsearchDomainResponse' => [ 'base' => '

The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.

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

Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation.

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

The result of a CreateOutboundCrossClusterSearchConnection request. Contains the details of the newly created cross-cluster search connection.

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

Container for request parameters to CreatePackage operation.

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

Container for response returned by CreatePackage operation.

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

Container for the parameters to the CreateVpcEndpointRequest operation.

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

Container for response parameters to the CreateVpcEndpoint operation. Contains the configuration and status of the VPC Endpoint being created.

', 'refs' => [], ], 'CreatedAt' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$CreatedAt' => '

Timestamp which tells creation date of the package.

', 'PackageVersionHistory$CreatedAt' => '

Timestamp which tells creation time of the package version.

', ], ], 'CrossClusterSearchConnectionId' => [ 'base' => NULL, 'refs' => [ 'AcceptInboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

The id of the inbound connection that you want to accept.

', 'CreateOutboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnectionId' => '

Unique id for the created outbound connection, which is used for subsequent operations on connection.

', 'DeleteInboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

The id of the inbound connection that you want to permanently delete.

', 'DeleteOutboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

The id of the outbound connection that you want to permanently delete.

', 'InboundCrossClusterSearchConnection$CrossClusterSearchConnectionId' => '

Specifies the connection id for the inbound cross-cluster search connection.

', 'OutboundCrossClusterSearchConnection$CrossClusterSearchConnectionId' => '

Specifies the connection id for the outbound cross-cluster search connection.

', 'RejectInboundCrossClusterSearchConnectionRequest$CrossClusterSearchConnectionId' => '

The id of the inbound connection that you want to reject.

', ], ], 'CrossClusterSearchConnectionStatusMessage' => [ 'base' => NULL, 'refs' => [ 'InboundCrossClusterSearchConnectionStatus$Message' => '

Specifies verbose information for the inbound connection status.

', 'OutboundCrossClusterSearchConnectionStatus$Message' => '

Specifies verbose information for the outbound connection status.

', ], ], 'DeleteElasticsearchDomainRequest' => [ 'base' => '

Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.

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

The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.

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

Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation.

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

The result of a DeleteInboundCrossClusterSearchConnection operation. Contains details of deleted inbound connection.

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

Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation.

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

The result of a DeleteOutboundCrossClusterSearchConnection operation. Contains details of deleted outbound connection.

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

Container for request parameters to DeletePackage operation.

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

Container for response parameters to DeletePackage operation.

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

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

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

Container for response parameters to the DeleteVpcEndpoint operation. Contains the summarized detail of the VPC Endpoint being deleted.

', 'refs' => [], ], 'DeploymentCloseDateTimeStamp' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$AutomatedUpdateDate' => '

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. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

', ], ], 'DeploymentType' => [ 'base' => NULL, 'refs' => [ 'DryRunResults$DeploymentType' => '

Specifies the deployment mechanism through which the update shall be applied on the domain. Possible responses are Blue/Green (The update will require a blue/green deployment.) DynamicUpdate (The update can be applied in-place without a Blue/Green deployment required.) Undetermined (The domain is undergoing an update which needs to complete before the deployment type can be predicted.) None (The configuration change matches the current configuration and will not result in any update.)

', ], ], 'DescribeDomainAutoTunesRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainAutoTunes operation.

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

The result of DescribeDomainAutoTunes request. See the Developer Guide for more information.

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

Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the domain name and optional change specific identity for which you want progress information.

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

The result of a DescribeDomainChangeProgress request. Contains the progress information of the requested domain change.

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

Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.

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

The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.

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

Container for the parameters to the DescribeElasticsearchDomain operation.

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

The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.

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

Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

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

The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.

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

Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

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

Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation.

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

Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.

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

The result of a DescribeInboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.

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

Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.

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

The result of a DescribeOutboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.

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

Filter to apply in DescribePackage response.

', 'refs' => [ 'DescribePackagesFilterList$member' => NULL, ], ], 'DescribePackagesFilterList' => [ 'base' => '

A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.

', 'refs' => [ 'DescribePackagesRequest$Filters' => '

Only returns packages that match the DescribePackagesFilterList values.

', ], ], 'DescribePackagesFilterName' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Name' => '

Any field from PackageDetails.

', ], ], 'DescribePackagesFilterValue' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilterValues$member' => NULL, ], ], 'DescribePackagesFilterValues' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Value' => '

A non-empty list of values for the specified field.

', ], ], 'DescribePackagesRequest' => [ 'base' => '

Container for request parameters to DescribePackage operation.

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

Container for response returned by DescribePackages operation.

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

Container for parameters to DescribeReservedElasticsearchInstanceOfferings

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

Container for results from DescribeReservedElasticsearchInstanceOfferings

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

Container for parameters to DescribeReservedElasticsearchInstances

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

Container for results from DescribeReservedElasticsearchInstances

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

Container for request parameters to the DescribeVpcEndpoints operation. Specifies the list of VPC endpoints to be described.

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

Container for response parameters to the DescribeVpcEndpoints operation. Returns a list containing configuration details and status of the VPC Endpoints as well as a list containing error responses of the endpoints that could not be described

', 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Description' => '

The description of the progress stage.

', ], ], 'DisableTimestamp' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$AnonymousAuthDisableDate' => '

Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

', ], ], 'DisabledOperationException' => [ 'base' => '

An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

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

Container for request parameters to DissociatePackage operation.

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

Container for response returned by DissociatePackage operation.

', 'refs' => [], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$DomainArn' => '

The Amazon Resource Name (ARN) of the domain to grant access to.

', '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.

', ], ], 'DomainEndpointOptions' => [ 'base' => '

Options to configure endpoint for the Elasticsearch domain.

', 'refs' => [ 'CreateElasticsearchDomainRequest$DomainEndpointOptions' => '

Options to specify configuration that will be applied to the domain endpoint.

', 'DomainEndpointOptionsStatus$Options' => '

Options to configure endpoint for the Elasticsearch domain.

', 'ElasticsearchDomainStatus$DomainEndpointOptions' => '

The current status of the Elasticsearch domain\'s endpoint options.

', 'UpdateElasticsearchDomainConfigRequest$DomainEndpointOptions' => '

Options to specify configuration that will be applied to the domain endpoint.

', ], ], 'DomainEndpointOptionsStatus' => [ 'base' => '

The configured endpoint options for the domain and their current status.

', 'refs' => [ 'ElasticsearchDomainConfig$DomainEndpointOptions' => '

Specifies the DomainEndpointOptions for the Elasticsearch domain.

', ], ], 'DomainId' => [ 'base' => '

Unique identifier for an Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainStatus$DomainId' => '

The unique identifier for the specified Elasticsearch domain.

', ], ], 'DomainInfo' => [ 'base' => NULL, 'refs' => [ 'DomainInfoList$member' => NULL, ], ], 'DomainInfoList' => [ 'base' => '

Contains the list of Elasticsearch domain information.

', 'refs' => [ 'ListDomainNamesResponse$DomainNames' => '

List of domain names and respective engine types.

', ], ], 'DomainInformation' => [ 'base' => NULL, 'refs' => [ 'CreateOutboundCrossClusterSearchConnectionRequest$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'CreateOutboundCrossClusterSearchConnectionRequest$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', 'CreateOutboundCrossClusterSearchConnectionResponse$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'CreateOutboundCrossClusterSearchConnectionResponse$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', 'InboundCrossClusterSearchConnection$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'InboundCrossClusterSearchConnection$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', 'OutboundCrossClusterSearchConnection$SourceDomainInfo' => '

Specifies the DomainInformation for the source Elasticsearch domain.

', 'OutboundCrossClusterSearchConnection$DestinationDomainInfo' => '

Specifies the DomainInformation for the destination Elasticsearch domain.

', ], ], 'DomainName' => [ 'base' => '

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

', 'refs' => [ 'AssociatePackageRequest$DomainName' => '

Name of the domain that you want to associate the package with.

', 'AuthorizeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to provide access to.

', 'CancelElasticsearchServiceSoftwareUpdateRequest$DomainName' => '

The name of the domain that you want to stop the latest service software update on.

', 'CreateElasticsearchDomainRequest$DomainName' => '

The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

', 'DeleteElasticsearchDomainRequest$DomainName' => '

The name of the Elasticsearch domain that you want to permanently delete.

', 'DescribeDomainAutoTunesRequest$DomainName' => '

Specifies the domain name for which you want Auto-Tune action details.

', 'DescribeDomainChangeProgressRequest$DomainName' => '

The domain you want to get the progress information about.

', 'DescribeElasticsearchDomainConfigRequest$DomainName' => '

The Elasticsearch domain that you want to get information about.

', 'DescribeElasticsearchDomainRequest$DomainName' => '

The name of the Elasticsearch domain for which you want information.

', 'DescribeElasticsearchInstanceTypeLimitsRequest$DomainName' => '

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.

', 'DissociatePackageRequest$DomainName' => '

Name of the domain that you want to associate the package with.

', 'DomainInfo$DomainName' => '

Specifies the DomainName.

', 'DomainInformation$DomainName' => NULL, 'DomainNameList$member' => NULL, 'DomainPackageDetails$DomainName' => '

Name of the domain you\'ve associated a package with.

', 'ElasticsearchDomainStatus$DomainName' => '

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

', 'GetCompatibleElasticsearchVersionsRequest$DomainName' => NULL, 'GetUpgradeHistoryRequest$DomainName' => NULL, 'GetUpgradeStatusRequest$DomainName' => NULL, 'ListElasticsearchInstanceTypesRequest$DomainName' => '

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

', 'ListPackagesForDomainRequest$DomainName' => '

The name of the domain for which you want to list associated packages.

', 'ListVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to retrieve access information for.

', 'ListVpcEndpointsForDomainRequest$DomainName' => '

Name of the ElasticSearch domain whose VPC endpoints are to be listed.

', 'RevokeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain.

', 'StartElasticsearchServiceSoftwareUpdateRequest$DomainName' => '

The name of the domain that you want to update to the latest service software.

', 'UpdateElasticsearchDomainConfigRequest$DomainName' => '

The name of the Elasticsearch domain that you are updating.

', 'UpgradeElasticsearchDomainRequest$DomainName' => NULL, 'UpgradeElasticsearchDomainResponse$DomainName' => NULL, ], ], 'DomainNameFqdn' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$CustomEndpoint' => '

Specify the fully qualified domain for your custom endpoint.

', ], ], 'DomainNameList' => [ 'base' => '

A list of Elasticsearch domain names.

', 'refs' => [ 'DescribeElasticsearchDomainsRequest$DomainNames' => '

The Elasticsearch domains for which you want information.

', ], ], 'DomainPackageDetails' => [ 'base' => '

Information on a package that is associated with a domain.

', 'refs' => [ 'AssociatePackageResponse$DomainPackageDetails' => '

DomainPackageDetails

', 'DissociatePackageResponse$DomainPackageDetails' => '

DomainPackageDetails

', 'DomainPackageDetailsList$member' => NULL, ], ], 'DomainPackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsForPackageResponse$DomainPackageDetailsList' => '

List of DomainPackageDetails objects.

', 'ListPackagesForDomainResponse$DomainPackageDetailsList' => '

List of DomainPackageDetails objects.

', ], ], 'DomainPackageStatus' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$DomainPackageStatus' => '

State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$RecurringChargeAmount' => '

The monetary amount of the recurring charge.

', 'ReservedElasticsearchInstance$FixedPrice' => '

The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.

', 'ReservedElasticsearchInstance$UsagePrice' => '

The rate you are charged for each hour for the domain that is using this reserved instance.

', 'ReservedElasticsearchInstanceOffering$FixedPrice' => '

The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.

', 'ReservedElasticsearchInstanceOffering$UsagePrice' => '

The rate you are charged for each hour the domain that is using the offering is running.

', 'UpgradeStepItem$ProgressPercent' => '

The Floating point value representing progress percentage of a particular step.

', ], ], 'DryRun' => [ 'base' => NULL, 'refs' => [ 'UpdateElasticsearchDomainConfigRequest$DryRun' => '

This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

', ], ], 'DryRunResults' => [ 'base' => NULL, 'refs' => [ 'UpdateElasticsearchDomainConfigResponse$DryRunResults' => '

Contains result of DryRun.

', ], ], 'Duration' => [ 'base' => '

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

', 'refs' => [ 'AutoTuneMaintenanceSchedule$Duration' => '

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

', ], ], 'DurationValue' => [ 'base' => '

Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

', 'refs' => [ 'Duration$Value' => '

Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

', ], ], 'EBSOptions' => [ 'base' => '

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.

', 'refs' => [ 'CreateElasticsearchDomainRequest$EBSOptions' => '

Options to enable, disable and specify the type and size of EBS storage volumes.

', 'EBSOptionsStatus$Options' => '

Specifies the EBS options for the specified Elasticsearch domain.

', 'ElasticsearchDomainStatus$EBSOptions' => '

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

', 'UpdateElasticsearchDomainConfigRequest$EBSOptions' => '

Specify the type and size of the EBS volume that you want to use.

', ], ], 'EBSOptionsStatus' => [ 'base' => '

Status of the EBS options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$EBSOptions' => '

Specifies the EBSOptions for the Elasticsearch domain.

', ], ], 'ESPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'DescribeElasticsearchInstanceTypeLimitsRequest$InstanceType' => '

The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.

', 'ElasticsearchClusterConfig$InstanceType' => '

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

', 'ElasticsearchClusterConfig$DedicatedMasterType' => '

The instance type for a dedicated master node.

', 'ElasticsearchInstanceTypeList$member' => NULL, 'ReservedElasticsearchInstance$ElasticsearchInstanceType' => '

The Elasticsearch instance type offered by the reserved instance offering.

', 'ReservedElasticsearchInstanceOffering$ElasticsearchInstanceType' => '

The Elasticsearch instance type offered by the reserved instance offering.

', ], ], 'ESWarmPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ElasticsearchClusterConfig$WarmType' => '

The instance type for the Elasticsearch cluster\'s warm nodes.

', ], ], 'ElasticsearchClusterConfig' => [ 'base' => '

Specifies the configuration for the domain cluster, such as the type and number of instances.

', 'refs' => [ 'CreateElasticsearchDomainRequest$ElasticsearchClusterConfig' => '

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

', 'ElasticsearchClusterConfigStatus$Options' => '

Specifies the cluster configuration for the specified Elasticsearch domain.

', 'ElasticsearchDomainStatus$ElasticsearchClusterConfig' => '

The type and number of instances in the domain cluster.

', 'UpdateElasticsearchDomainConfigRequest$ElasticsearchClusterConfig' => '

The type and number of instances to instantiate for the domain cluster.

', ], ], 'ElasticsearchClusterConfigStatus' => [ 'base' => '

Specifies the configuration status for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$ElasticsearchClusterConfig' => '

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

', ], ], 'ElasticsearchDomainConfig' => [ 'base' => '

The configuration of an Elasticsearch domain.

', 'refs' => [ 'DescribeElasticsearchDomainConfigResponse$DomainConfig' => '

The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.

', 'UpdateElasticsearchDomainConfigResponse$DomainConfig' => '

The status of the updated Elasticsearch domain.

', ], ], 'ElasticsearchDomainStatus' => [ 'base' => '

The current status of an Elasticsearch domain.

', 'refs' => [ 'CreateElasticsearchDomainResponse$DomainStatus' => '

The status of the newly created Elasticsearch domain.

', 'DeleteElasticsearchDomainResponse$DomainStatus' => '

The status of the Elasticsearch domain being deleted.

', 'DescribeElasticsearchDomainResponse$DomainStatus' => '

The current status of the Elasticsearch domain.

', 'ElasticsearchDomainStatusList$member' => NULL, ], ], 'ElasticsearchDomainStatusList' => [ 'base' => '

A list that contains the status of each requested Elasticsearch domain.

', 'refs' => [ 'DescribeElasticsearchDomainsResponse$DomainStatusList' => '

The status of the domains requested in the DescribeElasticsearchDomains request.

', ], ], 'ElasticsearchInstanceTypeList' => [ 'base' => '

List of instance types supported by Amazon Elasticsearch service.

', 'refs' => [ 'ListElasticsearchInstanceTypesResponse$ElasticsearchInstanceTypes' => '

List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

', ], ], 'ElasticsearchVersionList' => [ 'base' => '

List of supported elastic search versions.

', 'refs' => [ 'CompatibleVersionsMap$TargetVersions' => NULL, 'ListElasticsearchVersionsResponse$ElasticsearchVersions' => NULL, ], ], 'ElasticsearchVersionStatus' => [ 'base' => '

Status of the Elasticsearch version options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$ElasticsearchVersion' => '

String of format X.Y to specify version for the Elasticsearch domain.

', ], ], 'ElasticsearchVersionString' => [ 'base' => NULL, 'refs' => [ 'CompatibleVersionsMap$SourceVersion' => '

The current version of Elasticsearch on which a domain is.

', 'CreateElasticsearchDomainRequest$ElasticsearchVersion' => '

String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

', 'DescribeElasticsearchInstanceTypeLimitsRequest$ElasticsearchVersion' => '

Version of Elasticsearch for which Limits are needed.

', 'ElasticsearchDomainStatus$ElasticsearchVersion' => NULL, 'ElasticsearchVersionList$member' => NULL, 'ElasticsearchVersionStatus$Options' => '

Specifies the Elasticsearch version for the specified Elasticsearch domain.

', 'ListElasticsearchInstanceTypesRequest$ElasticsearchVersion' => '

Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

', 'UpgradeElasticsearchDomainRequest$TargetVersion' => '

The version of Elasticsearch that you intend to upgrade the domain to.

', 'UpgradeElasticsearchDomainResponse$TargetVersion' => '

The version of Elasticsearch that you intend to upgrade the domain to.

', ], ], 'EncryptionAtRestOptions' => [ 'base' => '

Specifies the Encryption At Rest Options.

', 'refs' => [ 'CreateElasticsearchDomainRequest$EncryptionAtRestOptions' => '

Specifies the Encryption At Rest Options.

', 'ElasticsearchDomainStatus$EncryptionAtRestOptions' => '

Specifies the status of the EncryptionAtRestOptions.

', 'EncryptionAtRestOptionsStatus$Options' => '

Specifies the Encryption At Rest options for the specified Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$EncryptionAtRestOptions' => '

Specifies the Encryption At Rest Options.

', ], ], 'EncryptionAtRestOptionsStatus' => [ 'base' => '

Status of the Encryption At Rest options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$EncryptionAtRestOptions' => '

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

', ], ], 'Endpoint' => [ 'base' => NULL, 'refs' => [ 'VpcEndpoint$Endpoint' => '

The connection endpoint ID for connecting to the domain.

', ], ], 'EndpointsMap' => [ 'base' => NULL, 'refs' => [ 'ElasticsearchDomainStatus$Endpoints' => '

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: \'vpc\',\'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com\'.

', ], ], 'EngineType' => [ 'base' => NULL, 'refs' => [ 'DomainInfo$EngineType' => '

Specifies the EngineType of the domain.

', 'ListDomainNamesRequest$EngineType' => '

Optional parameter to filter the output by domain engine type. Acceptable values are \'Elasticsearch\' and \'OpenSearch\'.

', ], ], 'ErrorDetails' => [ 'base' => NULL, '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' => NULL, ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorType' => NULL, ], ], 'Filter' => [ 'base' => '

A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search 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' => [ 'DescribeInboundCrossClusterSearchConnectionsRequest$Filters' => '

A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are:

  • cross-cluster-search-connection-id
  • source-domain-info.domain-name
  • source-domain-info.owner-id
  • source-domain-info.region
  • destination-domain-info.domain-name

', 'DescribeOutboundCrossClusterSearchConnectionsRequest$Filters' => '

A list of filters used to match properties for outbound cross-cluster search connection. Available Filter names for this operation are:

  • cross-cluster-search-connection-id
  • destination-domain-info.domain-name
  • destination-domain-info.owner-id
  • destination-domain-info.region
  • source-domain-info.domain-name

', ], ], 'GUID' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$ChangeId' => '

The unique change identifier associated with a specific domain 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. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

', 'DescribeReservedElasticsearchInstanceOfferingsRequest$ReservedElasticsearchInstanceOfferingId' => '

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

', 'DescribeReservedElasticsearchInstancesRequest$ReservedElasticsearchInstanceId' => '

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

', 'PurchaseReservedElasticsearchInstanceOfferingRequest$ReservedElasticsearchInstanceOfferingId' => '

The ID of the reserved Elasticsearch instance offering to purchase.

', 'PurchaseReservedElasticsearchInstanceOfferingResponse$ReservedElasticsearchInstanceId' => '

Details of the reserved Elasticsearch instance which was purchased.

', 'ReservedElasticsearchInstance$ReservedElasticsearchInstanceId' => '

The unique identifier for the reservation.

', 'ReservedElasticsearchInstanceOffering$ReservedElasticsearchInstanceOfferingId' => '

The Elasticsearch reserved instance offering identifier.

', ], ], 'GetCompatibleElasticsearchVersionsRequest' => [ 'base' => '

Container for request parameters to GetCompatibleElasticsearchVersions operation.

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

Container for response returned by GetCompatibleElasticsearchVersions operation.

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

Container for request parameters to GetPackageVersionHistory operation.

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

Container for response returned by GetPackageVersionHistory operation.

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

Container for request parameters to GetUpgradeHistory operation.

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

Container for response returned by GetUpgradeHistory operation.

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

Container for request parameters to GetUpgradeStatus operation.

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

Container for response returned by GetUpgradeStatus operation.

', 'refs' => [], ], 'IdentityPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$IdentityPoolId' => '

Specifies the Cognito identity pool ID for Kibana authentication.

', ], ], 'InboundCrossClusterSearchConnection' => [ 'base' => '

Specifies details of an inbound connection.

', 'refs' => [ 'AcceptInboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.

', 'DeleteInboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.

', 'InboundCrossClusterSearchConnections$member' => NULL, 'RejectInboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the InboundCrossClusterSearchConnection of rejected inbound connection.

', ], ], 'InboundCrossClusterSearchConnectionStatus' => [ 'base' => '

Specifies the coonection status of an inbound cross-cluster search connection.

', 'refs' => [ 'InboundCrossClusterSearchConnection$ConnectionStatus' => '

Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.

', ], ], 'InboundCrossClusterSearchConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'InboundCrossClusterSearchConnectionStatus$StatusCode' => '

The state code for inbound connection. This can be one of the following:

  • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
  • APPROVED: Inbound connection is pending acceptance by destination domain owner.
  • 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 cannot be used further.
', ], ], 'InboundCrossClusterSearchConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundCrossClusterSearchConnectionsResponse$CrossClusterSearchConnections' => '

Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.

', ], ], 'InstanceCount' => [ 'base' => '

Specifies the number of EC2 instances in the Elasticsearch domain.

', 'refs' => [ 'PurchaseReservedElasticsearchInstanceOfferingRequest$InstanceCount' => '

The number of Elasticsearch instances to reserve.

', ], ], 'InstanceCountLimits' => [ 'base' => '

InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.

', 'refs' => [ 'InstanceLimits$InstanceCountLimits' => NULL, ], ], 'InstanceLimits' => [ 'base' => '

InstanceLimits represents the list of instance related attributes that are available for given InstanceType.

', 'refs' => [ 'Limits$InstanceLimits' => NULL, ], ], 'InstanceRole' => [ 'base' => NULL, 'refs' => [ 'LimitsByRole$key' => NULL, ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ReservedElasticsearchInstance$Duration' => '

The duration, in seconds, for which the Elasticsearch instance is reserved.

', 'ReservedElasticsearchInstance$ElasticsearchInstanceCount' => '

The number of Elasticsearch instances that have been reserved.

', 'ReservedElasticsearchInstanceOffering$Duration' => '

The duration, in seconds, for which the offering will reserve the Elasticsearch instance.

', ], ], 'IntegerClass' => [ 'base' => NULL, 'refs' => [ 'EBSOptions$VolumeSize' => '

Integer to specify the size of an EBS volume.

', 'EBSOptions$Iops' => '

Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

', 'EBSOptions$Throughput' => '

Specifies the Throughput for GP3 EBS volume (SSD).

', 'ElasticsearchClusterConfig$InstanceCount' => '

The number of instances in the specified domain cluster.

', 'ElasticsearchClusterConfig$DedicatedMasterCount' => '

Total number of dedicated master nodes, active and on standby, for the cluster.

', 'ElasticsearchClusterConfig$WarmCount' => '

The number of warm nodes in the cluster.

', 'SAMLOptionsInput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

', 'SAMLOptionsOutput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive.

', 'SnapshotOptions$AutomatedSnapshotStartHour' => '

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

', 'ZoneAwarenessConfig$AvailabilityZoneCount' => '

An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled

', ], ], 'InternalException' => [ 'base' => '

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

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

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

', 'refs' => [], ], 'Issue' => [ 'base' => NULL, 'refs' => [ 'Issues$member' => NULL, ], ], 'Issues' => [ 'base' => NULL, 'refs' => [ 'UpgradeStepItem$Issues' => '

A list of strings containing detailed information about the errors encountered in a particular step.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyId' => '

Specifies the KMS Key ID for Encryption At Rest options.

', ], ], 'LastUpdated' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$LastUpdated' => '

The last updated timestamp of the progress stage.

', 'DomainPackageDetails$LastUpdated' => '

Timestamp of the most-recent update to the association status.

', 'PackageDetails$LastUpdatedAt' => NULL, ], ], 'LimitExceededException' => [ 'base' => '

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

', 'refs' => [], ], 'LimitName' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitName' => '

Name of Additional Limit is specific to a given InstanceType and for each of it\'s InstanceRole etc.
Attributes and their details:

  • MaximumNumberOfDataNodesSupported
    • This attribute will be present in Master node only to specify how much data nodes upto which given ESPartitionInstanceType can support as master node.
  • MaximumNumberOfDataNodesWithoutMasterNode
    • This attribute will be present in Data node only to specify how much data nodes of given ESPartitionInstanceType upto which you don\'t need any master nodes to govern them.

', 'StorageTypeLimit$LimitName' => '

Name of storage limits that are applicable for given storage type. If StorageType is ebs, following storage options are applicable

  1. MinimumVolumeSize
    2. Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
  2. MaximumVolumeSize
    3. Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
  3. MaximumIops
    4. Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
  4. MinimumIops
    5. Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
  5. MaximumThroughput
    6. Maximum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.
  6. MinimumThroughput
    7. Minimum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.

', ], ], 'LimitValue' => [ 'base' => NULL, 'refs' => [ 'LimitValueList$member' => NULL, ], ], 'LimitValueList' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitValues' => '

Value for given AdditionalLimit$LimitName .

', 'StorageTypeLimit$LimitValues' => '

Values for the StorageTypeLimit$LimitName .

', ], ], 'Limits' => [ 'base' => '

Limits for given InstanceType and for each of it\'s role.
Limits contains following StorageTypes, InstanceLimits and AdditionalLimits

', 'refs' => [ 'LimitsByRole$value' => NULL, ], ], 'LimitsByRole' => [ 'base' => '

Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:

  • data: If the given InstanceType is used as data node
  • master: If the given InstanceType is used as master node
  • ultra_warm: If the given InstanceType is used as warm node

', 'refs' => [ 'DescribeElasticsearchInstanceTypeLimitsResponse$LimitsByRole' => NULL, ], ], 'ListDomainNamesRequest' => [ 'base' => '

Container for the parameters to the ListDomainNames operation.

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

The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

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

Container for request parameters to ListDomainsForPackage operation.

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

Container for response parameters to ListDomainsForPackage operation.

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

Container for the parameters to the ListElasticsearchInstanceTypes operation.

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

Container for the parameters returned by ListElasticsearchInstanceTypes operation.

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

Container for the parameters to the ListElasticsearchVersions operation.

Use MaxResults to control the maximum number of results to retrieve in a single call.

Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.

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

Container for the parameters for response received from ListElasticsearchVersions operation.

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

Container for request parameters to ListPackagesForDomain operation.

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

Container for response parameters to ListPackagesForDomain operation.

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

Container for the parameters to the ListTags operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached.

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

The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.

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

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint

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

Container for response parameters to the ListVpcEndpointAccess operation. Returns a list of accounts id and account type authorized to manage VPC endpoints.

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

Container for request parameters to the ListVpcEndpointsForDomain operation. Specifies the domain whose VPC endpoints will be listed.

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

Container for response parameters to the ListVpcEndpointsForDomain operation. Returns a list containing summarized details of the VPC endpoints.

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

Container for request parameters to the ListVpcEndpoints operation.

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

Container for response parameters to the ListVpcEndpoints operation. Returns a list containing summarized details of the VPC endpoints.

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

Log Publishing option that is set for given domain.
Attributes and their details:

  • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
  • Enabled: Whether the log publishing for given log type is enabled or not

', 'refs' => [ 'LogPublishingOptions$value' => NULL, ], ], 'LogPublishingOptions' => [ 'base' => NULL, 'refs' => [ 'CreateElasticsearchDomainRequest$LogPublishingOptions' => '

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

', 'ElasticsearchDomainStatus$LogPublishingOptions' => '

Log publishing options for the given domain.

', 'LogPublishingOptionsStatus$Options' => '

The log publishing options configured for the Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$LogPublishingOptions' => '

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

', ], ], 'LogPublishingOptionsStatus' => [ 'base' => '

The configured log publishing options for the domain and their current status.

', 'refs' => [ 'ElasticsearchDomainConfig$LogPublishingOptions' => '

Log publishing options for the given domain.

', ], ], 'LogType' => [ 'base' => '

Type of Log File, it can be one of the following:

  • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
  • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
  • ES_APPLICATION_LOGS: Elasticsearch 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 from the domain.

', 'refs' => [ 'LogPublishingOptions$key' => NULL, ], ], 'MasterUserOptions' => [ 'base' => '

Credentials for the master user: username and password, ARN, or both.

', 'refs' => [ 'AdvancedSecurityOptionsInput$MasterUserOptions' => '

Credentials for the master user: username and password, ARN, or both.

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

Set this value to limit the number of results returned.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$MaxResults' => '

Set this value to limit the number of results returned. If not specified, defaults to 100.

', 'DescribeInboundCrossClusterSearchConnectionsRequest$MaxResults' => '

Set this value to limit the number of results returned. If not specified, defaults to 100.

', 'DescribeOutboundCrossClusterSearchConnectionsRequest$MaxResults' => '

Set this value to limit the number of results returned. If not specified, defaults to 100.

', 'DescribePackagesRequest$MaxResults' => '

Limits results to a maximum number of packages.

', 'DescribeReservedElasticsearchInstanceOfferingsRequest$MaxResults' => '

Set this value to limit the number of results returned. If not specified, defaults to 100.

', 'DescribeReservedElasticsearchInstancesRequest$MaxResults' => '

Set this value to limit the number of results returned. If not specified, defaults to 100.

', 'GetPackageVersionHistoryRequest$MaxResults' => '

Limits results to a maximum number of versions.

', 'GetUpgradeHistoryRequest$MaxResults' => NULL, 'ListDomainsForPackageRequest$MaxResults' => '

Limits results to a maximum number of domains.

', 'ListElasticsearchInstanceTypesRequest$MaxResults' => '

Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

', 'ListElasticsearchVersionsRequest$MaxResults' => '

Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored.

', 'ListPackagesForDomainRequest$MaxResults' => '

Limits results to a maximum number of packages.

', ], ], 'MaximumInstanceCount' => [ 'base' => '

Maximum number of Instances that can be instantiated for given InstanceType.

', 'refs' => [ 'InstanceCountLimits$MaximumInstanceCount' => NULL, ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$Message' => '

Contains an optional message associated with the domain configuration change.

', 'DryRunResults$Message' => '

Contains an optional message associated with the DryRunResults.

', ], ], 'MinimumInstanceCount' => [ 'base' => '

Minimum number of Instances that can be instantiated for given InstanceType.

', 'refs' => [ 'InstanceCountLimits$MinimumInstanceCount' => NULL, ], ], 'NextToken' => [ 'base' => '

Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$NextToken' => '

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

', 'DescribeDomainAutoTunesResponse$NextToken' => '

Specifies an identifier to allow retrieval of paginated results.

', 'DescribeInboundCrossClusterSearchConnectionsRequest$NextToken' => '

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

', 'DescribeInboundCrossClusterSearchConnectionsResponse$NextToken' => '

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

', 'DescribeOutboundCrossClusterSearchConnectionsRequest$NextToken' => '

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

', 'DescribeOutboundCrossClusterSearchConnectionsResponse$NextToken' => '

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

', 'DescribePackagesRequest$NextToken' => '

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

', 'DescribeReservedElasticsearchInstanceOfferingsRequest$NextToken' => '

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

', 'DescribeReservedElasticsearchInstanceOfferingsResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'DescribeReservedElasticsearchInstancesRequest$NextToken' => '

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

', 'GetPackageVersionHistoryRequest$NextToken' => '

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

', 'GetUpgradeHistoryRequest$NextToken' => NULL, 'ListDomainsForPackageRequest$NextToken' => '

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

', 'ListElasticsearchInstanceTypesRequest$NextToken' => '

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

', 'ListElasticsearchInstanceTypesResponse$NextToken' => '

In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.

', 'ListElasticsearchVersionsRequest$NextToken' => NULL, 'ListElasticsearchVersionsResponse$NextToken' => NULL, 'ListPackagesForDomainRequest$NextToken' => '

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

', 'ListVpcEndpointAccessRequest$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'ListVpcEndpointAccessResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'ListVpcEndpointsForDomainRequest$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'ListVpcEndpointsForDomainResponse$NextToken' => '

Information about each endpoint associated with the domain.

', 'ListVpcEndpointsRequest$NextToken' => '

Identifier to allow retrieval of paginated results.

', 'ListVpcEndpointsResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', ], ], 'NodeToNodeEncryptionOptions' => [ 'base' => '

Specifies the node-to-node encryption options.

', 'refs' => [ 'CreateElasticsearchDomainRequest$NodeToNodeEncryptionOptions' => '

Specifies the NodeToNodeEncryptionOptions.

', 'ElasticsearchDomainStatus$NodeToNodeEncryptionOptions' => '

Specifies the status of the NodeToNodeEncryptionOptions.

', 'NodeToNodeEncryptionOptionsStatus$Options' => '

Specifies the node-to-node encryption options for the specified Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$NodeToNodeEncryptionOptions' => '

Specifies the NodeToNodeEncryptionOptions.

', ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'base' => '

Status of the node-to-node encryption options for the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$NodeToNodeEncryptionOptions' => '

Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

Specifies the name of the filter.

', 'ValueStringList$member' => NULL, ], ], 'OptionState' => [ 'base' => '

The state of a requested change. One of the following:

  • Processing: The request change is still in-process.
  • Active: The request change is processed and deployed to the Elasticsearch domain.
', 'refs' => [ 'OptionStatus$State' => '

Provides the OptionState for the Elasticsearch domain.

', ], ], 'OptionStatus' => [ 'base' => '

Provides the current status of the entity.

', 'refs' => [ 'AccessPoliciesStatus$Status' => '

The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that\'s included.

', 'AdvancedOptionsStatus$Status' => '

Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

', 'AdvancedSecurityOptionsStatus$Status' => '

Status of the advanced security options for the specified Elasticsearch domain.

', 'CognitoOptionsStatus$Status' => '

Specifies the status of the Cognito options for the specified Elasticsearch domain.

', 'DomainEndpointOptionsStatus$Status' => '

The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that\'s included.

', 'EBSOptionsStatus$Status' => '

Specifies the status of the EBS options for the specified Elasticsearch domain.

', 'ElasticsearchClusterConfigStatus$Status' => '

Specifies the status of the configuration for the specified Elasticsearch domain.

', 'ElasticsearchVersionStatus$Status' => '

Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

', 'EncryptionAtRestOptionsStatus$Status' => '

Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

', 'LogPublishingOptionsStatus$Status' => '

The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that\'s included.

', 'NodeToNodeEncryptionOptionsStatus$Status' => '

Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.

', 'SnapshotOptionsStatus$Status' => '

Specifies the status of a daily automated snapshot.

', 'VPCDerivedInfoStatus$Status' => '

Specifies the status of the VPC options for the specified Elasticsearch domain.

', ], ], 'OutboundCrossClusterSearchConnection' => [ 'base' => '

Specifies details of an outbound connection.

', 'refs' => [ 'DeleteOutboundCrossClusterSearchConnectionResponse$CrossClusterSearchConnection' => '

Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.

', 'OutboundCrossClusterSearchConnections$member' => NULL, ], ], 'OutboundCrossClusterSearchConnectionStatus' => [ 'base' => '

Specifies the connection status of an outbound cross-cluster search connection.

', 'refs' => [ 'CreateOutboundCrossClusterSearchConnectionResponse$ConnectionStatus' => '

Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.

', 'OutboundCrossClusterSearchConnection$ConnectionStatus' => '

Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.

', ], ], 'OutboundCrossClusterSearchConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'OutboundCrossClusterSearchConnectionStatus$StatusCode' => '

The state code for outbound connection. This 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 destination domain owner.
  • PROVISIONING: Outbound connection request is in process.
  • ACTIVE: Outbound connection is active and ready to use.
  • REJECTED: Outbound connection request is rejected by destination domain owner.
  • DELETING: Outbound connection deletion is in progress.
  • DELETED: Outbound connection is deleted and cannot be used further.
', ], ], 'OutboundCrossClusterSearchConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeOutboundCrossClusterSearchConnectionsResponse$CrossClusterSearchConnections' => '

Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.

', ], ], 'OverallChangeStatus' => [ 'base' => '

The overall status value of the domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$Status' => '

The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED

', ], ], 'OwnerId' => [ 'base' => NULL, 'refs' => [ 'DomainInformation$OwnerId' => NULL, ], ], 'PackageDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageDescription' => '

Description of the package.

', 'PackageDetails$PackageDescription' => '

User-specified description of the package.

', 'UpdatePackageRequest$PackageDescription' => '

New description of the package.

', ], ], 'PackageDetails' => [ 'base' => '

Basic information about a package.

', 'refs' => [ 'CreatePackageResponse$PackageDetails' => '

Information about the package PackageDetails.

', 'DeletePackageResponse$PackageDetails' => '

PackageDetails

', 'PackageDetailsList$member' => NULL, 'UpdatePackageResponse$PackageDetails' => '

Information about the package PackageDetails.

', ], ], 'PackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesResponse$PackageDetailsList' => '

List of PackageDetails objects.

', ], ], 'PackageID' => [ 'base' => NULL, 'refs' => [ 'AssociatePackageRequest$PackageID' => '

Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

', 'DeletePackageRequest$PackageID' => '

Internal ID of the package that you want to delete. Use DescribePackages to find this value.

', 'DissociatePackageRequest$PackageID' => '

Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

', 'DomainPackageDetails$PackageID' => '

Internal ID of the package.

', 'GetPackageVersionHistoryRequest$PackageID' => '

Returns an audit history of versions of the package.

', 'GetPackageVersionHistoryResponse$PackageID' => NULL, 'ListDomainsForPackageRequest$PackageID' => '

The package for which to list domains.

', 'PackageDetails$PackageID' => '

Internal ID of the package.

', 'UpdatePackageRequest$PackageID' => '

Unique identifier for the package.

', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageName' => '

Unique identifier for the package.

', 'DomainPackageDetails$PackageName' => '

User specified name of the package.

', 'PackageDetails$PackageName' => '

User specified name of the package.

', ], ], 'PackageSource' => [ 'base' => '

The S3 location for importing the package specified as S3BucketName and S3Key

', 'refs' => [ 'CreatePackageRequest$PackageSource' => '

The customer S3 location PackageSource for importing the package.

', 'UpdatePackageRequest$PackageSource' => NULL, ], ], 'PackageStatus' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$PackageStatus' => '

Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED

', ], ], 'PackageType' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageType' => '

Type of package. Currently supports only TXT-DICTIONARY.

', 'DomainPackageDetails$PackageType' => '

Currently supports only TXT-DICTIONARY.

', 'PackageDetails$PackageType' => '

Currently supports only TXT-DICTIONARY.

', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$PackageVersion' => NULL, 'PackageDetails$AvailablePackageVersion' => NULL, 'PackageVersionHistory$PackageVersion' => '

Version of the package.

', ], ], 'PackageVersionHistory' => [ 'base' => '

Details of a package version.

', 'refs' => [ 'PackageVersionHistoryList$member' => NULL, ], ], 'PackageVersionHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionHistoryResponse$PackageVersionHistoryList' => '

List of PackageVersionHistory objects.

', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserPassword' => '

The master user\'s password, which is stored in the Amazon Elasticsearch Service domain\'s internal database.

', ], ], 'PolicyDocument' => [ 'base' => '

Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.

', 'refs' => [ 'AccessPoliciesStatus$Options' => '

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.

', 'CreateElasticsearchDomainRequest$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', 'ElasticsearchDomainStatus$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', 'UpdateElasticsearchDomainConfigRequest$AccessPolicies' => '

IAM access policy as a JSON-formatted string.

', ], ], 'PrincipalType' => [ 'base' => '

Specifies the type of AWS account permitted to manage VPC endpoints.:

  • AWS_ACCOUNT: Indicates that the account is owned by an AWS user.
  • AWS_SERVICE: Indicates the the account is owned by an AWS service.

', 'refs' => [ 'AuthorizedPrincipal$PrincipalType' => '

The type of principal.

', ], ], 'PurchaseReservedElasticsearchInstanceOfferingRequest' => [ 'base' => '

Container for parameters to PurchaseReservedElasticsearchInstanceOffering

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

Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.

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

Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.

', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedElasticsearchInstance$RecurringCharges' => '

The charge to your account regardless of whether you are creating any domains using the instance offering.

', 'ReservedElasticsearchInstanceOffering$RecurringCharges' => '

The charge to your account regardless of whether you are creating any domains using the instance offering.

', ], ], 'ReferencePath' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$ReferencePath' => '

The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'DomainInformation$Region' => NULL, ], ], 'RejectInboundCrossClusterSearchConnectionRequest' => [ 'base' => '

Container for the parameters to the RejectInboundCrossClusterSearchConnection operation.

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

The result of a RejectInboundCrossClusterSearchConnection operation. Contains details of rejected inbound connection.

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

Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.

', 'refs' => [], ], 'ReservationToken' => [ 'base' => NULL, 'refs' => [ 'PurchaseReservedElasticsearchInstanceOfferingRequest$ReservationName' => '

A customer-specified identifier to track this reservation.

', 'PurchaseReservedElasticsearchInstanceOfferingResponse$ReservationName' => '

The customer-specified identifier used to track this reservation.

', 'ReservedElasticsearchInstance$ReservationName' => '

The customer-specified identifier to track this reservation.

', ], ], 'ReservedElasticsearchInstance' => [ 'base' => '

Details of a reserved Elasticsearch instance.

', 'refs' => [ 'ReservedElasticsearchInstanceList$member' => NULL, ], ], 'ReservedElasticsearchInstanceList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedElasticsearchInstancesResponse$ReservedElasticsearchInstances' => '

List of reserved Elasticsearch instances.

', ], ], 'ReservedElasticsearchInstanceOffering' => [ 'base' => '

Details of a reserved Elasticsearch instance offering.

', 'refs' => [ 'ReservedElasticsearchInstanceOfferingList$member' => NULL, ], ], 'ReservedElasticsearchInstanceOfferingList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedElasticsearchInstanceOfferingsResponse$ReservedElasticsearchInstanceOfferings' => '

List of reserved Elasticsearch instance offerings

', ], ], 'ReservedElasticsearchInstancePaymentOption' => [ 'base' => NULL, 'refs' => [ 'ReservedElasticsearchInstance$PaymentOption' => '

The payment option as defined in the reserved Elasticsearch instance offering.

', 'ReservedElasticsearchInstanceOffering$PaymentOption' => '

Payment option for the reserved Elasticsearch instance offering

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

An exception for creating a resource that already exists. Gives http status code of 400.

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

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

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

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

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

Container for response parameters to the RevokeVpcEndpointAccess operation. The response body for this operation is empty.

', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$RoleArn' => '

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

', ], ], 'RollbackOnDisable' => [ 'base' => '

Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.

', 'refs' => [ 'AutoTuneOptions$RollbackOnDisable' => '

Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3BucketName' => '

Name of the bucket containing the package.

', ], ], '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 SAML Identity Provider.

', ], ], 'SAMLIdp' => [ 'base' => '

Specifies the SAML Identity Provider\'s information.

', 'refs' => [ 'SAMLOptionsInput$Idp' => '

Specifies 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' => '

Specifies the SAML application configuration for the domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$SAMLOptions' => '

Specifies the SAML application configuration for the domain.

', ], ], 'SAMLOptionsOutput' => [ 'base' => '

Describes the SAML application configured for the domain.

', 'refs' => [ 'AdvancedSecurityOptions$SAMLOptions' => '

Describes the SAML application configured for a domain.

', ], ], 'ScheduledAutoTuneActionType' => [ 'base' => '

Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

', 'refs' => [ 'ScheduledAutoTuneDetails$ActionType' => '

Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

', ], ], 'ScheduledAutoTuneDescription' => [ 'base' => '

Specifies Auto-Tune action description.

', 'refs' => [ 'ScheduledAutoTuneDetails$Action' => '

Specifies Auto-Tune action description.

', ], ], 'ScheduledAutoTuneDetails' => [ 'base' => '

Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.

', 'refs' => [ 'AutoTuneDetails$ScheduledAutoTuneDetails' => NULL, ], ], 'ScheduledAutoTuneSeverityType' => [ 'base' => '

Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.

', 'refs' => [ 'ScheduledAutoTuneDetails$Severity' => '

Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.

', ], ], 'ServiceSoftwareOptions' => [ 'base' => '

The current options of an Elasticsearch domain service software options.

', 'refs' => [ 'CancelElasticsearchServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

The current status of the Elasticsearch service software update.

', 'ElasticsearchDomainStatus$ServiceSoftwareOptions' => '

The current status of the Elasticsearch domain\'s service software.

', 'StartElasticsearchServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

The current status of the Elasticsearch service software update.

', ], ], 'ServiceUrl' => [ 'base' => '

The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com.

', 'refs' => [ 'ElasticsearchDomainStatus$Endpoint' => '

The Elasticsearch domain endpoint that you use to submit index and search requests.

', 'EndpointsMap$value' => NULL, ], ], 'SnapshotOptions' => [ 'base' => '

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

', 'refs' => [ 'CreateElasticsearchDomainRequest$SnapshotOptions' => '

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

', 'ElasticsearchDomainStatus$SnapshotOptions' => '

Specifies the status of the SnapshotOptions

', 'SnapshotOptionsStatus$Options' => '

Specifies the daily snapshot options specified for the Elasticsearch domain.

', 'UpdateElasticsearchDomainConfigRequest$SnapshotOptions' => '

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

', ], ], 'SnapshotOptionsStatus' => [ 'base' => '

Status of a daily automated snapshot.

', 'refs' => [ 'ElasticsearchDomainConfig$SnapshotOptions' => '

Specifies the SnapshotOptions for the Elasticsearch domain.

', ], ], 'StartAt' => [ 'base' => NULL, 'refs' => [ 'AutoTuneMaintenanceSchedule$StartAt' => '

Specifies timestamp at which Auto-Tune maintenance schedule start.

', ], ], 'StartElasticsearchServiceSoftwareUpdateRequest' => [ 'base' => '

Container for the parameters to the StartElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.

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

The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

', 'refs' => [], ], 'StartTimestamp' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StartTimestamp' => '

UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.

', ], ], 'StorageSubTypeName' => [ 'base' => '

SubType of the given storage type. List of available sub-storage options: For "instance" storageType we wont have any storageSubType, in case of "ebs" storageType we will have following valid storageSubTypes

  1. standard
  2. gp2
  3. gp3
  4. io1
Refer VolumeType for more information regarding above EBS storage options.

', 'refs' => [ 'StorageType$StorageSubTypeName' => NULL, ], ], 'StorageType' => [ 'base' => '

StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.

', 'refs' => [ 'StorageTypeList$member' => NULL, ], ], 'StorageTypeLimit' => [ 'base' => '

Limits that are applicable for given storage type.

', 'refs' => [ 'StorageTypeLimitList$member' => NULL, ], ], 'StorageTypeLimitList' => [ 'base' => NULL, 'refs' => [ 'StorageType$StorageTypeLimits' => '

List of limits that are applicable for given storage type.

', ], ], 'StorageTypeList' => [ 'base' => NULL, 'refs' => [ 'Limits$StorageTypes' => '

StorageType represents the list of storage related types and attributes that are available for given InstanceType.

', ], ], 'StorageTypeName' => [ 'base' => '

Type of the storage. List of available storage options:

  1. instance
    2. Inbuilt storage available for the given Instance
  2. ebs
    3. Elastic block storage that would be attached to the given Instance

', 'refs' => [ 'StorageType$StorageTypeName' => NULL, ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AdvancedOptions$key' => NULL, 'AdvancedOptions$value' => NULL, 'AuthorizedPrincipal$Principal' => '

The IAM principal that is allowed access to the domain.

', 'AutoTuneMaintenanceSchedule$CronExpressionForRecurrence' => '

Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.

', 'AutoTuneOptionsOutput$ErrorMessage' => '

Specifies the error message while enabling or disabling the Auto-Tune.

', 'AutoTuneStatus$ErrorMessage' => '

Specifies the error message while enabling or disabling the Auto-Tune options.

', 'DescribePackagesResponse$NextToken' => NULL, 'DescribeReservedElasticsearchInstancesResponse$NextToken' => '

Provides an identifier to allow retrieval of paginated results.

', 'EndpointsMap$key' => NULL, 'GetPackageVersionHistoryResponse$NextToken' => NULL, 'GetUpgradeHistoryResponse$NextToken' => '

Pagination token that needs to be supplied to the next call to get the next page of results

', 'ListDomainsForPackageResponse$NextToken' => NULL, 'ListPackagesForDomainResponse$NextToken' => '

Pagination token that needs to be supplied to the next call to get the next page of results.

', 'RecurringCharge$RecurringChargeFrequency' => '

The frequency of the recurring charge.

', 'ReservedElasticsearchInstance$ReservedElasticsearchInstanceOfferingId' => '

The offering identifier.

', 'ReservedElasticsearchInstance$CurrencyCode' => '

The currency code for the reserved Elasticsearch instance offering.

', 'ReservedElasticsearchInstance$State' => '

The state of the reserved Elasticsearch instance.

', 'ReservedElasticsearchInstanceOffering$CurrencyCode' => '

The currency code for the reserved Elasticsearch instance offering.

', 'SAMLOptionsInput$SubjectKey' => '

The key to use for matching the SAML Subject attribute.

', 'SAMLOptionsInput$RolesKey' => '

The key to use for matching the SAML Roles attribute.

', 'SAMLOptionsOutput$SubjectKey' => '

The key used for matching the SAML Subject attribute.

', 'SAMLOptionsOutput$RolesKey' => '

The key used for matching the SAML Roles attribute.

', 'ServiceSoftwareOptions$CurrentVersion' => '

The current service software version that is present on the domain.

', 'ServiceSoftwareOptions$NewVersion' => '

The new service software version if one is available.

', 'ServiceSoftwareOptions$Description' => '

The description of the UpdateStatus.

', 'StringList$member' => NULL, 'VPCDerivedInfo$VPCId' => '

The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

', 'VpcEndpointError$ErrorMessage' => '

A message describing the error.

', 'VpcEndpointSummary$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$PendingProperties' => '

The list of properties involved in the domain configuration change that are still in pending.

', 'ChangeProgressStatusDetails$CompletedProperties' => '

The list of properties involved in the domain configuration change that are completed.

', 'RemoveTagsRequest$TagKeys' => '

Specifies the TagKey list which you want to remove from the Elasticsearch domain.

', 'VPCDerivedInfo$SubnetIds' => '

Specifies the subnets for VPC endpoint.

', 'VPCDerivedInfo$AvailabilityZones' => '

The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

', 'VPCDerivedInfo$SecurityGroupIds' => '

Specifies the security groups for VPC endpoint.

', 'VPCOptions$SubnetIds' => '

Specifies the subnets for VPC endpoint.

', 'VPCOptions$SecurityGroupIds' => '

Specifies the security groups for VPC endpoint.

', ], ], 'TLSSecurityPolicy' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$TLSSecurityPolicy' => '

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It 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

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

Specifies a key value pair for a resource tag.

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

A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

', 'refs' => [ 'Tag$Key' => '

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

', ], ], 'TagList' => [ 'base' => '

A list of Tag

', 'refs' => [ 'AddTagsRequest$TagList' => '

List of Tag that need to be added for the Elasticsearch domain.

', 'CreateElasticsearchDomainRequest$TagList' => '

A list of Tag added during domain creation.

', 'ListTagsResponse$TagList' => '

List of Tag for the requested Elasticsearch domain.

', ], ], 'TagValue' => [ 'base' => '

A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set.

', 'refs' => [ 'Tag$Value' => '

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

', ], ], 'TimeUnit' => [ 'base' => '

Specifies the unit of a maintenance schedule duration. Valid value is HOUR. See the Developer Guide for more information.

', 'refs' => [ 'Duration$Unit' => '

Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.

', ], ], 'TotalNumberOfStages' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$TotalNumberOfStages' => '

The total number of stages required for the configuration change.

', ], ], 'UIntValue' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$UpdateVersion' => '

Specifies the Auto-Tune options latest version.

', 'OptionStatus$UpdateVersion' => '

Specifies the latest version for the entity.

', ], ], 'UpdateElasticsearchDomainConfigRequest' => [ 'base' => '

Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

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

The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.

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

Container for request parameters to UpdatePackage operation.

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

Container for response returned by UpdatePackage operation.

', 'refs' => [], ], 'UpdateTimestamp' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$CreationDate' => '

Timestamp which tells Auto-Tune options creation date .

', 'AutoTuneStatus$UpdateDate' => '

Timestamp which tells Auto-Tune options last updated time.

', 'ChangeProgressStatusDetails$StartTime' => '

The time at which the configuration change is made on the domain.

', 'OptionStatus$CreationDate' => '

Timestamp which tells the creation date for the entity.

', 'OptionStatus$UpdateDate' => '

Timestamp which tells the last updated time for the entity.

', 'ReservedElasticsearchInstance$StartTime' => '

The time the reservation started.

', ], ], 'UpdateVpcEndpointRequest' => [ 'base' => '

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

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

Contains the configuration and status of the VPC endpoint being updated.

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

Container for request parameters to UpgradeElasticsearchDomain operation.

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

Container for response returned by UpgradeElasticsearchDomain operation.

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

History of the last 10 Upgrades and Upgrade Eligibility Checks.

', 'refs' => [ 'UpgradeHistoryList$member' => NULL, ], ], 'UpgradeHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeHistoryResponse$UpgradeHistories' => '

A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object.

', ], ], 'UpgradeName' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeName' => '

A string that describes the update briefly

', 'UpgradeHistory$UpgradeName' => '

A string that describes the update briefly

', ], ], 'UpgradeStatus' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$StepStatus' => '

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

', 'UpgradeHistory$UpgradeStatus' => '

The overall status of the update. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

', 'UpgradeStepItem$UpgradeStepStatus' => '

The status of a particular step during an upgrade. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

', ], ], 'UpgradeStep' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeStep' => '

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

', 'UpgradeStepItem$UpgradeStep' => '

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

', ], ], 'UpgradeStepItem' => [ 'base' => '

Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

', 'refs' => [ 'UpgradeStepsList$member' => NULL, ], ], 'UpgradeStepsList' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StepsList' => '

A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.

', ], ], 'UserPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$UserPoolId' => '

Specifies the Cognito user pool ID for Kibana authentication.

', ], ], 'Username' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserName' => '

The master user\'s username, which is stored in the Amazon Elasticsearch Service domain\'s internal database.

', 'SAMLOptionsInput$MasterUserName' => '

The SAML master username, which is stored in the Amazon Elasticsearch Service domain\'s internal database.

', ], ], 'VPCDerivedInfo' => [ 'base' => '

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

', 'refs' => [ 'ElasticsearchDomainStatus$VPCOptions' => '

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

', 'VPCDerivedInfoStatus$Options' => '

Specifies the VPC options for the specified Elasticsearch 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 the specified Elasticsearch domain.

', 'refs' => [ 'ElasticsearchDomainConfig$VPCOptions' => '

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

', ], ], 'VPCOptions' => [ 'base' => '

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

', 'refs' => [ 'CreateElasticsearchDomainRequest$VPCOptions' => '

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

', 'CreateVpcEndpointRequest$VpcOptions' => '

Options to specify the subnets and security groups for the endpoint.

', 'UpdateElasticsearchDomainConfigRequest$VPCOptions' => '

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

', 'UpdateVpcEndpointRequest$VpcOptions' => '

The security groups and/or subnets to add, remove, or modify.

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

An exception for missing / invalid input fields. Gives http status code of 400.

', 'refs' => [], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

Contains one or more values for the filter.

', ], ], 'VolumeType' => [ 'base' => '

The type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based Storagefor more information.

', 'refs' => [ 'EBSOptions$VolumeType' => '

Specifies the volume type for EBS-based storage.

', ], ], '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' => '

Specifies the error code of the failure encountered while describing the VPC endpoint:

  • ENDPOINT_NOT_FOUND: Indicates that the requested VPC endpoint does not exist.
  • SERVER_ERROR: Indicates the describe endpoint operation failed due to an internal server error.

', '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 to be deleted.

', 'UpdateVpcEndpointRequest$VpcEndpointId' => '

Unique identifier of the VPC endpoint to be updated.

', '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' => '

Specifies the current status of the VPC endpoint:

  • CREATING: Indicates that the VPC endpoint is currently being created.
  • CREATE_FAILED: Indicates that the VPC endpoint creation failed.
  • ACTIVE: Indicates that the VPC endpoint is currently active.
  • UPDATING: Indicates that the VPC endpoint is currently being updated.
  • UPDATE_FAILED: Indicates that the VPC endpoint update failed.
  • DELETING: Indicates that the VPC endpoint is currently being deleted.
  • DELETE_FAILED: Indicates that the VPC endpoint deletion failed.

', 'refs' => [ 'VpcEndpoint$Status' => '

The current status of the endpoint.

', 'VpcEndpointSummary$Status' => '

The current status of the endpoint.

', ], ], 'VpcEndpointSummary' => [ 'base' => '

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'DeleteVpcEndpointResponse$VpcEndpointSummary' => '

Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).

', 'VpcEndpointSummaryList$member' => NULL, ], ], 'VpcEndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointsForDomainResponse$VpcEndpointSummaryList' => '

Provides list of VpcEndpointSummary summarizing details of the VPC endpoints.

', 'ListVpcEndpointsResponse$VpcEndpointSummaryList' => '

Information about each endpoint.

', ], ], 'VpcEndpoints' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpoints' => '

Information about each requested VPC endpoint.

', ], ], 'ZoneAwarenessConfig' => [ 'base' => '

Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.

', 'refs' => [ 'ElasticsearchClusterConfig$ZoneAwarenessConfig' => '

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

', ], ], ],]; diff --git a/src/data/es/2015-01-01/endpoint-rule-set-1.json b/src/data/es/2015-01-01/endpoint-rule-set-1.json index 4d07181f86..fbf68aefdb 100644 --- a/src/data/es/2015-01-01/endpoint-rule-set-1.json +++ b/src/data/es/2015-01-01/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,11 +212,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -231,14 +227,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,7 +250,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -272,8 +269,82 @@ ] } ], - "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://aos.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-cn", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://aos.{Region}.api.amazonwebservices.com.cn", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://aos.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { @@ -283,14 +354,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -301,9 +374,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/src/data/es/2015-01-01/endpoint-rule-set-1.json.php b/src/data/es/2015-01-01/endpoint-rule-set-1.json.php index 2ecd3b7517..257611dd9a 100644 --- a/src/data/es/2015-01-01/endpoint-rule-set-1.json.php +++ b/src/data/es/2015-01-01/endpoint-rule-set-1.json.php @@ -1,3 +1,3 @@ '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://es-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://es-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://es.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://es.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ],]; +return [ 'version' => '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://es-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], true, ], ], ], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://es-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'stringEquals', 'argv' => [ 'aws', [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'name', ], ], ], ], ], 'endpoint' => [ 'url' => 'https://aos.{Region}.api.aws', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], [ 'conditions' => [ [ 'fn' => 'stringEquals', 'argv' => [ 'aws-cn', [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'name', ], ], ], ], ], 'endpoint' => [ 'url' => 'https://aos.{Region}.api.amazonwebservices.com.cn', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], [ 'conditions' => [ [ 'fn' => 'stringEquals', 'argv' => [ 'aws-us-gov', [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'name', ], ], ], ], ], 'endpoint' => [ 'url' => 'https://aos.{Region}.api.aws', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://es.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://es.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ],]; diff --git a/src/data/es/2015-01-01/endpoint-tests-1.json b/src/data/es/2015-01-01/endpoint-tests-1.json index 491f64e69d..f65ad7d5a5 100644 --- a/src/data/es/2015-01-01/endpoint-tests-1.json +++ b/src/data/es/2015-01-01/endpoint-tests-1.json @@ -355,7 +355,7 @@ "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://es.us-east-1.api.aws" + "url": "https://aos.us-east-1.api.aws" } }, "params": { @@ -420,7 +420,7 @@ "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://es.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://aos.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { @@ -498,7 +498,7 @@ "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://es.us-gov-east-1.api.aws" + "url": "https://aos.us-gov-east-1.api.aws" } }, "params": { diff --git a/src/data/es/2015-01-01/endpoint-tests-1.json.php b/src/data/es/2015-01-01/endpoint-tests-1.json.php index 180a8075f2..dfef1b0877 100644 --- a/src/data/es/2015-01-01/endpoint-tests-1.json.php +++ b/src/data/es/2015-01-01/endpoint-tests-1.json.php @@ -1,3 +1,3 @@ [ [ 'documentation' => 'For region af-south-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.af-south-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'af-south-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-northeast-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-northeast-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-northeast-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-northeast-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-northeast-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-northeast-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-northeast-3 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-northeast-3.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-northeast-3', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-south-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-south-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-south-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-southeast-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-southeast-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-southeast-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-southeast-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-southeast-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-southeast-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-southeast-3 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-southeast-3.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-southeast-3', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ca-central-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ca-central-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'ca-central-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-central-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-central-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-central-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-north-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-north-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-north-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-south-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-south-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-south-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-west-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-west-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-west-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-west-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-west-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-west-3 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-west-3.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-west-3', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region me-south-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.me-south-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'me-south-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region sa-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.sa-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'sa-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-east-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-2 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-east-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-2', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-west-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-west-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-west-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-west-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-west-2 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-west-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-2', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-northwest-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.cn-northwest-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-northwest-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-west-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-gov-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-west-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-west-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-gov-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-west-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-west-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-iso-west-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-west-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For custom endpoint with region set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with region not set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips enabled and dualstack disabled', 'expect' => [ 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips disabled and dualstack enabled', 'expect' => [ 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'Missing region', 'expect' => [ 'error' => 'Invalid Configuration: Missing Region', ], ], ], 'version' => '1.0',]; +return [ 'testCases' => [ [ 'documentation' => 'For region af-south-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.af-south-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'af-south-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-northeast-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-northeast-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-northeast-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-northeast-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-northeast-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-northeast-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-northeast-3 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-northeast-3.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-northeast-3', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-south-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-south-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-south-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-southeast-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-southeast-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-southeast-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-southeast-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-southeast-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-southeast-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ap-southeast-3 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ap-southeast-3.amazonaws.com', ], ], 'params' => [ 'Region' => 'ap-southeast-3', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region ca-central-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.ca-central-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'ca-central-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-central-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-central-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-central-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-north-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-north-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-north-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-south-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-south-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-south-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-west-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-west-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-west-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-west-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-west-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region eu-west-3 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.eu-west-3.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-west-3', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region me-south-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.me-south-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'me-south-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region sa-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.sa-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'sa-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-east-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-2 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-east-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-2', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-west-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-west-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-west-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-west-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-west-2 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-west-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-2', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://aos.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-northwest-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.cn-northwest-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-northwest-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://aos.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-west-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-gov-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-west-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-west-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-gov-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-west-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://aos.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-west-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-iso-west-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-west-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://es-fips.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For custom endpoint with region set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with region not set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips enabled and dualstack disabled', 'expect' => [ 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips disabled and dualstack enabled', 'expect' => [ 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'Missing region', 'expect' => [ 'error' => 'Invalid Configuration: Missing Region', ], ], ], 'version' => '1.0',]; diff --git a/src/data/lightsail/2016-11-28/api-2.json b/src/data/lightsail/2016-11-28/api-2.json index 8030a3ca13..9e01a41940 100644 --- a/src/data/lightsail/2016-11-28/api-2.json +++ b/src/data/lightsail/2016-11-28/api-2.json @@ -2153,6 +2153,22 @@ {"shape":"UnauthenticatedException"} ] }, + "GetSetupHistory":{ + "name":"GetSetupHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSetupHistoryRequest"}, + "output":{"shape":"GetSetupHistoryResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"UnauthenticatedException"} + ] + }, "GetStaticIp":{ "name":"GetStaticIp", "http":{ @@ -2434,6 +2450,22 @@ {"shape":"UnauthenticatedException"} ] }, + "SetupInstanceHttps":{ + "name":"SetupInstanceHttps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetupInstanceHttpsRequest"}, + "output":{"shape":"SetupInstanceHttpsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"UnauthenticatedException"} + ] + }, "StartGUISession":{ "name":"StartGUISession", "http":{ @@ -3324,6 +3356,10 @@ ] }, "CertificateName":{"type":"string"}, + "CertificateProvider":{ + "type":"string", + "enum":["LetsEncrypt"] + }, "CertificateStatus":{ "type":"string", "enum":[ @@ -4833,6 +4869,13 @@ } }, "EligibleToRenew":{"type":"string"}, + "EmailAddress":{ + "type":"string", + "max":254, + "min":6, + "pattern":"^[\\w!#$%&.'*+\\/=?^_\\x60{|}~\\-]{1,64}@[a-zA-Z0-9\\-]{1,63}(\\.[a-zA-Z0-9\\-]{1,63}){0,8}(\\.[a-zA-Z]{2,63})$", + "sensitive":true + }, "EnableAddOnRequest":{ "type":"structure", "required":[ @@ -5874,6 +5917,21 @@ "nextPageToken":{"shape":"string"} } }, + "GetSetupHistoryRequest":{ + "type":"structure", + "required":["resourceName"], + "members":{ + "resourceName":{"shape":"ResourceName"}, + "pageToken":{"shape":"SetupHistoryPageToken"} + } + }, + "GetSetupHistoryResult":{ + "type":"structure", + "members":{ + "setupHistory":{"shape":"setupHistoryList"}, + "nextPageToken":{"shape":"SetupHistoryPageToken"} + } + }, "GetStaticIpRequest":{ "type":"structure", "required":["staticIpName"], @@ -6885,7 +6943,8 @@ "SetResourceAccessForBucket", "UpdateInstanceMetadataOptions", "StartGUISession", - "StopGUISession" + "StopGUISession", + "SetupInstanceHttps" ] }, "Origin":{ @@ -7558,6 +7617,97 @@ "operations":{"shape":"OperationList"} } }, + "SetupDomainName":{ + "type":"string", + "max":253, + "min":4, + "pattern":"^[a-zA-Z0-9\\-]{1,63}(\\.[a-zA-Z0-9\\-]{1,63}){0,8}(\\.[a-zA-Z]{2,63})$" + }, + "SetupDomainNameList":{ + "type":"list", + "member":{"shape":"SetupDomainName"}, + "max":10, + "min":1 + }, + "SetupExecutionDetails":{ + "type":"structure", + "members":{ + "command":{"shape":"string"}, + "dateTime":{"shape":"IsoDate"}, + "name":{"shape":"NonEmptyString"}, + "status":{"shape":"SetupStatus"}, + "standardError":{"shape":"string"}, + "standardOutput":{"shape":"string"}, + "version":{"shape":"string"} + } + }, + "SetupExecutionDetailsList":{ + "type":"list", + "member":{"shape":"SetupExecutionDetails"} + }, + "SetupHistory":{ + "type":"structure", + "members":{ + "operationId":{"shape":"NonEmptyString"}, + "request":{"shape":"SetupRequest"}, + "resource":{"shape":"SetupHistoryResource"}, + "executionDetails":{"shape":"SetupExecutionDetailsList"}, + "status":{"shape":"SetupStatus"} + } + }, + "SetupHistoryPageToken":{ + "type":"string", + "max":40, + "min":24, + "pattern":"^[A-Za-z0-9+/=]+$" + }, + "SetupHistoryResource":{ + "type":"structure", + "members":{ + "name":{"shape":"ResourceName"}, + "arn":{"shape":"NonEmptyString"}, + "createdAt":{"shape":"IsoDate"}, + "location":{"shape":"ResourceLocation"}, + "resourceType":{"shape":"ResourceType"} + } + }, + "SetupInstanceHttpsRequest":{ + "type":"structure", + "required":[ + "instanceName", + "emailAddress", + "domainNames", + "certificateProvider" + ], + "members":{ + "instanceName":{"shape":"ResourceName"}, + "emailAddress":{"shape":"EmailAddress"}, + "domainNames":{"shape":"SetupDomainNameList"}, + "certificateProvider":{"shape":"CertificateProvider"} + } + }, + "SetupInstanceHttpsResult":{ + "type":"structure", + "members":{ + "operations":{"shape":"OperationList"} + } + }, + "SetupRequest":{ + "type":"structure", + "members":{ + "instanceName":{"shape":"ResourceName"}, + "domainNames":{"shape":"SetupDomainNameList"}, + "certificateProvider":{"shape":"CertificateProvider"} + } + }, + "SetupStatus":{ + "type":"string", + "enum":[ + "succeeded", + "failed", + "inProgress" + ] + }, "StartGUISessionRequest":{ "type":"structure", "required":["resourceName"], @@ -7990,6 +8140,10 @@ "float":{"type":"float"}, "integer":{"type":"integer"}, "long":{"type":"long"}, + "setupHistoryList":{ + "type":"list", + "member":{"shape":"SetupHistory"} + }, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} } diff --git a/src/data/lightsail/2016-11-28/api-2.json.php b/src/data/lightsail/2016-11-28/api-2.json.php index 05346c4837..7394d89f13 100644 --- a/src/data/lightsail/2016-11-28/api-2.json.php +++ b/src/data/lightsail/2016-11-28/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2016-11-28', 'endpointPrefix' => 'lightsail', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'Amazon Lightsail', 'serviceId' => 'Lightsail', 'signatureVersion' => 'v4', 'targetPrefix' => 'Lightsail_20161128', 'uid' => 'lightsail-2016-11-28', ], 'operations' => [ 'AllocateStaticIp' => [ 'name' => 'AllocateStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocateStaticIpRequest', ], 'output' => [ 'shape' => 'AllocateStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachCertificateToDistribution' => [ 'name' => 'AttachCertificateToDistribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachCertificateToDistributionRequest', ], 'output' => [ 'shape' => 'AttachCertificateToDistributionResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachDisk' => [ 'name' => 'AttachDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachDiskRequest', ], 'output' => [ 'shape' => 'AttachDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachInstancesToLoadBalancer' => [ 'name' => 'AttachInstancesToLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachInstancesToLoadBalancerRequest', ], 'output' => [ 'shape' => 'AttachInstancesToLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachLoadBalancerTlsCertificate' => [ 'name' => 'AttachLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'AttachLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachStaticIp' => [ 'name' => 'AttachStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachStaticIpRequest', ], 'output' => [ 'shape' => 'AttachStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CloseInstancePublicPorts' => [ 'name' => 'CloseInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CloseInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'CloseInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CopySnapshot' => [ 'name' => 'CopySnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopySnapshotRequest', ], 'output' => [ 'shape' => 'CopySnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateBucket' => [ 'name' => 'CreateBucket', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBucketRequest', ], 'output' => [ 'shape' => 'CreateBucketResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateBucketAccessKey' => [ 'name' => 'CreateBucketAccessKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBucketAccessKeyRequest', ], 'output' => [ 'shape' => 'CreateBucketAccessKeyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateCertificate' => [ 'name' => 'CreateCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCertificateRequest', ], 'output' => [ 'shape' => 'CreateCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateCloudFormationStack' => [ 'name' => 'CreateCloudFormationStack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCloudFormationStackRequest', ], 'output' => [ 'shape' => 'CreateCloudFormationStackResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateContactMethod' => [ 'name' => 'CreateContactMethod', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContactMethodRequest', ], 'output' => [ 'shape' => 'CreateContactMethodResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateContainerService' => [ 'name' => 'CreateContainerService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContainerServiceRequest', ], 'output' => [ 'shape' => 'CreateContainerServiceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateContainerServiceDeployment' => [ 'name' => 'CreateContainerServiceDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContainerServiceDeploymentRequest', ], 'output' => [ 'shape' => 'CreateContainerServiceDeploymentResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateContainerServiceRegistryLogin' => [ 'name' => 'CreateContainerServiceRegistryLogin', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContainerServiceRegistryLoginRequest', ], 'output' => [ 'shape' => 'CreateContainerServiceRegistryLoginResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDisk' => [ 'name' => 'CreateDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskRequest', ], 'output' => [ 'shape' => 'CreateDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDiskFromSnapshot' => [ 'name' => 'CreateDiskFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateDiskFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDiskSnapshot' => [ 'name' => 'CreateDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskSnapshotRequest', ], 'output' => [ 'shape' => 'CreateDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDistribution' => [ 'name' => 'CreateDistribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDistributionRequest', ], 'output' => [ 'shape' => 'CreateDistributionResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDomainEntry' => [ 'name' => 'CreateDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainEntryRequest', ], 'output' => [ 'shape' => 'CreateDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateGUISessionAccessDetails' => [ 'name' => 'CreateGUISessionAccessDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGUISessionAccessDetailsRequest', ], 'output' => [ 'shape' => 'CreateGUISessionAccessDetailsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstanceSnapshot' => [ 'name' => 'CreateInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'CreateInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstances' => [ 'name' => 'CreateInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstancesRequest', ], 'output' => [ 'shape' => 'CreateInstancesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstancesFromSnapshot' => [ 'name' => 'CreateInstancesFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstancesFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateInstancesFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateKeyPair' => [ 'name' => 'CreateKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateKeyPairRequest', ], 'output' => [ 'shape' => 'CreateKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateLoadBalancer' => [ 'name' => 'CreateLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLoadBalancerRequest', ], 'output' => [ 'shape' => 'CreateLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateLoadBalancerTlsCertificate' => [ 'name' => 'CreateLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'CreateLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabase' => [ 'name' => 'CreateRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabaseFromSnapshot' => [ 'name' => 'CreateRelationalDatabaseFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabaseSnapshot' => [ 'name' => 'CreateRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteAlarm' => [ 'name' => 'DeleteAlarm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAlarmRequest', ], 'output' => [ 'shape' => 'DeleteAlarmResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'DeleteAutoSnapshot' => [ 'name' => 'DeleteAutoSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAutoSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteAutoSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteBucket' => [ 'name' => 'DeleteBucket', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBucketRequest', ], 'output' => [ 'shape' => 'DeleteBucketResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteBucketAccessKey' => [ 'name' => 'DeleteBucketAccessKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBucketAccessKeyRequest', ], 'output' => [ 'shape' => 'DeleteBucketAccessKeyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteCertificate' => [ 'name' => 'DeleteCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCertificateRequest', ], 'output' => [ 'shape' => 'DeleteCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteContactMethod' => [ 'name' => 'DeleteContactMethod', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContactMethodRequest', ], 'output' => [ 'shape' => 'DeleteContactMethodResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'DeleteContainerImage' => [ 'name' => 'DeleteContainerImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContainerImageRequest', ], 'output' => [ 'shape' => 'DeleteContainerImageResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteContainerService' => [ 'name' => 'DeleteContainerService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContainerServiceRequest', ], 'output' => [ 'shape' => 'DeleteContainerServiceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDisk' => [ 'name' => 'DeleteDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDiskRequest', ], 'output' => [ 'shape' => 'DeleteDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDiskSnapshot' => [ 'name' => 'DeleteDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDiskSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDistribution' => [ 'name' => 'DeleteDistribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDistributionRequest', ], 'output' => [ 'shape' => 'DeleteDistributionResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'output' => [ 'shape' => 'DeleteDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDomainEntry' => [ 'name' => 'DeleteDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainEntryRequest', ], 'output' => [ 'shape' => 'DeleteDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteInstance' => [ 'name' => 'DeleteInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInstanceRequest', ], 'output' => [ 'shape' => 'DeleteInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteInstanceSnapshot' => [ 'name' => 'DeleteInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteKeyPair' => [ 'name' => 'DeleteKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteKeyPairRequest', ], 'output' => [ 'shape' => 'DeleteKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteKnownHostKeys' => [ 'name' => 'DeleteKnownHostKeys', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteKnownHostKeysRequest', ], 'output' => [ 'shape' => 'DeleteKnownHostKeysResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteLoadBalancer' => [ 'name' => 'DeleteLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLoadBalancerRequest', ], 'output' => [ 'shape' => 'DeleteLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteLoadBalancerTlsCertificate' => [ 'name' => 'DeleteLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'DeleteLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteRelationalDatabase' => [ 'name' => 'DeleteRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'DeleteRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteRelationalDatabaseSnapshot' => [ 'name' => 'DeleteRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachCertificateFromDistribution' => [ 'name' => 'DetachCertificateFromDistribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachCertificateFromDistributionRequest', ], 'output' => [ 'shape' => 'DetachCertificateFromDistributionResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachDisk' => [ 'name' => 'DetachDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachDiskRequest', ], 'output' => [ 'shape' => 'DetachDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachInstancesFromLoadBalancer' => [ 'name' => 'DetachInstancesFromLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachInstancesFromLoadBalancerRequest', ], 'output' => [ 'shape' => 'DetachInstancesFromLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachStaticIp' => [ 'name' => 'DetachStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachStaticIpRequest', ], 'output' => [ 'shape' => 'DetachStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DisableAddOn' => [ 'name' => 'DisableAddOn', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableAddOnRequest', ], 'output' => [ 'shape' => 'DisableAddOnResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DownloadDefaultKeyPair' => [ 'name' => 'DownloadDefaultKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DownloadDefaultKeyPairRequest', ], 'output' => [ 'shape' => 'DownloadDefaultKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'EnableAddOn' => [ 'name' => 'EnableAddOn', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableAddOnRequest', ], 'output' => [ 'shape' => 'EnableAddOnResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ExportSnapshot' => [ 'name' => 'ExportSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExportSnapshotRequest', ], 'output' => [ 'shape' => 'ExportSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetActiveNames' => [ 'name' => 'GetActiveNames', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetActiveNamesRequest', ], 'output' => [ 'shape' => 'GetActiveNamesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetAlarms' => [ 'name' => 'GetAlarms', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAlarmsRequest', ], 'output' => [ 'shape' => 'GetAlarmsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'GetAutoSnapshots' => [ 'name' => 'GetAutoSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAutoSnapshotsRequest', ], 'output' => [ 'shape' => 'GetAutoSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBlueprints' => [ 'name' => 'GetBlueprints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBlueprintsRequest', ], 'output' => [ 'shape' => 'GetBlueprintsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBucketAccessKeys' => [ 'name' => 'GetBucketAccessKeys', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBucketAccessKeysRequest', ], 'output' => [ 'shape' => 'GetBucketAccessKeysResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBucketBundles' => [ 'name' => 'GetBucketBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBucketBundlesRequest', ], 'output' => [ 'shape' => 'GetBucketBundlesResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBucketMetricData' => [ 'name' => 'GetBucketMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBucketMetricDataRequest', ], 'output' => [ 'shape' => 'GetBucketMetricDataResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBuckets' => [ 'name' => 'GetBuckets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBucketsRequest', ], 'output' => [ 'shape' => 'GetBucketsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBundles' => [ 'name' => 'GetBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBundlesRequest', ], 'output' => [ 'shape' => 'GetBundlesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetCertificates' => [ 'name' => 'GetCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCertificatesRequest', ], 'output' => [ 'shape' => 'GetCertificatesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetCloudFormationStackRecords' => [ 'name' => 'GetCloudFormationStackRecords', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCloudFormationStackRecordsRequest', ], 'output' => [ 'shape' => 'GetCloudFormationStackRecordsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContactMethods' => [ 'name' => 'GetContactMethods', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContactMethodsRequest', ], 'output' => [ 'shape' => 'GetContactMethodsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerAPIMetadata' => [ 'name' => 'GetContainerAPIMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerAPIMetadataRequest', ], 'output' => [ 'shape' => 'GetContainerAPIMetadataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerImages' => [ 'name' => 'GetContainerImages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerImagesRequest', ], 'output' => [ 'shape' => 'GetContainerImagesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerLog' => [ 'name' => 'GetContainerLog', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerLogRequest', ], 'output' => [ 'shape' => 'GetContainerLogResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerServiceDeployments' => [ 'name' => 'GetContainerServiceDeployments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerServiceDeploymentsRequest', ], 'output' => [ 'shape' => 'GetContainerServiceDeploymentsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerServiceMetricData' => [ 'name' => 'GetContainerServiceMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerServiceMetricDataRequest', ], 'output' => [ 'shape' => 'GetContainerServiceMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerServicePowers' => [ 'name' => 'GetContainerServicePowers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerServicePowersRequest', ], 'output' => [ 'shape' => 'GetContainerServicePowersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerServices' => [ 'name' => 'GetContainerServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerServicesRequest', ], 'output' => [ 'shape' => 'ContainerServicesListResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetCostEstimate' => [ 'name' => 'GetCostEstimate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCostEstimateRequest', ], 'output' => [ 'shape' => 'GetCostEstimateResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDisk' => [ 'name' => 'GetDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskRequest', ], 'output' => [ 'shape' => 'GetDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDiskSnapshot' => [ 'name' => 'GetDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskSnapshotRequest', ], 'output' => [ 'shape' => 'GetDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDiskSnapshots' => [ 'name' => 'GetDiskSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskSnapshotsRequest', ], 'output' => [ 'shape' => 'GetDiskSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDisks' => [ 'name' => 'GetDisks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDisksRequest', ], 'output' => [ 'shape' => 'GetDisksResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDistributionBundles' => [ 'name' => 'GetDistributionBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDistributionBundlesRequest', ], 'output' => [ 'shape' => 'GetDistributionBundlesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDistributionLatestCacheReset' => [ 'name' => 'GetDistributionLatestCacheReset', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDistributionLatestCacheResetRequest', ], 'output' => [ 'shape' => 'GetDistributionLatestCacheResetResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDistributionMetricData' => [ 'name' => 'GetDistributionMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDistributionMetricDataRequest', ], 'output' => [ 'shape' => 'GetDistributionMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDistributions' => [ 'name' => 'GetDistributions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDistributionsRequest', ], 'output' => [ 'shape' => 'GetDistributionsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDomain' => [ 'name' => 'GetDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDomainRequest', ], 'output' => [ 'shape' => 'GetDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDomains' => [ 'name' => 'GetDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDomainsRequest', ], 'output' => [ 'shape' => 'GetDomainsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetExportSnapshotRecords' => [ 'name' => 'GetExportSnapshotRecords', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetExportSnapshotRecordsRequest', ], 'output' => [ 'shape' => 'GetExportSnapshotRecordsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstance' => [ 'name' => 'GetInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceRequest', ], 'output' => [ 'shape' => 'GetInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceAccessDetails' => [ 'name' => 'GetInstanceAccessDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceAccessDetailsRequest', ], 'output' => [ 'shape' => 'GetInstanceAccessDetailsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceMetricData' => [ 'name' => 'GetInstanceMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceMetricDataRequest', ], 'output' => [ 'shape' => 'GetInstanceMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstancePortStates' => [ 'name' => 'GetInstancePortStates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstancePortStatesRequest', ], 'output' => [ 'shape' => 'GetInstancePortStatesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceSnapshot' => [ 'name' => 'GetInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'GetInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceSnapshots' => [ 'name' => 'GetInstanceSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceSnapshotsRequest', ], 'output' => [ 'shape' => 'GetInstanceSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceState' => [ 'name' => 'GetInstanceState', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceStateRequest', ], 'output' => [ 'shape' => 'GetInstanceStateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstances' => [ 'name' => 'GetInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstancesRequest', ], 'output' => [ 'shape' => 'GetInstancesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetKeyPair' => [ 'name' => 'GetKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetKeyPairRequest', ], 'output' => [ 'shape' => 'GetKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetKeyPairs' => [ 'name' => 'GetKeyPairs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetKeyPairsRequest', ], 'output' => [ 'shape' => 'GetKeyPairsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancer' => [ 'name' => 'GetLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancerMetricData' => [ 'name' => 'GetLoadBalancerMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerMetricDataRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancerTlsCertificates' => [ 'name' => 'GetLoadBalancerTlsCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerTlsCertificatesRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerTlsCertificatesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancerTlsPolicies' => [ 'name' => 'GetLoadBalancerTlsPolicies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerTlsPoliciesRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerTlsPoliciesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'InvalidInputException', ], ], ], 'GetLoadBalancers' => [ 'name' => 'GetLoadBalancers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancersRequest', ], 'output' => [ 'shape' => 'GetLoadBalancersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperation' => [ 'name' => 'GetOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationRequest', ], 'output' => [ 'shape' => 'GetOperationResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperations' => [ 'name' => 'GetOperations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationsRequest', ], 'output' => [ 'shape' => 'GetOperationsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperationsForResource' => [ 'name' => 'GetOperationsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationsForResourceRequest', ], 'output' => [ 'shape' => 'GetOperationsForResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRegions' => [ 'name' => 'GetRegions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRegionsRequest', ], 'output' => [ 'shape' => 'GetRegionsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabase' => [ 'name' => 'GetRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseBlueprints' => [ 'name' => 'GetRelationalDatabaseBlueprints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseBlueprintsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseBlueprintsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseBundles' => [ 'name' => 'GetRelationalDatabaseBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseBundlesRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseBundlesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseEvents' => [ 'name' => 'GetRelationalDatabaseEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseEventsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseEventsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseLogEvents' => [ 'name' => 'GetRelationalDatabaseLogEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseLogEventsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseLogEventsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseLogStreams' => [ 'name' => 'GetRelationalDatabaseLogStreams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseLogStreamsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseLogStreamsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseMasterUserPassword' => [ 'name' => 'GetRelationalDatabaseMasterUserPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseMasterUserPasswordRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseMasterUserPasswordResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseMetricData' => [ 'name' => 'GetRelationalDatabaseMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseMetricDataRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseParameters' => [ 'name' => 'GetRelationalDatabaseParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseParametersRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseParametersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseSnapshot' => [ 'name' => 'GetRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseSnapshots' => [ 'name' => 'GetRelationalDatabaseSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseSnapshotsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabases' => [ 'name' => 'GetRelationalDatabases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabasesRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabasesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetStaticIp' => [ 'name' => 'GetStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStaticIpRequest', ], 'output' => [ 'shape' => 'GetStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetStaticIps' => [ 'name' => 'GetStaticIps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStaticIpsRequest', ], 'output' => [ 'shape' => 'GetStaticIpsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ImportKeyPair' => [ 'name' => 'ImportKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportKeyPairRequest', ], 'output' => [ 'shape' => 'ImportKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'IsVpcPeered' => [ 'name' => 'IsVpcPeered', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'IsVpcPeeredRequest', ], 'output' => [ 'shape' => 'IsVpcPeeredResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'OpenInstancePublicPorts' => [ 'name' => 'OpenInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'OpenInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'OpenInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'PeerVpc' => [ 'name' => 'PeerVpc', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PeerVpcRequest', ], 'output' => [ 'shape' => 'PeerVpcResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'PutAlarm' => [ 'name' => 'PutAlarm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAlarmRequest', ], 'output' => [ 'shape' => 'PutAlarmResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'PutInstancePublicPorts' => [ 'name' => 'PutInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'PutInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'RebootInstance' => [ 'name' => 'RebootInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootInstanceRequest', ], 'output' => [ 'shape' => 'RebootInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'RebootRelationalDatabase' => [ 'name' => 'RebootRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'RebootRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'RegisterContainerImage' => [ 'name' => 'RegisterContainerImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterContainerImageRequest', ], 'output' => [ 'shape' => 'RegisterContainerImageResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ReleaseStaticIp' => [ 'name' => 'ReleaseStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ReleaseStaticIpRequest', ], 'output' => [ 'shape' => 'ReleaseStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ResetDistributionCache' => [ 'name' => 'ResetDistributionCache', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDistributionCacheRequest', ], 'output' => [ 'shape' => 'ResetDistributionCacheResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'SendContactMethodVerification' => [ 'name' => 'SendContactMethodVerification', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendContactMethodVerificationRequest', ], 'output' => [ 'shape' => 'SendContactMethodVerificationResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'SetIpAddressType' => [ 'name' => 'SetIpAddressType', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetIpAddressTypeRequest', ], 'output' => [ 'shape' => 'SetIpAddressTypeResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'SetResourceAccessForBucket' => [ 'name' => 'SetResourceAccessForBucket', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetResourceAccessForBucketRequest', ], 'output' => [ 'shape' => 'SetResourceAccessForBucketResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StartGUISession' => [ 'name' => 'StartGUISession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartGUISessionRequest', ], 'output' => [ 'shape' => 'StartGUISessionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StartInstance' => [ 'name' => 'StartInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartInstanceRequest', ], 'output' => [ 'shape' => 'StartInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StartRelationalDatabase' => [ 'name' => 'StartRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'StartRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StopGUISession' => [ 'name' => 'StopGUISession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopGUISessionRequest', ], 'output' => [ 'shape' => 'StopGUISessionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StopInstance' => [ 'name' => 'StopInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInstanceRequest', ], 'output' => [ 'shape' => 'StopInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StopRelationalDatabase' => [ 'name' => 'StopRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'StopRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'TestAlarm' => [ 'name' => 'TestAlarm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TestAlarmRequest', ], 'output' => [ 'shape' => 'TestAlarmResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'UnpeerVpc' => [ 'name' => 'UnpeerVpc', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UnpeerVpcRequest', ], 'output' => [ 'shape' => 'UnpeerVpcResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateBucket' => [ 'name' => 'UpdateBucket', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateBucketRequest', ], 'output' => [ 'shape' => 'UpdateBucketResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateBucketBundle' => [ 'name' => 'UpdateBucketBundle', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateBucketBundleRequest', ], 'output' => [ 'shape' => 'UpdateBucketBundleResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateContainerService' => [ 'name' => 'UpdateContainerService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerServiceRequest', ], 'output' => [ 'shape' => 'UpdateContainerServiceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateDistribution' => [ 'name' => 'UpdateDistribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDistributionRequest', ], 'output' => [ 'shape' => 'UpdateDistributionResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateDistributionBundle' => [ 'name' => 'UpdateDistributionBundle', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDistributionBundleRequest', ], 'output' => [ 'shape' => 'UpdateDistributionBundleResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateDomainEntry' => [ 'name' => 'UpdateDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDomainEntryRequest', ], 'output' => [ 'shape' => 'UpdateDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateInstanceMetadataOptions' => [ 'name' => 'UpdateInstanceMetadataOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInstanceMetadataOptionsRequest', ], 'output' => [ 'shape' => 'UpdateInstanceMetadataOptionsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateLoadBalancerAttribute' => [ 'name' => 'UpdateLoadBalancerAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateLoadBalancerAttributeRequest', ], 'output' => [ 'shape' => 'UpdateLoadBalancerAttributeResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateRelationalDatabase' => [ 'name' => 'UpdateRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'UpdateRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateRelationalDatabaseParameters' => [ 'name' => 'UpdateRelationalDatabaseParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRelationalDatabaseParametersRequest', ], 'output' => [ 'shape' => 'UpdateRelationalDatabaseParametersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'AccessDirection' => [ 'type' => 'string', 'enum' => [ 'inbound', 'outbound', ], ], 'AccessKey' => [ 'type' => 'structure', 'members' => [ 'accessKeyId' => [ 'shape' => 'IAMAccessKeyId', ], 'secretAccessKey' => [ 'shape' => 'NonEmptyString', ], 'status' => [ 'shape' => 'StatusType', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'lastUsed' => [ 'shape' => 'AccessKeyLastUsed', ], ], ], 'AccessKeyLastUsed' => [ 'type' => 'structure', 'members' => [ 'lastUsedDate' => [ 'shape' => 'IsoDate', ], 'region' => [ 'shape' => 'string', ], 'serviceName' => [ 'shape' => 'string', ], ], ], 'AccessKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessKey', ], ], 'AccessReceiverList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceReceivingAccess', ], ], 'AccessRules' => [ 'type' => 'structure', 'members' => [ 'getObject' => [ 'shape' => 'AccessType', ], 'allowPublicOverrides' => [ 'shape' => 'boolean', ], ], ], 'AccessType' => [ 'type' => 'string', 'enum' => [ 'public', 'private', ], ], 'AccountLevelBpaSync' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'AccountLevelBpaSyncStatus', ], 'lastSyncedAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'BPAStatusMessage', ], 'bpaImpactsLightsail' => [ 'shape' => 'boolean', ], ], ], 'AccountLevelBpaSyncStatus' => [ 'type' => 'string', 'enum' => [ 'InSync', 'Failed', 'NeverSynced', 'Defaulted', ], ], 'AccountSetupInProgressException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'AddOn' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'string', ], 'status' => [ 'shape' => 'string', ], 'snapshotTimeOfDay' => [ 'shape' => 'TimeOfDay', ], 'nextSnapshotTimeOfDay' => [ 'shape' => 'TimeOfDay', ], 'threshold' => [ 'shape' => 'string', ], 'duration' => [ 'shape' => 'string', ], ], ], 'AddOnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AddOn', ], ], 'AddOnRequest' => [ 'type' => 'structure', 'required' => [ 'addOnType', ], 'members' => [ 'addOnType' => [ 'shape' => 'AddOnType', ], 'autoSnapshotAddOnRequest' => [ 'shape' => 'AutoSnapshotAddOnRequest', ], 'stopInstanceOnIdleRequest' => [ 'shape' => 'StopInstanceOnIdleRequest', ], ], ], 'AddOnRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AddOnRequest', ], ], 'AddOnType' => [ 'type' => 'string', 'enum' => [ 'AutoSnapshot', 'StopInstanceOnIdle', ], ], 'Alarm' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'supportCode' => [ 'shape' => 'string', ], 'monitoredResourceInfo' => [ 'shape' => 'MonitoredResourceInfo', ], 'comparisonOperator' => [ 'shape' => 'ComparisonOperator', ], 'evaluationPeriods' => [ 'shape' => 'integer', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'threshold' => [ 'shape' => 'double', ], 'datapointsToAlarm' => [ 'shape' => 'integer', ], 'treatMissingData' => [ 'shape' => 'TreatMissingData', ], 'statistic' => [ 'shape' => 'MetricStatistic', ], 'metricName' => [ 'shape' => 'MetricName', ], 'state' => [ 'shape' => 'AlarmState', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'contactProtocols' => [ 'shape' => 'ContactProtocolsList', ], 'notificationTriggers' => [ 'shape' => 'NotificationTriggerList', ], 'notificationEnabled' => [ 'shape' => 'boolean', ], ], ], 'AlarmState' => [ 'type' => 'string', 'enum' => [ 'OK', 'ALARM', 'INSUFFICIENT_DATA', ], ], 'AlarmsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Alarm', ], ], 'AllocateStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'AllocateStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AppCategory' => [ 'type' => 'string', 'enum' => [ 'LfR', ], ], 'AppCategoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppCategory', ], ], 'AttachCertificateToDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'distributionName', 'certificateName', ], 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], ], ], 'AttachCertificateToDistributionResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'AttachDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'instanceName', 'diskPath', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'diskPath' => [ 'shape' => 'NonEmptyString', ], 'autoMounting' => [ 'shape' => 'boolean', ], ], ], 'AttachDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachInstancesToLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instanceNames', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instanceNames' => [ 'shape' => 'ResourceNameList', ], ], ], 'AttachInstancesToLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], ], ], 'AttachLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', 'instanceName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'AttachStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachedDisk' => [ 'type' => 'structure', 'members' => [ 'path' => [ 'shape' => 'string', ], 'sizeInGb' => [ 'shape' => 'integer', ], ], ], 'AttachedDiskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachedDisk', ], ], 'AttachedDiskMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceName', ], 'value' => [ 'shape' => 'DiskMapList', ], ], 'AutoMountStatus' => [ 'type' => 'string', 'enum' => [ 'Failed', 'Pending', 'Mounted', 'NotMounted', ], ], 'AutoSnapshotAddOnRequest' => [ 'type' => 'structure', 'members' => [ 'snapshotTimeOfDay' => [ 'shape' => 'TimeOfDay', ], ], ], 'AutoSnapshotDate' => [ 'type' => 'string', 'pattern' => '^[0-9]{4}-[0-9]{2}-[0-9]{2}$', ], 'AutoSnapshotDetails' => [ 'type' => 'structure', 'members' => [ 'date' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'status' => [ 'shape' => 'AutoSnapshotStatus', ], 'fromAttachedDisks' => [ 'shape' => 'AttachedDiskList', ], ], ], 'AutoSnapshotDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoSnapshotDetails', ], ], 'AutoSnapshotStatus' => [ 'type' => 'string', 'enum' => [ 'Success', 'Failed', 'InProgress', 'NotFound', ], ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'zoneName' => [ 'shape' => 'NonEmptyString', ], 'state' => [ 'shape' => 'NonEmptyString', ], ], ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', ], ], 'BPAStatusMessage' => [ 'type' => 'string', 'enum' => [ 'DEFAULTED_FOR_SLR_MISSING', 'SYNC_ON_HOLD', 'DEFAULTED_FOR_SLR_MISSING_ON_HOLD', 'Unknown', ], ], 'Base64' => [ 'type' => 'string', ], 'BehaviorEnum' => [ 'type' => 'string', 'enum' => [ 'dont-cache', 'cache', ], ], 'Blueprint' => [ 'type' => 'structure', 'members' => [ 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'ResourceName', ], 'group' => [ 'shape' => 'NonEmptyString', ], 'type' => [ 'shape' => 'BlueprintType', ], 'description' => [ 'shape' => 'string', ], 'isActive' => [ 'shape' => 'boolean', ], 'minPower' => [ 'shape' => 'integer', ], 'version' => [ 'shape' => 'string', ], 'versionCode' => [ 'shape' => 'string', ], 'productUrl' => [ 'shape' => 'string', ], 'licenseUrl' => [ 'shape' => 'string', ], 'platform' => [ 'shape' => 'InstancePlatform', ], 'appCategory' => [ 'shape' => 'AppCategory', ], ], ], 'BlueprintList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Blueprint', ], ], 'BlueprintType' => [ 'type' => 'string', 'enum' => [ 'os', 'app', ], ], 'Bucket' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'NonEmptyString', ], 'accessRules' => [ 'shape' => 'AccessRules', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'url' => [ 'shape' => 'NonEmptyString', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'name' => [ 'shape' => 'BucketName', ], 'supportCode' => [ 'shape' => 'NonEmptyString', ], 'tags' => [ 'shape' => 'TagList', ], 'objectVersioning' => [ 'shape' => 'NonEmptyString', ], 'ableToUpdateBundle' => [ 'shape' => 'boolean', ], 'readonlyAccessAccounts' => [ 'shape' => 'PartnerIdList', ], 'resourcesReceivingAccess' => [ 'shape' => 'AccessReceiverList', ], 'state' => [ 'shape' => 'BucketState', ], 'accessLogConfig' => [ 'shape' => 'BucketAccessLogConfig', ], ], ], 'BucketAccessLogConfig' => [ 'type' => 'structure', 'required' => [ 'enabled', ], 'members' => [ 'enabled' => [ 'shape' => 'boolean', ], 'destination' => [ 'shape' => 'BucketName', ], 'prefix' => [ 'shape' => 'BucketAccessLogPrefix', ], ], ], 'BucketAccessLogPrefix' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[\\w/!.*\')(-]+$', ], 'BucketBundle' => [ 'type' => 'structure', 'members' => [ 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'price' => [ 'shape' => 'float', ], 'storagePerMonthInGb' => [ 'shape' => 'integer', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'isActive' => [ 'shape' => 'boolean', ], ], ], 'BucketBundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BucketBundle', ], ], 'BucketList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Bucket', ], ], 'BucketMetricName' => [ 'type' => 'string', 'enum' => [ 'BucketSizeBytes', 'NumberOfObjects', ], ], 'BucketName' => [ 'type' => 'string', 'max' => 54, 'min' => 3, 'pattern' => '^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$', ], 'BucketState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'NonEmptyString', ], 'message' => [ 'shape' => 'string', ], ], ], 'Bundle' => [ 'type' => 'structure', 'members' => [ 'price' => [ 'shape' => 'float', ], 'cpuCount' => [ 'shape' => 'integer', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'instanceType' => [ 'shape' => 'string', ], 'isActive' => [ 'shape' => 'boolean', ], 'name' => [ 'shape' => 'string', ], 'power' => [ 'shape' => 'integer', ], 'ramSizeInGb' => [ 'shape' => 'float', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'supportedPlatforms' => [ 'shape' => 'InstancePlatformList', ], 'supportedAppCategories' => [ 'shape' => 'AppCategoryList', ], ], ], 'BundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Bundle', ], ], 'CacheBehavior' => [ 'type' => 'structure', 'members' => [ 'behavior' => [ 'shape' => 'BehaviorEnum', ], ], ], 'CacheBehaviorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheBehaviorPerPath', ], ], 'CacheBehaviorPerPath' => [ 'type' => 'structure', 'members' => [ 'path' => [ 'shape' => 'string', ], 'behavior' => [ 'shape' => 'BehaviorEnum', ], ], ], 'CacheSettings' => [ 'type' => 'structure', 'members' => [ 'defaultTTL' => [ 'shape' => 'long', ], 'minimumTTL' => [ 'shape' => 'long', ], 'maximumTTL' => [ 'shape' => 'long', ], 'allowedHTTPMethods' => [ 'shape' => 'NonEmptyString', ], 'cachedHTTPMethods' => [ 'shape' => 'NonEmptyString', ], 'forwardedCookies' => [ 'shape' => 'CookieObject', ], 'forwardedHeaders' => [ 'shape' => 'HeaderObject', ], 'forwardedQueryStrings' => [ 'shape' => 'QueryStringObject', ], ], ], 'Certificate' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'CertificateName', ], 'domainName' => [ 'shape' => 'DomainName', ], 'status' => [ 'shape' => 'CertificateStatus', ], 'serialNumber' => [ 'shape' => 'SerialNumber', ], 'subjectAlternativeNames' => [ 'shape' => 'SubjectAlternativeNameList', ], 'domainValidationRecords' => [ 'shape' => 'DomainValidationRecordList', ], 'requestFailureReason' => [ 'shape' => 'RequestFailureReason', ], 'inUseResourceCount' => [ 'shape' => 'InUseResourceCount', ], 'keyAlgorithm' => [ 'shape' => 'KeyAlgorithm', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'issuedAt' => [ 'shape' => 'IsoDate', ], 'issuerCA' => [ 'shape' => 'IssuerCA', ], 'notBefore' => [ 'shape' => 'IsoDate', ], 'notAfter' => [ 'shape' => 'IsoDate', ], 'eligibleToRenew' => [ 'shape' => 'EligibleToRenew', ], 'renewalSummary' => [ 'shape' => 'RenewalSummary', ], 'revokedAt' => [ 'shape' => 'IsoDate', ], 'revocationReason' => [ 'shape' => 'RevocationReason', ], 'tags' => [ 'shape' => 'TagList', ], 'supportCode' => [ 'shape' => 'string', ], ], ], 'CertificateDomainValidationStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'FAILED', 'SUCCESS', ], ], 'CertificateName' => [ 'type' => 'string', ], 'CertificateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'ISSUED', 'INACTIVE', 'EXPIRED', 'VALIDATION_TIMED_OUT', 'REVOKED', 'FAILED', ], ], 'CertificateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CertificateStatus', ], ], 'CertificateSummary' => [ 'type' => 'structure', 'members' => [ 'certificateArn' => [ 'shape' => 'NonEmptyString', ], 'certificateName' => [ 'shape' => 'CertificateName', ], 'domainName' => [ 'shape' => 'DomainName', ], 'certificateDetail' => [ 'shape' => 'Certificate', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CertificateSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CertificateSummary', ], ], 'CloseInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfo', 'instanceName', ], 'members' => [ 'portInfo' => [ 'shape' => 'PortInfo', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'CloseInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CloudFormationStackRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'state' => [ 'shape' => 'RecordState', ], 'sourceInfo' => [ 'shape' => 'CloudFormationStackRecordSourceInfoList', ], 'destinationInfo' => [ 'shape' => 'DestinationInfo', ], ], ], 'CloudFormationStackRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudFormationStackRecord', ], ], 'CloudFormationStackRecordSourceInfo' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'CloudFormationStackRecordSourceType', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'arn' => [ 'shape' => 'NonEmptyString', ], ], ], 'CloudFormationStackRecordSourceInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudFormationStackRecordSourceInfo', ], ], 'CloudFormationStackRecordSourceType' => [ 'type' => 'string', 'enum' => [ 'ExportSnapshotRecord', ], ], 'ComparisonOperator' => [ 'type' => 'string', 'enum' => [ 'GreaterThanOrEqualToThreshold', 'GreaterThanThreshold', 'LessThanThreshold', 'LessThanOrEqualToThreshold', ], ], 'ContactMethod' => [ 'type' => 'structure', 'members' => [ 'contactEndpoint' => [ 'shape' => 'NonEmptyString', ], 'status' => [ 'shape' => 'ContactMethodStatus', ], 'protocol' => [ 'shape' => 'ContactProtocol', ], 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'supportCode' => [ 'shape' => 'string', ], ], ], 'ContactMethodStatus' => [ 'type' => 'string', 'enum' => [ 'PendingVerification', 'Valid', 'Invalid', ], ], 'ContactMethodVerificationProtocol' => [ 'type' => 'string', 'enum' => [ 'Email', ], ], 'ContactMethodsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactMethod', ], ], 'ContactProtocol' => [ 'type' => 'string', 'enum' => [ 'Email', 'SMS', ], ], 'ContactProtocolsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactProtocol', ], ], 'Container' => [ 'type' => 'structure', 'members' => [ 'image' => [ 'shape' => 'string', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'Environment', ], 'ports' => [ 'shape' => 'PortMap', ], ], ], 'ContainerImage' => [ 'type' => 'structure', 'members' => [ 'image' => [ 'shape' => 'string', ], 'digest' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], ], ], 'ContainerImageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerImage', ], ], 'ContainerLabel' => [ 'type' => 'string', 'max' => 53, 'min' => 1, 'pattern' => '^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$', ], 'ContainerMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ContainerName', ], 'value' => [ 'shape' => 'Container', ], ], 'ContainerName' => [ 'type' => 'string', 'max' => 53, 'min' => 1, 'pattern' => '^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$', ], 'ContainerService' => [ 'type' => 'structure', 'members' => [ 'containerServiceName' => [ 'shape' => 'ContainerServiceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'power' => [ 'shape' => 'ContainerServicePowerName', ], 'powerId' => [ 'shape' => 'string', ], 'state' => [ 'shape' => 'ContainerServiceState', ], 'stateDetail' => [ 'shape' => 'ContainerServiceStateDetail', ], 'scale' => [ 'shape' => 'ContainerServiceScale', ], 'currentDeployment' => [ 'shape' => 'ContainerServiceDeployment', ], 'nextDeployment' => [ 'shape' => 'ContainerServiceDeployment', ], 'isDisabled' => [ 'shape' => 'boolean', ], 'principalArn' => [ 'shape' => 'string', ], 'privateDomainName' => [ 'shape' => 'string', ], 'publicDomainNames' => [ 'shape' => 'ContainerServicePublicDomains', ], 'url' => [ 'shape' => 'string', ], 'privateRegistryAccess' => [ 'shape' => 'PrivateRegistryAccess', ], ], ], 'ContainerServiceDeployment' => [ 'type' => 'structure', 'members' => [ 'version' => [ 'shape' => 'integer', ], 'state' => [ 'shape' => 'ContainerServiceDeploymentState', ], 'containers' => [ 'shape' => 'ContainerMap', ], 'publicEndpoint' => [ 'shape' => 'ContainerServiceEndpoint', ], 'createdAt' => [ 'shape' => 'IsoDate', ], ], ], 'ContainerServiceDeploymentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerServiceDeployment', ], ], 'ContainerServiceDeploymentRequest' => [ 'type' => 'structure', 'members' => [ 'containers' => [ 'shape' => 'ContainerMap', ], 'publicEndpoint' => [ 'shape' => 'EndpointRequest', ], ], ], 'ContainerServiceDeploymentState' => [ 'type' => 'string', 'enum' => [ 'ACTIVATING', 'ACTIVE', 'INACTIVE', 'FAILED', ], ], 'ContainerServiceECRImagePullerRole' => [ 'type' => 'structure', 'members' => [ 'isActive' => [ 'shape' => 'boolean', ], 'principalArn' => [ 'shape' => 'string', ], ], ], 'ContainerServiceECRImagePullerRoleRequest' => [ 'type' => 'structure', 'members' => [ 'isActive' => [ 'shape' => 'boolean', ], ], ], 'ContainerServiceEndpoint' => [ 'type' => 'structure', 'members' => [ 'containerName' => [ 'shape' => 'string', ], 'containerPort' => [ 'shape' => 'integer', ], 'healthCheck' => [ 'shape' => 'ContainerServiceHealthCheckConfig', ], ], ], 'ContainerServiceHealthCheckConfig' => [ 'type' => 'structure', 'members' => [ 'healthyThreshold' => [ 'shape' => 'integer', ], 'unhealthyThreshold' => [ 'shape' => 'integer', ], 'timeoutSeconds' => [ 'shape' => 'integer', ], 'intervalSeconds' => [ 'shape' => 'integer', ], 'path' => [ 'shape' => 'string', ], 'successCodes' => [ 'shape' => 'string', ], ], ], 'ContainerServiceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerService', ], ], 'ContainerServiceLogEvent' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'string', ], ], ], 'ContainerServiceLogEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerServiceLogEvent', ], ], 'ContainerServiceMetadataEntry' => [ 'type' => 'map', 'key' => [ 'shape' => 'string', ], 'value' => [ 'shape' => 'string', ], ], 'ContainerServiceMetadataEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerServiceMetadataEntry', ], ], 'ContainerServiceMetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'MemoryUtilization', ], ], 'ContainerServiceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$', ], 'ContainerServicePower' => [ 'type' => 'structure', 'members' => [ 'powerId' => [ 'shape' => 'string', ], 'price' => [ 'shape' => 'float', ], 'cpuCount' => [ 'shape' => 'float', ], 'ramSizeInGb' => [ 'shape' => 'float', ], 'name' => [ 'shape' => 'string', ], 'isActive' => [ 'shape' => 'boolean', ], ], ], 'ContainerServicePowerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerServicePower', ], ], 'ContainerServicePowerName' => [ 'type' => 'string', 'enum' => [ 'nano', 'micro', 'small', 'medium', 'large', 'xlarge', ], ], 'ContainerServiceProtocol' => [ 'type' => 'string', 'enum' => [ 'HTTP', 'HTTPS', 'TCP', 'UDP', ], ], 'ContainerServicePublicDomains' => [ 'type' => 'map', 'key' => [ 'shape' => 'string', ], 'value' => [ 'shape' => 'ContainerServicePublicDomainsList', ], ], 'ContainerServicePublicDomainsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'string', ], ], 'ContainerServiceRegistryLogin' => [ 'type' => 'structure', 'members' => [ 'username' => [ 'shape' => 'string', ], 'password' => [ 'shape' => 'string', ], 'expiresAt' => [ 'shape' => 'IsoDate', ], 'registry' => [ 'shape' => 'string', ], ], ], 'ContainerServiceScale' => [ 'type' => 'integer', 'max' => 20, 'min' => 1, ], 'ContainerServiceState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'READY', 'RUNNING', 'UPDATING', 'DELETING', 'DISABLED', 'DEPLOYING', ], ], 'ContainerServiceStateDetail' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'ContainerServiceStateDetailCode', ], 'message' => [ 'shape' => 'string', ], ], ], 'ContainerServiceStateDetailCode' => [ 'type' => 'string', 'enum' => [ 'CREATING_SYSTEM_RESOURCES', 'CREATING_NETWORK_INFRASTRUCTURE', 'PROVISIONING_CERTIFICATE', 'PROVISIONING_SERVICE', 'CREATING_DEPLOYMENT', 'EVALUATING_HEALTH_CHECK', 'ACTIVATING_DEPLOYMENT', 'CERTIFICATE_LIMIT_EXCEEDED', 'UNKNOWN_ERROR', ], ], 'ContainerServicesListResult' => [ 'type' => 'structure', 'members' => [ 'containerServices' => [ 'shape' => 'ContainerServiceList', ], ], ], 'CookieObject' => [ 'type' => 'structure', 'members' => [ 'option' => [ 'shape' => 'ForwardValues', ], 'cookiesAllowList' => [ 'shape' => 'StringList', ], ], ], 'CopySnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'targetSnapshotName', 'sourceRegion', ], 'members' => [ 'sourceSnapshotName' => [ 'shape' => 'ResourceName', ], 'sourceResourceName' => [ 'shape' => 'string', ], 'restoreDate' => [ 'shape' => 'string', ], 'useLatestRestorableAutoSnapshot' => [ 'shape' => 'boolean', ], 'targetSnapshotName' => [ 'shape' => 'ResourceName', ], 'sourceRegion' => [ 'shape' => 'RegionName', ], ], ], 'CopySnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CostEstimate' => [ 'type' => 'structure', 'members' => [ 'usageType' => [ 'shape' => 'NonEmptyString', ], 'resultsByTime' => [ 'shape' => 'EstimatesByTime', ], ], ], 'CostEstimates' => [ 'type' => 'list', 'member' => [ 'shape' => 'CostEstimate', ], ], 'CreateBucketAccessKeyRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], ], ], 'CreateBucketAccessKeyResult' => [ 'type' => 'structure', 'members' => [ 'accessKey' => [ 'shape' => 'AccessKey', ], 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateBucketRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', 'bundleId', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'tags' => [ 'shape' => 'TagList', ], 'enableObjectVersioning' => [ 'shape' => 'boolean', ], ], ], 'CreateBucketResult' => [ 'type' => 'structure', 'members' => [ 'bucket' => [ 'shape' => 'Bucket', ], 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'certificateName', 'domainName', ], 'members' => [ 'certificateName' => [ 'shape' => 'CertificateName', ], 'domainName' => [ 'shape' => 'DomainName', ], 'subjectAlternativeNames' => [ 'shape' => 'SubjectAlternativeNameList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCertificateResult' => [ 'type' => 'structure', 'members' => [ 'certificate' => [ 'shape' => 'CertificateSummary', ], 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateCloudFormationStackRequest' => [ 'type' => 'structure', 'required' => [ 'instances', ], 'members' => [ 'instances' => [ 'shape' => 'InstanceEntryList', ], ], ], 'CreateCloudFormationStackResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateContactMethodRequest' => [ 'type' => 'structure', 'required' => [ 'protocol', 'contactEndpoint', ], 'members' => [ 'protocol' => [ 'shape' => 'ContactProtocol', ], 'contactEndpoint' => [ 'shape' => 'StringMax256', ], ], ], 'CreateContactMethodResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateContainerServiceDeploymentRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'containers' => [ 'shape' => 'ContainerMap', ], 'publicEndpoint' => [ 'shape' => 'EndpointRequest', ], ], ], 'CreateContainerServiceDeploymentResult' => [ 'type' => 'structure', 'members' => [ 'containerService' => [ 'shape' => 'ContainerService', ], ], ], 'CreateContainerServiceRegistryLoginRequest' => [ 'type' => 'structure', 'members' => [], ], 'CreateContainerServiceRegistryLoginResult' => [ 'type' => 'structure', 'members' => [ 'registryLogin' => [ 'shape' => 'ContainerServiceRegistryLogin', ], ], ], 'CreateContainerServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'power', 'scale', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'power' => [ 'shape' => 'ContainerServicePowerName', ], 'scale' => [ 'shape' => 'ContainerServiceScale', ], 'tags' => [ 'shape' => 'TagList', ], 'publicDomainNames' => [ 'shape' => 'ContainerServicePublicDomains', ], 'deployment' => [ 'shape' => 'ContainerServiceDeploymentRequest', ], 'privateRegistryAccess' => [ 'shape' => 'PrivateRegistryAccessRequest', ], ], ], 'CreateContainerServiceResult' => [ 'type' => 'structure', 'members' => [ 'containerService' => [ 'shape' => 'ContainerService', ], ], ], 'CreateDiskFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'availabilityZone', 'sizeInGb', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'tags' => [ 'shape' => 'TagList', ], 'addOns' => [ 'shape' => 'AddOnRequestList', ], 'sourceDiskName' => [ 'shape' => 'string', ], 'restoreDate' => [ 'shape' => 'string', ], 'useLatestRestorableAutoSnapshot' => [ 'shape' => 'boolean', ], ], ], 'CreateDiskFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'availabilityZone', 'sizeInGb', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'tags' => [ 'shape' => 'TagList', ], 'addOns' => [ 'shape' => 'AddOnRequestList', ], ], ], 'CreateDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'distributionName', 'origin', 'defaultCacheBehavior', 'bundleId', ], 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'origin' => [ 'shape' => 'InputOrigin', ], 'defaultCacheBehavior' => [ 'shape' => 'CacheBehavior', ], 'cacheBehaviorSettings' => [ 'shape' => 'CacheSettings', ], 'cacheBehaviors' => [ 'shape' => 'CacheBehaviorList', ], 'bundleId' => [ 'shape' => 'string', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDistributionResult' => [ 'type' => 'structure', 'members' => [ 'distribution' => [ 'shape' => 'LightsailDistribution', ], 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'CreateDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDomainResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateGUISessionAccessDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], ], ], 'CreateGUISessionAccessDetailsResult' => [ 'type' => 'structure', 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'status' => [ 'shape' => 'Status', ], 'percentageComplete' => [ 'shape' => 'integer', ], 'failureReason' => [ 'shape' => 'string', ], 'sessions' => [ 'shape' => 'Sessions', ], ], ], 'CreateInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', 'instanceName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateInstancesFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceNames', 'availabilityZone', 'bundleId', ], 'members' => [ 'instanceNames' => [ 'shape' => 'StringList', ], 'attachedDiskMapping' => [ 'shape' => 'AttachedDiskMap', ], 'availabilityZone' => [ 'shape' => 'string', ], 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'userData' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], 'addOns' => [ 'shape' => 'AddOnRequestList', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'sourceInstanceName' => [ 'shape' => 'string', ], 'restoreDate' => [ 'shape' => 'string', ], 'useLatestRestorableAutoSnapshot' => [ 'shape' => 'boolean', ], ], ], 'CreateInstancesFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateInstancesRequest' => [ 'type' => 'structure', 'required' => [ 'instanceNames', 'availabilityZone', 'blueprintId', 'bundleId', ], 'members' => [ 'instanceNames' => [ 'shape' => 'StringList', ], 'availabilityZone' => [ 'shape' => 'string', ], 'customImageName' => [ 'shape' => 'ResourceName', 'deprecated' => true, ], 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'userData' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], 'addOns' => [ 'shape' => 'AddOnRequestList', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], ], ], 'CreateInstancesResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'keyPair' => [ 'shape' => 'KeyPair', ], 'publicKeyBase64' => [ 'shape' => 'Base64', ], 'privateKeyBase64' => [ 'shape' => 'Base64', ], 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instancePort', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instancePort' => [ 'shape' => 'Port', ], 'healthCheckPath' => [ 'shape' => 'string', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'certificateDomainName' => [ 'shape' => 'DomainName', ], 'certificateAlternativeNames' => [ 'shape' => 'DomainNameList', ], 'tags' => [ 'shape' => 'TagList', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'tlsPolicyName' => [ 'shape' => 'string', ], ], ], 'CreateLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', 'certificateDomainName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'certificateDomainName' => [ 'shape' => 'DomainName', ], 'certificateAlternativeNames' => [ 'shape' => 'DomainNameList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'string', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseBundleId' => [ 'shape' => 'string', ], 'sourceRelationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'restoreTime' => [ 'shape' => 'IsoDate', ], 'useLatestRestorableTime' => [ 'shape' => 'boolean', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'relationalDatabaseBlueprintId', 'relationalDatabaseBundleId', 'masterDatabaseName', 'masterUsername', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'string', ], 'relationalDatabaseBlueprintId' => [ 'shape' => 'string', ], 'relationalDatabaseBundleId' => [ 'shape' => 'string', ], 'masterDatabaseName' => [ 'shape' => 'string', ], 'masterUsername' => [ 'shape' => 'string', ], 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'preferredBackupWindow' => [ 'shape' => 'string', ], 'preferredMaintenanceWindow' => [ 'shape' => 'string', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'Currency' => [ 'type' => 'string', 'enum' => [ 'USD', ], ], 'DeleteAlarmRequest' => [ 'type' => 'structure', 'required' => [ 'alarmName', ], 'members' => [ 'alarmName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteAlarmResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteAutoSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'date', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'date' => [ 'shape' => 'AutoSnapshotDate', ], ], ], 'DeleteAutoSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteBucketAccessKeyRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', 'accessKeyId', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'accessKeyId' => [ 'shape' => 'NonEmptyString', ], ], ], 'DeleteBucketAccessKeyResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteBucketRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'forceDelete' => [ 'shape' => 'boolean', ], ], ], 'DeleteBucketResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'certificateName', ], 'members' => [ 'certificateName' => [ 'shape' => 'CertificateName', ], ], ], 'DeleteCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteContactMethodRequest' => [ 'type' => 'structure', 'required' => [ 'protocol', ], 'members' => [ 'protocol' => [ 'shape' => 'ContactProtocol', ], ], ], 'DeleteContactMethodResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteContainerImageRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'image', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'image' => [ 'shape' => 'string', ], ], ], 'DeleteContainerImageResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteContainerServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], ], ], 'DeleteContainerServiceResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'forceDeleteAddOns' => [ 'shape' => 'boolean', ], ], ], 'DeleteDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteDistributionRequest' => [ 'type' => 'structure', 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteDistributionResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'DeleteDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], ], ], 'DeleteDomainResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'forceDeleteAddOns' => [ 'shape' => 'boolean', ], ], ], 'DeleteInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], 'expectedFingerprint' => [ 'shape' => 'string', ], ], ], 'DeleteKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteKnownHostKeysRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteKnownHostKeysResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'force' => [ 'shape' => 'boolean', ], ], ], 'DeleteLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'skipFinalSnapshot' => [ 'shape' => 'boolean', ], 'finalRelationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DestinationInfo' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'service' => [ 'shape' => 'NonEmptyString', ], ], ], 'DetachCertificateFromDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'distributionName', ], 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], ], ], 'DetachCertificateFromDistributionResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DetachDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], ], ], 'DetachDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DetachInstancesFromLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instanceNames', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instanceNames' => [ 'shape' => 'ResourceNameList', ], ], ], 'DetachInstancesFromLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DetachStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'DetachStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DisableAddOnRequest' => [ 'type' => 'structure', 'required' => [ 'addOnType', 'resourceName', ], 'members' => [ 'addOnType' => [ 'shape' => 'AddOnType', ], 'resourceName' => [ 'shape' => 'ResourceName', ], ], ], 'DisableAddOnResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'Disk' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'addOns' => [ 'shape' => 'AddOnList', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'isSystemDisk' => [ 'shape' => 'boolean', ], 'iops' => [ 'shape' => 'integer', ], 'path' => [ 'shape' => 'string', ], 'state' => [ 'shape' => 'DiskState', ], 'attachedTo' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], 'attachmentState' => [ 'shape' => 'string', 'deprecated' => true, ], 'gbInUse' => [ 'shape' => 'integer', 'deprecated' => true, ], 'autoMountStatus' => [ 'shape' => 'AutoMountStatus', ], ], ], 'DiskInfo' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'string', ], 'path' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'isSystemDisk' => [ 'shape' => 'boolean', ], ], ], 'DiskInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskInfo', ], ], 'DiskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Disk', ], ], 'DiskMap' => [ 'type' => 'structure', 'members' => [ 'originalDiskPath' => [ 'shape' => 'NonEmptyString', ], 'newDiskName' => [ 'shape' => 'ResourceName', ], ], ], 'DiskMapList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskMap', ], ], 'DiskSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'state' => [ 'shape' => 'DiskSnapshotState', ], 'progress' => [ 'shape' => 'string', ], 'fromDiskName' => [ 'shape' => 'ResourceName', ], 'fromDiskArn' => [ 'shape' => 'NonEmptyString', ], 'fromInstanceName' => [ 'shape' => 'ResourceName', ], 'fromInstanceArn' => [ 'shape' => 'NonEmptyString', ], 'isFromAutoSnapshot' => [ 'shape' => 'boolean', ], ], ], 'DiskSnapshotInfo' => [ 'type' => 'structure', 'members' => [ 'sizeInGb' => [ 'shape' => 'integer', ], ], ], 'DiskSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskSnapshot', ], ], 'DiskSnapshotState' => [ 'type' => 'string', 'enum' => [ 'pending', 'completed', 'error', 'unknown', ], ], 'DiskState' => [ 'type' => 'string', 'enum' => [ 'pending', 'error', 'available', 'in-use', 'unknown', ], ], 'DistributionBundle' => [ 'type' => 'structure', 'members' => [ 'bundleId' => [ 'shape' => 'string', ], 'name' => [ 'shape' => 'string', ], 'price' => [ 'shape' => 'float', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'isActive' => [ 'shape' => 'boolean', ], ], ], 'DistributionBundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DistributionBundle', ], ], 'DistributionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LightsailDistribution', ], ], 'DistributionMetricName' => [ 'type' => 'string', 'enum' => [ 'Requests', 'BytesDownloaded', 'BytesUploaded', 'TotalErrorRate', 'Http4xxErrorRate', 'Http5xxErrorRate', ], ], 'DnsRecordCreationState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'DnsRecordCreationStateCode', ], 'message' => [ 'shape' => 'string', ], ], ], 'DnsRecordCreationStateCode' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'STARTED', 'FAILED', ], ], 'Domain' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'domainEntries' => [ 'shape' => 'DomainEntryList', ], 'registeredDomainDelegationInfo' => [ 'shape' => 'RegisteredDomainDelegationInfo', ], ], ], 'DomainEntry' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'DomainName', ], 'target' => [ 'shape' => 'string', ], 'isAlias' => [ 'shape' => 'boolean', ], 'type' => [ 'shape' => 'DomainEntryType', ], 'options' => [ 'shape' => 'DomainEntryOptions', 'deprecated' => true, ], ], ], 'DomainEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainEntry', ], ], 'DomainEntryOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'DomainEntryOptionsKeys', ], 'value' => [ 'shape' => 'string', ], ], 'DomainEntryOptionsKeys' => [ 'type' => 'string', ], 'DomainEntryType' => [ 'type' => 'string', ], 'DomainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Domain', ], ], 'DomainName' => [ 'type' => 'string', ], 'DomainNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainName', ], ], 'DomainValidationRecord' => [ 'type' => 'structure', 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'resourceRecord' => [ 'shape' => 'ResourceRecord', ], 'dnsRecordCreationState' => [ 'shape' => 'DnsRecordCreationState', ], 'validationStatus' => [ 'shape' => 'CertificateDomainValidationStatus', ], ], ], 'DomainValidationRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainValidationRecord', ], ], 'DownloadDefaultKeyPairRequest' => [ 'type' => 'structure', 'members' => [], ], 'DownloadDefaultKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'publicKeyBase64' => [ 'shape' => 'Base64', ], 'privateKeyBase64' => [ 'shape' => 'Base64', ], 'createdAt' => [ 'shape' => 'IsoDate', ], ], ], 'EligibleToRenew' => [ 'type' => 'string', ], 'EnableAddOnRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'addOnRequest', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'addOnRequest' => [ 'shape' => 'AddOnRequest', ], ], ], 'EnableAddOnResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'EndpointRequest' => [ 'type' => 'structure', 'required' => [ 'containerName', 'containerPort', ], 'members' => [ 'containerName' => [ 'shape' => 'string', ], 'containerPort' => [ 'shape' => 'integer', ], 'healthCheck' => [ 'shape' => 'ContainerServiceHealthCheckConfig', ], ], ], 'Environment' => [ 'type' => 'map', 'key' => [ 'shape' => 'string', ], 'value' => [ 'shape' => 'string', ], ], 'EstimateByTime' => [ 'type' => 'structure', 'members' => [ 'usageCost' => [ 'shape' => 'double', ], 'pricingUnit' => [ 'shape' => 'PricingUnit', ], 'unit' => [ 'shape' => 'double', ], 'currency' => [ 'shape' => 'Currency', ], 'timePeriod' => [ 'shape' => 'TimePeriod', ], ], ], 'EstimatesByTime' => [ 'type' => 'list', 'member' => [ 'shape' => 'EstimateByTime', ], ], 'ExportSnapshotRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'state' => [ 'shape' => 'RecordState', ], 'sourceInfo' => [ 'shape' => 'ExportSnapshotRecordSourceInfo', ], 'destinationInfo' => [ 'shape' => 'DestinationInfo', ], ], ], 'ExportSnapshotRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportSnapshotRecord', ], ], 'ExportSnapshotRecordSourceInfo' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'ExportSnapshotRecordSourceType', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'fromResourceName' => [ 'shape' => 'NonEmptyString', ], 'fromResourceArn' => [ 'shape' => 'NonEmptyString', ], 'instanceSnapshotInfo' => [ 'shape' => 'InstanceSnapshotInfo', ], 'diskSnapshotInfo' => [ 'shape' => 'DiskSnapshotInfo', ], ], ], 'ExportSnapshotRecordSourceType' => [ 'type' => 'string', 'enum' => [ 'InstanceSnapshot', 'DiskSnapshot', ], ], 'ExportSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'sourceSnapshotName', ], 'members' => [ 'sourceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'ExportSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'ForwardValues' => [ 'type' => 'string', 'enum' => [ 'none', 'allow-list', 'all', ], ], 'GetActiveNamesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetActiveNamesResult' => [ 'type' => 'structure', 'members' => [ 'activeNames' => [ 'shape' => 'StringList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetAlarmsRequest' => [ 'type' => 'structure', 'members' => [ 'alarmName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], 'monitoredResourceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetAlarmsResult' => [ 'type' => 'structure', 'members' => [ 'alarms' => [ 'shape' => 'AlarmsList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetAutoSnapshotsRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetAutoSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'autoSnapshots' => [ 'shape' => 'AutoSnapshotDetailsList', ], ], ], 'GetBlueprintsRequest' => [ 'type' => 'structure', 'members' => [ 'includeInactive' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], 'appCategory' => [ 'shape' => 'AppCategory', ], ], ], 'GetBlueprintsResult' => [ 'type' => 'structure', 'members' => [ 'blueprints' => [ 'shape' => 'BlueprintList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetBucketAccessKeysRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], ], ], 'GetBucketAccessKeysResult' => [ 'type' => 'structure', 'members' => [ 'accessKeys' => [ 'shape' => 'AccessKeyList', ], ], ], 'GetBucketBundlesRequest' => [ 'type' => 'structure', 'members' => [ 'includeInactive' => [ 'shape' => 'boolean', ], ], ], 'GetBucketBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'BucketBundleList', ], ], ], 'GetBucketMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', 'metricName', 'startTime', 'endTime', 'period', 'statistics', 'unit', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'metricName' => [ 'shape' => 'BucketMetricName', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], 'unit' => [ 'shape' => 'MetricUnit', ], ], ], 'GetBucketMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'BucketMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetBucketsRequest' => [ 'type' => 'structure', 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'pageToken' => [ 'shape' => 'string', ], 'includeConnectedResources' => [ 'shape' => 'boolean', ], ], ], 'GetBucketsResult' => [ 'type' => 'structure', 'members' => [ 'buckets' => [ 'shape' => 'BucketList', ], 'nextPageToken' => [ 'shape' => 'string', ], 'accountLevelBpaSync' => [ 'shape' => 'AccountLevelBpaSync', ], ], ], 'GetBundlesRequest' => [ 'type' => 'structure', 'members' => [ 'includeInactive' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], 'appCategory' => [ 'shape' => 'AppCategory', ], ], ], 'GetBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'BundleList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetCertificatesRequest' => [ 'type' => 'structure', 'members' => [ 'certificateStatuses' => [ 'shape' => 'CertificateStatusList', ], 'includeCertificateDetails' => [ 'shape' => 'IncludeCertificateDetails', ], 'certificateName' => [ 'shape' => 'CertificateName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetCertificatesResult' => [ 'type' => 'structure', 'members' => [ 'certificates' => [ 'shape' => 'CertificateSummaryList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetCloudFormationStackRecordsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetCloudFormationStackRecordsResult' => [ 'type' => 'structure', 'members' => [ 'cloudFormationStackRecords' => [ 'shape' => 'CloudFormationStackRecordList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetContactMethodsRequest' => [ 'type' => 'structure', 'members' => [ 'protocols' => [ 'shape' => 'ContactProtocolsList', ], ], ], 'GetContactMethodsResult' => [ 'type' => 'structure', 'members' => [ 'contactMethods' => [ 'shape' => 'ContactMethodsList', ], ], ], 'GetContainerAPIMetadataRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetContainerAPIMetadataResult' => [ 'type' => 'structure', 'members' => [ 'metadata' => [ 'shape' => 'ContainerServiceMetadataEntryList', ], ], ], 'GetContainerImagesRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], ], ], 'GetContainerImagesResult' => [ 'type' => 'structure', 'members' => [ 'containerImages' => [ 'shape' => 'ContainerImageList', ], ], ], 'GetContainerLogRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'containerName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'containerName' => [ 'shape' => 'string', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'filterPattern' => [ 'shape' => 'string', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetContainerLogResult' => [ 'type' => 'structure', 'members' => [ 'logEvents' => [ 'shape' => 'ContainerServiceLogEventList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetContainerServiceDeploymentsRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], ], ], 'GetContainerServiceDeploymentsResult' => [ 'type' => 'structure', 'members' => [ 'deployments' => [ 'shape' => 'ContainerServiceDeploymentList', ], ], ], 'GetContainerServiceMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'metricName', 'startTime', 'endTime', 'period', 'statistics', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'metricName' => [ 'shape' => 'ContainerServiceMetricName', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetContainerServiceMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'ContainerServiceMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetContainerServicePowersRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetContainerServicePowersResult' => [ 'type' => 'structure', 'members' => [ 'powers' => [ 'shape' => 'ContainerServicePowerList', ], ], ], 'GetContainerServicesRequest' => [ 'type' => 'structure', 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], ], ], 'GetCostEstimateRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'startTime', 'endTime', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], ], ], 'GetCostEstimateResult' => [ 'type' => 'structure', 'members' => [ 'resourcesBudgetEstimate' => [ 'shape' => 'ResourcesBudgetEstimate', ], ], ], 'GetDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], ], ], 'GetDiskResult' => [ 'type' => 'structure', 'members' => [ 'disk' => [ 'shape' => 'Disk', ], ], ], 'GetDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'diskSnapshot' => [ 'shape' => 'DiskSnapshot', ], ], ], 'GetDiskSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDiskSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'diskSnapshots' => [ 'shape' => 'DiskSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDisksRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDisksResult' => [ 'type' => 'structure', 'members' => [ 'disks' => [ 'shape' => 'DiskList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDistributionBundlesRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetDistributionBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'DistributionBundleList', ], ], ], 'GetDistributionLatestCacheResetRequest' => [ 'type' => 'structure', 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], ], ], 'GetDistributionLatestCacheResetResult' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'string', ], 'createTime' => [ 'shape' => 'IsoDate', ], ], ], 'GetDistributionMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'distributionName', 'metricName', 'startTime', 'endTime', 'period', 'unit', 'statistics', ], 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'DistributionMetricName', ], 'startTime' => [ 'shape' => 'timestamp', ], 'endTime' => [ 'shape' => 'timestamp', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetDistributionMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'DistributionMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetDistributionsRequest' => [ 'type' => 'structure', 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDistributionsResult' => [ 'type' => 'structure', 'members' => [ 'distributions' => [ 'shape' => 'DistributionList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], ], ], 'GetDomainResult' => [ 'type' => 'structure', 'members' => [ 'domain' => [ 'shape' => 'Domain', ], ], ], 'GetDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDomainsResult' => [ 'type' => 'structure', 'members' => [ 'domains' => [ 'shape' => 'DomainList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetExportSnapshotRecordsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetExportSnapshotRecordsResult' => [ 'type' => 'structure', 'members' => [ 'exportSnapshotRecords' => [ 'shape' => 'ExportSnapshotRecordList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceAccessDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'protocol' => [ 'shape' => 'InstanceAccessProtocol', ], ], ], 'GetInstanceAccessDetailsResult' => [ 'type' => 'structure', 'members' => [ 'accessDetails' => [ 'shape' => 'InstanceAccessDetails', ], ], ], 'GetInstanceMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'InstanceMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'timestamp', ], 'endTime' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetInstanceMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'InstanceMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetInstancePortStatesRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstancePortStatesResult' => [ 'type' => 'structure', 'members' => [ 'portStates' => [ 'shape' => 'InstancePortStateList', ], ], ], 'GetInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceResult' => [ 'type' => 'structure', 'members' => [ 'instance' => [ 'shape' => 'Instance', ], ], ], 'GetInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'instanceSnapshot' => [ 'shape' => 'InstanceSnapshot', ], ], ], 'GetInstanceSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'instanceSnapshots' => [ 'shape' => 'InstanceSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceStateRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceStateResult' => [ 'type' => 'structure', 'members' => [ 'state' => [ 'shape' => 'InstanceState', ], ], ], 'GetInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetInstancesResult' => [ 'type' => 'structure', 'members' => [ 'instances' => [ 'shape' => 'InstanceList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], ], ], 'GetKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'keyPair' => [ 'shape' => 'KeyPair', ], ], ], 'GetKeyPairsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], 'includeDefaultKeyPair' => [ 'shape' => 'boolean', ], ], ], 'GetKeyPairsResult' => [ 'type' => 'structure', 'members' => [ 'keyPairs' => [ 'shape' => 'KeyPairList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancerMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'LoadBalancerMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'timestamp', ], 'endTime' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetLoadBalancerMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'LoadBalancerMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'GetLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'loadBalancer' => [ 'shape' => 'LoadBalancer', ], ], ], 'GetLoadBalancerTlsCertificatesRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'GetLoadBalancerTlsCertificatesResult' => [ 'type' => 'structure', 'members' => [ 'tlsCertificates' => [ 'shape' => 'LoadBalancerTlsCertificateList', ], ], ], 'GetLoadBalancerTlsPoliciesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancerTlsPoliciesResult' => [ 'type' => 'structure', 'members' => [ 'tlsPolicies' => [ 'shape' => 'LoadBalancerTlsPolicyList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancersRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancersResult' => [ 'type' => 'structure', 'members' => [ 'loadBalancers' => [ 'shape' => 'LoadBalancerList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationRequest' => [ 'type' => 'structure', 'required' => [ 'operationId', ], 'members' => [ 'operationId' => [ 'shape' => 'NonEmptyString', ], ], ], 'GetOperationResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'GetOperationsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsForResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], 'nextPageCount' => [ 'shape' => 'string', 'deprecated' => true, ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRegionsRequest' => [ 'type' => 'structure', 'members' => [ 'includeAvailabilityZones' => [ 'shape' => 'boolean', ], 'includeRelationalDatabaseAvailabilityZones' => [ 'shape' => 'boolean', ], ], ], 'GetRegionsResult' => [ 'type' => 'structure', 'members' => [ 'regions' => [ 'shape' => 'RegionList', ], ], ], 'GetRelationalDatabaseBlueprintsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseBlueprintsResult' => [ 'type' => 'structure', 'members' => [ 'blueprints' => [ 'shape' => 'RelationalDatabaseBlueprintList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseBundlesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], 'includeInactive' => [ 'shape' => 'boolean', ], ], ], 'GetRelationalDatabaseBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'RelationalDatabaseBundleList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseEventsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'durationInMinutes' => [ 'shape' => 'integer', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseEventsResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseEvents' => [ 'shape' => 'RelationalDatabaseEventList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogEventsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'logStreamName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'logStreamName' => [ 'shape' => 'string', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'startFromHead' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogEventsResult' => [ 'type' => 'structure', 'members' => [ 'resourceLogEvents' => [ 'shape' => 'LogEventList', ], 'nextBackwardToken' => [ 'shape' => 'string', ], 'nextForwardToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogStreamsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseLogStreamsResult' => [ 'type' => 'structure', 'members' => [ 'logStreams' => [ 'shape' => 'StringList', ], ], ], 'GetRelationalDatabaseMasterUserPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'passwordVersion' => [ 'shape' => 'RelationalDatabasePasswordVersion', ], ], ], 'GetRelationalDatabaseMasterUserPasswordResult' => [ 'type' => 'structure', 'members' => [ 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], ], ], 'GetRelationalDatabaseMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'RelationalDatabaseMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetRelationalDatabaseMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'RelationalDatabaseMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetRelationalDatabaseParametersRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseParametersResult' => [ 'type' => 'structure', 'members' => [ 'parameters' => [ 'shape' => 'RelationalDatabaseParameterList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabase' => [ 'shape' => 'RelationalDatabase', ], ], ], 'GetRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseSnapshot' => [ 'shape' => 'RelationalDatabaseSnapshot', ], ], ], 'GetRelationalDatabaseSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseSnapshots' => [ 'shape' => 'RelationalDatabaseSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabasesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabasesResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabases' => [ 'shape' => 'RelationalDatabaseList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'GetStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'staticIp' => [ 'shape' => 'StaticIp', ], ], ], 'GetStaticIpsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetStaticIpsResult' => [ 'type' => 'structure', 'members' => [ 'staticIps' => [ 'shape' => 'StaticIpList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'HeaderEnum' => [ 'type' => 'string', 'enum' => [ 'Accept', 'Accept-Charset', 'Accept-Datetime', 'Accept-Encoding', 'Accept-Language', 'Authorization', 'CloudFront-Forwarded-Proto', 'CloudFront-Is-Desktop-Viewer', 'CloudFront-Is-Mobile-Viewer', 'CloudFront-Is-SmartTV-Viewer', 'CloudFront-Is-Tablet-Viewer', 'CloudFront-Viewer-Country', 'Host', 'Origin', 'Referer', ], ], 'HeaderForwardList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HeaderEnum', ], ], 'HeaderObject' => [ 'type' => 'structure', 'members' => [ 'option' => [ 'shape' => 'ForwardValues', ], 'headersAllowList' => [ 'shape' => 'HeaderForwardList', ], ], ], 'HostKeyAttributes' => [ 'type' => 'structure', 'members' => [ 'algorithm' => [ 'shape' => 'string', ], 'publicKey' => [ 'shape' => 'string', ], 'witnessedAt' => [ 'shape' => 'IsoDate', ], 'fingerprintSHA1' => [ 'shape' => 'string', ], 'fingerprintSHA256' => [ 'shape' => 'string', ], 'notValidBefore' => [ 'shape' => 'IsoDate', ], 'notValidAfter' => [ 'shape' => 'IsoDate', ], ], ], 'HostKeysList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HostKeyAttributes', ], ], 'HttpEndpoint' => [ 'type' => 'string', 'enum' => [ 'disabled', 'enabled', ], ], 'HttpProtocolIpv6' => [ 'type' => 'string', 'enum' => [ 'disabled', 'enabled', ], ], 'HttpTokens' => [ 'type' => 'string', 'enum' => [ 'optional', 'required', ], ], 'IAMAccessKeyId' => [ 'type' => 'string', 'max' => 20, 'min' => 20, 'pattern' => '^[A-Z0-9]{20}$', 'sensitive' => true, ], 'ImportKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', 'publicKeyBase64', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], 'publicKeyBase64' => [ 'shape' => 'Base64', ], ], ], 'ImportKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'InUseResourceCount' => [ 'type' => 'integer', ], 'IncludeCertificateDetails' => [ 'type' => 'boolean', ], 'InputOrigin' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'regionName' => [ 'shape' => 'RegionName', ], 'protocolPolicy' => [ 'shape' => 'OriginProtocolPolicyEnum', ], ], ], 'Instance' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'blueprintName' => [ 'shape' => 'NonEmptyString', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'addOns' => [ 'shape' => 'AddOnList', ], 'isStaticIp' => [ 'shape' => 'boolean', ], 'privateIpAddress' => [ 'shape' => 'IpAddress', ], 'publicIpAddress' => [ 'shape' => 'IpAddress', ], 'ipv6Addresses' => [ 'shape' => 'Ipv6AddressList', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'hardware' => [ 'shape' => 'InstanceHardware', ], 'networking' => [ 'shape' => 'InstanceNetworking', ], 'state' => [ 'shape' => 'InstanceState', ], 'username' => [ 'shape' => 'NonEmptyString', ], 'sshKeyName' => [ 'shape' => 'ResourceName', ], 'metadataOptions' => [ 'shape' => 'InstanceMetadataOptions', ], ], ], 'InstanceAccessDetails' => [ 'type' => 'structure', 'members' => [ 'certKey' => [ 'shape' => 'string', ], 'expiresAt' => [ 'shape' => 'IsoDate', ], 'ipAddress' => [ 'shape' => 'IpAddress', ], 'password' => [ 'shape' => 'string', ], 'passwordData' => [ 'shape' => 'PasswordData', ], 'privateKey' => [ 'shape' => 'string', ], 'protocol' => [ 'shape' => 'InstanceAccessProtocol', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'username' => [ 'shape' => 'string', ], 'hostKeys' => [ 'shape' => 'HostKeysList', ], ], ], 'InstanceAccessProtocol' => [ 'type' => 'string', 'enum' => [ 'ssh', 'rdp', ], ], 'InstanceEntry' => [ 'type' => 'structure', 'required' => [ 'sourceName', 'instanceType', 'portInfoSource', 'availabilityZone', ], 'members' => [ 'sourceName' => [ 'shape' => 'ResourceName', ], 'instanceType' => [ 'shape' => 'NonEmptyString', ], 'portInfoSource' => [ 'shape' => 'PortInfoSourceType', ], 'userData' => [ 'shape' => 'string', ], 'availabilityZone' => [ 'shape' => 'string', ], ], ], 'InstanceEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceEntry', ], ], 'InstanceHardware' => [ 'type' => 'structure', 'members' => [ 'cpuCount' => [ 'shape' => 'integer', ], 'disks' => [ 'shape' => 'DiskList', ], 'ramSizeInGb' => [ 'shape' => 'float', ], ], ], 'InstanceHealthReason' => [ 'type' => 'string', 'enum' => [ 'Lb.RegistrationInProgress', 'Lb.InitialHealthChecking', 'Lb.InternalError', 'Instance.ResponseCodeMismatch', 'Instance.Timeout', 'Instance.FailedHealthChecks', 'Instance.NotRegistered', 'Instance.NotInUse', 'Instance.DeregistrationInProgress', 'Instance.InvalidState', 'Instance.IpUnusable', ], ], 'InstanceHealthState' => [ 'type' => 'string', 'enum' => [ 'initial', 'healthy', 'unhealthy', 'unused', 'draining', 'unavailable', ], ], 'InstanceHealthSummary' => [ 'type' => 'structure', 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'instanceHealth' => [ 'shape' => 'InstanceHealthState', ], 'instanceHealthReason' => [ 'shape' => 'InstanceHealthReason', ], ], ], 'InstanceHealthSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceHealthSummary', ], ], 'InstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Instance', ], ], 'InstanceMetadataOptions' => [ 'type' => 'structure', 'members' => [ 'state' => [ 'shape' => 'InstanceMetadataState', ], 'httpTokens' => [ 'shape' => 'HttpTokens', ], 'httpEndpoint' => [ 'shape' => 'HttpEndpoint', ], 'httpPutResponseHopLimit' => [ 'shape' => 'integer', ], 'httpProtocolIpv6' => [ 'shape' => 'HttpProtocolIpv6', ], ], ], 'InstanceMetadataState' => [ 'type' => 'string', 'enum' => [ 'pending', 'applied', ], ], 'InstanceMetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'NetworkIn', 'NetworkOut', 'StatusCheckFailed', 'StatusCheckFailed_Instance', 'StatusCheckFailed_System', 'BurstCapacityTime', 'BurstCapacityPercentage', 'MetadataNoToken', ], ], 'InstanceNetworking' => [ 'type' => 'structure', 'members' => [ 'monthlyTransfer' => [ 'shape' => 'MonthlyTransfer', ], 'ports' => [ 'shape' => 'InstancePortInfoList', ], ], ], 'InstancePlatform' => [ 'type' => 'string', 'enum' => [ 'LINUX_UNIX', 'WINDOWS', ], ], 'InstancePlatformList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePlatform', ], ], 'InstancePortInfo' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], 'accessFrom' => [ 'shape' => 'string', ], 'accessType' => [ 'shape' => 'PortAccessType', ], 'commonName' => [ 'shape' => 'string', ], 'accessDirection' => [ 'shape' => 'AccessDirection', ], 'cidrs' => [ 'shape' => 'StringList', ], 'ipv6Cidrs' => [ 'shape' => 'StringList', ], 'cidrListAliases' => [ 'shape' => 'StringList', ], ], ], 'InstancePortInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePortInfo', ], ], 'InstancePortState' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], 'state' => [ 'shape' => 'PortState', ], 'cidrs' => [ 'shape' => 'StringList', ], 'ipv6Cidrs' => [ 'shape' => 'StringList', ], 'cidrListAliases' => [ 'shape' => 'StringList', ], ], ], 'InstancePortStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePortState', ], ], 'InstanceSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'state' => [ 'shape' => 'InstanceSnapshotState', ], 'progress' => [ 'shape' => 'string', ], 'fromAttachedDisks' => [ 'shape' => 'DiskList', ], 'fromInstanceName' => [ 'shape' => 'ResourceName', ], 'fromInstanceArn' => [ 'shape' => 'NonEmptyString', ], 'fromBlueprintId' => [ 'shape' => 'string', ], 'fromBundleId' => [ 'shape' => 'string', ], 'isFromAutoSnapshot' => [ 'shape' => 'boolean', ], 'sizeInGb' => [ 'shape' => 'integer', ], ], ], 'InstanceSnapshotInfo' => [ 'type' => 'structure', 'members' => [ 'fromBundleId' => [ 'shape' => 'NonEmptyString', ], 'fromBlueprintId' => [ 'shape' => 'NonEmptyString', ], 'fromDiskInfo' => [ 'shape' => 'DiskInfoList', ], ], ], 'InstanceSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceSnapshot', ], ], 'InstanceSnapshotState' => [ 'type' => 'string', 'enum' => [ 'pending', 'error', 'available', ], ], 'InstanceState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'integer', ], 'name' => [ 'shape' => 'string', ], ], ], 'InvalidInputException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'IpAddress' => [ 'type' => 'string', 'pattern' => '([0-9]{1,3}\\.){3}[0-9]{1,3}', ], 'IpAddressType' => [ 'type' => 'string', 'enum' => [ 'dualstack', 'ipv4', ], ], 'Ipv6Address' => [ 'type' => 'string', 'pattern' => '([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}', ], 'Ipv6AddressList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Ipv6Address', ], ], 'IsVpcPeeredRequest' => [ 'type' => 'structure', 'members' => [], ], 'IsVpcPeeredResult' => [ 'type' => 'structure', 'members' => [ 'isPeered' => [ 'shape' => 'boolean', ], ], ], 'IsoDate' => [ 'type' => 'timestamp', ], 'IssuerCA' => [ 'type' => 'string', ], 'KeyAlgorithm' => [ 'type' => 'string', ], 'KeyPair' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'fingerprint' => [ 'shape' => 'Base64', ], ], ], 'KeyPairList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyPair', ], ], 'LightsailDistribution' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'alternativeDomainNames' => [ 'shape' => 'StringList', ], 'status' => [ 'shape' => 'string', ], 'isEnabled' => [ 'shape' => 'boolean', ], 'domainName' => [ 'shape' => 'string', ], 'bundleId' => [ 'shape' => 'string', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'origin' => [ 'shape' => 'Origin', ], 'originPublicDNS' => [ 'shape' => 'string', ], 'defaultCacheBehavior' => [ 'shape' => 'CacheBehavior', ], 'cacheBehaviorSettings' => [ 'shape' => 'CacheSettings', ], 'cacheBehaviors' => [ 'shape' => 'CacheBehaviorList', ], 'ableToUpdateBundle' => [ 'shape' => 'boolean', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'LoadBalancer' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'dnsName' => [ 'shape' => 'NonEmptyString', ], 'state' => [ 'shape' => 'LoadBalancerState', ], 'protocol' => [ 'shape' => 'LoadBalancerProtocol', ], 'publicPorts' => [ 'shape' => 'PortList', ], 'healthCheckPath' => [ 'shape' => 'NonEmptyString', ], 'instancePort' => [ 'shape' => 'integer', ], 'instanceHealthSummary' => [ 'shape' => 'InstanceHealthSummaryList', ], 'tlsCertificateSummaries' => [ 'shape' => 'LoadBalancerTlsCertificateSummaryList', ], 'configurationOptions' => [ 'shape' => 'LoadBalancerConfigurationOptions', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'httpsRedirectionEnabled' => [ 'shape' => 'boolean', ], 'tlsPolicyName' => [ 'shape' => 'ResourceName', ], ], ], 'LoadBalancerAttributeName' => [ 'type' => 'string', 'enum' => [ 'HealthCheckPath', 'SessionStickinessEnabled', 'SessionStickiness_LB_CookieDurationSeconds', 'HttpsRedirectionEnabled', 'TlsPolicyName', ], ], 'LoadBalancerConfigurationOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'LoadBalancerAttributeName', ], 'value' => [ 'shape' => 'string', ], ], 'LoadBalancerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancer', ], ], 'LoadBalancerMetricName' => [ 'type' => 'string', 'enum' => [ 'ClientTLSNegotiationErrorCount', 'HealthyHostCount', 'UnhealthyHostCount', 'HTTPCode_LB_4XX_Count', 'HTTPCode_LB_5XX_Count', 'HTTPCode_Instance_2XX_Count', 'HTTPCode_Instance_3XX_Count', 'HTTPCode_Instance_4XX_Count', 'HTTPCode_Instance_5XX_Count', 'InstanceResponseTime', 'RejectedConnectionCount', 'RequestCount', ], ], 'LoadBalancerProtocol' => [ 'type' => 'string', 'enum' => [ 'HTTP_HTTPS', 'HTTP', ], ], 'LoadBalancerState' => [ 'type' => 'string', 'enum' => [ 'active', 'provisioning', 'active_impaired', 'failed', 'unknown', ], ], 'LoadBalancerTlsCertificate' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], 'status' => [ 'shape' => 'LoadBalancerTlsCertificateStatus', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainValidationRecords' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationRecordList', ], 'failureReason' => [ 'shape' => 'LoadBalancerTlsCertificateFailureReason', ], 'issuedAt' => [ 'shape' => 'IsoDate', ], 'issuer' => [ 'shape' => 'NonEmptyString', ], 'keyAlgorithm' => [ 'shape' => 'NonEmptyString', ], 'notAfter' => [ 'shape' => 'IsoDate', ], 'notBefore' => [ 'shape' => 'IsoDate', ], 'renewalSummary' => [ 'shape' => 'LoadBalancerTlsCertificateRenewalSummary', ], 'revocationReason' => [ 'shape' => 'LoadBalancerTlsCertificateRevocationReason', ], 'revokedAt' => [ 'shape' => 'IsoDate', ], 'serial' => [ 'shape' => 'NonEmptyString', ], 'signatureAlgorithm' => [ 'shape' => 'NonEmptyString', ], 'subject' => [ 'shape' => 'NonEmptyString', ], 'subjectAlternativeNames' => [ 'shape' => 'StringList', ], ], ], 'LoadBalancerTlsCertificateDnsRecordCreationState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'LoadBalancerTlsCertificateDnsRecordCreationStateCode', ], 'message' => [ 'shape' => 'string', ], ], ], 'LoadBalancerTlsCertificateDnsRecordCreationStateCode' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'STARTED', 'FAILED', ], ], 'LoadBalancerTlsCertificateDomainStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'FAILED', 'SUCCESS', ], ], 'LoadBalancerTlsCertificateDomainValidationOption' => [ 'type' => 'structure', 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'validationStatus' => [ 'shape' => 'LoadBalancerTlsCertificateDomainStatus', ], ], ], 'LoadBalancerTlsCertificateDomainValidationOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationOption', ], ], 'LoadBalancerTlsCertificateDomainValidationRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'NonEmptyString', ], 'type' => [ 'shape' => 'NonEmptyString', ], 'value' => [ 'shape' => 'NonEmptyString', ], 'validationStatus' => [ 'shape' => 'LoadBalancerTlsCertificateDomainStatus', ], 'domainName' => [ 'shape' => 'DomainName', ], 'dnsRecordCreationState' => [ 'shape' => 'LoadBalancerTlsCertificateDnsRecordCreationState', ], ], ], 'LoadBalancerTlsCertificateDomainValidationRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationRecord', ], ], 'LoadBalancerTlsCertificateFailureReason' => [ 'type' => 'string', 'enum' => [ 'NO_AVAILABLE_CONTACTS', 'ADDITIONAL_VERIFICATION_REQUIRED', 'DOMAIN_NOT_ALLOWED', 'INVALID_PUBLIC_DOMAIN', 'OTHER', ], ], 'LoadBalancerTlsCertificateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificate', ], ], 'LoadBalancerTlsCertificateRenewalStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_AUTO_RENEWAL', 'PENDING_VALIDATION', 'SUCCESS', 'FAILED', ], ], 'LoadBalancerTlsCertificateRenewalSummary' => [ 'type' => 'structure', 'members' => [ 'renewalStatus' => [ 'shape' => 'LoadBalancerTlsCertificateRenewalStatus', ], 'domainValidationOptions' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationOptionList', ], ], ], 'LoadBalancerTlsCertificateRevocationReason' => [ 'type' => 'string', 'enum' => [ 'UNSPECIFIED', 'KEY_COMPROMISE', 'CA_COMPROMISE', 'AFFILIATION_CHANGED', 'SUPERCEDED', 'CESSATION_OF_OPERATION', 'CERTIFICATE_HOLD', 'REMOVE_FROM_CRL', 'PRIVILEGE_WITHDRAWN', 'A_A_COMPROMISE', ], ], 'LoadBalancerTlsCertificateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'ISSUED', 'INACTIVE', 'EXPIRED', 'VALIDATION_TIMED_OUT', 'REVOKED', 'FAILED', 'UNKNOWN', ], ], 'LoadBalancerTlsCertificateSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], ], ], 'LoadBalancerTlsCertificateSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateSummary', ], ], 'LoadBalancerTlsPolicy' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'isDefault' => [ 'shape' => 'boolean', ], 'description' => [ 'shape' => 'string', ], 'protocols' => [ 'shape' => 'StringList', ], 'ciphers' => [ 'shape' => 'StringList', ], ], ], 'LoadBalancerTlsPolicyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsPolicy', ], ], 'LogEvent' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'string', ], ], ], 'LogEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogEvent', ], ], 'MetricDatapoint' => [ 'type' => 'structure', 'members' => [ 'average' => [ 'shape' => 'double', ], 'maximum' => [ 'shape' => 'double', ], 'minimum' => [ 'shape' => 'double', ], 'sampleCount' => [ 'shape' => 'double', ], 'sum' => [ 'shape' => 'double', ], 'timestamp' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], ], ], 'MetricDatapointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDatapoint', ], ], 'MetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'NetworkIn', 'NetworkOut', 'StatusCheckFailed', 'StatusCheckFailed_Instance', 'StatusCheckFailed_System', 'ClientTLSNegotiationErrorCount', 'HealthyHostCount', 'UnhealthyHostCount', 'HTTPCode_LB_4XX_Count', 'HTTPCode_LB_5XX_Count', 'HTTPCode_Instance_2XX_Count', 'HTTPCode_Instance_3XX_Count', 'HTTPCode_Instance_4XX_Count', 'HTTPCode_Instance_5XX_Count', 'InstanceResponseTime', 'RejectedConnectionCount', 'RequestCount', 'DatabaseConnections', 'DiskQueueDepth', 'FreeStorageSpace', 'NetworkReceiveThroughput', 'NetworkTransmitThroughput', 'BurstCapacityTime', 'BurstCapacityPercentage', ], ], 'MetricPeriod' => [ 'type' => 'integer', 'max' => 86400, 'min' => 60, ], 'MetricStatistic' => [ 'type' => 'string', 'enum' => [ 'Minimum', 'Maximum', 'Sum', 'Average', 'SampleCount', ], ], 'MetricStatisticList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricStatistic', ], ], 'MetricUnit' => [ 'type' => 'string', 'enum' => [ 'Seconds', 'Microseconds', 'Milliseconds', 'Bytes', 'Kilobytes', 'Megabytes', 'Gigabytes', 'Terabytes', 'Bits', 'Kilobits', 'Megabits', 'Gigabits', 'Terabits', 'Percent', 'Count', 'Bytes/Second', 'Kilobytes/Second', 'Megabytes/Second', 'Gigabytes/Second', 'Terabytes/Second', 'Bits/Second', 'Kilobits/Second', 'Megabits/Second', 'Gigabits/Second', 'Terabits/Second', 'Count/Second', 'None', ], ], 'MonitoredResourceInfo' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'ResourceArn', ], 'name' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], ], 'MonthlyTransfer' => [ 'type' => 'structure', 'members' => [ 'gbPerMonthAllocated' => [ 'shape' => 'integer', ], ], ], 'NameServersUpdateState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'NameServersUpdateStateCode', ], 'message' => [ 'shape' => 'string', ], ], ], 'NameServersUpdateStateCode' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'PENDING', 'FAILED', 'STARTED', ], ], 'NetworkProtocol' => [ 'type' => 'string', 'enum' => [ 'tcp', 'all', 'udp', 'icmp', ], ], 'NonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'NotificationTriggerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlarmState', ], ], 'OpenInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfo', 'instanceName', ], 'members' => [ 'portInfo' => [ 'shape' => 'PortInfo', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'OpenInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'Operation' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'isTerminal' => [ 'shape' => 'boolean', ], 'operationDetails' => [ 'shape' => 'string', ], 'operationType' => [ 'shape' => 'OperationType', ], 'status' => [ 'shape' => 'OperationStatus', ], 'statusChangedAt' => [ 'shape' => 'IsoDate', ], 'errorCode' => [ 'shape' => 'string', ], 'errorDetails' => [ 'shape' => 'string', ], ], ], 'OperationFailureException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'OperationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Operation', ], ], 'OperationStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'Started', 'Failed', 'Completed', 'Succeeded', ], ], 'OperationType' => [ 'type' => 'string', 'enum' => [ 'DeleteKnownHostKeys', 'DeleteInstance', 'CreateInstance', 'StopInstance', 'StartInstance', 'RebootInstance', 'OpenInstancePublicPorts', 'PutInstancePublicPorts', 'CloseInstancePublicPorts', 'AllocateStaticIp', 'ReleaseStaticIp', 'AttachStaticIp', 'DetachStaticIp', 'UpdateDomainEntry', 'DeleteDomainEntry', 'CreateDomain', 'DeleteDomain', 'CreateInstanceSnapshot', 'DeleteInstanceSnapshot', 'CreateInstancesFromSnapshot', 'CreateLoadBalancer', 'DeleteLoadBalancer', 'AttachInstancesToLoadBalancer', 'DetachInstancesFromLoadBalancer', 'UpdateLoadBalancerAttribute', 'CreateLoadBalancerTlsCertificate', 'DeleteLoadBalancerTlsCertificate', 'AttachLoadBalancerTlsCertificate', 'CreateDisk', 'DeleteDisk', 'AttachDisk', 'DetachDisk', 'CreateDiskSnapshot', 'DeleteDiskSnapshot', 'CreateDiskFromSnapshot', 'CreateRelationalDatabase', 'UpdateRelationalDatabase', 'DeleteRelationalDatabase', 'CreateRelationalDatabaseFromSnapshot', 'CreateRelationalDatabaseSnapshot', 'DeleteRelationalDatabaseSnapshot', 'UpdateRelationalDatabaseParameters', 'StartRelationalDatabase', 'RebootRelationalDatabase', 'StopRelationalDatabase', 'EnableAddOn', 'DisableAddOn', 'PutAlarm', 'GetAlarms', 'DeleteAlarm', 'TestAlarm', 'CreateContactMethod', 'GetContactMethods', 'SendContactMethodVerification', 'DeleteContactMethod', 'CreateDistribution', 'UpdateDistribution', 'DeleteDistribution', 'ResetDistributionCache', 'AttachCertificateToDistribution', 'DetachCertificateFromDistribution', 'UpdateDistributionBundle', 'SetIpAddressType', 'CreateCertificate', 'DeleteCertificate', 'CreateContainerService', 'UpdateContainerService', 'DeleteContainerService', 'CreateContainerServiceDeployment', 'CreateContainerServiceRegistryLogin', 'RegisterContainerImage', 'DeleteContainerImage', 'CreateBucket', 'DeleteBucket', 'CreateBucketAccessKey', 'DeleteBucketAccessKey', 'UpdateBucketBundle', 'UpdateBucket', 'SetResourceAccessForBucket', 'UpdateInstanceMetadataOptions', 'StartGUISession', 'StopGUISession', ], ], 'Origin' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'regionName' => [ 'shape' => 'RegionName', ], 'protocolPolicy' => [ 'shape' => 'OriginProtocolPolicyEnum', ], ], ], 'OriginProtocolPolicyEnum' => [ 'type' => 'string', 'enum' => [ 'http-only', 'https-only', ], ], 'PartnerIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString', ], 'max' => 10, ], 'PasswordData' => [ 'type' => 'structure', 'members' => [ 'ciphertext' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], ], ], 'PeerVpcRequest' => [ 'type' => 'structure', 'members' => [], ], 'PeerVpcResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'PendingMaintenanceAction' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'NonEmptyString', ], 'description' => [ 'shape' => 'NonEmptyString', ], 'currentApplyDate' => [ 'shape' => 'IsoDate', ], ], ], 'PendingMaintenanceActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingMaintenanceAction', ], ], 'PendingModifiedRelationalDatabaseValues' => [ 'type' => 'structure', 'members' => [ 'masterUserPassword' => [ 'shape' => 'string', ], 'engineVersion' => [ 'shape' => 'string', ], 'backupRetentionEnabled' => [ 'shape' => 'boolean', ], ], ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => -1, ], 'PortAccessType' => [ 'type' => 'string', 'enum' => [ 'Public', 'Private', ], ], 'PortInfo' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], 'cidrs' => [ 'shape' => 'StringList', ], 'ipv6Cidrs' => [ 'shape' => 'StringList', ], 'cidrListAliases' => [ 'shape' => 'StringList', ], ], ], 'PortInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortInfo', ], ], 'PortInfoSourceType' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'INSTANCE', 'NONE', 'CLOSED', ], ], 'PortList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Port', ], ], 'PortMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'string', ], 'value' => [ 'shape' => 'ContainerServiceProtocol', ], ], 'PortState' => [ 'type' => 'string', 'enum' => [ 'open', 'closed', ], ], 'PricingUnit' => [ 'type' => 'string', 'enum' => [ 'GB', 'Hrs', 'GB-Mo', 'Bundles', 'Queries', ], ], 'PrivateRegistryAccess' => [ 'type' => 'structure', 'members' => [ 'ecrImagePullerRole' => [ 'shape' => 'ContainerServiceECRImagePullerRole', ], ], ], 'PrivateRegistryAccessRequest' => [ 'type' => 'structure', 'members' => [ 'ecrImagePullerRole' => [ 'shape' => 'ContainerServiceECRImagePullerRoleRequest', ], ], ], 'PutAlarmRequest' => [ 'type' => 'structure', 'required' => [ 'alarmName', 'metricName', 'monitoredResourceName', 'comparisonOperator', 'threshold', 'evaluationPeriods', ], 'members' => [ 'alarmName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'MetricName', ], 'monitoredResourceName' => [ 'shape' => 'ResourceName', ], 'comparisonOperator' => [ 'shape' => 'ComparisonOperator', ], 'threshold' => [ 'shape' => 'double', ], 'evaluationPeriods' => [ 'shape' => 'integer', ], 'datapointsToAlarm' => [ 'shape' => 'integer', ], 'treatMissingData' => [ 'shape' => 'TreatMissingData', ], 'contactProtocols' => [ 'shape' => 'ContactProtocolsList', ], 'notificationTriggers' => [ 'shape' => 'NotificationTriggerList', ], 'notificationEnabled' => [ 'shape' => 'boolean', ], ], ], 'PutAlarmResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'PutInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfos', 'instanceName', ], 'members' => [ 'portInfos' => [ 'shape' => 'PortInfoList', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'PutInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'QueryStringObject' => [ 'type' => 'structure', 'members' => [ 'option' => [ 'shape' => 'boolean', ], 'queryStringsAllowList' => [ 'shape' => 'StringList', ], ], ], 'R53HostedZoneDeletionState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'R53HostedZoneDeletionStateCode', ], 'message' => [ 'shape' => 'string', ], ], ], 'R53HostedZoneDeletionStateCode' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'PENDING', 'FAILED', 'STARTED', ], ], 'RebootInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'RebootInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'RebootRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'RebootRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'RecordState' => [ 'type' => 'string', 'enum' => [ 'Started', 'Succeeded', 'Failed', ], ], 'Region' => [ 'type' => 'structure', 'members' => [ 'continentCode' => [ 'shape' => 'string', ], 'description' => [ 'shape' => 'string', ], 'displayName' => [ 'shape' => 'string', ], 'name' => [ 'shape' => 'RegionName', ], 'availabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], 'relationalDatabaseAvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], ], ], 'RegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Region', ], ], 'RegionName' => [ 'type' => 'string', 'enum' => [ 'us-east-1', 'us-east-2', 'us-west-1', 'us-west-2', 'eu-west-1', 'eu-west-2', 'eu-west-3', 'eu-central-1', 'ca-central-1', 'ap-south-1', 'ap-southeast-1', 'ap-southeast-2', 'ap-northeast-1', 'ap-northeast-2', 'eu-north-1', ], ], 'RegisterContainerImageRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'label', 'digest', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'label' => [ 'shape' => 'ContainerLabel', ], 'digest' => [ 'shape' => 'string', ], ], ], 'RegisterContainerImageResult' => [ 'type' => 'structure', 'members' => [ 'containerImage' => [ 'shape' => 'ContainerImage', ], ], ], 'RegisteredDomainDelegationInfo' => [ 'type' => 'structure', 'members' => [ 'nameServersUpdateState' => [ 'shape' => 'NameServersUpdateState', ], 'r53HostedZoneDeletionState' => [ 'shape' => 'R53HostedZoneDeletionState', ], ], ], 'RelationalDatabase' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'relationalDatabaseBlueprintId' => [ 'shape' => 'NonEmptyString', ], 'relationalDatabaseBundleId' => [ 'shape' => 'NonEmptyString', ], 'masterDatabaseName' => [ 'shape' => 'string', ], 'hardware' => [ 'shape' => 'RelationalDatabaseHardware', ], 'state' => [ 'shape' => 'NonEmptyString', ], 'secondaryAvailabilityZone' => [ 'shape' => 'string', ], 'backupRetentionEnabled' => [ 'shape' => 'boolean', ], 'pendingModifiedValues' => [ 'shape' => 'PendingModifiedRelationalDatabaseValues', ], 'engine' => [ 'shape' => 'NonEmptyString', ], 'engineVersion' => [ 'shape' => 'NonEmptyString', ], 'latestRestorableTime' => [ 'shape' => 'IsoDate', ], 'masterUsername' => [ 'shape' => 'NonEmptyString', ], 'parameterApplyStatus' => [ 'shape' => 'NonEmptyString', ], 'preferredBackupWindow' => [ 'shape' => 'NonEmptyString', ], 'preferredMaintenanceWindow' => [ 'shape' => 'NonEmptyString', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'masterEndpoint' => [ 'shape' => 'RelationalDatabaseEndpoint', ], 'pendingMaintenanceActions' => [ 'shape' => 'PendingMaintenanceActionList', ], 'caCertificateIdentifier' => [ 'shape' => 'string', ], ], ], 'RelationalDatabaseBlueprint' => [ 'type' => 'structure', 'members' => [ 'blueprintId' => [ 'shape' => 'string', ], 'engine' => [ 'shape' => 'RelationalDatabaseEngine', ], 'engineVersion' => [ 'shape' => 'string', ], 'engineDescription' => [ 'shape' => 'string', ], 'engineVersionDescription' => [ 'shape' => 'string', ], 'isEngineDefault' => [ 'shape' => 'boolean', ], ], ], 'RelationalDatabaseBlueprintList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseBlueprint', ], ], 'RelationalDatabaseBundle' => [ 'type' => 'structure', 'members' => [ 'bundleId' => [ 'shape' => 'string', ], 'name' => [ 'shape' => 'string', ], 'price' => [ 'shape' => 'float', ], 'ramSizeInGb' => [ 'shape' => 'float', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'cpuCount' => [ 'shape' => 'integer', ], 'isEncrypted' => [ 'shape' => 'boolean', ], 'isActive' => [ 'shape' => 'boolean', ], ], ], 'RelationalDatabaseBundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseBundle', ], ], 'RelationalDatabaseEndpoint' => [ 'type' => 'structure', 'members' => [ 'port' => [ 'shape' => 'integer', ], 'address' => [ 'shape' => 'NonEmptyString', ], ], ], 'RelationalDatabaseEngine' => [ 'type' => 'string', 'enum' => [ 'mysql', ], ], 'RelationalDatabaseEvent' => [ 'type' => 'structure', 'members' => [ 'resource' => [ 'shape' => 'ResourceName', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'string', ], 'eventCategories' => [ 'shape' => 'StringList', ], ], ], 'RelationalDatabaseEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseEvent', ], ], 'RelationalDatabaseHardware' => [ 'type' => 'structure', 'members' => [ 'cpuCount' => [ 'shape' => 'integer', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'ramSizeInGb' => [ 'shape' => 'float', ], ], ], 'RelationalDatabaseList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabase', ], ], 'RelationalDatabaseMetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'DatabaseConnections', 'DiskQueueDepth', 'FreeStorageSpace', 'NetworkReceiveThroughput', 'NetworkTransmitThroughput', ], ], 'RelationalDatabaseParameter' => [ 'type' => 'structure', 'members' => [ 'allowedValues' => [ 'shape' => 'string', ], 'applyMethod' => [ 'shape' => 'string', ], 'applyType' => [ 'shape' => 'string', ], 'dataType' => [ 'shape' => 'string', ], 'description' => [ 'shape' => 'string', ], 'isModifiable' => [ 'shape' => 'boolean', ], 'parameterName' => [ 'shape' => 'string', ], 'parameterValue' => [ 'shape' => 'string', ], ], ], 'RelationalDatabaseParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseParameter', ], ], 'RelationalDatabasePasswordVersion' => [ 'type' => 'string', 'enum' => [ 'CURRENT', 'PREVIOUS', 'PENDING', ], ], 'RelationalDatabaseSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'engine' => [ 'shape' => 'NonEmptyString', ], 'engineVersion' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'state' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseName' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseArn' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseBundleId' => [ 'shape' => 'string', ], 'fromRelationalDatabaseBlueprintId' => [ 'shape' => 'string', ], ], ], 'RelationalDatabaseSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseSnapshot', ], ], 'ReleaseStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'ReleaseStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'RenewalStatus' => [ 'type' => 'string', 'enum' => [ 'PendingAutoRenewal', 'PendingValidation', 'Success', 'Failed', ], ], 'RenewalStatusReason' => [ 'type' => 'string', ], 'RenewalSummary' => [ 'type' => 'structure', 'members' => [ 'domainValidationRecords' => [ 'shape' => 'DomainValidationRecordList', ], 'renewalStatus' => [ 'shape' => 'RenewalStatus', ], 'renewalStatusReason' => [ 'shape' => 'RenewalStatusReason', ], 'updatedAt' => [ 'shape' => 'IsoDate', ], ], ], 'RequestFailureReason' => [ 'type' => 'string', ], 'ResetDistributionCacheRequest' => [ 'type' => 'structure', 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], ], ], 'ResetDistributionCacheResult' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'string', ], 'createTime' => [ 'shape' => 'IsoDate', ], 'operation' => [ 'shape' => 'Operation', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'pattern' => '^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$', ], 'ResourceBucketAccess' => [ 'type' => 'string', 'enum' => [ 'allow', 'deny', ], ], 'ResourceBudgetEstimate' => [ 'type' => 'structure', 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'costEstimates' => [ 'shape' => 'CostEstimates', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], ], ], 'ResourceLocation' => [ 'type' => 'structure', 'members' => [ 'availabilityZone' => [ 'shape' => 'string', ], 'regionName' => [ 'shape' => 'RegionName', ], ], ], 'ResourceName' => [ 'type' => 'string', 'pattern' => '\\w[\\w\\-]*\\w', ], 'ResourceNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceName', ], ], 'ResourceReceivingAccess' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'NonEmptyString', ], 'resourceType' => [ 'shape' => 'NonEmptyString', ], ], ], 'ResourceRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'string', ], 'type' => [ 'shape' => 'string', ], 'value' => [ 'shape' => 'string', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'ContainerService', 'Instance', 'StaticIp', 'KeyPair', 'InstanceSnapshot', 'Domain', 'PeeredVpc', 'LoadBalancer', 'LoadBalancerTlsCertificate', 'Disk', 'DiskSnapshot', 'RelationalDatabase', 'RelationalDatabaseSnapshot', 'ExportSnapshotRecord', 'CloudFormationStackRecord', 'Alarm', 'ContactMethod', 'Distribution', 'Certificate', 'Bucket', ], ], 'ResourcesBudgetEstimate' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceBudgetEstimate', ], ], 'RevocationReason' => [ 'type' => 'string', ], 'SendContactMethodVerificationRequest' => [ 'type' => 'structure', 'required' => [ 'protocol', ], 'members' => [ 'protocol' => [ 'shape' => 'ContactMethodVerificationProtocol', ], ], ], 'SendContactMethodVerificationResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'SensitiveNonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', 'sensitive' => true, ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'SerialNumber' => [ 'type' => 'string', ], 'ServiceException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, 'fault' => true, ], 'Session' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'NonEmptyString', ], 'url' => [ 'shape' => 'SensitiveNonEmptyString', ], 'isPrimary' => [ 'shape' => 'boolean', ], ], ], 'Sessions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Session', ], ], 'SetIpAddressTypeRequest' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resourceName', 'ipAddressType', ], 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], ], ], 'SetIpAddressTypeResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'SetResourceAccessForBucketRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'bucketName', 'access', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'bucketName' => [ 'shape' => 'BucketName', ], 'access' => [ 'shape' => 'ResourceBucketAccess', ], ], ], 'SetResourceAccessForBucketResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StartGUISessionRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], ], ], 'StartGUISessionResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StartInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'StartInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StartRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'StartRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StaticIp' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'ipAddress' => [ 'shape' => 'IpAddress', ], 'attachedTo' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], ], ], 'StaticIpList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StaticIp', ], ], 'Status' => [ 'type' => 'string', 'enum' => [ 'startExpired', 'notStarted', 'started', 'starting', 'stopped', 'stopping', 'settingUpInstance', 'failedInstanceCreation', 'failedStartingGUISession', 'failedStoppingGUISession', ], ], 'StatusType' => [ 'type' => 'string', 'enum' => [ 'Active', 'Inactive', ], ], 'StopGUISessionRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], ], ], 'StopGUISessionResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StopInstanceOnIdleRequest' => [ 'type' => 'structure', 'members' => [ 'threshold' => [ 'shape' => 'string', ], 'duration' => [ 'shape' => 'string', ], ], ], 'StopInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'force' => [ 'shape' => 'boolean', ], ], ], 'StopInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StopRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'StopRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'string', ], ], 'StringMax256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'SubjectAlternativeNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainName', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'tags', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceArn' => [ 'shape' => 'ResourceArn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'TagValue' => [ 'type' => 'string', ], 'TestAlarmRequest' => [ 'type' => 'structure', 'required' => [ 'alarmName', 'state', ], 'members' => [ 'alarmName' => [ 'shape' => 'ResourceName', ], 'state' => [ 'shape' => 'AlarmState', ], ], ], 'TestAlarmResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'TimeOfDay' => [ 'type' => 'string', 'pattern' => '^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$', ], 'TimePeriod' => [ 'type' => 'structure', 'members' => [ 'start' => [ 'shape' => 'IsoDate', ], 'end' => [ 'shape' => 'IsoDate', ], ], ], 'TreatMissingData' => [ 'type' => 'string', 'enum' => [ 'breaching', 'notBreaching', 'ignore', 'missing', ], ], 'UnauthenticatedException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'UnpeerVpcRequest' => [ 'type' => 'structure', 'members' => [], ], 'UnpeerVpcResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'tagKeys', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceArn' => [ 'shape' => 'ResourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateBucketBundleRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', 'bundleId', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], ], ], 'UpdateBucketBundleResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateBucketRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'accessRules' => [ 'shape' => 'AccessRules', ], 'versioning' => [ 'shape' => 'NonEmptyString', ], 'readonlyAccessAccounts' => [ 'shape' => 'PartnerIdList', ], 'accessLogConfig' => [ 'shape' => 'BucketAccessLogConfig', ], ], ], 'UpdateBucketResult' => [ 'type' => 'structure', 'members' => [ 'bucket' => [ 'shape' => 'Bucket', ], 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateContainerServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'power' => [ 'shape' => 'ContainerServicePowerName', ], 'scale' => [ 'shape' => 'ContainerServiceScale', ], 'isDisabled' => [ 'shape' => 'boolean', ], 'publicDomainNames' => [ 'shape' => 'ContainerServicePublicDomains', ], 'privateRegistryAccess' => [ 'shape' => 'PrivateRegistryAccessRequest', ], ], ], 'UpdateContainerServiceResult' => [ 'type' => 'structure', 'members' => [ 'containerService' => [ 'shape' => 'ContainerService', ], ], ], 'UpdateDistributionBundleRequest' => [ 'type' => 'structure', 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'bundleId' => [ 'shape' => 'string', ], ], ], 'UpdateDistributionBundleResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'UpdateDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'distributionName', ], 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'origin' => [ 'shape' => 'InputOrigin', ], 'defaultCacheBehavior' => [ 'shape' => 'CacheBehavior', ], 'cacheBehaviorSettings' => [ 'shape' => 'CacheSettings', ], 'cacheBehaviors' => [ 'shape' => 'CacheBehaviorList', ], 'isEnabled' => [ 'shape' => 'boolean', ], ], ], 'UpdateDistributionResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'UpdateDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'UpdateDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateInstanceMetadataOptionsRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'httpTokens' => [ 'shape' => 'HttpTokens', ], 'httpEndpoint' => [ 'shape' => 'HttpEndpoint', ], 'httpPutResponseHopLimit' => [ 'shape' => 'integer', ], 'httpProtocolIpv6' => [ 'shape' => 'HttpProtocolIpv6', ], ], ], 'UpdateInstanceMetadataOptionsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'UpdateLoadBalancerAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'attributeName', 'attributeValue', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'attributeName' => [ 'shape' => 'LoadBalancerAttributeName', ], 'attributeValue' => [ 'shape' => 'StringMax256', ], ], ], 'UpdateLoadBalancerAttributeResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateRelationalDatabaseParametersRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'parameters', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'parameters' => [ 'shape' => 'RelationalDatabaseParameterList', ], ], ], 'UpdateRelationalDatabaseParametersResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'rotateMasterUserPassword' => [ 'shape' => 'boolean', ], 'preferredBackupWindow' => [ 'shape' => 'string', ], 'preferredMaintenanceWindow' => [ 'shape' => 'string', ], 'enableBackupRetention' => [ 'shape' => 'boolean', ], 'disableBackupRetention' => [ 'shape' => 'boolean', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'applyImmediately' => [ 'shape' => 'boolean', ], 'caCertificateIdentifier' => [ 'shape' => 'string', ], ], ], 'UpdateRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'boolean' => [ 'type' => 'boolean', ], 'double' => [ 'type' => 'double', ], 'float' => [ 'type' => 'float', ], 'integer' => [ 'type' => 'integer', ], 'long' => [ 'type' => 'long', ], 'string' => [ 'type' => 'string', ], 'timestamp' => [ 'type' => 'timestamp', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2016-11-28', 'endpointPrefix' => 'lightsail', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'Amazon Lightsail', 'serviceId' => 'Lightsail', 'signatureVersion' => 'v4', 'targetPrefix' => 'Lightsail_20161128', 'uid' => 'lightsail-2016-11-28', ], 'operations' => [ 'AllocateStaticIp' => [ 'name' => 'AllocateStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocateStaticIpRequest', ], 'output' => [ 'shape' => 'AllocateStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachCertificateToDistribution' => [ 'name' => 'AttachCertificateToDistribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachCertificateToDistributionRequest', ], 'output' => [ 'shape' => 'AttachCertificateToDistributionResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachDisk' => [ 'name' => 'AttachDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachDiskRequest', ], 'output' => [ 'shape' => 'AttachDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachInstancesToLoadBalancer' => [ 'name' => 'AttachInstancesToLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachInstancesToLoadBalancerRequest', ], 'output' => [ 'shape' => 'AttachInstancesToLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachLoadBalancerTlsCertificate' => [ 'name' => 'AttachLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'AttachLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'AttachStaticIp' => [ 'name' => 'AttachStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AttachStaticIpRequest', ], 'output' => [ 'shape' => 'AttachStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CloseInstancePublicPorts' => [ 'name' => 'CloseInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CloseInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'CloseInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CopySnapshot' => [ 'name' => 'CopySnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopySnapshotRequest', ], 'output' => [ 'shape' => 'CopySnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateBucket' => [ 'name' => 'CreateBucket', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBucketRequest', ], 'output' => [ 'shape' => 'CreateBucketResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateBucketAccessKey' => [ 'name' => 'CreateBucketAccessKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBucketAccessKeyRequest', ], 'output' => [ 'shape' => 'CreateBucketAccessKeyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateCertificate' => [ 'name' => 'CreateCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCertificateRequest', ], 'output' => [ 'shape' => 'CreateCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateCloudFormationStack' => [ 'name' => 'CreateCloudFormationStack', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCloudFormationStackRequest', ], 'output' => [ 'shape' => 'CreateCloudFormationStackResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateContactMethod' => [ 'name' => 'CreateContactMethod', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContactMethodRequest', ], 'output' => [ 'shape' => 'CreateContactMethodResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateContainerService' => [ 'name' => 'CreateContainerService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContainerServiceRequest', ], 'output' => [ 'shape' => 'CreateContainerServiceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateContainerServiceDeployment' => [ 'name' => 'CreateContainerServiceDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContainerServiceDeploymentRequest', ], 'output' => [ 'shape' => 'CreateContainerServiceDeploymentResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateContainerServiceRegistryLogin' => [ 'name' => 'CreateContainerServiceRegistryLogin', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContainerServiceRegistryLoginRequest', ], 'output' => [ 'shape' => 'CreateContainerServiceRegistryLoginResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDisk' => [ 'name' => 'CreateDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskRequest', ], 'output' => [ 'shape' => 'CreateDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDiskFromSnapshot' => [ 'name' => 'CreateDiskFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateDiskFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDiskSnapshot' => [ 'name' => 'CreateDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDiskSnapshotRequest', ], 'output' => [ 'shape' => 'CreateDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDistribution' => [ 'name' => 'CreateDistribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDistributionRequest', ], 'output' => [ 'shape' => 'CreateDistributionResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateDomainEntry' => [ 'name' => 'CreateDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainEntryRequest', ], 'output' => [ 'shape' => 'CreateDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateGUISessionAccessDetails' => [ 'name' => 'CreateGUISessionAccessDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGUISessionAccessDetailsRequest', ], 'output' => [ 'shape' => 'CreateGUISessionAccessDetailsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstanceSnapshot' => [ 'name' => 'CreateInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'CreateInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstances' => [ 'name' => 'CreateInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstancesRequest', ], 'output' => [ 'shape' => 'CreateInstancesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateInstancesFromSnapshot' => [ 'name' => 'CreateInstancesFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstancesFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateInstancesFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateKeyPair' => [ 'name' => 'CreateKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateKeyPairRequest', ], 'output' => [ 'shape' => 'CreateKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateLoadBalancer' => [ 'name' => 'CreateLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLoadBalancerRequest', ], 'output' => [ 'shape' => 'CreateLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateLoadBalancerTlsCertificate' => [ 'name' => 'CreateLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'CreateLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabase' => [ 'name' => 'CreateRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabaseFromSnapshot' => [ 'name' => 'CreateRelationalDatabaseFromSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseFromSnapshotRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseFromSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'CreateRelationalDatabaseSnapshot' => [ 'name' => 'CreateRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'CreateRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteAlarm' => [ 'name' => 'DeleteAlarm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAlarmRequest', ], 'output' => [ 'shape' => 'DeleteAlarmResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'DeleteAutoSnapshot' => [ 'name' => 'DeleteAutoSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAutoSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteAutoSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteBucket' => [ 'name' => 'DeleteBucket', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBucketRequest', ], 'output' => [ 'shape' => 'DeleteBucketResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteBucketAccessKey' => [ 'name' => 'DeleteBucketAccessKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBucketAccessKeyRequest', ], 'output' => [ 'shape' => 'DeleteBucketAccessKeyResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteCertificate' => [ 'name' => 'DeleteCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCertificateRequest', ], 'output' => [ 'shape' => 'DeleteCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteContactMethod' => [ 'name' => 'DeleteContactMethod', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContactMethodRequest', ], 'output' => [ 'shape' => 'DeleteContactMethodResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'DeleteContainerImage' => [ 'name' => 'DeleteContainerImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContainerImageRequest', ], 'output' => [ 'shape' => 'DeleteContainerImageResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteContainerService' => [ 'name' => 'DeleteContainerService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContainerServiceRequest', ], 'output' => [ 'shape' => 'DeleteContainerServiceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDisk' => [ 'name' => 'DeleteDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDiskRequest', ], 'output' => [ 'shape' => 'DeleteDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDiskSnapshot' => [ 'name' => 'DeleteDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDiskSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDistribution' => [ 'name' => 'DeleteDistribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDistributionRequest', ], 'output' => [ 'shape' => 'DeleteDistributionResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'output' => [ 'shape' => 'DeleteDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteDomainEntry' => [ 'name' => 'DeleteDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainEntryRequest', ], 'output' => [ 'shape' => 'DeleteDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteInstance' => [ 'name' => 'DeleteInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInstanceRequest', ], 'output' => [ 'shape' => 'DeleteInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteInstanceSnapshot' => [ 'name' => 'DeleteInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteKeyPair' => [ 'name' => 'DeleteKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteKeyPairRequest', ], 'output' => [ 'shape' => 'DeleteKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteKnownHostKeys' => [ 'name' => 'DeleteKnownHostKeys', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteKnownHostKeysRequest', ], 'output' => [ 'shape' => 'DeleteKnownHostKeysResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteLoadBalancer' => [ 'name' => 'DeleteLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLoadBalancerRequest', ], 'output' => [ 'shape' => 'DeleteLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteLoadBalancerTlsCertificate' => [ 'name' => 'DeleteLoadBalancerTlsCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLoadBalancerTlsCertificateRequest', ], 'output' => [ 'shape' => 'DeleteLoadBalancerTlsCertificateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteRelationalDatabase' => [ 'name' => 'DeleteRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'DeleteRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DeleteRelationalDatabaseSnapshot' => [ 'name' => 'DeleteRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachCertificateFromDistribution' => [ 'name' => 'DetachCertificateFromDistribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachCertificateFromDistributionRequest', ], 'output' => [ 'shape' => 'DetachCertificateFromDistributionResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachDisk' => [ 'name' => 'DetachDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachDiskRequest', ], 'output' => [ 'shape' => 'DetachDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachInstancesFromLoadBalancer' => [ 'name' => 'DetachInstancesFromLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachInstancesFromLoadBalancerRequest', ], 'output' => [ 'shape' => 'DetachInstancesFromLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DetachStaticIp' => [ 'name' => 'DetachStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DetachStaticIpRequest', ], 'output' => [ 'shape' => 'DetachStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DisableAddOn' => [ 'name' => 'DisableAddOn', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableAddOnRequest', ], 'output' => [ 'shape' => 'DisableAddOnResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'DownloadDefaultKeyPair' => [ 'name' => 'DownloadDefaultKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DownloadDefaultKeyPairRequest', ], 'output' => [ 'shape' => 'DownloadDefaultKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'EnableAddOn' => [ 'name' => 'EnableAddOn', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableAddOnRequest', ], 'output' => [ 'shape' => 'EnableAddOnResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ExportSnapshot' => [ 'name' => 'ExportSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExportSnapshotRequest', ], 'output' => [ 'shape' => 'ExportSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetActiveNames' => [ 'name' => 'GetActiveNames', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetActiveNamesRequest', ], 'output' => [ 'shape' => 'GetActiveNamesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetAlarms' => [ 'name' => 'GetAlarms', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAlarmsRequest', ], 'output' => [ 'shape' => 'GetAlarmsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'GetAutoSnapshots' => [ 'name' => 'GetAutoSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAutoSnapshotsRequest', ], 'output' => [ 'shape' => 'GetAutoSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBlueprints' => [ 'name' => 'GetBlueprints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBlueprintsRequest', ], 'output' => [ 'shape' => 'GetBlueprintsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBucketAccessKeys' => [ 'name' => 'GetBucketAccessKeys', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBucketAccessKeysRequest', ], 'output' => [ 'shape' => 'GetBucketAccessKeysResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBucketBundles' => [ 'name' => 'GetBucketBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBucketBundlesRequest', ], 'output' => [ 'shape' => 'GetBucketBundlesResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBucketMetricData' => [ 'name' => 'GetBucketMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBucketMetricDataRequest', ], 'output' => [ 'shape' => 'GetBucketMetricDataResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBuckets' => [ 'name' => 'GetBuckets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBucketsRequest', ], 'output' => [ 'shape' => 'GetBucketsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetBundles' => [ 'name' => 'GetBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBundlesRequest', ], 'output' => [ 'shape' => 'GetBundlesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetCertificates' => [ 'name' => 'GetCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCertificatesRequest', ], 'output' => [ 'shape' => 'GetCertificatesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetCloudFormationStackRecords' => [ 'name' => 'GetCloudFormationStackRecords', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCloudFormationStackRecordsRequest', ], 'output' => [ 'shape' => 'GetCloudFormationStackRecordsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContactMethods' => [ 'name' => 'GetContactMethods', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContactMethodsRequest', ], 'output' => [ 'shape' => 'GetContactMethodsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerAPIMetadata' => [ 'name' => 'GetContainerAPIMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerAPIMetadataRequest', ], 'output' => [ 'shape' => 'GetContainerAPIMetadataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerImages' => [ 'name' => 'GetContainerImages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerImagesRequest', ], 'output' => [ 'shape' => 'GetContainerImagesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerLog' => [ 'name' => 'GetContainerLog', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerLogRequest', ], 'output' => [ 'shape' => 'GetContainerLogResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerServiceDeployments' => [ 'name' => 'GetContainerServiceDeployments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerServiceDeploymentsRequest', ], 'output' => [ 'shape' => 'GetContainerServiceDeploymentsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerServiceMetricData' => [ 'name' => 'GetContainerServiceMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerServiceMetricDataRequest', ], 'output' => [ 'shape' => 'GetContainerServiceMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerServicePowers' => [ 'name' => 'GetContainerServicePowers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerServicePowersRequest', ], 'output' => [ 'shape' => 'GetContainerServicePowersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetContainerServices' => [ 'name' => 'GetContainerServices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetContainerServicesRequest', ], 'output' => [ 'shape' => 'ContainerServicesListResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetCostEstimate' => [ 'name' => 'GetCostEstimate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCostEstimateRequest', ], 'output' => [ 'shape' => 'GetCostEstimateResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDisk' => [ 'name' => 'GetDisk', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskRequest', ], 'output' => [ 'shape' => 'GetDiskResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDiskSnapshot' => [ 'name' => 'GetDiskSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskSnapshotRequest', ], 'output' => [ 'shape' => 'GetDiskSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDiskSnapshots' => [ 'name' => 'GetDiskSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiskSnapshotsRequest', ], 'output' => [ 'shape' => 'GetDiskSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDisks' => [ 'name' => 'GetDisks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDisksRequest', ], 'output' => [ 'shape' => 'GetDisksResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDistributionBundles' => [ 'name' => 'GetDistributionBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDistributionBundlesRequest', ], 'output' => [ 'shape' => 'GetDistributionBundlesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDistributionLatestCacheReset' => [ 'name' => 'GetDistributionLatestCacheReset', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDistributionLatestCacheResetRequest', ], 'output' => [ 'shape' => 'GetDistributionLatestCacheResetResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDistributionMetricData' => [ 'name' => 'GetDistributionMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDistributionMetricDataRequest', ], 'output' => [ 'shape' => 'GetDistributionMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDistributions' => [ 'name' => 'GetDistributions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDistributionsRequest', ], 'output' => [ 'shape' => 'GetDistributionsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDomain' => [ 'name' => 'GetDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDomainRequest', ], 'output' => [ 'shape' => 'GetDomainResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetDomains' => [ 'name' => 'GetDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDomainsRequest', ], 'output' => [ 'shape' => 'GetDomainsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetExportSnapshotRecords' => [ 'name' => 'GetExportSnapshotRecords', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetExportSnapshotRecordsRequest', ], 'output' => [ 'shape' => 'GetExportSnapshotRecordsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstance' => [ 'name' => 'GetInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceRequest', ], 'output' => [ 'shape' => 'GetInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceAccessDetails' => [ 'name' => 'GetInstanceAccessDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceAccessDetailsRequest', ], 'output' => [ 'shape' => 'GetInstanceAccessDetailsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceMetricData' => [ 'name' => 'GetInstanceMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceMetricDataRequest', ], 'output' => [ 'shape' => 'GetInstanceMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstancePortStates' => [ 'name' => 'GetInstancePortStates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstancePortStatesRequest', ], 'output' => [ 'shape' => 'GetInstancePortStatesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceSnapshot' => [ 'name' => 'GetInstanceSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceSnapshotRequest', ], 'output' => [ 'shape' => 'GetInstanceSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceSnapshots' => [ 'name' => 'GetInstanceSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceSnapshotsRequest', ], 'output' => [ 'shape' => 'GetInstanceSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstanceState' => [ 'name' => 'GetInstanceState', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceStateRequest', ], 'output' => [ 'shape' => 'GetInstanceStateResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetInstances' => [ 'name' => 'GetInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstancesRequest', ], 'output' => [ 'shape' => 'GetInstancesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetKeyPair' => [ 'name' => 'GetKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetKeyPairRequest', ], 'output' => [ 'shape' => 'GetKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetKeyPairs' => [ 'name' => 'GetKeyPairs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetKeyPairsRequest', ], 'output' => [ 'shape' => 'GetKeyPairsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancer' => [ 'name' => 'GetLoadBalancer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancerMetricData' => [ 'name' => 'GetLoadBalancerMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerMetricDataRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancerTlsCertificates' => [ 'name' => 'GetLoadBalancerTlsCertificates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerTlsCertificatesRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerTlsCertificatesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetLoadBalancerTlsPolicies' => [ 'name' => 'GetLoadBalancerTlsPolicies', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancerTlsPoliciesRequest', ], 'output' => [ 'shape' => 'GetLoadBalancerTlsPoliciesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'InvalidInputException', ], ], ], 'GetLoadBalancers' => [ 'name' => 'GetLoadBalancers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLoadBalancersRequest', ], 'output' => [ 'shape' => 'GetLoadBalancersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperation' => [ 'name' => 'GetOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationRequest', ], 'output' => [ 'shape' => 'GetOperationResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperations' => [ 'name' => 'GetOperations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationsRequest', ], 'output' => [ 'shape' => 'GetOperationsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetOperationsForResource' => [ 'name' => 'GetOperationsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOperationsForResourceRequest', ], 'output' => [ 'shape' => 'GetOperationsForResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRegions' => [ 'name' => 'GetRegions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRegionsRequest', ], 'output' => [ 'shape' => 'GetRegionsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabase' => [ 'name' => 'GetRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseBlueprints' => [ 'name' => 'GetRelationalDatabaseBlueprints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseBlueprintsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseBlueprintsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseBundles' => [ 'name' => 'GetRelationalDatabaseBundles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseBundlesRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseBundlesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseEvents' => [ 'name' => 'GetRelationalDatabaseEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseEventsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseEventsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseLogEvents' => [ 'name' => 'GetRelationalDatabaseLogEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseLogEventsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseLogEventsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseLogStreams' => [ 'name' => 'GetRelationalDatabaseLogStreams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseLogStreamsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseLogStreamsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseMasterUserPassword' => [ 'name' => 'GetRelationalDatabaseMasterUserPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseMasterUserPasswordRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseMasterUserPasswordResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseMetricData' => [ 'name' => 'GetRelationalDatabaseMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseMetricDataRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseMetricDataResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseParameters' => [ 'name' => 'GetRelationalDatabaseParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseParametersRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseParametersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseSnapshot' => [ 'name' => 'GetRelationalDatabaseSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseSnapshotRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabaseSnapshots' => [ 'name' => 'GetRelationalDatabaseSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabaseSnapshotsRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabaseSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetRelationalDatabases' => [ 'name' => 'GetRelationalDatabases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRelationalDatabasesRequest', ], 'output' => [ 'shape' => 'GetRelationalDatabasesResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetSetupHistory' => [ 'name' => 'GetSetupHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSetupHistoryRequest', ], 'output' => [ 'shape' => 'GetSetupHistoryResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetStaticIp' => [ 'name' => 'GetStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStaticIpRequest', ], 'output' => [ 'shape' => 'GetStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'GetStaticIps' => [ 'name' => 'GetStaticIps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStaticIpsRequest', ], 'output' => [ 'shape' => 'GetStaticIpsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ImportKeyPair' => [ 'name' => 'ImportKeyPair', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportKeyPairRequest', ], 'output' => [ 'shape' => 'ImportKeyPairResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'IsVpcPeered' => [ 'name' => 'IsVpcPeered', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'IsVpcPeeredRequest', ], 'output' => [ 'shape' => 'IsVpcPeeredResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'OpenInstancePublicPorts' => [ 'name' => 'OpenInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'OpenInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'OpenInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'PeerVpc' => [ 'name' => 'PeerVpc', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PeerVpcRequest', ], 'output' => [ 'shape' => 'PeerVpcResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'PutAlarm' => [ 'name' => 'PutAlarm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAlarmRequest', ], 'output' => [ 'shape' => 'PutAlarmResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'PutInstancePublicPorts' => [ 'name' => 'PutInstancePublicPorts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutInstancePublicPortsRequest', ], 'output' => [ 'shape' => 'PutInstancePublicPortsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'RebootInstance' => [ 'name' => 'RebootInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootInstanceRequest', ], 'output' => [ 'shape' => 'RebootInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'RebootRelationalDatabase' => [ 'name' => 'RebootRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'RebootRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'RegisterContainerImage' => [ 'name' => 'RegisterContainerImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterContainerImageRequest', ], 'output' => [ 'shape' => 'RegisterContainerImageResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ReleaseStaticIp' => [ 'name' => 'ReleaseStaticIp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ReleaseStaticIpRequest', ], 'output' => [ 'shape' => 'ReleaseStaticIpResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'ResetDistributionCache' => [ 'name' => 'ResetDistributionCache', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetDistributionCacheRequest', ], 'output' => [ 'shape' => 'ResetDistributionCacheResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'SendContactMethodVerification' => [ 'name' => 'SendContactMethodVerification', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendContactMethodVerificationRequest', ], 'output' => [ 'shape' => 'SendContactMethodVerificationResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'SetIpAddressType' => [ 'name' => 'SetIpAddressType', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetIpAddressTypeRequest', ], 'output' => [ 'shape' => 'SetIpAddressTypeResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'SetResourceAccessForBucket' => [ 'name' => 'SetResourceAccessForBucket', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetResourceAccessForBucketRequest', ], 'output' => [ 'shape' => 'SetResourceAccessForBucketResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'SetupInstanceHttps' => [ 'name' => 'SetupInstanceHttps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetupInstanceHttpsRequest', ], 'output' => [ 'shape' => 'SetupInstanceHttpsResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StartGUISession' => [ 'name' => 'StartGUISession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartGUISessionRequest', ], 'output' => [ 'shape' => 'StartGUISessionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StartInstance' => [ 'name' => 'StartInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartInstanceRequest', ], 'output' => [ 'shape' => 'StartInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StartRelationalDatabase' => [ 'name' => 'StartRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'StartRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StopGUISession' => [ 'name' => 'StopGUISession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopGUISessionRequest', ], 'output' => [ 'shape' => 'StopGUISessionResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StopInstance' => [ 'name' => 'StopInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInstanceRequest', ], 'output' => [ 'shape' => 'StopInstanceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'StopRelationalDatabase' => [ 'name' => 'StopRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'StopRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'TestAlarm' => [ 'name' => 'TestAlarm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TestAlarmRequest', ], 'output' => [ 'shape' => 'TestAlarmResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'UnauthenticatedException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'NotFoundException', ], ], ], 'UnpeerVpc' => [ 'name' => 'UnpeerVpc', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UnpeerVpcRequest', ], 'output' => [ 'shape' => 'UnpeerVpcResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateBucket' => [ 'name' => 'UpdateBucket', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateBucketRequest', ], 'output' => [ 'shape' => 'UpdateBucketResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateBucketBundle' => [ 'name' => 'UpdateBucketBundle', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateBucketBundleRequest', ], 'output' => [ 'shape' => 'UpdateBucketBundleResult', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateContainerService' => [ 'name' => 'UpdateContainerService', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContainerServiceRequest', ], 'output' => [ 'shape' => 'UpdateContainerServiceResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateDistribution' => [ 'name' => 'UpdateDistribution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDistributionRequest', ], 'output' => [ 'shape' => 'UpdateDistributionResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateDistributionBundle' => [ 'name' => 'UpdateDistributionBundle', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDistributionBundleRequest', ], 'output' => [ 'shape' => 'UpdateDistributionBundleResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateDomainEntry' => [ 'name' => 'UpdateDomainEntry', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDomainEntryRequest', ], 'output' => [ 'shape' => 'UpdateDomainEntryResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateInstanceMetadataOptions' => [ 'name' => 'UpdateInstanceMetadataOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInstanceMetadataOptionsRequest', ], 'output' => [ 'shape' => 'UpdateInstanceMetadataOptionsResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateLoadBalancerAttribute' => [ 'name' => 'UpdateLoadBalancerAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateLoadBalancerAttributeRequest', ], 'output' => [ 'shape' => 'UpdateLoadBalancerAttributeResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateRelationalDatabase' => [ 'name' => 'UpdateRelationalDatabase', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRelationalDatabaseRequest', ], 'output' => [ 'shape' => 'UpdateRelationalDatabaseResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], 'UpdateRelationalDatabaseParameters' => [ 'name' => 'UpdateRelationalDatabaseParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateRelationalDatabaseParametersRequest', ], 'output' => [ 'shape' => 'UpdateRelationalDatabaseParametersResult', ], 'errors' => [ [ 'shape' => 'ServiceException', ], [ 'shape' => 'InvalidInputException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'OperationFailureException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'AccountSetupInProgressException', ], [ 'shape' => 'UnauthenticatedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'AccessDirection' => [ 'type' => 'string', 'enum' => [ 'inbound', 'outbound', ], ], 'AccessKey' => [ 'type' => 'structure', 'members' => [ 'accessKeyId' => [ 'shape' => 'IAMAccessKeyId', ], 'secretAccessKey' => [ 'shape' => 'NonEmptyString', ], 'status' => [ 'shape' => 'StatusType', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'lastUsed' => [ 'shape' => 'AccessKeyLastUsed', ], ], ], 'AccessKeyLastUsed' => [ 'type' => 'structure', 'members' => [ 'lastUsedDate' => [ 'shape' => 'IsoDate', ], 'region' => [ 'shape' => 'string', ], 'serviceName' => [ 'shape' => 'string', ], ], ], 'AccessKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessKey', ], ], 'AccessReceiverList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceReceivingAccess', ], ], 'AccessRules' => [ 'type' => 'structure', 'members' => [ 'getObject' => [ 'shape' => 'AccessType', ], 'allowPublicOverrides' => [ 'shape' => 'boolean', ], ], ], 'AccessType' => [ 'type' => 'string', 'enum' => [ 'public', 'private', ], ], 'AccountLevelBpaSync' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'AccountLevelBpaSyncStatus', ], 'lastSyncedAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'BPAStatusMessage', ], 'bpaImpactsLightsail' => [ 'shape' => 'boolean', ], ], ], 'AccountLevelBpaSyncStatus' => [ 'type' => 'string', 'enum' => [ 'InSync', 'Failed', 'NeverSynced', 'Defaulted', ], ], 'AccountSetupInProgressException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'AddOn' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'string', ], 'status' => [ 'shape' => 'string', ], 'snapshotTimeOfDay' => [ 'shape' => 'TimeOfDay', ], 'nextSnapshotTimeOfDay' => [ 'shape' => 'TimeOfDay', ], 'threshold' => [ 'shape' => 'string', ], 'duration' => [ 'shape' => 'string', ], ], ], 'AddOnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AddOn', ], ], 'AddOnRequest' => [ 'type' => 'structure', 'required' => [ 'addOnType', ], 'members' => [ 'addOnType' => [ 'shape' => 'AddOnType', ], 'autoSnapshotAddOnRequest' => [ 'shape' => 'AutoSnapshotAddOnRequest', ], 'stopInstanceOnIdleRequest' => [ 'shape' => 'StopInstanceOnIdleRequest', ], ], ], 'AddOnRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AddOnRequest', ], ], 'AddOnType' => [ 'type' => 'string', 'enum' => [ 'AutoSnapshot', 'StopInstanceOnIdle', ], ], 'Alarm' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'supportCode' => [ 'shape' => 'string', ], 'monitoredResourceInfo' => [ 'shape' => 'MonitoredResourceInfo', ], 'comparisonOperator' => [ 'shape' => 'ComparisonOperator', ], 'evaluationPeriods' => [ 'shape' => 'integer', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'threshold' => [ 'shape' => 'double', ], 'datapointsToAlarm' => [ 'shape' => 'integer', ], 'treatMissingData' => [ 'shape' => 'TreatMissingData', ], 'statistic' => [ 'shape' => 'MetricStatistic', ], 'metricName' => [ 'shape' => 'MetricName', ], 'state' => [ 'shape' => 'AlarmState', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'contactProtocols' => [ 'shape' => 'ContactProtocolsList', ], 'notificationTriggers' => [ 'shape' => 'NotificationTriggerList', ], 'notificationEnabled' => [ 'shape' => 'boolean', ], ], ], 'AlarmState' => [ 'type' => 'string', 'enum' => [ 'OK', 'ALARM', 'INSUFFICIENT_DATA', ], ], 'AlarmsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Alarm', ], ], 'AllocateStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'AllocateStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AppCategory' => [ 'type' => 'string', 'enum' => [ 'LfR', ], ], 'AppCategoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppCategory', ], ], 'AttachCertificateToDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'distributionName', 'certificateName', ], 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], ], ], 'AttachCertificateToDistributionResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'AttachDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'instanceName', 'diskPath', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'diskPath' => [ 'shape' => 'NonEmptyString', ], 'autoMounting' => [ 'shape' => 'boolean', ], ], ], 'AttachDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachInstancesToLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instanceNames', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instanceNames' => [ 'shape' => 'ResourceNameList', ], ], ], 'AttachInstancesToLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], ], ], 'AttachLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', 'instanceName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'AttachStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'AttachedDisk' => [ 'type' => 'structure', 'members' => [ 'path' => [ 'shape' => 'string', ], 'sizeInGb' => [ 'shape' => 'integer', ], ], ], 'AttachedDiskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachedDisk', ], ], 'AttachedDiskMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceName', ], 'value' => [ 'shape' => 'DiskMapList', ], ], 'AutoMountStatus' => [ 'type' => 'string', 'enum' => [ 'Failed', 'Pending', 'Mounted', 'NotMounted', ], ], 'AutoSnapshotAddOnRequest' => [ 'type' => 'structure', 'members' => [ 'snapshotTimeOfDay' => [ 'shape' => 'TimeOfDay', ], ], ], 'AutoSnapshotDate' => [ 'type' => 'string', 'pattern' => '^[0-9]{4}-[0-9]{2}-[0-9]{2}$', ], 'AutoSnapshotDetails' => [ 'type' => 'structure', 'members' => [ 'date' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'status' => [ 'shape' => 'AutoSnapshotStatus', ], 'fromAttachedDisks' => [ 'shape' => 'AttachedDiskList', ], ], ], 'AutoSnapshotDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoSnapshotDetails', ], ], 'AutoSnapshotStatus' => [ 'type' => 'string', 'enum' => [ 'Success', 'Failed', 'InProgress', 'NotFound', ], ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'zoneName' => [ 'shape' => 'NonEmptyString', ], 'state' => [ 'shape' => 'NonEmptyString', ], ], ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', ], ], 'BPAStatusMessage' => [ 'type' => 'string', 'enum' => [ 'DEFAULTED_FOR_SLR_MISSING', 'SYNC_ON_HOLD', 'DEFAULTED_FOR_SLR_MISSING_ON_HOLD', 'Unknown', ], ], 'Base64' => [ 'type' => 'string', ], 'BehaviorEnum' => [ 'type' => 'string', 'enum' => [ 'dont-cache', 'cache', ], ], 'Blueprint' => [ 'type' => 'structure', 'members' => [ 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'ResourceName', ], 'group' => [ 'shape' => 'NonEmptyString', ], 'type' => [ 'shape' => 'BlueprintType', ], 'description' => [ 'shape' => 'string', ], 'isActive' => [ 'shape' => 'boolean', ], 'minPower' => [ 'shape' => 'integer', ], 'version' => [ 'shape' => 'string', ], 'versionCode' => [ 'shape' => 'string', ], 'productUrl' => [ 'shape' => 'string', ], 'licenseUrl' => [ 'shape' => 'string', ], 'platform' => [ 'shape' => 'InstancePlatform', ], 'appCategory' => [ 'shape' => 'AppCategory', ], ], ], 'BlueprintList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Blueprint', ], ], 'BlueprintType' => [ 'type' => 'string', 'enum' => [ 'os', 'app', ], ], 'Bucket' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'NonEmptyString', ], 'accessRules' => [ 'shape' => 'AccessRules', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'url' => [ 'shape' => 'NonEmptyString', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'name' => [ 'shape' => 'BucketName', ], 'supportCode' => [ 'shape' => 'NonEmptyString', ], 'tags' => [ 'shape' => 'TagList', ], 'objectVersioning' => [ 'shape' => 'NonEmptyString', ], 'ableToUpdateBundle' => [ 'shape' => 'boolean', ], 'readonlyAccessAccounts' => [ 'shape' => 'PartnerIdList', ], 'resourcesReceivingAccess' => [ 'shape' => 'AccessReceiverList', ], 'state' => [ 'shape' => 'BucketState', ], 'accessLogConfig' => [ 'shape' => 'BucketAccessLogConfig', ], ], ], 'BucketAccessLogConfig' => [ 'type' => 'structure', 'required' => [ 'enabled', ], 'members' => [ 'enabled' => [ 'shape' => 'boolean', ], 'destination' => [ 'shape' => 'BucketName', ], 'prefix' => [ 'shape' => 'BucketAccessLogPrefix', ], ], ], 'BucketAccessLogPrefix' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[\\w/!.*\')(-]+$', ], 'BucketBundle' => [ 'type' => 'structure', 'members' => [ 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'price' => [ 'shape' => 'float', ], 'storagePerMonthInGb' => [ 'shape' => 'integer', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'isActive' => [ 'shape' => 'boolean', ], ], ], 'BucketBundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BucketBundle', ], ], 'BucketList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Bucket', ], ], 'BucketMetricName' => [ 'type' => 'string', 'enum' => [ 'BucketSizeBytes', 'NumberOfObjects', ], ], 'BucketName' => [ 'type' => 'string', 'max' => 54, 'min' => 3, 'pattern' => '^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$', ], 'BucketState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'NonEmptyString', ], 'message' => [ 'shape' => 'string', ], ], ], 'Bundle' => [ 'type' => 'structure', 'members' => [ 'price' => [ 'shape' => 'float', ], 'cpuCount' => [ 'shape' => 'integer', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'instanceType' => [ 'shape' => 'string', ], 'isActive' => [ 'shape' => 'boolean', ], 'name' => [ 'shape' => 'string', ], 'power' => [ 'shape' => 'integer', ], 'ramSizeInGb' => [ 'shape' => 'float', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'supportedPlatforms' => [ 'shape' => 'InstancePlatformList', ], 'supportedAppCategories' => [ 'shape' => 'AppCategoryList', ], ], ], 'BundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Bundle', ], ], 'CacheBehavior' => [ 'type' => 'structure', 'members' => [ 'behavior' => [ 'shape' => 'BehaviorEnum', ], ], ], 'CacheBehaviorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheBehaviorPerPath', ], ], 'CacheBehaviorPerPath' => [ 'type' => 'structure', 'members' => [ 'path' => [ 'shape' => 'string', ], 'behavior' => [ 'shape' => 'BehaviorEnum', ], ], ], 'CacheSettings' => [ 'type' => 'structure', 'members' => [ 'defaultTTL' => [ 'shape' => 'long', ], 'minimumTTL' => [ 'shape' => 'long', ], 'maximumTTL' => [ 'shape' => 'long', ], 'allowedHTTPMethods' => [ 'shape' => 'NonEmptyString', ], 'cachedHTTPMethods' => [ 'shape' => 'NonEmptyString', ], 'forwardedCookies' => [ 'shape' => 'CookieObject', ], 'forwardedHeaders' => [ 'shape' => 'HeaderObject', ], 'forwardedQueryStrings' => [ 'shape' => 'QueryStringObject', ], ], ], 'Certificate' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'CertificateName', ], 'domainName' => [ 'shape' => 'DomainName', ], 'status' => [ 'shape' => 'CertificateStatus', ], 'serialNumber' => [ 'shape' => 'SerialNumber', ], 'subjectAlternativeNames' => [ 'shape' => 'SubjectAlternativeNameList', ], 'domainValidationRecords' => [ 'shape' => 'DomainValidationRecordList', ], 'requestFailureReason' => [ 'shape' => 'RequestFailureReason', ], 'inUseResourceCount' => [ 'shape' => 'InUseResourceCount', ], 'keyAlgorithm' => [ 'shape' => 'KeyAlgorithm', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'issuedAt' => [ 'shape' => 'IsoDate', ], 'issuerCA' => [ 'shape' => 'IssuerCA', ], 'notBefore' => [ 'shape' => 'IsoDate', ], 'notAfter' => [ 'shape' => 'IsoDate', ], 'eligibleToRenew' => [ 'shape' => 'EligibleToRenew', ], 'renewalSummary' => [ 'shape' => 'RenewalSummary', ], 'revokedAt' => [ 'shape' => 'IsoDate', ], 'revocationReason' => [ 'shape' => 'RevocationReason', ], 'tags' => [ 'shape' => 'TagList', ], 'supportCode' => [ 'shape' => 'string', ], ], ], 'CertificateDomainValidationStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'FAILED', 'SUCCESS', ], ], 'CertificateName' => [ 'type' => 'string', ], 'CertificateProvider' => [ 'type' => 'string', 'enum' => [ 'LetsEncrypt', ], ], 'CertificateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'ISSUED', 'INACTIVE', 'EXPIRED', 'VALIDATION_TIMED_OUT', 'REVOKED', 'FAILED', ], ], 'CertificateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CertificateStatus', ], ], 'CertificateSummary' => [ 'type' => 'structure', 'members' => [ 'certificateArn' => [ 'shape' => 'NonEmptyString', ], 'certificateName' => [ 'shape' => 'CertificateName', ], 'domainName' => [ 'shape' => 'DomainName', ], 'certificateDetail' => [ 'shape' => 'Certificate', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CertificateSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CertificateSummary', ], ], 'CloseInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfo', 'instanceName', ], 'members' => [ 'portInfo' => [ 'shape' => 'PortInfo', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'CloseInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CloudFormationStackRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'state' => [ 'shape' => 'RecordState', ], 'sourceInfo' => [ 'shape' => 'CloudFormationStackRecordSourceInfoList', ], 'destinationInfo' => [ 'shape' => 'DestinationInfo', ], ], ], 'CloudFormationStackRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudFormationStackRecord', ], ], 'CloudFormationStackRecordSourceInfo' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'CloudFormationStackRecordSourceType', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'arn' => [ 'shape' => 'NonEmptyString', ], ], ], 'CloudFormationStackRecordSourceInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudFormationStackRecordSourceInfo', ], ], 'CloudFormationStackRecordSourceType' => [ 'type' => 'string', 'enum' => [ 'ExportSnapshotRecord', ], ], 'ComparisonOperator' => [ 'type' => 'string', 'enum' => [ 'GreaterThanOrEqualToThreshold', 'GreaterThanThreshold', 'LessThanThreshold', 'LessThanOrEqualToThreshold', ], ], 'ContactMethod' => [ 'type' => 'structure', 'members' => [ 'contactEndpoint' => [ 'shape' => 'NonEmptyString', ], 'status' => [ 'shape' => 'ContactMethodStatus', ], 'protocol' => [ 'shape' => 'ContactProtocol', ], 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'supportCode' => [ 'shape' => 'string', ], ], ], 'ContactMethodStatus' => [ 'type' => 'string', 'enum' => [ 'PendingVerification', 'Valid', 'Invalid', ], ], 'ContactMethodVerificationProtocol' => [ 'type' => 'string', 'enum' => [ 'Email', ], ], 'ContactMethodsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactMethod', ], ], 'ContactProtocol' => [ 'type' => 'string', 'enum' => [ 'Email', 'SMS', ], ], 'ContactProtocolsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactProtocol', ], ], 'Container' => [ 'type' => 'structure', 'members' => [ 'image' => [ 'shape' => 'string', ], 'command' => [ 'shape' => 'StringList', ], 'environment' => [ 'shape' => 'Environment', ], 'ports' => [ 'shape' => 'PortMap', ], ], ], 'ContainerImage' => [ 'type' => 'structure', 'members' => [ 'image' => [ 'shape' => 'string', ], 'digest' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], ], ], 'ContainerImageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerImage', ], ], 'ContainerLabel' => [ 'type' => 'string', 'max' => 53, 'min' => 1, 'pattern' => '^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$', ], 'ContainerMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ContainerName', ], 'value' => [ 'shape' => 'Container', ], ], 'ContainerName' => [ 'type' => 'string', 'max' => 53, 'min' => 1, 'pattern' => '^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$', ], 'ContainerService' => [ 'type' => 'structure', 'members' => [ 'containerServiceName' => [ 'shape' => 'ContainerServiceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'power' => [ 'shape' => 'ContainerServicePowerName', ], 'powerId' => [ 'shape' => 'string', ], 'state' => [ 'shape' => 'ContainerServiceState', ], 'stateDetail' => [ 'shape' => 'ContainerServiceStateDetail', ], 'scale' => [ 'shape' => 'ContainerServiceScale', ], 'currentDeployment' => [ 'shape' => 'ContainerServiceDeployment', ], 'nextDeployment' => [ 'shape' => 'ContainerServiceDeployment', ], 'isDisabled' => [ 'shape' => 'boolean', ], 'principalArn' => [ 'shape' => 'string', ], 'privateDomainName' => [ 'shape' => 'string', ], 'publicDomainNames' => [ 'shape' => 'ContainerServicePublicDomains', ], 'url' => [ 'shape' => 'string', ], 'privateRegistryAccess' => [ 'shape' => 'PrivateRegistryAccess', ], ], ], 'ContainerServiceDeployment' => [ 'type' => 'structure', 'members' => [ 'version' => [ 'shape' => 'integer', ], 'state' => [ 'shape' => 'ContainerServiceDeploymentState', ], 'containers' => [ 'shape' => 'ContainerMap', ], 'publicEndpoint' => [ 'shape' => 'ContainerServiceEndpoint', ], 'createdAt' => [ 'shape' => 'IsoDate', ], ], ], 'ContainerServiceDeploymentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerServiceDeployment', ], ], 'ContainerServiceDeploymentRequest' => [ 'type' => 'structure', 'members' => [ 'containers' => [ 'shape' => 'ContainerMap', ], 'publicEndpoint' => [ 'shape' => 'EndpointRequest', ], ], ], 'ContainerServiceDeploymentState' => [ 'type' => 'string', 'enum' => [ 'ACTIVATING', 'ACTIVE', 'INACTIVE', 'FAILED', ], ], 'ContainerServiceECRImagePullerRole' => [ 'type' => 'structure', 'members' => [ 'isActive' => [ 'shape' => 'boolean', ], 'principalArn' => [ 'shape' => 'string', ], ], ], 'ContainerServiceECRImagePullerRoleRequest' => [ 'type' => 'structure', 'members' => [ 'isActive' => [ 'shape' => 'boolean', ], ], ], 'ContainerServiceEndpoint' => [ 'type' => 'structure', 'members' => [ 'containerName' => [ 'shape' => 'string', ], 'containerPort' => [ 'shape' => 'integer', ], 'healthCheck' => [ 'shape' => 'ContainerServiceHealthCheckConfig', ], ], ], 'ContainerServiceHealthCheckConfig' => [ 'type' => 'structure', 'members' => [ 'healthyThreshold' => [ 'shape' => 'integer', ], 'unhealthyThreshold' => [ 'shape' => 'integer', ], 'timeoutSeconds' => [ 'shape' => 'integer', ], 'intervalSeconds' => [ 'shape' => 'integer', ], 'path' => [ 'shape' => 'string', ], 'successCodes' => [ 'shape' => 'string', ], ], ], 'ContainerServiceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerService', ], ], 'ContainerServiceLogEvent' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'string', ], ], ], 'ContainerServiceLogEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerServiceLogEvent', ], ], 'ContainerServiceMetadataEntry' => [ 'type' => 'map', 'key' => [ 'shape' => 'string', ], 'value' => [ 'shape' => 'string', ], ], 'ContainerServiceMetadataEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerServiceMetadataEntry', ], ], 'ContainerServiceMetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'MemoryUtilization', ], ], 'ContainerServiceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$', ], 'ContainerServicePower' => [ 'type' => 'structure', 'members' => [ 'powerId' => [ 'shape' => 'string', ], 'price' => [ 'shape' => 'float', ], 'cpuCount' => [ 'shape' => 'float', ], 'ramSizeInGb' => [ 'shape' => 'float', ], 'name' => [ 'shape' => 'string', ], 'isActive' => [ 'shape' => 'boolean', ], ], ], 'ContainerServicePowerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerServicePower', ], ], 'ContainerServicePowerName' => [ 'type' => 'string', 'enum' => [ 'nano', 'micro', 'small', 'medium', 'large', 'xlarge', ], ], 'ContainerServiceProtocol' => [ 'type' => 'string', 'enum' => [ 'HTTP', 'HTTPS', 'TCP', 'UDP', ], ], 'ContainerServicePublicDomains' => [ 'type' => 'map', 'key' => [ 'shape' => 'string', ], 'value' => [ 'shape' => 'ContainerServicePublicDomainsList', ], ], 'ContainerServicePublicDomainsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'string', ], ], 'ContainerServiceRegistryLogin' => [ 'type' => 'structure', 'members' => [ 'username' => [ 'shape' => 'string', ], 'password' => [ 'shape' => 'string', ], 'expiresAt' => [ 'shape' => 'IsoDate', ], 'registry' => [ 'shape' => 'string', ], ], ], 'ContainerServiceScale' => [ 'type' => 'integer', 'max' => 20, 'min' => 1, ], 'ContainerServiceState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'READY', 'RUNNING', 'UPDATING', 'DELETING', 'DISABLED', 'DEPLOYING', ], ], 'ContainerServiceStateDetail' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'ContainerServiceStateDetailCode', ], 'message' => [ 'shape' => 'string', ], ], ], 'ContainerServiceStateDetailCode' => [ 'type' => 'string', 'enum' => [ 'CREATING_SYSTEM_RESOURCES', 'CREATING_NETWORK_INFRASTRUCTURE', 'PROVISIONING_CERTIFICATE', 'PROVISIONING_SERVICE', 'CREATING_DEPLOYMENT', 'EVALUATING_HEALTH_CHECK', 'ACTIVATING_DEPLOYMENT', 'CERTIFICATE_LIMIT_EXCEEDED', 'UNKNOWN_ERROR', ], ], 'ContainerServicesListResult' => [ 'type' => 'structure', 'members' => [ 'containerServices' => [ 'shape' => 'ContainerServiceList', ], ], ], 'CookieObject' => [ 'type' => 'structure', 'members' => [ 'option' => [ 'shape' => 'ForwardValues', ], 'cookiesAllowList' => [ 'shape' => 'StringList', ], ], ], 'CopySnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'targetSnapshotName', 'sourceRegion', ], 'members' => [ 'sourceSnapshotName' => [ 'shape' => 'ResourceName', ], 'sourceResourceName' => [ 'shape' => 'string', ], 'restoreDate' => [ 'shape' => 'string', ], 'useLatestRestorableAutoSnapshot' => [ 'shape' => 'boolean', ], 'targetSnapshotName' => [ 'shape' => 'ResourceName', ], 'sourceRegion' => [ 'shape' => 'RegionName', ], ], ], 'CopySnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CostEstimate' => [ 'type' => 'structure', 'members' => [ 'usageType' => [ 'shape' => 'NonEmptyString', ], 'resultsByTime' => [ 'shape' => 'EstimatesByTime', ], ], ], 'CostEstimates' => [ 'type' => 'list', 'member' => [ 'shape' => 'CostEstimate', ], ], 'CreateBucketAccessKeyRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], ], ], 'CreateBucketAccessKeyResult' => [ 'type' => 'structure', 'members' => [ 'accessKey' => [ 'shape' => 'AccessKey', ], 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateBucketRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', 'bundleId', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'tags' => [ 'shape' => 'TagList', ], 'enableObjectVersioning' => [ 'shape' => 'boolean', ], ], ], 'CreateBucketResult' => [ 'type' => 'structure', 'members' => [ 'bucket' => [ 'shape' => 'Bucket', ], 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'certificateName', 'domainName', ], 'members' => [ 'certificateName' => [ 'shape' => 'CertificateName', ], 'domainName' => [ 'shape' => 'DomainName', ], 'subjectAlternativeNames' => [ 'shape' => 'SubjectAlternativeNameList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCertificateResult' => [ 'type' => 'structure', 'members' => [ 'certificate' => [ 'shape' => 'CertificateSummary', ], 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateCloudFormationStackRequest' => [ 'type' => 'structure', 'required' => [ 'instances', ], 'members' => [ 'instances' => [ 'shape' => 'InstanceEntryList', ], ], ], 'CreateCloudFormationStackResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateContactMethodRequest' => [ 'type' => 'structure', 'required' => [ 'protocol', 'contactEndpoint', ], 'members' => [ 'protocol' => [ 'shape' => 'ContactProtocol', ], 'contactEndpoint' => [ 'shape' => 'StringMax256', ], ], ], 'CreateContactMethodResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateContainerServiceDeploymentRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'containers' => [ 'shape' => 'ContainerMap', ], 'publicEndpoint' => [ 'shape' => 'EndpointRequest', ], ], ], 'CreateContainerServiceDeploymentResult' => [ 'type' => 'structure', 'members' => [ 'containerService' => [ 'shape' => 'ContainerService', ], ], ], 'CreateContainerServiceRegistryLoginRequest' => [ 'type' => 'structure', 'members' => [], ], 'CreateContainerServiceRegistryLoginResult' => [ 'type' => 'structure', 'members' => [ 'registryLogin' => [ 'shape' => 'ContainerServiceRegistryLogin', ], ], ], 'CreateContainerServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'power', 'scale', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'power' => [ 'shape' => 'ContainerServicePowerName', ], 'scale' => [ 'shape' => 'ContainerServiceScale', ], 'tags' => [ 'shape' => 'TagList', ], 'publicDomainNames' => [ 'shape' => 'ContainerServicePublicDomains', ], 'deployment' => [ 'shape' => 'ContainerServiceDeploymentRequest', ], 'privateRegistryAccess' => [ 'shape' => 'PrivateRegistryAccessRequest', ], ], ], 'CreateContainerServiceResult' => [ 'type' => 'structure', 'members' => [ 'containerService' => [ 'shape' => 'ContainerService', ], ], ], 'CreateDiskFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'availabilityZone', 'sizeInGb', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'tags' => [ 'shape' => 'TagList', ], 'addOns' => [ 'shape' => 'AddOnRequestList', ], 'sourceDiskName' => [ 'shape' => 'string', ], 'restoreDate' => [ 'shape' => 'string', ], 'useLatestRestorableAutoSnapshot' => [ 'shape' => 'boolean', ], ], ], 'CreateDiskFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', 'availabilityZone', 'sizeInGb', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'tags' => [ 'shape' => 'TagList', ], 'addOns' => [ 'shape' => 'AddOnRequestList', ], ], ], 'CreateDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'distributionName', 'origin', 'defaultCacheBehavior', 'bundleId', ], 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'origin' => [ 'shape' => 'InputOrigin', ], 'defaultCacheBehavior' => [ 'shape' => 'CacheBehavior', ], 'cacheBehaviorSettings' => [ 'shape' => 'CacheSettings', ], 'cacheBehaviors' => [ 'shape' => 'CacheBehaviorList', ], 'bundleId' => [ 'shape' => 'string', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDistributionResult' => [ 'type' => 'structure', 'members' => [ 'distribution' => [ 'shape' => 'LightsailDistribution', ], 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'CreateDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDomainResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateGUISessionAccessDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], ], ], 'CreateGUISessionAccessDetailsResult' => [ 'type' => 'structure', 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'status' => [ 'shape' => 'Status', ], 'percentageComplete' => [ 'shape' => 'integer', ], 'failureReason' => [ 'shape' => 'string', ], 'sessions' => [ 'shape' => 'Sessions', ], ], ], 'CreateInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', 'instanceName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateInstancesFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceNames', 'availabilityZone', 'bundleId', ], 'members' => [ 'instanceNames' => [ 'shape' => 'StringList', ], 'attachedDiskMapping' => [ 'shape' => 'AttachedDiskMap', ], 'availabilityZone' => [ 'shape' => 'string', ], 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'userData' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], 'addOns' => [ 'shape' => 'AddOnRequestList', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'sourceInstanceName' => [ 'shape' => 'string', ], 'restoreDate' => [ 'shape' => 'string', ], 'useLatestRestorableAutoSnapshot' => [ 'shape' => 'boolean', ], ], ], 'CreateInstancesFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateInstancesRequest' => [ 'type' => 'structure', 'required' => [ 'instanceNames', 'availabilityZone', 'blueprintId', 'bundleId', ], 'members' => [ 'instanceNames' => [ 'shape' => 'StringList', ], 'availabilityZone' => [ 'shape' => 'string', ], 'customImageName' => [ 'shape' => 'ResourceName', 'deprecated' => true, ], 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'userData' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], 'addOns' => [ 'shape' => 'AddOnRequestList', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], ], ], 'CreateInstancesResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'keyPair' => [ 'shape' => 'KeyPair', ], 'publicKeyBase64' => [ 'shape' => 'Base64', ], 'privateKeyBase64' => [ 'shape' => 'Base64', ], 'operation' => [ 'shape' => 'Operation', ], ], ], 'CreateLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instancePort', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instancePort' => [ 'shape' => 'Port', ], 'healthCheckPath' => [ 'shape' => 'string', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'certificateDomainName' => [ 'shape' => 'DomainName', ], 'certificateAlternativeNames' => [ 'shape' => 'DomainNameList', ], 'tags' => [ 'shape' => 'TagList', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'tlsPolicyName' => [ 'shape' => 'string', ], ], ], 'CreateLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', 'certificateDomainName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'certificateDomainName' => [ 'shape' => 'DomainName', ], 'certificateAlternativeNames' => [ 'shape' => 'DomainNameList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseFromSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'string', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseBundleId' => [ 'shape' => 'string', ], 'sourceRelationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'restoreTime' => [ 'shape' => 'IsoDate', ], 'useLatestRestorableTime' => [ 'shape' => 'boolean', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseFromSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'relationalDatabaseBlueprintId', 'relationalDatabaseBundleId', 'masterDatabaseName', 'masterUsername', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'availabilityZone' => [ 'shape' => 'string', ], 'relationalDatabaseBlueprintId' => [ 'shape' => 'string', ], 'relationalDatabaseBundleId' => [ 'shape' => 'string', ], 'masterDatabaseName' => [ 'shape' => 'string', ], 'masterUsername' => [ 'shape' => 'string', ], 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'preferredBackupWindow' => [ 'shape' => 'string', ], 'preferredMaintenanceWindow' => [ 'shape' => 'string', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'CreateRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'CreateRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'Currency' => [ 'type' => 'string', 'enum' => [ 'USD', ], ], 'DeleteAlarmRequest' => [ 'type' => 'structure', 'required' => [ 'alarmName', ], 'members' => [ 'alarmName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteAlarmResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteAutoSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'date', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'date' => [ 'shape' => 'AutoSnapshotDate', ], ], ], 'DeleteAutoSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteBucketAccessKeyRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', 'accessKeyId', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'accessKeyId' => [ 'shape' => 'NonEmptyString', ], ], ], 'DeleteBucketAccessKeyResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteBucketRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'forceDelete' => [ 'shape' => 'boolean', ], ], ], 'DeleteBucketResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'certificateName', ], 'members' => [ 'certificateName' => [ 'shape' => 'CertificateName', ], ], ], 'DeleteCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteContactMethodRequest' => [ 'type' => 'structure', 'required' => [ 'protocol', ], 'members' => [ 'protocol' => [ 'shape' => 'ContactProtocol', ], ], ], 'DeleteContactMethodResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteContainerImageRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'image', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'image' => [ 'shape' => 'string', ], ], ], 'DeleteContainerImageResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteContainerServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], ], ], 'DeleteContainerServiceResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], 'forceDeleteAddOns' => [ 'shape' => 'boolean', ], ], ], 'DeleteDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteDistributionRequest' => [ 'type' => 'structure', 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteDistributionResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'DeleteDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], ], ], 'DeleteDomainResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'forceDeleteAddOns' => [ 'shape' => 'boolean', ], ], ], 'DeleteInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], 'expectedFingerprint' => [ 'shape' => 'string', ], ], ], 'DeleteKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DeleteKnownHostKeysRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteKnownHostKeysResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteLoadBalancerTlsCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'certificateName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'force' => [ 'shape' => 'boolean', ], ], ], 'DeleteLoadBalancerTlsCertificateResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'skipFinalSnapshot' => [ 'shape' => 'boolean', ], 'finalRelationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DeleteRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'DeleteRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DestinationInfo' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'service' => [ 'shape' => 'NonEmptyString', ], ], ], 'DetachCertificateFromDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'distributionName', ], 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], ], ], 'DetachCertificateFromDistributionResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'DetachDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], ], ], 'DetachDiskResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DetachInstancesFromLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'instanceNames', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'instanceNames' => [ 'shape' => 'ResourceNameList', ], ], ], 'DetachInstancesFromLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DetachStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'DetachStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'DisableAddOnRequest' => [ 'type' => 'structure', 'required' => [ 'addOnType', 'resourceName', ], 'members' => [ 'addOnType' => [ 'shape' => 'AddOnType', ], 'resourceName' => [ 'shape' => 'ResourceName', ], ], ], 'DisableAddOnResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'Disk' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'addOns' => [ 'shape' => 'AddOnList', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'isSystemDisk' => [ 'shape' => 'boolean', ], 'iops' => [ 'shape' => 'integer', ], 'path' => [ 'shape' => 'string', ], 'state' => [ 'shape' => 'DiskState', ], 'attachedTo' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], 'attachmentState' => [ 'shape' => 'string', 'deprecated' => true, ], 'gbInUse' => [ 'shape' => 'integer', 'deprecated' => true, ], 'autoMountStatus' => [ 'shape' => 'AutoMountStatus', ], ], ], 'DiskInfo' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'string', ], 'path' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'isSystemDisk' => [ 'shape' => 'boolean', ], ], ], 'DiskInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskInfo', ], ], 'DiskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Disk', ], ], 'DiskMap' => [ 'type' => 'structure', 'members' => [ 'originalDiskPath' => [ 'shape' => 'NonEmptyString', ], 'newDiskName' => [ 'shape' => 'ResourceName', ], ], ], 'DiskMapList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskMap', ], ], 'DiskSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'state' => [ 'shape' => 'DiskSnapshotState', ], 'progress' => [ 'shape' => 'string', ], 'fromDiskName' => [ 'shape' => 'ResourceName', ], 'fromDiskArn' => [ 'shape' => 'NonEmptyString', ], 'fromInstanceName' => [ 'shape' => 'ResourceName', ], 'fromInstanceArn' => [ 'shape' => 'NonEmptyString', ], 'isFromAutoSnapshot' => [ 'shape' => 'boolean', ], ], ], 'DiskSnapshotInfo' => [ 'type' => 'structure', 'members' => [ 'sizeInGb' => [ 'shape' => 'integer', ], ], ], 'DiskSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DiskSnapshot', ], ], 'DiskSnapshotState' => [ 'type' => 'string', 'enum' => [ 'pending', 'completed', 'error', 'unknown', ], ], 'DiskState' => [ 'type' => 'string', 'enum' => [ 'pending', 'error', 'available', 'in-use', 'unknown', ], ], 'DistributionBundle' => [ 'type' => 'structure', 'members' => [ 'bundleId' => [ 'shape' => 'string', ], 'name' => [ 'shape' => 'string', ], 'price' => [ 'shape' => 'float', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'isActive' => [ 'shape' => 'boolean', ], ], ], 'DistributionBundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DistributionBundle', ], ], 'DistributionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LightsailDistribution', ], ], 'DistributionMetricName' => [ 'type' => 'string', 'enum' => [ 'Requests', 'BytesDownloaded', 'BytesUploaded', 'TotalErrorRate', 'Http4xxErrorRate', 'Http5xxErrorRate', ], ], 'DnsRecordCreationState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'DnsRecordCreationStateCode', ], 'message' => [ 'shape' => 'string', ], ], ], 'DnsRecordCreationStateCode' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'STARTED', 'FAILED', ], ], 'Domain' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'domainEntries' => [ 'shape' => 'DomainEntryList', ], 'registeredDomainDelegationInfo' => [ 'shape' => 'RegisteredDomainDelegationInfo', ], ], ], 'DomainEntry' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'name' => [ 'shape' => 'DomainName', ], 'target' => [ 'shape' => 'string', ], 'isAlias' => [ 'shape' => 'boolean', ], 'type' => [ 'shape' => 'DomainEntryType', ], 'options' => [ 'shape' => 'DomainEntryOptions', 'deprecated' => true, ], ], ], 'DomainEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainEntry', ], ], 'DomainEntryOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'DomainEntryOptionsKeys', ], 'value' => [ 'shape' => 'string', ], ], 'DomainEntryOptionsKeys' => [ 'type' => 'string', ], 'DomainEntryType' => [ 'type' => 'string', ], 'DomainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Domain', ], ], 'DomainName' => [ 'type' => 'string', ], 'DomainNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainName', ], ], 'DomainValidationRecord' => [ 'type' => 'structure', 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'resourceRecord' => [ 'shape' => 'ResourceRecord', ], 'dnsRecordCreationState' => [ 'shape' => 'DnsRecordCreationState', ], 'validationStatus' => [ 'shape' => 'CertificateDomainValidationStatus', ], ], ], 'DomainValidationRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainValidationRecord', ], ], 'DownloadDefaultKeyPairRequest' => [ 'type' => 'structure', 'members' => [], ], 'DownloadDefaultKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'publicKeyBase64' => [ 'shape' => 'Base64', ], 'privateKeyBase64' => [ 'shape' => 'Base64', ], 'createdAt' => [ 'shape' => 'IsoDate', ], ], ], 'EligibleToRenew' => [ 'type' => 'string', ], 'EmailAddress' => [ 'type' => 'string', 'max' => 254, 'min' => 6, 'pattern' => '^[\\w!#$%&.\'*+\\/=?^_\\x60{|}~\\-]{1,64}@[a-zA-Z0-9\\-]{1,63}(\\.[a-zA-Z0-9\\-]{1,63}){0,8}(\\.[a-zA-Z]{2,63})$', 'sensitive' => true, ], 'EnableAddOnRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'addOnRequest', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'addOnRequest' => [ 'shape' => 'AddOnRequest', ], ], ], 'EnableAddOnResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'EndpointRequest' => [ 'type' => 'structure', 'required' => [ 'containerName', 'containerPort', ], 'members' => [ 'containerName' => [ 'shape' => 'string', ], 'containerPort' => [ 'shape' => 'integer', ], 'healthCheck' => [ 'shape' => 'ContainerServiceHealthCheckConfig', ], ], ], 'Environment' => [ 'type' => 'map', 'key' => [ 'shape' => 'string', ], 'value' => [ 'shape' => 'string', ], ], 'EstimateByTime' => [ 'type' => 'structure', 'members' => [ 'usageCost' => [ 'shape' => 'double', ], 'pricingUnit' => [ 'shape' => 'PricingUnit', ], 'unit' => [ 'shape' => 'double', ], 'currency' => [ 'shape' => 'Currency', ], 'timePeriod' => [ 'shape' => 'TimePeriod', ], ], ], 'EstimatesByTime' => [ 'type' => 'list', 'member' => [ 'shape' => 'EstimateByTime', ], ], 'ExportSnapshotRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'state' => [ 'shape' => 'RecordState', ], 'sourceInfo' => [ 'shape' => 'ExportSnapshotRecordSourceInfo', ], 'destinationInfo' => [ 'shape' => 'DestinationInfo', ], ], ], 'ExportSnapshotRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportSnapshotRecord', ], ], 'ExportSnapshotRecordSourceInfo' => [ 'type' => 'structure', 'members' => [ 'resourceType' => [ 'shape' => 'ExportSnapshotRecordSourceType', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'fromResourceName' => [ 'shape' => 'NonEmptyString', ], 'fromResourceArn' => [ 'shape' => 'NonEmptyString', ], 'instanceSnapshotInfo' => [ 'shape' => 'InstanceSnapshotInfo', ], 'diskSnapshotInfo' => [ 'shape' => 'DiskSnapshotInfo', ], ], ], 'ExportSnapshotRecordSourceType' => [ 'type' => 'string', 'enum' => [ 'InstanceSnapshot', 'DiskSnapshot', ], ], 'ExportSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'sourceSnapshotName', ], 'members' => [ 'sourceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'ExportSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'ForwardValues' => [ 'type' => 'string', 'enum' => [ 'none', 'allow-list', 'all', ], ], 'GetActiveNamesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetActiveNamesResult' => [ 'type' => 'structure', 'members' => [ 'activeNames' => [ 'shape' => 'StringList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetAlarmsRequest' => [ 'type' => 'structure', 'members' => [ 'alarmName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], 'monitoredResourceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetAlarmsResult' => [ 'type' => 'structure', 'members' => [ 'alarms' => [ 'shape' => 'AlarmsList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetAutoSnapshotsRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetAutoSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'autoSnapshots' => [ 'shape' => 'AutoSnapshotDetailsList', ], ], ], 'GetBlueprintsRequest' => [ 'type' => 'structure', 'members' => [ 'includeInactive' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], 'appCategory' => [ 'shape' => 'AppCategory', ], ], ], 'GetBlueprintsResult' => [ 'type' => 'structure', 'members' => [ 'blueprints' => [ 'shape' => 'BlueprintList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetBucketAccessKeysRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], ], ], 'GetBucketAccessKeysResult' => [ 'type' => 'structure', 'members' => [ 'accessKeys' => [ 'shape' => 'AccessKeyList', ], ], ], 'GetBucketBundlesRequest' => [ 'type' => 'structure', 'members' => [ 'includeInactive' => [ 'shape' => 'boolean', ], ], ], 'GetBucketBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'BucketBundleList', ], ], ], 'GetBucketMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', 'metricName', 'startTime', 'endTime', 'period', 'statistics', 'unit', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'metricName' => [ 'shape' => 'BucketMetricName', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], 'unit' => [ 'shape' => 'MetricUnit', ], ], ], 'GetBucketMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'BucketMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetBucketsRequest' => [ 'type' => 'structure', 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'pageToken' => [ 'shape' => 'string', ], 'includeConnectedResources' => [ 'shape' => 'boolean', ], ], ], 'GetBucketsResult' => [ 'type' => 'structure', 'members' => [ 'buckets' => [ 'shape' => 'BucketList', ], 'nextPageToken' => [ 'shape' => 'string', ], 'accountLevelBpaSync' => [ 'shape' => 'AccountLevelBpaSync', ], ], ], 'GetBundlesRequest' => [ 'type' => 'structure', 'members' => [ 'includeInactive' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], 'appCategory' => [ 'shape' => 'AppCategory', ], ], ], 'GetBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'BundleList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetCertificatesRequest' => [ 'type' => 'structure', 'members' => [ 'certificateStatuses' => [ 'shape' => 'CertificateStatusList', ], 'includeCertificateDetails' => [ 'shape' => 'IncludeCertificateDetails', ], 'certificateName' => [ 'shape' => 'CertificateName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetCertificatesResult' => [ 'type' => 'structure', 'members' => [ 'certificates' => [ 'shape' => 'CertificateSummaryList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetCloudFormationStackRecordsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetCloudFormationStackRecordsResult' => [ 'type' => 'structure', 'members' => [ 'cloudFormationStackRecords' => [ 'shape' => 'CloudFormationStackRecordList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetContactMethodsRequest' => [ 'type' => 'structure', 'members' => [ 'protocols' => [ 'shape' => 'ContactProtocolsList', ], ], ], 'GetContactMethodsResult' => [ 'type' => 'structure', 'members' => [ 'contactMethods' => [ 'shape' => 'ContactMethodsList', ], ], ], 'GetContainerAPIMetadataRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetContainerAPIMetadataResult' => [ 'type' => 'structure', 'members' => [ 'metadata' => [ 'shape' => 'ContainerServiceMetadataEntryList', ], ], ], 'GetContainerImagesRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], ], ], 'GetContainerImagesResult' => [ 'type' => 'structure', 'members' => [ 'containerImages' => [ 'shape' => 'ContainerImageList', ], ], ], 'GetContainerLogRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'containerName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'containerName' => [ 'shape' => 'string', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'filterPattern' => [ 'shape' => 'string', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetContainerLogResult' => [ 'type' => 'structure', 'members' => [ 'logEvents' => [ 'shape' => 'ContainerServiceLogEventList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetContainerServiceDeploymentsRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], ], ], 'GetContainerServiceDeploymentsResult' => [ 'type' => 'structure', 'members' => [ 'deployments' => [ 'shape' => 'ContainerServiceDeploymentList', ], ], ], 'GetContainerServiceMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'metricName', 'startTime', 'endTime', 'period', 'statistics', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'metricName' => [ 'shape' => 'ContainerServiceMetricName', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetContainerServiceMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'ContainerServiceMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetContainerServicePowersRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetContainerServicePowersResult' => [ 'type' => 'structure', 'members' => [ 'powers' => [ 'shape' => 'ContainerServicePowerList', ], ], ], 'GetContainerServicesRequest' => [ 'type' => 'structure', 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], ], ], 'GetCostEstimateRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'startTime', 'endTime', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], ], ], 'GetCostEstimateResult' => [ 'type' => 'structure', 'members' => [ 'resourcesBudgetEstimate' => [ 'shape' => 'ResourcesBudgetEstimate', ], ], ], 'GetDiskRequest' => [ 'type' => 'structure', 'required' => [ 'diskName', ], 'members' => [ 'diskName' => [ 'shape' => 'ResourceName', ], ], ], 'GetDiskResult' => [ 'type' => 'structure', 'members' => [ 'disk' => [ 'shape' => 'Disk', ], ], ], 'GetDiskSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'diskSnapshotName', ], 'members' => [ 'diskSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetDiskSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'diskSnapshot' => [ 'shape' => 'DiskSnapshot', ], ], ], 'GetDiskSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDiskSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'diskSnapshots' => [ 'shape' => 'DiskSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDisksRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDisksResult' => [ 'type' => 'structure', 'members' => [ 'disks' => [ 'shape' => 'DiskList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDistributionBundlesRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetDistributionBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'DistributionBundleList', ], ], ], 'GetDistributionLatestCacheResetRequest' => [ 'type' => 'structure', 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], ], ], 'GetDistributionLatestCacheResetResult' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'string', ], 'createTime' => [ 'shape' => 'IsoDate', ], ], ], 'GetDistributionMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'distributionName', 'metricName', 'startTime', 'endTime', 'period', 'unit', 'statistics', ], 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'DistributionMetricName', ], 'startTime' => [ 'shape' => 'timestamp', ], 'endTime' => [ 'shape' => 'timestamp', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetDistributionMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'DistributionMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetDistributionsRequest' => [ 'type' => 'structure', 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDistributionsResult' => [ 'type' => 'structure', 'members' => [ 'distributions' => [ 'shape' => 'DistributionList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetDomainRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], ], ], 'GetDomainResult' => [ 'type' => 'structure', 'members' => [ 'domain' => [ 'shape' => 'Domain', ], ], ], 'GetDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetDomainsResult' => [ 'type' => 'structure', 'members' => [ 'domains' => [ 'shape' => 'DomainList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetExportSnapshotRecordsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetExportSnapshotRecordsResult' => [ 'type' => 'structure', 'members' => [ 'exportSnapshotRecords' => [ 'shape' => 'ExportSnapshotRecordList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceAccessDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'protocol' => [ 'shape' => 'InstanceAccessProtocol', ], ], ], 'GetInstanceAccessDetailsResult' => [ 'type' => 'structure', 'members' => [ 'accessDetails' => [ 'shape' => 'InstanceAccessDetails', ], ], ], 'GetInstanceMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'InstanceMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'timestamp', ], 'endTime' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetInstanceMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'InstanceMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetInstancePortStatesRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstancePortStatesResult' => [ 'type' => 'structure', 'members' => [ 'portStates' => [ 'shape' => 'InstancePortStateList', ], ], ], 'GetInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceResult' => [ 'type' => 'structure', 'members' => [ 'instance' => [ 'shape' => 'Instance', ], ], ], 'GetInstanceSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'instanceSnapshotName', ], 'members' => [ 'instanceSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'instanceSnapshot' => [ 'shape' => 'InstanceSnapshot', ], ], ], 'GetInstanceSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'instanceSnapshots' => [ 'shape' => 'InstanceSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetInstanceStateRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'GetInstanceStateResult' => [ 'type' => 'structure', 'members' => [ 'state' => [ 'shape' => 'InstanceState', ], ], ], 'GetInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetInstancesResult' => [ 'type' => 'structure', 'members' => [ 'instances' => [ 'shape' => 'InstanceList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], ], ], 'GetKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'keyPair' => [ 'shape' => 'KeyPair', ], ], ], 'GetKeyPairsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], 'includeDefaultKeyPair' => [ 'shape' => 'boolean', ], ], ], 'GetKeyPairsResult' => [ 'type' => 'structure', 'members' => [ 'keyPairs' => [ 'shape' => 'KeyPairList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancerMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'LoadBalancerMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'timestamp', ], 'endTime' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetLoadBalancerMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'LoadBalancerMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetLoadBalancerRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'GetLoadBalancerResult' => [ 'type' => 'structure', 'members' => [ 'loadBalancer' => [ 'shape' => 'LoadBalancer', ], ], ], 'GetLoadBalancerTlsCertificatesRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], ], ], 'GetLoadBalancerTlsCertificatesResult' => [ 'type' => 'structure', 'members' => [ 'tlsCertificates' => [ 'shape' => 'LoadBalancerTlsCertificateList', ], ], ], 'GetLoadBalancerTlsPoliciesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancerTlsPoliciesResult' => [ 'type' => 'structure', 'members' => [ 'tlsPolicies' => [ 'shape' => 'LoadBalancerTlsPolicyList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancersRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetLoadBalancersResult' => [ 'type' => 'structure', 'members' => [ 'loadBalancers' => [ 'shape' => 'LoadBalancerList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationRequest' => [ 'type' => 'structure', 'required' => [ 'operationId', ], 'members' => [ 'operationId' => [ 'shape' => 'NonEmptyString', ], ], ], 'GetOperationResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'GetOperationsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsForResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], 'nextPageCount' => [ 'shape' => 'string', 'deprecated' => true, ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetOperationsResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRegionsRequest' => [ 'type' => 'structure', 'members' => [ 'includeAvailabilityZones' => [ 'shape' => 'boolean', ], 'includeRelationalDatabaseAvailabilityZones' => [ 'shape' => 'boolean', ], ], ], 'GetRegionsResult' => [ 'type' => 'structure', 'members' => [ 'regions' => [ 'shape' => 'RegionList', ], ], ], 'GetRelationalDatabaseBlueprintsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseBlueprintsResult' => [ 'type' => 'structure', 'members' => [ 'blueprints' => [ 'shape' => 'RelationalDatabaseBlueprintList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseBundlesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], 'includeInactive' => [ 'shape' => 'boolean', ], ], ], 'GetRelationalDatabaseBundlesResult' => [ 'type' => 'structure', 'members' => [ 'bundles' => [ 'shape' => 'RelationalDatabaseBundleList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseEventsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'durationInMinutes' => [ 'shape' => 'integer', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseEventsResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseEvents' => [ 'shape' => 'RelationalDatabaseEventList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogEventsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'logStreamName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'logStreamName' => [ 'shape' => 'string', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'startFromHead' => [ 'shape' => 'boolean', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogEventsResult' => [ 'type' => 'structure', 'members' => [ 'resourceLogEvents' => [ 'shape' => 'LogEventList', ], 'nextBackwardToken' => [ 'shape' => 'string', ], 'nextForwardToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseLogStreamsRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseLogStreamsResult' => [ 'type' => 'structure', 'members' => [ 'logStreams' => [ 'shape' => 'StringList', ], ], ], 'GetRelationalDatabaseMasterUserPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'passwordVersion' => [ 'shape' => 'RelationalDatabasePasswordVersion', ], ], ], 'GetRelationalDatabaseMasterUserPasswordResult' => [ 'type' => 'structure', 'members' => [ 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], ], ], 'GetRelationalDatabaseMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'metricName', 'period', 'startTime', 'endTime', 'unit', 'statistics', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'RelationalDatabaseMetricName', ], 'period' => [ 'shape' => 'MetricPeriod', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], 'unit' => [ 'shape' => 'MetricUnit', ], 'statistics' => [ 'shape' => 'MetricStatisticList', ], ], ], 'GetRelationalDatabaseMetricDataResult' => [ 'type' => 'structure', 'members' => [ 'metricName' => [ 'shape' => 'RelationalDatabaseMetricName', ], 'metricData' => [ 'shape' => 'MetricDatapointList', ], ], ], 'GetRelationalDatabaseParametersRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseParametersResult' => [ 'type' => 'structure', 'members' => [ 'parameters' => [ 'shape' => 'RelationalDatabaseParameterList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabase' => [ 'shape' => 'RelationalDatabase', ], ], ], 'GetRelationalDatabaseSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseSnapshotName', ], 'members' => [ 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'GetRelationalDatabaseSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseSnapshot' => [ 'shape' => 'RelationalDatabaseSnapshot', ], ], ], 'GetRelationalDatabaseSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabaseSnapshotsResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabaseSnapshots' => [ 'shape' => 'RelationalDatabaseSnapshotList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabasesRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetRelationalDatabasesResult' => [ 'type' => 'structure', 'members' => [ 'relationalDatabases' => [ 'shape' => 'RelationalDatabaseList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'GetSetupHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'pageToken' => [ 'shape' => 'SetupHistoryPageToken', ], ], ], 'GetSetupHistoryResult' => [ 'type' => 'structure', 'members' => [ 'setupHistory' => [ 'shape' => 'setupHistoryList', ], 'nextPageToken' => [ 'shape' => 'SetupHistoryPageToken', ], ], ], 'GetStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'GetStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'staticIp' => [ 'shape' => 'StaticIp', ], ], ], 'GetStaticIpsRequest' => [ 'type' => 'structure', 'members' => [ 'pageToken' => [ 'shape' => 'string', ], ], ], 'GetStaticIpsResult' => [ 'type' => 'structure', 'members' => [ 'staticIps' => [ 'shape' => 'StaticIpList', ], 'nextPageToken' => [ 'shape' => 'string', ], ], ], 'HeaderEnum' => [ 'type' => 'string', 'enum' => [ 'Accept', 'Accept-Charset', 'Accept-Datetime', 'Accept-Encoding', 'Accept-Language', 'Authorization', 'CloudFront-Forwarded-Proto', 'CloudFront-Is-Desktop-Viewer', 'CloudFront-Is-Mobile-Viewer', 'CloudFront-Is-SmartTV-Viewer', 'CloudFront-Is-Tablet-Viewer', 'CloudFront-Viewer-Country', 'Host', 'Origin', 'Referer', ], ], 'HeaderForwardList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HeaderEnum', ], ], 'HeaderObject' => [ 'type' => 'structure', 'members' => [ 'option' => [ 'shape' => 'ForwardValues', ], 'headersAllowList' => [ 'shape' => 'HeaderForwardList', ], ], ], 'HostKeyAttributes' => [ 'type' => 'structure', 'members' => [ 'algorithm' => [ 'shape' => 'string', ], 'publicKey' => [ 'shape' => 'string', ], 'witnessedAt' => [ 'shape' => 'IsoDate', ], 'fingerprintSHA1' => [ 'shape' => 'string', ], 'fingerprintSHA256' => [ 'shape' => 'string', ], 'notValidBefore' => [ 'shape' => 'IsoDate', ], 'notValidAfter' => [ 'shape' => 'IsoDate', ], ], ], 'HostKeysList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HostKeyAttributes', ], ], 'HttpEndpoint' => [ 'type' => 'string', 'enum' => [ 'disabled', 'enabled', ], ], 'HttpProtocolIpv6' => [ 'type' => 'string', 'enum' => [ 'disabled', 'enabled', ], ], 'HttpTokens' => [ 'type' => 'string', 'enum' => [ 'optional', 'required', ], ], 'IAMAccessKeyId' => [ 'type' => 'string', 'max' => 20, 'min' => 20, 'pattern' => '^[A-Z0-9]{20}$', 'sensitive' => true, ], 'ImportKeyPairRequest' => [ 'type' => 'structure', 'required' => [ 'keyPairName', 'publicKeyBase64', ], 'members' => [ 'keyPairName' => [ 'shape' => 'ResourceName', ], 'publicKeyBase64' => [ 'shape' => 'Base64', ], ], ], 'ImportKeyPairResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'InUseResourceCount' => [ 'type' => 'integer', ], 'IncludeCertificateDetails' => [ 'type' => 'boolean', ], 'InputOrigin' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'regionName' => [ 'shape' => 'RegionName', ], 'protocolPolicy' => [ 'shape' => 'OriginProtocolPolicyEnum', ], ], ], 'Instance' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'blueprintId' => [ 'shape' => 'NonEmptyString', ], 'blueprintName' => [ 'shape' => 'NonEmptyString', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], 'addOns' => [ 'shape' => 'AddOnList', ], 'isStaticIp' => [ 'shape' => 'boolean', ], 'privateIpAddress' => [ 'shape' => 'IpAddress', ], 'publicIpAddress' => [ 'shape' => 'IpAddress', ], 'ipv6Addresses' => [ 'shape' => 'Ipv6AddressList', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'hardware' => [ 'shape' => 'InstanceHardware', ], 'networking' => [ 'shape' => 'InstanceNetworking', ], 'state' => [ 'shape' => 'InstanceState', ], 'username' => [ 'shape' => 'NonEmptyString', ], 'sshKeyName' => [ 'shape' => 'ResourceName', ], 'metadataOptions' => [ 'shape' => 'InstanceMetadataOptions', ], ], ], 'InstanceAccessDetails' => [ 'type' => 'structure', 'members' => [ 'certKey' => [ 'shape' => 'string', ], 'expiresAt' => [ 'shape' => 'IsoDate', ], 'ipAddress' => [ 'shape' => 'IpAddress', ], 'password' => [ 'shape' => 'string', ], 'passwordData' => [ 'shape' => 'PasswordData', ], 'privateKey' => [ 'shape' => 'string', ], 'protocol' => [ 'shape' => 'InstanceAccessProtocol', ], 'instanceName' => [ 'shape' => 'ResourceName', ], 'username' => [ 'shape' => 'string', ], 'hostKeys' => [ 'shape' => 'HostKeysList', ], ], ], 'InstanceAccessProtocol' => [ 'type' => 'string', 'enum' => [ 'ssh', 'rdp', ], ], 'InstanceEntry' => [ 'type' => 'structure', 'required' => [ 'sourceName', 'instanceType', 'portInfoSource', 'availabilityZone', ], 'members' => [ 'sourceName' => [ 'shape' => 'ResourceName', ], 'instanceType' => [ 'shape' => 'NonEmptyString', ], 'portInfoSource' => [ 'shape' => 'PortInfoSourceType', ], 'userData' => [ 'shape' => 'string', ], 'availabilityZone' => [ 'shape' => 'string', ], ], ], 'InstanceEntryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceEntry', ], ], 'InstanceHardware' => [ 'type' => 'structure', 'members' => [ 'cpuCount' => [ 'shape' => 'integer', ], 'disks' => [ 'shape' => 'DiskList', ], 'ramSizeInGb' => [ 'shape' => 'float', ], ], ], 'InstanceHealthReason' => [ 'type' => 'string', 'enum' => [ 'Lb.RegistrationInProgress', 'Lb.InitialHealthChecking', 'Lb.InternalError', 'Instance.ResponseCodeMismatch', 'Instance.Timeout', 'Instance.FailedHealthChecks', 'Instance.NotRegistered', 'Instance.NotInUse', 'Instance.DeregistrationInProgress', 'Instance.InvalidState', 'Instance.IpUnusable', ], ], 'InstanceHealthState' => [ 'type' => 'string', 'enum' => [ 'initial', 'healthy', 'unhealthy', 'unused', 'draining', 'unavailable', ], ], 'InstanceHealthSummary' => [ 'type' => 'structure', 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'instanceHealth' => [ 'shape' => 'InstanceHealthState', ], 'instanceHealthReason' => [ 'shape' => 'InstanceHealthReason', ], ], ], 'InstanceHealthSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceHealthSummary', ], ], 'InstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Instance', ], ], 'InstanceMetadataOptions' => [ 'type' => 'structure', 'members' => [ 'state' => [ 'shape' => 'InstanceMetadataState', ], 'httpTokens' => [ 'shape' => 'HttpTokens', ], 'httpEndpoint' => [ 'shape' => 'HttpEndpoint', ], 'httpPutResponseHopLimit' => [ 'shape' => 'integer', ], 'httpProtocolIpv6' => [ 'shape' => 'HttpProtocolIpv6', ], ], ], 'InstanceMetadataState' => [ 'type' => 'string', 'enum' => [ 'pending', 'applied', ], ], 'InstanceMetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'NetworkIn', 'NetworkOut', 'StatusCheckFailed', 'StatusCheckFailed_Instance', 'StatusCheckFailed_System', 'BurstCapacityTime', 'BurstCapacityPercentage', 'MetadataNoToken', ], ], 'InstanceNetworking' => [ 'type' => 'structure', 'members' => [ 'monthlyTransfer' => [ 'shape' => 'MonthlyTransfer', ], 'ports' => [ 'shape' => 'InstancePortInfoList', ], ], ], 'InstancePlatform' => [ 'type' => 'string', 'enum' => [ 'LINUX_UNIX', 'WINDOWS', ], ], 'InstancePlatformList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePlatform', ], ], 'InstancePortInfo' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], 'accessFrom' => [ 'shape' => 'string', ], 'accessType' => [ 'shape' => 'PortAccessType', ], 'commonName' => [ 'shape' => 'string', ], 'accessDirection' => [ 'shape' => 'AccessDirection', ], 'cidrs' => [ 'shape' => 'StringList', ], 'ipv6Cidrs' => [ 'shape' => 'StringList', ], 'cidrListAliases' => [ 'shape' => 'StringList', ], ], ], 'InstancePortInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePortInfo', ], ], 'InstancePortState' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], 'state' => [ 'shape' => 'PortState', ], 'cidrs' => [ 'shape' => 'StringList', ], 'ipv6Cidrs' => [ 'shape' => 'StringList', ], 'cidrListAliases' => [ 'shape' => 'StringList', ], ], ], 'InstancePortStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstancePortState', ], ], 'InstanceSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'state' => [ 'shape' => 'InstanceSnapshotState', ], 'progress' => [ 'shape' => 'string', ], 'fromAttachedDisks' => [ 'shape' => 'DiskList', ], 'fromInstanceName' => [ 'shape' => 'ResourceName', ], 'fromInstanceArn' => [ 'shape' => 'NonEmptyString', ], 'fromBlueprintId' => [ 'shape' => 'string', ], 'fromBundleId' => [ 'shape' => 'string', ], 'isFromAutoSnapshot' => [ 'shape' => 'boolean', ], 'sizeInGb' => [ 'shape' => 'integer', ], ], ], 'InstanceSnapshotInfo' => [ 'type' => 'structure', 'members' => [ 'fromBundleId' => [ 'shape' => 'NonEmptyString', ], 'fromBlueprintId' => [ 'shape' => 'NonEmptyString', ], 'fromDiskInfo' => [ 'shape' => 'DiskInfoList', ], ], ], 'InstanceSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceSnapshot', ], ], 'InstanceSnapshotState' => [ 'type' => 'string', 'enum' => [ 'pending', 'error', 'available', ], ], 'InstanceState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'integer', ], 'name' => [ 'shape' => 'string', ], ], ], 'InvalidInputException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'IpAddress' => [ 'type' => 'string', 'pattern' => '([0-9]{1,3}\\.){3}[0-9]{1,3}', ], 'IpAddressType' => [ 'type' => 'string', 'enum' => [ 'dualstack', 'ipv4', ], ], 'Ipv6Address' => [ 'type' => 'string', 'pattern' => '([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}', ], 'Ipv6AddressList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Ipv6Address', ], ], 'IsVpcPeeredRequest' => [ 'type' => 'structure', 'members' => [], ], 'IsVpcPeeredResult' => [ 'type' => 'structure', 'members' => [ 'isPeered' => [ 'shape' => 'boolean', ], ], ], 'IsoDate' => [ 'type' => 'timestamp', ], 'IssuerCA' => [ 'type' => 'string', ], 'KeyAlgorithm' => [ 'type' => 'string', ], 'KeyPair' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'fingerprint' => [ 'shape' => 'Base64', ], ], ], 'KeyPairList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyPair', ], ], 'LightsailDistribution' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'alternativeDomainNames' => [ 'shape' => 'StringList', ], 'status' => [ 'shape' => 'string', ], 'isEnabled' => [ 'shape' => 'boolean', ], 'domainName' => [ 'shape' => 'string', ], 'bundleId' => [ 'shape' => 'string', ], 'certificateName' => [ 'shape' => 'ResourceName', ], 'origin' => [ 'shape' => 'Origin', ], 'originPublicDNS' => [ 'shape' => 'string', ], 'defaultCacheBehavior' => [ 'shape' => 'CacheBehavior', ], 'cacheBehaviorSettings' => [ 'shape' => 'CacheSettings', ], 'cacheBehaviors' => [ 'shape' => 'CacheBehaviorList', ], 'ableToUpdateBundle' => [ 'shape' => 'boolean', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'LoadBalancer' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'dnsName' => [ 'shape' => 'NonEmptyString', ], 'state' => [ 'shape' => 'LoadBalancerState', ], 'protocol' => [ 'shape' => 'LoadBalancerProtocol', ], 'publicPorts' => [ 'shape' => 'PortList', ], 'healthCheckPath' => [ 'shape' => 'NonEmptyString', ], 'instancePort' => [ 'shape' => 'integer', ], 'instanceHealthSummary' => [ 'shape' => 'InstanceHealthSummaryList', ], 'tlsCertificateSummaries' => [ 'shape' => 'LoadBalancerTlsCertificateSummaryList', ], 'configurationOptions' => [ 'shape' => 'LoadBalancerConfigurationOptions', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], 'httpsRedirectionEnabled' => [ 'shape' => 'boolean', ], 'tlsPolicyName' => [ 'shape' => 'ResourceName', ], ], ], 'LoadBalancerAttributeName' => [ 'type' => 'string', 'enum' => [ 'HealthCheckPath', 'SessionStickinessEnabled', 'SessionStickiness_LB_CookieDurationSeconds', 'HttpsRedirectionEnabled', 'TlsPolicyName', ], ], 'LoadBalancerConfigurationOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'LoadBalancerAttributeName', ], 'value' => [ 'shape' => 'string', ], ], 'LoadBalancerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancer', ], ], 'LoadBalancerMetricName' => [ 'type' => 'string', 'enum' => [ 'ClientTLSNegotiationErrorCount', 'HealthyHostCount', 'UnhealthyHostCount', 'HTTPCode_LB_4XX_Count', 'HTTPCode_LB_5XX_Count', 'HTTPCode_Instance_2XX_Count', 'HTTPCode_Instance_3XX_Count', 'HTTPCode_Instance_4XX_Count', 'HTTPCode_Instance_5XX_Count', 'InstanceResponseTime', 'RejectedConnectionCount', 'RequestCount', ], ], 'LoadBalancerProtocol' => [ 'type' => 'string', 'enum' => [ 'HTTP_HTTPS', 'HTTP', ], ], 'LoadBalancerState' => [ 'type' => 'string', 'enum' => [ 'active', 'provisioning', 'active_impaired', 'failed', 'unknown', ], ], 'LoadBalancerTlsCertificate' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], 'status' => [ 'shape' => 'LoadBalancerTlsCertificateStatus', ], 'domainName' => [ 'shape' => 'DomainName', ], 'domainValidationRecords' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationRecordList', ], 'failureReason' => [ 'shape' => 'LoadBalancerTlsCertificateFailureReason', ], 'issuedAt' => [ 'shape' => 'IsoDate', ], 'issuer' => [ 'shape' => 'NonEmptyString', ], 'keyAlgorithm' => [ 'shape' => 'NonEmptyString', ], 'notAfter' => [ 'shape' => 'IsoDate', ], 'notBefore' => [ 'shape' => 'IsoDate', ], 'renewalSummary' => [ 'shape' => 'LoadBalancerTlsCertificateRenewalSummary', ], 'revocationReason' => [ 'shape' => 'LoadBalancerTlsCertificateRevocationReason', ], 'revokedAt' => [ 'shape' => 'IsoDate', ], 'serial' => [ 'shape' => 'NonEmptyString', ], 'signatureAlgorithm' => [ 'shape' => 'NonEmptyString', ], 'subject' => [ 'shape' => 'NonEmptyString', ], 'subjectAlternativeNames' => [ 'shape' => 'StringList', ], ], ], 'LoadBalancerTlsCertificateDnsRecordCreationState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'LoadBalancerTlsCertificateDnsRecordCreationStateCode', ], 'message' => [ 'shape' => 'string', ], ], ], 'LoadBalancerTlsCertificateDnsRecordCreationStateCode' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'STARTED', 'FAILED', ], ], 'LoadBalancerTlsCertificateDomainStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'FAILED', 'SUCCESS', ], ], 'LoadBalancerTlsCertificateDomainValidationOption' => [ 'type' => 'structure', 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'validationStatus' => [ 'shape' => 'LoadBalancerTlsCertificateDomainStatus', ], ], ], 'LoadBalancerTlsCertificateDomainValidationOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationOption', ], ], 'LoadBalancerTlsCertificateDomainValidationRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'NonEmptyString', ], 'type' => [ 'shape' => 'NonEmptyString', ], 'value' => [ 'shape' => 'NonEmptyString', ], 'validationStatus' => [ 'shape' => 'LoadBalancerTlsCertificateDomainStatus', ], 'domainName' => [ 'shape' => 'DomainName', ], 'dnsRecordCreationState' => [ 'shape' => 'LoadBalancerTlsCertificateDnsRecordCreationState', ], ], ], 'LoadBalancerTlsCertificateDomainValidationRecordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationRecord', ], ], 'LoadBalancerTlsCertificateFailureReason' => [ 'type' => 'string', 'enum' => [ 'NO_AVAILABLE_CONTACTS', 'ADDITIONAL_VERIFICATION_REQUIRED', 'DOMAIN_NOT_ALLOWED', 'INVALID_PUBLIC_DOMAIN', 'OTHER', ], ], 'LoadBalancerTlsCertificateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificate', ], ], 'LoadBalancerTlsCertificateRenewalStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_AUTO_RENEWAL', 'PENDING_VALIDATION', 'SUCCESS', 'FAILED', ], ], 'LoadBalancerTlsCertificateRenewalSummary' => [ 'type' => 'structure', 'members' => [ 'renewalStatus' => [ 'shape' => 'LoadBalancerTlsCertificateRenewalStatus', ], 'domainValidationOptions' => [ 'shape' => 'LoadBalancerTlsCertificateDomainValidationOptionList', ], ], ], 'LoadBalancerTlsCertificateRevocationReason' => [ 'type' => 'string', 'enum' => [ 'UNSPECIFIED', 'KEY_COMPROMISE', 'CA_COMPROMISE', 'AFFILIATION_CHANGED', 'SUPERCEDED', 'CESSATION_OF_OPERATION', 'CERTIFICATE_HOLD', 'REMOVE_FROM_CRL', 'PRIVILEGE_WITHDRAWN', 'A_A_COMPROMISE', ], ], 'LoadBalancerTlsCertificateStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_VALIDATION', 'ISSUED', 'INACTIVE', 'EXPIRED', 'VALIDATION_TIMED_OUT', 'REVOKED', 'FAILED', 'UNKNOWN', ], ], 'LoadBalancerTlsCertificateSummary' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], ], ], 'LoadBalancerTlsCertificateSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsCertificateSummary', ], ], 'LoadBalancerTlsPolicy' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'isDefault' => [ 'shape' => 'boolean', ], 'description' => [ 'shape' => 'string', ], 'protocols' => [ 'shape' => 'StringList', ], 'ciphers' => [ 'shape' => 'StringList', ], ], ], 'LoadBalancerTlsPolicyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LoadBalancerTlsPolicy', ], ], 'LogEvent' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'string', ], ], ], 'LogEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogEvent', ], ], 'MetricDatapoint' => [ 'type' => 'structure', 'members' => [ 'average' => [ 'shape' => 'double', ], 'maximum' => [ 'shape' => 'double', ], 'minimum' => [ 'shape' => 'double', ], 'sampleCount' => [ 'shape' => 'double', ], 'sum' => [ 'shape' => 'double', ], 'timestamp' => [ 'shape' => 'timestamp', ], 'unit' => [ 'shape' => 'MetricUnit', ], ], ], 'MetricDatapointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDatapoint', ], ], 'MetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'NetworkIn', 'NetworkOut', 'StatusCheckFailed', 'StatusCheckFailed_Instance', 'StatusCheckFailed_System', 'ClientTLSNegotiationErrorCount', 'HealthyHostCount', 'UnhealthyHostCount', 'HTTPCode_LB_4XX_Count', 'HTTPCode_LB_5XX_Count', 'HTTPCode_Instance_2XX_Count', 'HTTPCode_Instance_3XX_Count', 'HTTPCode_Instance_4XX_Count', 'HTTPCode_Instance_5XX_Count', 'InstanceResponseTime', 'RejectedConnectionCount', 'RequestCount', 'DatabaseConnections', 'DiskQueueDepth', 'FreeStorageSpace', 'NetworkReceiveThroughput', 'NetworkTransmitThroughput', 'BurstCapacityTime', 'BurstCapacityPercentage', ], ], 'MetricPeriod' => [ 'type' => 'integer', 'max' => 86400, 'min' => 60, ], 'MetricStatistic' => [ 'type' => 'string', 'enum' => [ 'Minimum', 'Maximum', 'Sum', 'Average', 'SampleCount', ], ], 'MetricStatisticList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricStatistic', ], ], 'MetricUnit' => [ 'type' => 'string', 'enum' => [ 'Seconds', 'Microseconds', 'Milliseconds', 'Bytes', 'Kilobytes', 'Megabytes', 'Gigabytes', 'Terabytes', 'Bits', 'Kilobits', 'Megabits', 'Gigabits', 'Terabits', 'Percent', 'Count', 'Bytes/Second', 'Kilobytes/Second', 'Megabytes/Second', 'Gigabytes/Second', 'Terabytes/Second', 'Bits/Second', 'Kilobits/Second', 'Megabits/Second', 'Gigabits/Second', 'Terabits/Second', 'Count/Second', 'None', ], ], 'MonitoredResourceInfo' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'ResourceArn', ], 'name' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], ], 'MonthlyTransfer' => [ 'type' => 'structure', 'members' => [ 'gbPerMonthAllocated' => [ 'shape' => 'integer', ], ], ], 'NameServersUpdateState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'NameServersUpdateStateCode', ], 'message' => [ 'shape' => 'string', ], ], ], 'NameServersUpdateStateCode' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'PENDING', 'FAILED', 'STARTED', ], ], 'NetworkProtocol' => [ 'type' => 'string', 'enum' => [ 'tcp', 'all', 'udp', 'icmp', ], ], 'NonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'NotificationTriggerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlarmState', ], ], 'OpenInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfo', 'instanceName', ], 'members' => [ 'portInfo' => [ 'shape' => 'PortInfo', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'OpenInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'Operation' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'NonEmptyString', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'isTerminal' => [ 'shape' => 'boolean', ], 'operationDetails' => [ 'shape' => 'string', ], 'operationType' => [ 'shape' => 'OperationType', ], 'status' => [ 'shape' => 'OperationStatus', ], 'statusChangedAt' => [ 'shape' => 'IsoDate', ], 'errorCode' => [ 'shape' => 'string', ], 'errorDetails' => [ 'shape' => 'string', ], ], ], 'OperationFailureException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'OperationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Operation', ], ], 'OperationStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'Started', 'Failed', 'Completed', 'Succeeded', ], ], 'OperationType' => [ 'type' => 'string', 'enum' => [ 'DeleteKnownHostKeys', 'DeleteInstance', 'CreateInstance', 'StopInstance', 'StartInstance', 'RebootInstance', 'OpenInstancePublicPorts', 'PutInstancePublicPorts', 'CloseInstancePublicPorts', 'AllocateStaticIp', 'ReleaseStaticIp', 'AttachStaticIp', 'DetachStaticIp', 'UpdateDomainEntry', 'DeleteDomainEntry', 'CreateDomain', 'DeleteDomain', 'CreateInstanceSnapshot', 'DeleteInstanceSnapshot', 'CreateInstancesFromSnapshot', 'CreateLoadBalancer', 'DeleteLoadBalancer', 'AttachInstancesToLoadBalancer', 'DetachInstancesFromLoadBalancer', 'UpdateLoadBalancerAttribute', 'CreateLoadBalancerTlsCertificate', 'DeleteLoadBalancerTlsCertificate', 'AttachLoadBalancerTlsCertificate', 'CreateDisk', 'DeleteDisk', 'AttachDisk', 'DetachDisk', 'CreateDiskSnapshot', 'DeleteDiskSnapshot', 'CreateDiskFromSnapshot', 'CreateRelationalDatabase', 'UpdateRelationalDatabase', 'DeleteRelationalDatabase', 'CreateRelationalDatabaseFromSnapshot', 'CreateRelationalDatabaseSnapshot', 'DeleteRelationalDatabaseSnapshot', 'UpdateRelationalDatabaseParameters', 'StartRelationalDatabase', 'RebootRelationalDatabase', 'StopRelationalDatabase', 'EnableAddOn', 'DisableAddOn', 'PutAlarm', 'GetAlarms', 'DeleteAlarm', 'TestAlarm', 'CreateContactMethod', 'GetContactMethods', 'SendContactMethodVerification', 'DeleteContactMethod', 'CreateDistribution', 'UpdateDistribution', 'DeleteDistribution', 'ResetDistributionCache', 'AttachCertificateToDistribution', 'DetachCertificateFromDistribution', 'UpdateDistributionBundle', 'SetIpAddressType', 'CreateCertificate', 'DeleteCertificate', 'CreateContainerService', 'UpdateContainerService', 'DeleteContainerService', 'CreateContainerServiceDeployment', 'CreateContainerServiceRegistryLogin', 'RegisterContainerImage', 'DeleteContainerImage', 'CreateBucket', 'DeleteBucket', 'CreateBucketAccessKey', 'DeleteBucketAccessKey', 'UpdateBucketBundle', 'UpdateBucket', 'SetResourceAccessForBucket', 'UpdateInstanceMetadataOptions', 'StartGUISession', 'StopGUISession', 'SetupInstanceHttps', ], ], 'Origin' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'regionName' => [ 'shape' => 'RegionName', ], 'protocolPolicy' => [ 'shape' => 'OriginProtocolPolicyEnum', ], ], ], 'OriginProtocolPolicyEnum' => [ 'type' => 'string', 'enum' => [ 'http-only', 'https-only', ], ], 'PartnerIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString', ], 'max' => 10, ], 'PasswordData' => [ 'type' => 'structure', 'members' => [ 'ciphertext' => [ 'shape' => 'string', ], 'keyPairName' => [ 'shape' => 'ResourceName', ], ], ], 'PeerVpcRequest' => [ 'type' => 'structure', 'members' => [], ], 'PeerVpcResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'PendingMaintenanceAction' => [ 'type' => 'structure', 'members' => [ 'action' => [ 'shape' => 'NonEmptyString', ], 'description' => [ 'shape' => 'NonEmptyString', ], 'currentApplyDate' => [ 'shape' => 'IsoDate', ], ], ], 'PendingMaintenanceActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingMaintenanceAction', ], ], 'PendingModifiedRelationalDatabaseValues' => [ 'type' => 'structure', 'members' => [ 'masterUserPassword' => [ 'shape' => 'string', ], 'engineVersion' => [ 'shape' => 'string', ], 'backupRetentionEnabled' => [ 'shape' => 'boolean', ], ], ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => -1, ], 'PortAccessType' => [ 'type' => 'string', 'enum' => [ 'Public', 'Private', ], ], 'PortInfo' => [ 'type' => 'structure', 'members' => [ 'fromPort' => [ 'shape' => 'Port', ], 'toPort' => [ 'shape' => 'Port', ], 'protocol' => [ 'shape' => 'NetworkProtocol', ], 'cidrs' => [ 'shape' => 'StringList', ], 'ipv6Cidrs' => [ 'shape' => 'StringList', ], 'cidrListAliases' => [ 'shape' => 'StringList', ], ], ], 'PortInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortInfo', ], ], 'PortInfoSourceType' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'INSTANCE', 'NONE', 'CLOSED', ], ], 'PortList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Port', ], ], 'PortMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'string', ], 'value' => [ 'shape' => 'ContainerServiceProtocol', ], ], 'PortState' => [ 'type' => 'string', 'enum' => [ 'open', 'closed', ], ], 'PricingUnit' => [ 'type' => 'string', 'enum' => [ 'GB', 'Hrs', 'GB-Mo', 'Bundles', 'Queries', ], ], 'PrivateRegistryAccess' => [ 'type' => 'structure', 'members' => [ 'ecrImagePullerRole' => [ 'shape' => 'ContainerServiceECRImagePullerRole', ], ], ], 'PrivateRegistryAccessRequest' => [ 'type' => 'structure', 'members' => [ 'ecrImagePullerRole' => [ 'shape' => 'ContainerServiceECRImagePullerRoleRequest', ], ], ], 'PutAlarmRequest' => [ 'type' => 'structure', 'required' => [ 'alarmName', 'metricName', 'monitoredResourceName', 'comparisonOperator', 'threshold', 'evaluationPeriods', ], 'members' => [ 'alarmName' => [ 'shape' => 'ResourceName', ], 'metricName' => [ 'shape' => 'MetricName', ], 'monitoredResourceName' => [ 'shape' => 'ResourceName', ], 'comparisonOperator' => [ 'shape' => 'ComparisonOperator', ], 'threshold' => [ 'shape' => 'double', ], 'evaluationPeriods' => [ 'shape' => 'integer', ], 'datapointsToAlarm' => [ 'shape' => 'integer', ], 'treatMissingData' => [ 'shape' => 'TreatMissingData', ], 'contactProtocols' => [ 'shape' => 'ContactProtocolsList', ], 'notificationTriggers' => [ 'shape' => 'NotificationTriggerList', ], 'notificationEnabled' => [ 'shape' => 'boolean', ], ], ], 'PutAlarmResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'PutInstancePublicPortsRequest' => [ 'type' => 'structure', 'required' => [ 'portInfos', 'instanceName', ], 'members' => [ 'portInfos' => [ 'shape' => 'PortInfoList', ], 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'PutInstancePublicPortsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'QueryStringObject' => [ 'type' => 'structure', 'members' => [ 'option' => [ 'shape' => 'boolean', ], 'queryStringsAllowList' => [ 'shape' => 'StringList', ], ], ], 'R53HostedZoneDeletionState' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'R53HostedZoneDeletionStateCode', ], 'message' => [ 'shape' => 'string', ], ], ], 'R53HostedZoneDeletionStateCode' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'PENDING', 'FAILED', 'STARTED', ], ], 'RebootInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'RebootInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'RebootRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'RebootRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'RecordState' => [ 'type' => 'string', 'enum' => [ 'Started', 'Succeeded', 'Failed', ], ], 'Region' => [ 'type' => 'structure', 'members' => [ 'continentCode' => [ 'shape' => 'string', ], 'description' => [ 'shape' => 'string', ], 'displayName' => [ 'shape' => 'string', ], 'name' => [ 'shape' => 'RegionName', ], 'availabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], 'relationalDatabaseAvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], ], ], 'RegionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Region', ], ], 'RegionName' => [ 'type' => 'string', 'enum' => [ 'us-east-1', 'us-east-2', 'us-west-1', 'us-west-2', 'eu-west-1', 'eu-west-2', 'eu-west-3', 'eu-central-1', 'ca-central-1', 'ap-south-1', 'ap-southeast-1', 'ap-southeast-2', 'ap-northeast-1', 'ap-northeast-2', 'eu-north-1', ], ], 'RegisterContainerImageRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', 'label', 'digest', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'label' => [ 'shape' => 'ContainerLabel', ], 'digest' => [ 'shape' => 'string', ], ], ], 'RegisterContainerImageResult' => [ 'type' => 'structure', 'members' => [ 'containerImage' => [ 'shape' => 'ContainerImage', ], ], ], 'RegisteredDomainDelegationInfo' => [ 'type' => 'structure', 'members' => [ 'nameServersUpdateState' => [ 'shape' => 'NameServersUpdateState', ], 'r53HostedZoneDeletionState' => [ 'shape' => 'R53HostedZoneDeletionState', ], ], ], 'RelationalDatabase' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'relationalDatabaseBlueprintId' => [ 'shape' => 'NonEmptyString', ], 'relationalDatabaseBundleId' => [ 'shape' => 'NonEmptyString', ], 'masterDatabaseName' => [ 'shape' => 'string', ], 'hardware' => [ 'shape' => 'RelationalDatabaseHardware', ], 'state' => [ 'shape' => 'NonEmptyString', ], 'secondaryAvailabilityZone' => [ 'shape' => 'string', ], 'backupRetentionEnabled' => [ 'shape' => 'boolean', ], 'pendingModifiedValues' => [ 'shape' => 'PendingModifiedRelationalDatabaseValues', ], 'engine' => [ 'shape' => 'NonEmptyString', ], 'engineVersion' => [ 'shape' => 'NonEmptyString', ], 'latestRestorableTime' => [ 'shape' => 'IsoDate', ], 'masterUsername' => [ 'shape' => 'NonEmptyString', ], 'parameterApplyStatus' => [ 'shape' => 'NonEmptyString', ], 'preferredBackupWindow' => [ 'shape' => 'NonEmptyString', ], 'preferredMaintenanceWindow' => [ 'shape' => 'NonEmptyString', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'masterEndpoint' => [ 'shape' => 'RelationalDatabaseEndpoint', ], 'pendingMaintenanceActions' => [ 'shape' => 'PendingMaintenanceActionList', ], 'caCertificateIdentifier' => [ 'shape' => 'string', ], ], ], 'RelationalDatabaseBlueprint' => [ 'type' => 'structure', 'members' => [ 'blueprintId' => [ 'shape' => 'string', ], 'engine' => [ 'shape' => 'RelationalDatabaseEngine', ], 'engineVersion' => [ 'shape' => 'string', ], 'engineDescription' => [ 'shape' => 'string', ], 'engineVersionDescription' => [ 'shape' => 'string', ], 'isEngineDefault' => [ 'shape' => 'boolean', ], ], ], 'RelationalDatabaseBlueprintList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseBlueprint', ], ], 'RelationalDatabaseBundle' => [ 'type' => 'structure', 'members' => [ 'bundleId' => [ 'shape' => 'string', ], 'name' => [ 'shape' => 'string', ], 'price' => [ 'shape' => 'float', ], 'ramSizeInGb' => [ 'shape' => 'float', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'transferPerMonthInGb' => [ 'shape' => 'integer', ], 'cpuCount' => [ 'shape' => 'integer', ], 'isEncrypted' => [ 'shape' => 'boolean', ], 'isActive' => [ 'shape' => 'boolean', ], ], ], 'RelationalDatabaseBundleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseBundle', ], ], 'RelationalDatabaseEndpoint' => [ 'type' => 'structure', 'members' => [ 'port' => [ 'shape' => 'integer', ], 'address' => [ 'shape' => 'NonEmptyString', ], ], ], 'RelationalDatabaseEngine' => [ 'type' => 'string', 'enum' => [ 'mysql', ], ], 'RelationalDatabaseEvent' => [ 'type' => 'structure', 'members' => [ 'resource' => [ 'shape' => 'ResourceName', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'message' => [ 'shape' => 'string', ], 'eventCategories' => [ 'shape' => 'StringList', ], ], ], 'RelationalDatabaseEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseEvent', ], ], 'RelationalDatabaseHardware' => [ 'type' => 'structure', 'members' => [ 'cpuCount' => [ 'shape' => 'integer', ], 'diskSizeInGb' => [ 'shape' => 'integer', ], 'ramSizeInGb' => [ 'shape' => 'float', ], ], ], 'RelationalDatabaseList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabase', ], ], 'RelationalDatabaseMetricName' => [ 'type' => 'string', 'enum' => [ 'CPUUtilization', 'DatabaseConnections', 'DiskQueueDepth', 'FreeStorageSpace', 'NetworkReceiveThroughput', 'NetworkTransmitThroughput', ], ], 'RelationalDatabaseParameter' => [ 'type' => 'structure', 'members' => [ 'allowedValues' => [ 'shape' => 'string', ], 'applyMethod' => [ 'shape' => 'string', ], 'applyType' => [ 'shape' => 'string', ], 'dataType' => [ 'shape' => 'string', ], 'description' => [ 'shape' => 'string', ], 'isModifiable' => [ 'shape' => 'boolean', ], 'parameterName' => [ 'shape' => 'string', ], 'parameterValue' => [ 'shape' => 'string', ], ], ], 'RelationalDatabaseParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseParameter', ], ], 'RelationalDatabasePasswordVersion' => [ 'type' => 'string', 'enum' => [ 'CURRENT', 'PREVIOUS', 'PENDING', ], ], 'RelationalDatabaseSnapshot' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'tags' => [ 'shape' => 'TagList', ], 'engine' => [ 'shape' => 'NonEmptyString', ], 'engineVersion' => [ 'shape' => 'NonEmptyString', ], 'sizeInGb' => [ 'shape' => 'integer', ], 'state' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseName' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseArn' => [ 'shape' => 'NonEmptyString', ], 'fromRelationalDatabaseBundleId' => [ 'shape' => 'string', ], 'fromRelationalDatabaseBlueprintId' => [ 'shape' => 'string', ], ], ], 'RelationalDatabaseSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RelationalDatabaseSnapshot', ], ], 'ReleaseStaticIpRequest' => [ 'type' => 'structure', 'required' => [ 'staticIpName', ], 'members' => [ 'staticIpName' => [ 'shape' => 'ResourceName', ], ], ], 'ReleaseStaticIpResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'RenewalStatus' => [ 'type' => 'string', 'enum' => [ 'PendingAutoRenewal', 'PendingValidation', 'Success', 'Failed', ], ], 'RenewalStatusReason' => [ 'type' => 'string', ], 'RenewalSummary' => [ 'type' => 'structure', 'members' => [ 'domainValidationRecords' => [ 'shape' => 'DomainValidationRecordList', ], 'renewalStatus' => [ 'shape' => 'RenewalStatus', ], 'renewalStatusReason' => [ 'shape' => 'RenewalStatusReason', ], 'updatedAt' => [ 'shape' => 'IsoDate', ], ], ], 'RequestFailureReason' => [ 'type' => 'string', ], 'ResetDistributionCacheRequest' => [ 'type' => 'structure', 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], ], ], 'ResetDistributionCacheResult' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'string', ], 'createTime' => [ 'shape' => 'IsoDate', ], 'operation' => [ 'shape' => 'Operation', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'pattern' => '^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$', ], 'ResourceBucketAccess' => [ 'type' => 'string', 'enum' => [ 'allow', 'deny', ], ], 'ResourceBudgetEstimate' => [ 'type' => 'structure', 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'costEstimates' => [ 'shape' => 'CostEstimates', ], 'startTime' => [ 'shape' => 'IsoDate', ], 'endTime' => [ 'shape' => 'IsoDate', ], ], ], 'ResourceLocation' => [ 'type' => 'structure', 'members' => [ 'availabilityZone' => [ 'shape' => 'string', ], 'regionName' => [ 'shape' => 'RegionName', ], ], ], 'ResourceName' => [ 'type' => 'string', 'pattern' => '\\w[\\w\\-]*\\w', ], 'ResourceNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceName', ], ], 'ResourceReceivingAccess' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'NonEmptyString', ], 'resourceType' => [ 'shape' => 'NonEmptyString', ], ], ], 'ResourceRecord' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'string', ], 'type' => [ 'shape' => 'string', ], 'value' => [ 'shape' => 'string', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'ContainerService', 'Instance', 'StaticIp', 'KeyPair', 'InstanceSnapshot', 'Domain', 'PeeredVpc', 'LoadBalancer', 'LoadBalancerTlsCertificate', 'Disk', 'DiskSnapshot', 'RelationalDatabase', 'RelationalDatabaseSnapshot', 'ExportSnapshotRecord', 'CloudFormationStackRecord', 'Alarm', 'ContactMethod', 'Distribution', 'Certificate', 'Bucket', ], ], 'ResourcesBudgetEstimate' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceBudgetEstimate', ], ], 'RevocationReason' => [ 'type' => 'string', ], 'SendContactMethodVerificationRequest' => [ 'type' => 'structure', 'required' => [ 'protocol', ], 'members' => [ 'protocol' => [ 'shape' => 'ContactMethodVerificationProtocol', ], ], ], 'SendContactMethodVerificationResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'SensitiveNonEmptyString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', 'sensitive' => true, ], 'SensitiveString' => [ 'type' => 'string', 'sensitive' => true, ], 'SerialNumber' => [ 'type' => 'string', ], 'ServiceException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, 'fault' => true, ], 'Session' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'NonEmptyString', ], 'url' => [ 'shape' => 'SensitiveNonEmptyString', ], 'isPrimary' => [ 'shape' => 'boolean', ], ], ], 'Sessions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Session', ], ], 'SetIpAddressTypeRequest' => [ 'type' => 'structure', 'required' => [ 'resourceType', 'resourceName', 'ipAddressType', ], 'members' => [ 'resourceType' => [ 'shape' => 'ResourceType', ], 'resourceName' => [ 'shape' => 'ResourceName', ], 'ipAddressType' => [ 'shape' => 'IpAddressType', ], ], ], 'SetIpAddressTypeResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'SetResourceAccessForBucketRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'bucketName', 'access', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'bucketName' => [ 'shape' => 'BucketName', ], 'access' => [ 'shape' => 'ResourceBucketAccess', ], ], ], 'SetResourceAccessForBucketResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'SetupDomainName' => [ 'type' => 'string', 'max' => 253, 'min' => 4, 'pattern' => '^[a-zA-Z0-9\\-]{1,63}(\\.[a-zA-Z0-9\\-]{1,63}){0,8}(\\.[a-zA-Z]{2,63})$', ], 'SetupDomainNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SetupDomainName', ], 'max' => 10, 'min' => 1, ], 'SetupExecutionDetails' => [ 'type' => 'structure', 'members' => [ 'command' => [ 'shape' => 'string', ], 'dateTime' => [ 'shape' => 'IsoDate', ], 'name' => [ 'shape' => 'NonEmptyString', ], 'status' => [ 'shape' => 'SetupStatus', ], 'standardError' => [ 'shape' => 'string', ], 'standardOutput' => [ 'shape' => 'string', ], 'version' => [ 'shape' => 'string', ], ], ], 'SetupExecutionDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SetupExecutionDetails', ], ], 'SetupHistory' => [ 'type' => 'structure', 'members' => [ 'operationId' => [ 'shape' => 'NonEmptyString', ], 'request' => [ 'shape' => 'SetupRequest', ], 'resource' => [ 'shape' => 'SetupHistoryResource', ], 'executionDetails' => [ 'shape' => 'SetupExecutionDetailsList', ], 'status' => [ 'shape' => 'SetupStatus', ], ], ], 'SetupHistoryPageToken' => [ 'type' => 'string', 'max' => 40, 'min' => 24, 'pattern' => '^[A-Za-z0-9+/=]+$', ], 'SetupHistoryResource' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], ], ], 'SetupInstanceHttpsRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', 'emailAddress', 'domainNames', 'certificateProvider', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'emailAddress' => [ 'shape' => 'EmailAddress', ], 'domainNames' => [ 'shape' => 'SetupDomainNameList', ], 'certificateProvider' => [ 'shape' => 'CertificateProvider', ], ], ], 'SetupInstanceHttpsResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'SetupRequest' => [ 'type' => 'structure', 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'domainNames' => [ 'shape' => 'SetupDomainNameList', ], 'certificateProvider' => [ 'shape' => 'CertificateProvider', ], ], ], 'SetupStatus' => [ 'type' => 'string', 'enum' => [ 'succeeded', 'failed', 'inProgress', ], ], 'StartGUISessionRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], ], ], 'StartGUISessionResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StartInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], ], ], 'StartInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StartRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], ], ], 'StartRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StaticIp' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ResourceName', ], 'arn' => [ 'shape' => 'NonEmptyString', ], 'supportCode' => [ 'shape' => 'string', ], 'createdAt' => [ 'shape' => 'IsoDate', ], 'location' => [ 'shape' => 'ResourceLocation', ], 'resourceType' => [ 'shape' => 'ResourceType', ], 'ipAddress' => [ 'shape' => 'IpAddress', ], 'attachedTo' => [ 'shape' => 'ResourceName', ], 'isAttached' => [ 'shape' => 'boolean', ], ], ], 'StaticIpList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StaticIp', ], ], 'Status' => [ 'type' => 'string', 'enum' => [ 'startExpired', 'notStarted', 'started', 'starting', 'stopped', 'stopping', 'settingUpInstance', 'failedInstanceCreation', 'failedStartingGUISession', 'failedStoppingGUISession', ], ], 'StatusType' => [ 'type' => 'string', 'enum' => [ 'Active', 'Inactive', ], ], 'StopGUISessionRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], ], ], 'StopGUISessionResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StopInstanceOnIdleRequest' => [ 'type' => 'structure', 'members' => [ 'threshold' => [ 'shape' => 'string', ], 'duration' => [ 'shape' => 'string', ], ], ], 'StopInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'force' => [ 'shape' => 'boolean', ], ], ], 'StopInstanceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StopRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'relationalDatabaseSnapshotName' => [ 'shape' => 'ResourceName', ], ], ], 'StopRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'string', ], ], 'StringMax256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'SubjectAlternativeNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainName', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'tags', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceArn' => [ 'shape' => 'ResourceArn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'TagValue' => [ 'type' => 'string', ], 'TestAlarmRequest' => [ 'type' => 'structure', 'required' => [ 'alarmName', 'state', ], 'members' => [ 'alarmName' => [ 'shape' => 'ResourceName', ], 'state' => [ 'shape' => 'AlarmState', ], ], ], 'TestAlarmResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'TimeOfDay' => [ 'type' => 'string', 'pattern' => '^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$', ], 'TimePeriod' => [ 'type' => 'structure', 'members' => [ 'start' => [ 'shape' => 'IsoDate', ], 'end' => [ 'shape' => 'IsoDate', ], ], ], 'TreatMissingData' => [ 'type' => 'string', 'enum' => [ 'breaching', 'notBreaching', 'ignore', 'missing', ], ], 'UnauthenticatedException' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'string', ], 'docs' => [ 'shape' => 'string', ], 'message' => [ 'shape' => 'string', ], 'tip' => [ 'shape' => 'string', ], ], 'exception' => true, ], 'UnpeerVpcRequest' => [ 'type' => 'structure', 'members' => [], ], 'UnpeerVpcResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceName', 'tagKeys', ], 'members' => [ 'resourceName' => [ 'shape' => 'ResourceName', ], 'resourceArn' => [ 'shape' => 'ResourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateBucketBundleRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', 'bundleId', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'bundleId' => [ 'shape' => 'NonEmptyString', ], ], ], 'UpdateBucketBundleResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateBucketRequest' => [ 'type' => 'structure', 'required' => [ 'bucketName', ], 'members' => [ 'bucketName' => [ 'shape' => 'BucketName', ], 'accessRules' => [ 'shape' => 'AccessRules', ], 'versioning' => [ 'shape' => 'NonEmptyString', ], 'readonlyAccessAccounts' => [ 'shape' => 'PartnerIdList', ], 'accessLogConfig' => [ 'shape' => 'BucketAccessLogConfig', ], ], ], 'UpdateBucketResult' => [ 'type' => 'structure', 'members' => [ 'bucket' => [ 'shape' => 'Bucket', ], 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateContainerServiceRequest' => [ 'type' => 'structure', 'required' => [ 'serviceName', ], 'members' => [ 'serviceName' => [ 'shape' => 'ContainerServiceName', ], 'power' => [ 'shape' => 'ContainerServicePowerName', ], 'scale' => [ 'shape' => 'ContainerServiceScale', ], 'isDisabled' => [ 'shape' => 'boolean', ], 'publicDomainNames' => [ 'shape' => 'ContainerServicePublicDomains', ], 'privateRegistryAccess' => [ 'shape' => 'PrivateRegistryAccessRequest', ], ], ], 'UpdateContainerServiceResult' => [ 'type' => 'structure', 'members' => [ 'containerService' => [ 'shape' => 'ContainerService', ], ], ], 'UpdateDistributionBundleRequest' => [ 'type' => 'structure', 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'bundleId' => [ 'shape' => 'string', ], ], ], 'UpdateDistributionBundleResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'UpdateDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'distributionName', ], 'members' => [ 'distributionName' => [ 'shape' => 'ResourceName', ], 'origin' => [ 'shape' => 'InputOrigin', ], 'defaultCacheBehavior' => [ 'shape' => 'CacheBehavior', ], 'cacheBehaviorSettings' => [ 'shape' => 'CacheSettings', ], 'cacheBehaviors' => [ 'shape' => 'CacheBehaviorList', ], 'isEnabled' => [ 'shape' => 'boolean', ], ], ], 'UpdateDistributionResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'UpdateDomainEntryRequest' => [ 'type' => 'structure', 'required' => [ 'domainName', 'domainEntry', ], 'members' => [ 'domainName' => [ 'shape' => 'DomainName', ], 'domainEntry' => [ 'shape' => 'DomainEntry', ], ], ], 'UpdateDomainEntryResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateInstanceMetadataOptionsRequest' => [ 'type' => 'structure', 'required' => [ 'instanceName', ], 'members' => [ 'instanceName' => [ 'shape' => 'ResourceName', ], 'httpTokens' => [ 'shape' => 'HttpTokens', ], 'httpEndpoint' => [ 'shape' => 'HttpEndpoint', ], 'httpPutResponseHopLimit' => [ 'shape' => 'integer', ], 'httpProtocolIpv6' => [ 'shape' => 'HttpProtocolIpv6', ], ], ], 'UpdateInstanceMetadataOptionsResult' => [ 'type' => 'structure', 'members' => [ 'operation' => [ 'shape' => 'Operation', ], ], ], 'UpdateLoadBalancerAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'loadBalancerName', 'attributeName', 'attributeValue', ], 'members' => [ 'loadBalancerName' => [ 'shape' => 'ResourceName', ], 'attributeName' => [ 'shape' => 'LoadBalancerAttributeName', ], 'attributeValue' => [ 'shape' => 'StringMax256', ], ], ], 'UpdateLoadBalancerAttributeResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateRelationalDatabaseParametersRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', 'parameters', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'parameters' => [ 'shape' => 'RelationalDatabaseParameterList', ], ], ], 'UpdateRelationalDatabaseParametersResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'UpdateRelationalDatabaseRequest' => [ 'type' => 'structure', 'required' => [ 'relationalDatabaseName', ], 'members' => [ 'relationalDatabaseName' => [ 'shape' => 'ResourceName', ], 'masterUserPassword' => [ 'shape' => 'SensitiveString', ], 'rotateMasterUserPassword' => [ 'shape' => 'boolean', ], 'preferredBackupWindow' => [ 'shape' => 'string', ], 'preferredMaintenanceWindow' => [ 'shape' => 'string', ], 'enableBackupRetention' => [ 'shape' => 'boolean', ], 'disableBackupRetention' => [ 'shape' => 'boolean', ], 'publiclyAccessible' => [ 'shape' => 'boolean', ], 'applyImmediately' => [ 'shape' => 'boolean', ], 'caCertificateIdentifier' => [ 'shape' => 'string', ], ], ], 'UpdateRelationalDatabaseResult' => [ 'type' => 'structure', 'members' => [ 'operations' => [ 'shape' => 'OperationList', ], ], ], 'boolean' => [ 'type' => 'boolean', ], 'double' => [ 'type' => 'double', ], 'float' => [ 'type' => 'float', ], 'integer' => [ 'type' => 'integer', ], 'long' => [ 'type' => 'long', ], 'setupHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SetupHistory', ], ], 'string' => [ 'type' => 'string', ], 'timestamp' => [ 'type' => 'timestamp', ], ],]; diff --git a/src/data/lightsail/2016-11-28/docs-2.json b/src/data/lightsail/2016-11-28/docs-2.json index 51d59a0081..aaf0e7b66a 100644 --- a/src/data/lightsail/2016-11-28/docs-2.json +++ b/src/data/lightsail/2016-11-28/docs-2.json @@ -18,11 +18,11 @@ "CreateContainerService": "

Creates an Amazon Lightsail container service.

A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.

", "CreateContainerServiceDeployment": "

Creates a deployment for your Amazon Lightsail container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

", "CreateContainerServiceRegistryLogin": "

Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.

You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.

After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.

This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

", - "CreateDisk": "

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "CreateDiskFromSnapshot": "

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.

", + "CreateDisk": "

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).

The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "CreateDiskFromSnapshot": "

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.

", "CreateDiskSnapshot": "

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.

You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", "CreateDistribution": "

Creates an Amazon Lightsail content delivery network (CDN) distribution.

A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.

", - "CreateDomain": "

Creates a domain resource for the specified domain (e.g., example.com).

The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "CreateDomain": "

Creates a domain resource for the specified domain (example.com).

The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", "CreateDomainEntry": "

Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

", "CreateGUISessionAccessDetails": "

Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.

Use StartGUISession to open the session.

", "CreateInstanceSnapshot": "

Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.

The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", @@ -111,7 +111,7 @@ "GetLoadBalancers": "

Returns information about all load balancers in an account.

", "GetOperation": "

Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.

", "GetOperations": "

Returns information about all operations.

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.

", - "GetOperationsForResource": "

Gets operations for a specific resource (e.g., an instance or a static IP).

", + "GetOperationsForResource": "

Gets operations for a specific resource (an instance or a static IP).

", "GetRegions": "

Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.

", "GetRelationalDatabase": "

Returns information about a specific database in Amazon Lightsail.

", "GetRelationalDatabaseBlueprints": "

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

You can use a blueprint ID to create a new database that runs a specific database engine.

", @@ -125,6 +125,7 @@ "GetRelationalDatabaseSnapshot": "

Returns information about a specific database snapshot in Amazon Lightsail.

", "GetRelationalDatabaseSnapshots": "

Returns information about all of your database snapshots in Amazon Lightsail.

", "GetRelationalDatabases": "

Returns information about all of your databases in Amazon Lightsail.

", + "GetSetupHistory": "

Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance.

", "GetStaticIp": "

Returns information about an Amazon Lightsail static IP.

", "GetStaticIps": "

Returns information about all static IPs in the user's account.

", "ImportKeyPair": "

Imports a public SSH key from a specific key pair.

", @@ -141,6 +142,7 @@ "SendContactMethodVerification": "

Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.

Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.

", "SetIpAddressType": "

Sets the IP address type for an Amazon Lightsail resource.

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.

", "SetResourceAccessForBucket": "

Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.

", + "SetupInstanceHttps": "

Creates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance.

If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length.

", "StartGUISession": "

Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.

", "StartInstance": "

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

", "StartRelationalDatabase": "

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.

The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

", @@ -466,7 +468,7 @@ "BlueprintType": { "base": null, "refs": { - "Blueprint$type": "

The type of the blueprint (e.g., os or app).

" + "Blueprint$type": "

The type of the blueprint (os or app).

" } }, "Bucket": { @@ -595,13 +597,20 @@ "CertificateName": { "base": null, "refs": { - "Certificate$name": "

The name of the certificate (e.g., my-certificate).

", + "Certificate$name": "

The name of the certificate (my-certificate).

", "CertificateSummary$certificateName": "

The name of the certificate.

", "CreateCertificateRequest$certificateName": "

The name for the certificate.

", "DeleteCertificateRequest$certificateName": "

The name of the certificate to delete.

Use the GetCertificates action to get a list of certificate names that you can specify.

", "GetCertificatesRequest$certificateName": "

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.

" } }, + "CertificateProvider": { + "base": null, + "refs": { + "SetupInstanceHttpsRequest$certificateProvider": "

The certificate authority that issues the SSL/TLS certificate.

", + "SetupRequest$certificateProvider": "

The Certificate Authority (CA) that issues the SSL/TLS certificate.

" + } + }, "CertificateStatus": { "base": null, "refs": { @@ -665,7 +674,7 @@ "CloudFormationStackRecordSourceType": { "base": null, "refs": { - "CloudFormationStackRecordSourceInfo$resourceType": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" + "CloudFormationStackRecordSourceInfo$resourceType": "

The Lightsail resource type (ExportSnapshotRecord).

" } }, "ComparisonOperator": { @@ -787,7 +796,7 @@ "ContainerServiceDeploymentState": { "base": null, "refs": { - "ContainerServiceDeployment$state": "

The state of the deployment.

A deployment can be in one of the following states:

  • Activating - The deployment is being created.

  • Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.

  • Inactive - The deployment was previously successfully created, but it is not currently running on the container service.

  • Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.

" + "ContainerServiceDeployment$state": "

The state of the deployment.

A deployment can be in one of the following states:

  • ACTIVATING - The deployment is being created.

  • ACTIVE - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.

  • INACTIVE - The deployment was previously successfully created, but it is not currently running on the container service.

  • FAILED - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.

" } }, "ContainerServiceECRImagePullerRole": { @@ -1619,7 +1628,7 @@ "DomainEntryOptions": { "base": null, "refs": { - "DomainEntry$options": "

(Deprecated) The options for the domain entry.

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

" + "DomainEntry$options": "

(Discontinued) The options for the domain entry.

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now discontinued.

" } }, "DomainEntryOptionsKeys": { @@ -1645,11 +1654,11 @@ "refs": { "Certificate$domainName": "

The domain name of the certificate.

", "CertificateSummary$domainName": "

The domain name of the certificate.

", - "CreateCertificateRequest$domainName": "

The domain name (e.g., example.com) for the certificate.

", - "CreateDomainEntryRequest$domainName": "

The domain name (e.g., example.com) for which you want to create the domain entry.

", - "CreateDomainRequest$domainName": "

The domain name to manage (e.g., example.com).

", - "CreateLoadBalancerRequest$certificateDomainName": "

The domain name with which your certificate is associated (e.g., example.com).

If you specify certificateDomainName, then certificateName is required (and vice-versa).

", - "CreateLoadBalancerTlsCertificateRequest$certificateDomainName": "

The domain name (e.g., example.com) for your SSL/TLS certificate.

", + "CreateCertificateRequest$domainName": "

The domain name (example.com) for the certificate.

", + "CreateDomainEntryRequest$domainName": "

The domain name (example.com) for which you want to create the domain entry.

", + "CreateDomainRequest$domainName": "

The domain name to manage (example.com).

", + "CreateLoadBalancerRequest$certificateDomainName": "

The domain name with which your certificate is associated (example.com).

If you specify certificateDomainName, then certificateName is required (and vice-versa).

", + "CreateLoadBalancerTlsCertificateRequest$certificateDomainName": "

The domain name (example.com) for your SSL/TLS certificate.

", "DeleteDomainEntryRequest$domainName": "

The name of the domain entry to delete.

", "DeleteDomainRequest$domainName": "

The specific domain name to delete.

", "DomainEntry$name": "

The name of the domain.

", @@ -1666,8 +1675,8 @@ "DomainNameList": { "base": null, "refs": { - "CreateLoadBalancerRequest$certificateAlternativeNames": "

The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com).

", - "CreateLoadBalancerTlsCertificateRequest$certificateAlternativeNames": "

An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com).

" + "CreateLoadBalancerRequest$certificateAlternativeNames": "

The optional alternative domains and subdomains to use with your SSL/TLS certificate (www.example.com, example.com, m.example.com, blog.example.com).

", + "CreateLoadBalancerTlsCertificateRequest$certificateAlternativeNames": "

An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (*.example.com).

" } }, "DomainValidationRecord": { @@ -1699,6 +1708,12 @@ "Certificate$eligibleToRenew": "

The renewal eligibility of the certificate.

" } }, + "EmailAddress": { + "base": null, + "refs": { + "SetupInstanceHttpsRequest$emailAddress": "

The contact method for SSL/TLS certificate renewal alerts. You can enter one email address.

" + } + }, "EnableAddOnRequest": { "base": null, "refs": { @@ -1755,7 +1770,7 @@ "ExportSnapshotRecordSourceType": { "base": null, "refs": { - "ExportSnapshotRecordSourceInfo$resourceType": "

The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot).

" + "ExportSnapshotRecordSourceInfo$resourceType": "

The Lightsail resource type (InstanceSnapshot or DiskSnapshot).

" } }, "ExportSnapshotRequest": { @@ -2390,6 +2405,16 @@ "refs": { } }, + "GetSetupHistoryRequest": { + "base": null, + "refs": { + } + }, + "GetSetupHistoryResult": { + "base": null, + "refs": { + } + }, "GetStaticIpRequest": { "base": null, "refs": { @@ -2490,7 +2515,7 @@ } }, "InputOrigin": { - "base": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

", + "base": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, container service, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

", "refs": { "CreateDistributionRequest$origin": "

An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

", "UpdateDistributionRequest$origin": "

An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

" @@ -2655,7 +2680,7 @@ "base": "

Describes the virtual private server (or instance) status.

", "refs": { "GetInstanceStateResult$state": "

The state of the instance.

", - "Instance$state": "

The status code and the state (e.g., running) for the instance.

" + "Instance$state": "

The status code and the state (running) for the instance.

" } }, "InvalidInputException": { @@ -2743,7 +2768,7 @@ "GetContainerServiceMetricDataRequest$endTime": "

The end time of the time period.

", "GetCostEstimateRequest$startTime": "

The cost estimate start time.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", "GetCostEstimateRequest$endTime": "

The cost estimate end time.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "GetDistributionLatestCacheResetResult$createTime": "

The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time format.

", + "GetDistributionLatestCacheResetResult$createTime": "

The timestamp of the last cache reset (1479734909.17) in Unix time format.

", "GetRelationalDatabaseLogEventsRequest$startTime": "

The start of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

", "GetRelationalDatabaseLogEventsRequest$endTime": "

The end of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

", "GetRelationalDatabaseMasterUserPasswordResult$createdAt": "

The timestamp when the specified version of the master user password was created.

", @@ -2752,10 +2777,10 @@ "HostKeyAttributes$witnessedAt": "

The time that the SSH host key or RDP certificate was recorded by Lightsail.

", "HostKeyAttributes$notValidBefore": "

The returned RDP certificate is valid after this point in time.

This value is listed only for RDP certificates.

", "HostKeyAttributes$notValidAfter": "

The returned RDP certificate is not valid after this point in time.

This value is listed only for RDP certificates.

", - "Instance$createdAt": "

The timestamp when the instance was created (e.g., 1479734909.17) in Unix time format.

", + "Instance$createdAt": "

The timestamp when the instance was created (1479734909.17) in Unix time format.

", "InstanceAccessDetails$expiresAt": "

For SSH access, the date on which the temporary keys expire.

", - "InstanceSnapshot$createdAt": "

The timestamp when the snapshot was created (e.g., 1479907467.024).

", - "KeyPair$createdAt": "

The timestamp when the key pair was created (e.g., 1479816991.349).

", + "InstanceSnapshot$createdAt": "

The timestamp when the snapshot was created (1479907467.024).

", + "KeyPair$createdAt": "

The timestamp when the key pair was created (1479816991.349).

", "LightsailDistribution$createdAt": "

The timestamp when the distribution was created.

", "LoadBalancer$createdAt": "

The date when your load balancer was created.

", "LoadBalancerTlsCertificate$createdAt": "

The time when you created your SSL/TLS certificate.

", @@ -2764,18 +2789,20 @@ "LoadBalancerTlsCertificate$notBefore": "

The timestamp when the SSL/TLS certificate is first valid.

", "LoadBalancerTlsCertificate$revokedAt": "

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

", "LogEvent$createdAt": "

The timestamp when the database log event was created.

", - "Operation$createdAt": "

The timestamp when the operation was initialized (e.g., 1479816991.349).

", - "Operation$statusChangedAt": "

The timestamp when the status was changed (e.g., 1479816991.349).

", + "Operation$createdAt": "

The timestamp when the operation was initialized (1479816991.349).

", + "Operation$statusChangedAt": "

The timestamp when the status was changed (1479816991.349).

", "PendingMaintenanceAction$currentApplyDate": "

The effective date of the pending database maintenance action.

", "RelationalDatabase$createdAt": "

The timestamp when the database was created. Formatted in Unix time.

", "RelationalDatabase$latestRestorableTime": "

The latest point in time to which the database can be restored. Formatted in Unix time.

", "RelationalDatabaseEvent$createdAt": "

The timestamp when the database event was created.

", "RelationalDatabaseSnapshot$createdAt": "

The timestamp when the database snapshot was created.

", "RenewalSummary$updatedAt": "

The timestamp when the certificate was last updated.

", - "ResetDistributionCacheResult$createTime": "

The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time format.

", + "ResetDistributionCacheResult$createTime": "

The timestamp of the reset cache request (1479734909.17) in Unix time format.

", "ResourceBudgetEstimate$startTime": "

The estimate start time.

", "ResourceBudgetEstimate$endTime": "

The estimate end time.

", - "StaticIp$createdAt": "

The timestamp when the static IP was created (e.g., 1479735304.222).

", + "SetupExecutionDetails$dateTime": "

The timestamp for when the request was run.

", + "SetupHistoryResource$createdAt": "

The timestamp for when the resource was created.

", + "StaticIp$createdAt": "

The timestamp when the static IP was created (1479735304.222).

", "TimePeriod$start": "

The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Lightsail for Research retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

", "TimePeriod$end": "

The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

" } @@ -3082,12 +3109,12 @@ "refs": { "AccessKey$secretAccessKey": "

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

", "Alarm$arn": "

The Amazon Resource Name (ARN) of the alarm.

", - "AttachDiskRequest$diskPath": "

The disk path to expose to the instance (e.g., /dev/xvdf).

", + "AttachDiskRequest$diskPath": "

The disk path to expose to the instance (/dev/xvdf).

", "AvailabilityZone$zoneName": "

The name of the Availability Zone. The format is us-east-2a (case-sensitive).

", "AvailabilityZone$state": "

The state of the Availability Zone.

", - "Blueprint$blueprintId": "

The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).

", - "Blueprint$group": "

The group name of the blueprint (e.g., amazon-linux).

", - "Bucket$resourceType": "

The Lightsail resource type of the bucket (for example, Bucket).

", + "Blueprint$blueprintId": "

The ID for the virtual private server image (app_wordpress_4_4 or app_lamp_7_0).

", + "Blueprint$group": "

The group name of the blueprint (amazon-linux).

", + "Bucket$resourceType": "

The Lightsail resource type of the bucket.

", "Bucket$arn": "

The Amazon Resource Name (ARN) of the bucket.

", "Bucket$bundleId": "

The ID of the bundle currently applied to the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to change the bundle of a bucket.

", "Bucket$url": "

The URL of the bucket.

", @@ -3096,7 +3123,7 @@ "BucketBundle$bundleId": "

The ID of the bundle.

", "BucketBundle$name": "

The name of the bundle.

", "BucketState$code": "

The state code of the bucket.

The following codes are possible:

  • OK - The bucket is in a running state.

  • Unknown - Creation of the bucket might have timed-out. You might want to delete the bucket and create a new one.

", - "Bundle$bundleId": "

The bundle ID (e.g., micro_1_0).

", + "Bundle$bundleId": "

The bundle ID (micro_1_0).

", "CacheSettings$allowedHTTPMethods": "

The HTTP methods that are processed and forwarded to the distribution's origin.

You can specify the following options:

  • GET,HEAD - The distribution forwards the GET and HEAD methods.

  • GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.

  • GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.

If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.

", "CacheSettings$cachedHTTPMethods": "

The HTTP method responses that are cached by your distribution.

You can specify the following options:

  • GET,HEAD - The distribution caches responses to the GET and HEAD methods.

  • GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.

", "Certificate$arn": "

The Amazon Resource Name (ARN) of the certificate.

", @@ -3109,11 +3136,11 @@ "ContainerService$arn": "

The Amazon Resource Name (ARN) of the container service.

", "CostEstimate$usageType": "

The types of usage that are included in the estimate, such as costs, usage, or data transfer.

", "CreateBucketRequest$bundleId": "

The ID of the bundle to use for the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

Use the UpdateBucketBundle action to change the bundle after the bucket is created.

", - "CreateDiskFromSnapshotRequest$availabilityZone": "

The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

", - "CreateDiskRequest$availabilityZone": "

The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.

Use the get regions operation to list the Availability Zones where Lightsail is currently available.

", - "CreateInstancesFromSnapshotRequest$bundleId": "

The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

", - "CreateInstancesRequest$blueprintId": "

The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints).

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

", - "CreateInstancesRequest$bundleId": "

The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

", + "CreateDiskFromSnapshotRequest$availabilityZone": "

The Availability Zone where you want to create the disk (us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

", + "CreateDiskRequest$availabilityZone": "

The Availability Zone where you want to create the disk (us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.

Use the get regions operation to list the Availability Zones where Lightsail is currently available.

", + "CreateInstancesFromSnapshotRequest$bundleId": "

The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_1_0).

", + "CreateInstancesRequest$blueprintId": "

The ID for a virtual private server image (app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints).

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

", + "CreateInstancesRequest$bundleId": "

The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_1_0).

", "DeleteBucketAccessKeyRequest$accessKeyId": "

The ID of the access key to delete.

Use the GetBucketAccessKeys action to get a list of access key IDs that you can specify.

", "DestinationInfo$id": "

The ID of the resource created at the destination.

", "DestinationInfo$service": "

The destination service of the record.

", @@ -3123,7 +3150,7 @@ "DiskSnapshot$arn": "

The Amazon Resource Name (ARN) of the disk snapshot.

", "DiskSnapshot$fromDiskArn": "

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

", "DiskSnapshot$fromInstanceArn": "

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

", - "Domain$arn": "

The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

", + "Domain$arn": "

The Amazon Resource Name (ARN) of the domain recordset (arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

", "DomainEntry$id": "

The ID of the domain recordset entry.

", "ExportSnapshotRecord$arn": "

The Amazon Resource Name (ARN) of the export snapshot record.

", "ExportSnapshotRecordSourceInfo$name": "

The name of the source instance or disk snapshot.

", @@ -3131,17 +3158,17 @@ "ExportSnapshotRecordSourceInfo$fromResourceName": "

The name of the snapshot's source instance or disk.

", "ExportSnapshotRecordSourceInfo$fromResourceArn": "

The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

", "GetOperationRequest$operationId": "

A GUID used to identify the operation.

", - "Instance$arn": "

The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

", - "Instance$blueprintId": "

The blueprint ID (e.g., os_amlinux_2016_03).

", - "Instance$blueprintName": "

The friendly name of the blueprint (e.g., Amazon Linux).

", - "Instance$bundleId": "

The bundle for the instance (e.g., micro_1_0).

", - "Instance$username": "

The user name for connecting to the instance (e.g., ec2-user).

", - "InstanceEntry$instanceType": "

The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.

", - "InstanceSnapshot$arn": "

The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

", - "InstanceSnapshot$fromInstanceArn": "

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

", - "InstanceSnapshotInfo$fromBundleId": "

The bundle ID from which the source instance was created (e.g., micro_1_0).

", - "InstanceSnapshotInfo$fromBlueprintId": "

The blueprint ID from which the source instance (e.g., os_debian_8_3).

", - "KeyPair$arn": "

The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

", + "Instance$arn": "

The Amazon Resource Name (ARN) of the instance (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

", + "Instance$blueprintId": "

The blueprint ID (os_amlinux_2016_03).

", + "Instance$blueprintName": "

The friendly name of the blueprint (Amazon Linux).

", + "Instance$bundleId": "

The bundle for the instance (micro_1_0).

", + "Instance$username": "

The user name for connecting to the instance (ec2-user).

", + "InstanceEntry$instanceType": "

The instance type (t2.micro) to use for the new Amazon EC2 instance.

", + "InstanceSnapshot$arn": "

The Amazon Resource Name (ARN) of the snapshot (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

", + "InstanceSnapshot$fromInstanceArn": "

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

", + "InstanceSnapshotInfo$fromBundleId": "

The bundle ID from which the source instance was created (micro_1_0).

", + "InstanceSnapshotInfo$fromBlueprintId": "

The blueprint ID from which the source instance (os_debian_8_3).

", + "KeyPair$arn": "

The Amazon Resource Name (ARN) of the key pair (arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

", "LightsailDistribution$arn": "

The Amazon Resource Name (ARN) of the distribution.

", "LoadBalancer$arn": "

The Amazon Resource Name (ARN) of the load balancer.

", "LoadBalancer$dnsName": "

The DNS name of your Lightsail load balancer.

", @@ -3179,7 +3206,10 @@ "ResourceReceivingAccess$name": "

The name of the Lightsail instance.

", "ResourceReceivingAccess$resourceType": "

The Lightsail resource type (for example, Instance).

", "Session$name": "

The session name.

", - "StaticIp$arn": "

The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

", + "SetupExecutionDetails$name": "

The name of the target resource.

", + "SetupHistory$operationId": "

A GUID that's used to identify the operation.

", + "SetupHistoryResource$arn": "

The Amazon Resource Name (ARN) of the Lightsail resource.

", + "StaticIp$arn": "

The Amazon Resource Name (ARN) of the static IP (arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

", "UpdateBucketBundleRequest$bundleId": "

The ID of the new bundle to apply to the bucket.

Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

", "UpdateBucketRequest$versioning": "

Specifies whether to enable or suspend versioning of objects in the bucket.

The following options can be specified:

  • Enabled - Enables versioning of objects in the specified bucket.

  • Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.

" } @@ -3293,6 +3323,7 @@ "SendContactMethodVerificationResult$operations": "

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

", "SetIpAddressTypeResult$operations": "

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

", "SetResourceAccessForBucketResult$operations": "

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

", + "SetupInstanceHttpsResult$operations": "

The available API operations for SetupInstanceHttps.

", "StartGUISessionResult$operations": "

The available API operations.

", "StartInstanceResult$operations": "

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

", "StartRelationalDatabaseResult$operations": "

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

", @@ -3535,7 +3566,7 @@ "CopySnapshotRequest$sourceRegion": "

The Amazon Web Services Region where the source manual or automatic snapshot is located.

", "InputOrigin$regionName": "

The AWS Region name of the origin resource.

", "Origin$regionName": "

The AWS Region name of the origin resource.

", - "Region$name": "

The region name (e.g., us-east-2).

", + "Region$name": "

The region name (us-east-2).

", "ResourceLocation$regionName": "

The Amazon Web Services Region name.

" } }, @@ -3741,11 +3772,12 @@ "InstanceSnapshot$location": "

The region name and Availability Zone where you created the snapshot.

", "KeyPair$location": "

The region name and Availability Zone where the key pair was created.

", "LightsailDistribution$location": "

An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.

Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

", - "LoadBalancer$location": "

The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

", + "LoadBalancer$location": "

The AWS Region where your load balancer was created (us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

", "LoadBalancerTlsCertificate$location": "

The Amazon Web Services Region and Availability Zone where you created your certificate.

", "Operation$location": "

The Amazon Web Services Region and Availability Zone.

", "RelationalDatabase$location": "

The Region name and Availability Zone where the database is located.

", "RelationalDatabaseSnapshot$location": "

The Region name and Availability Zone where the database snapshot is located.

", + "SetupHistoryResource$location": null, "StaticIp$location": "

The region and Availability Zone where the static IP was created.

" } }, @@ -3756,7 +3788,7 @@ "AllocateStaticIpRequest$staticIpName": "

The name of the static IP address.

", "AttachCertificateToDistributionRequest$distributionName": "

The name of the distribution that the certificate will be attached to.

Use the GetDistributions action to get a list of distribution names that you can specify.

", "AttachCertificateToDistributionRequest$certificateName": "

The name of the certificate to attach to a distribution.

Only certificates with a status of ISSUED can be attached to a distribution.

Use the GetCertificates action to get a list of certificate names that you can specify.

This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com.

", - "AttachDiskRequest$diskName": "

The unique Lightsail disk name (e.g., my-disk).

", + "AttachDiskRequest$diskName": "

The unique Lightsail disk name (my-disk).

", "AttachDiskRequest$instanceName": "

The name of the Lightsail instance where you want to utilize the storage disk.

", "AttachInstancesToLoadBalancerRequest$loadBalancerName": "

The name of the load balancer.

", "AttachLoadBalancerTlsCertificateRequest$loadBalancerName": "

The name of the load balancer to which you want to associate the SSL/TLS certificate.

", @@ -3764,18 +3796,18 @@ "AttachStaticIpRequest$staticIpName": "

The name of the static IP.

", "AttachStaticIpRequest$instanceName": "

The instance name to which you want to attach the static IP address.

", "AttachedDiskMap$key": null, - "Blueprint$name": "

The friendly name of the blueprint (e.g., Amazon Linux).

", + "Blueprint$name": "

The friendly name of the blueprint (Amazon Linux).

", "CloseInstancePublicPortsRequest$instanceName": "

The name of the instance for which to close ports.

", "CloudFormationStackRecord$name": "

The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID.

", "ContactMethod$name": "

The name of the contact method.

", "CopySnapshotRequest$sourceSnapshotName": "

The name of the source manual snapshot to copy.

Constraint:

  • Define this parameter only when copying a manual snapshot as another manual snapshot.

", "CopySnapshotRequest$targetSnapshotName": "

The name of the new manual snapshot to be created as a copy.

", - "CreateDiskFromSnapshotRequest$diskName": "

The unique Lightsail disk name (e.g., my-disk).

", - "CreateDiskFromSnapshotRequest$diskSnapshotName": "

The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk.

Constraint:

  • This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

", - "CreateDiskRequest$diskName": "

The unique Lightsail disk name (e.g., my-disk).

", - "CreateDiskSnapshotRequest$diskName": "

The unique name of the source disk (e.g., Disk-Virginia-1).

This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.

", - "CreateDiskSnapshotRequest$diskSnapshotName": "

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.

", - "CreateDiskSnapshotRequest$instanceName": "

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance's system volume is created.

This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.

", + "CreateDiskFromSnapshotRequest$diskName": "

The unique Lightsail disk name (my-disk).

", + "CreateDiskFromSnapshotRequest$diskSnapshotName": "

The name of the disk snapshot (my-snapshot) from which to create the new storage disk.

Constraint:

  • This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

", + "CreateDiskRequest$diskName": "

The unique Lightsail disk name (my-disk).

", + "CreateDiskSnapshotRequest$diskName": "

The unique name of the source disk (Disk-Virginia-1).

This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.

", + "CreateDiskSnapshotRequest$diskSnapshotName": "

The name of the destination disk snapshot (my-disk-snapshot) based on the source disk.

", + "CreateDiskSnapshotRequest$instanceName": "

The unique name of the source instance (Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance's system volume is created.

This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.

", "CreateDistributionRequest$distributionName": "

The name for the distribution.

", "CreateGUISessionAccessDetailsRequest$resourceName": "

The resource name.

", "CreateGUISessionAccessDetailsResult$resourceName": "

The resource name.

", @@ -3783,7 +3815,7 @@ "CreateInstanceSnapshotRequest$instanceName": "

The Lightsail instance on which to base your snapshot.

", "CreateInstancesFromSnapshotRequest$instanceSnapshotName": "

The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.

Constraint:

  • This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.

", "CreateInstancesFromSnapshotRequest$keyPairName": "

The name for your key pair.

", - "CreateInstancesRequest$customImageName": "

(Deprecated) The name for your custom image.

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.

", + "CreateInstancesRequest$customImageName": "

(Discontinued) The name for your custom image.

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.

", "CreateInstancesRequest$keyPairName": "

The name of your key pair.

", "CreateKeyPairRequest$keyPairName": "

The name for your new key pair.

", "CreateLoadBalancerRequest$loadBalancerName": "

The name of your load balancer.

", @@ -3798,8 +3830,8 @@ "CreateRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName": "

The name for your new database snapshot.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

", "DeleteAlarmRequest$alarmName": "

The name of the alarm to delete.

", "DeleteAutoSnapshotRequest$resourceName": "

The name of the source instance or disk from which to delete the automatic snapshot.

", - "DeleteDiskRequest$diskName": "

The unique name of the disk you want to delete (e.g., my-disk).

", - "DeleteDiskSnapshotRequest$diskSnapshotName": "

The name of the disk snapshot you want to delete (e.g., my-disk-snapshot).

", + "DeleteDiskRequest$diskName": "

The unique name of the disk you want to delete (my-disk).

", + "DeleteDiskSnapshotRequest$diskSnapshotName": "

The name of the disk snapshot you want to delete (my-disk-snapshot).

", "DeleteDistributionRequest$distributionName": "

The name of the distribution to delete.

Use the GetDistributions action to get a list of distribution names that you can specify.

", "DeleteInstanceRequest$instanceName": "

The name of the instance to delete.

", "DeleteInstanceSnapshotRequest$instanceSnapshotName": "

The name of the snapshot to delete.

", @@ -3812,14 +3844,14 @@ "DeleteRelationalDatabaseRequest$finalRelationalDatabaseSnapshotName": "

The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.

Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

", "DeleteRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName": "

The name of the database snapshot that you are deleting.

", "DetachCertificateFromDistributionRequest$distributionName": "

The name of the distribution from which to detach the certificate.

Use the GetDistributions action to get a list of distribution names that you can specify.

", - "DetachDiskRequest$diskName": "

The unique name of the disk you want to detach from your instance (e.g., my-disk).

", + "DetachDiskRequest$diskName": "

The unique name of the disk you want to detach from your instance (my-disk).

", "DetachInstancesFromLoadBalancerRequest$loadBalancerName": "

The name of the Lightsail load balancer.

", "DetachStaticIpRequest$staticIpName": "

The name of the static IP to detach from the instance.

", "DisableAddOnRequest$resourceName": "

The name of the source resource for which to disable the add-on.

", "Disk$name": "

The unique name of the disk.

", "Disk$attachedTo": "

The resources to which the disk is attached.

", - "DiskMap$newDiskName": "

The new disk name (e.g., my-new-disk).

", - "DiskSnapshot$name": "

The name of the disk snapshot (e.g., my-disk-snapshot).

", + "DiskMap$newDiskName": "

The new disk name (my-new-disk).

", + "DiskSnapshot$name": "

The name of the disk snapshot (my-disk-snapshot).

", "DiskSnapshot$fromDiskName": "

The unique name of the source disk from which the disk snapshot was created.

", "DiskSnapshot$fromInstanceName": "

The unique name of the source instance from which the disk (system volume) snapshot was created.

", "Domain$name": "

The name of the domain.

", @@ -3831,8 +3863,8 @@ "GetAutoSnapshotsRequest$resourceName": "

The name of the source instance or disk from which to get automatic snapshot information.

", "GetAutoSnapshotsResult$resourceName": "

The name of the source instance or disk for the automatic snapshots.

", "GetCostEstimateRequest$resourceName": "

The resource name.

", - "GetDiskRequest$diskName": "

The name of the disk (e.g., my-disk).

", - "GetDiskSnapshotRequest$diskSnapshotName": "

The name of the disk snapshot (e.g., my-disk-snapshot).

", + "GetDiskRequest$diskName": "

The name of the disk (my-disk).

", + "GetDiskSnapshotRequest$diskSnapshotName": "

The name of the disk snapshot (my-disk-snapshot).

", "GetDistributionLatestCacheResetRequest$distributionName": "

The name of the distribution for which to return the timestamp of the last cache reset.

Use the GetDistributions action to get a list of distribution names that you can specify.

When omitted, the response includes the latest cache reset timestamp of all your distributions.

", "GetDistributionMetricDataRequest$distributionName": "

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

", "GetDistributionsRequest$distributionName": "

The name of the distribution for which to return information.

When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.

", @@ -3855,11 +3887,12 @@ "GetRelationalDatabaseParametersRequest$relationalDatabaseName": "

The name of your database for which to get parameters.

", "GetRelationalDatabaseRequest$relationalDatabaseName": "

The name of the database that you are looking up.

", "GetRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName": "

The name of the database snapshot for which to get information.

", + "GetSetupHistoryRequest$resourceName": "

The name of the resource for which you are requesting information.

", "GetStaticIpRequest$staticIpName": "

The name of the static IP in Lightsail.

", "ImportKeyPairRequest$keyPairName": "

The name of the key pair for which you want to import the public key.

", "InputOrigin$name": "

The name of the origin resource.

", - "Instance$name": "

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

", - "Instance$sshKeyName": "

The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).

", + "Instance$name": "

The name the user gave the instance (Amazon_Linux-1GB-Ohio-1).

", + "Instance$sshKeyName": "

The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).

", "InstanceAccessDetails$instanceName": "

The name of this Amazon Lightsail instance.

", "InstanceEntry$sourceName": "

The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.

Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack.

", "InstanceHealthSummary$instanceName": "

The name of the Lightsail instance for which you are requesting health check data.

", @@ -3868,9 +3901,9 @@ "KeyPair$name": "

The friendly name of the SSH key pair.

", "LightsailDistribution$name": "

The name of the distribution.

", "LightsailDistribution$certificateName": "

The name of the SSL/TLS certificate attached to the distribution, if any.

", - "LoadBalancer$name": "

The name of the load balancer (e.g., my-load-balancer).

", + "LoadBalancer$name": "

The name of the load balancer (my-load-balancer).

", "LoadBalancer$tlsPolicyName": "

The name of the TLS security policy for the load balancer.

", - "LoadBalancerTlsCertificate$name": "

The name of the SSL/TLS certificate (e.g., my-certificate).

", + "LoadBalancerTlsCertificate$name": "

The name of the SSL/TLS certificate (my-certificate).

", "LoadBalancerTlsCertificate$loadBalancerName": "

The load balancer name where your SSL/TLS certificate is attached.

", "LoadBalancerTlsCertificateSummary$name": "

The name of the SSL/TLS certificate.

", "LoadBalancerTlsPolicy$name": "

The name of the TLS security policy.

", @@ -3893,11 +3926,14 @@ "ResourceNameList$member": null, "SetIpAddressTypeRequest$resourceName": "

The name of the resource for which to set the IP address type.

", "SetResourceAccessForBucketRequest$resourceName": "

The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state.

", + "SetupHistoryResource$name": "

The name of the Lightsail resource.

", + "SetupInstanceHttpsRequest$instanceName": "

The name of the Lightsail instance.

", + "SetupRequest$instanceName": "

The name of the Lightsail instance.

", "StartGUISessionRequest$resourceName": "

The resource name.

", "StartInstanceRequest$instanceName": "

The name of the instance (a virtual private server) to start.

", "StartRelationalDatabaseRequest$relationalDatabaseName": "

The name of your database to start.

", - "StaticIp$name": "

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).

", - "StaticIp$attachedTo": "

The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).

", + "StaticIp$name": "

The name of the static IP (StaticIP-Ohio-EXAMPLE).

", + "StaticIp$attachedTo": "

The instance where the static IP is attached (Amazon_Linux-1GB-Ohio-1).

", "StopGUISessionRequest$resourceName": "

The resource name.

", "StopInstanceRequest$instanceName": "

The name of the instance (a virtual private server) to stop.

", "StopRelationalDatabaseRequest$relationalDatabaseName": "

The name of your database to stop.

", @@ -3908,7 +3944,7 @@ "UpdateDistributionBundleRequest$distributionName": "

The name of the distribution for which to update the bundle.

Use the GetDistributions action to get a list of distribution names that you can specify.

", "UpdateDistributionRequest$distributionName": "

The name of the distribution to update.

Use the GetDistributions action to get a list of distribution names that you can specify.

", "UpdateInstanceMetadataOptionsRequest$instanceName": "

The name of the instance for which to update metadata parameters.

", - "UpdateLoadBalancerAttributeRequest$loadBalancerName": "

The name of the load balancer that you want to modify (e.g., my-load-balancer.

", + "UpdateLoadBalancerAttributeRequest$loadBalancerName": "

The name of the load balancer that you want to modify (my-load-balancer.

", "UpdateRelationalDatabaseParametersRequest$relationalDatabaseName": "

The name of your database for which to update parameters.

", "UpdateRelationalDatabaseRequest$relationalDatabaseName": "

The name of your Lightsail database resource to update.

" } @@ -3935,28 +3971,29 @@ "ResourceType": { "base": null, "refs": { - "Alarm$resourceType": "

The Lightsail resource type (e.g., Alarm).

", - "CloudFormationStackRecord$resourceType": "

The Lightsail resource type (e.g., CloudFormationStackRecord).

", - "ContactMethod$resourceType": "

The Lightsail resource type (e.g., ContactMethod).

", - "ContainerService$resourceType": "

The Lightsail resource type of the container service (i.e., ContainerService).

", - "Disk$resourceType": "

The Lightsail resource type (e.g., Disk).

", - "DiskSnapshot$resourceType": "

The Lightsail resource type (e.g., DiskSnapshot).

", + "Alarm$resourceType": "

The Lightsail resource type of the alarm.

", + "CloudFormationStackRecord$resourceType": "

The Lightsail resource type (CloudFormationStackRecord).

", + "ContactMethod$resourceType": "

The Lightsail resource type of the contact method.

", + "ContainerService$resourceType": "

The Lightsail resource type of the container service.

", + "Disk$resourceType": "

The Lightsail resource type (Disk).

", + "DiskSnapshot$resourceType": "

The Lightsail resource type (DiskSnapshot).

", "Domain$resourceType": "

The resource type.

", - "ExportSnapshotRecord$resourceType": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

", - "GetAutoSnapshotsResult$resourceType": "

The resource type (e.g., Instance or Disk).

", + "ExportSnapshotRecord$resourceType": "

The Lightsail resource type (ExportSnapshotRecord).

", + "GetAutoSnapshotsResult$resourceType": "

The resource type of the automatic snapshot. The possible values are Instance, and Disk.

", "Instance$resourceType": "

The type of resource (usually Instance).

", "InstanceSnapshot$resourceType": "

The type of resource (usually InstanceSnapshot).

", "KeyPair$resourceType": "

The resource type (usually KeyPair).

", - "LightsailDistribution$resourceType": "

The Lightsail resource type (e.g., Distribution).

", - "LoadBalancer$resourceType": "

The resource type (e.g., LoadBalancer.

", - "LoadBalancerTlsCertificate$resourceType": "

The resource type (e.g., LoadBalancerTlsCertificate).

  • Instance - A Lightsail instance (a virtual private server)

  • StaticIp - A static IP address

  • KeyPair - The key pair used to connect to a Lightsail instance

  • InstanceSnapshot - A Lightsail instance snapshot

  • Domain - A DNS zone

  • PeeredVpc - A peered VPC

  • LoadBalancer - A Lightsail load balancer

  • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer

  • Disk - A Lightsail block storage disk

  • DiskSnapshot - A block storage disk snapshot

", + "LightsailDistribution$resourceType": "

The Lightsail resource type (Distribution).

", + "LoadBalancer$resourceType": "

The resource type (LoadBalancer.

", + "LoadBalancerTlsCertificate$resourceType": "

The resource type (LoadBalancerTlsCertificate).

  • Instance - A Lightsail instance (a virtual private server)

  • StaticIp - A static IP address

  • KeyPair - The key pair used to connect to a Lightsail instance

  • InstanceSnapshot - A Lightsail instance snapshot

  • Domain - A DNS zone

  • PeeredVpc - A peered VPC

  • LoadBalancer - A Lightsail load balancer

  • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer

  • Disk - A Lightsail block storage disk

  • DiskSnapshot - A block storage disk snapshot

", "MonitoredResourceInfo$resourceType": "

The Lightsail resource type of the resource being monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

", "Operation$resourceType": "

The resource type.

", - "Origin$resourceType": "

The resource type of the origin resource (e.g., Instance).

", + "Origin$resourceType": "

The resource type of the origin resource (Instance).

", "RelationalDatabase$resourceType": "

The Lightsail resource type for the database (for example, RelationalDatabase).

", "RelationalDatabaseSnapshot$resourceType": "

The Lightsail resource type.

", "ResourceBudgetEstimate$resourceType": "

The type of resource the budget will track.

", - "SetIpAddressTypeRequest$resourceType": "

The resource type.

The possible values are Distribution, Instance, and LoadBalancer.

Distribution-related APIs are available only in the N. Virginia (us-east-1) Amazon Web Services Region. Set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit distributions.

", + "SetIpAddressTypeRequest$resourceType": "

The resource type.

The resource values are Distribution, Instance, and LoadBalancer.

Distribution-related APIs are available only in the N. Virginia (us-east-1) Amazon Web Services Region. Set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit distributions.

", + "SetupHistoryResource$resourceType": "

The Lightsail resource type. For example, Instance.

", "StaticIp$resourceType": "

The resource type (usually StaticIp).

" } }, @@ -4039,6 +4076,73 @@ "refs": { } }, + "SetupDomainName": { + "base": null, + "refs": { + "SetupDomainNameList$member": null + } + }, + "SetupDomainNameList": { + "base": null, + "refs": { + "SetupInstanceHttpsRequest$domainNames": "

The name of the domain and subdomains that were specified for the SSL/TLS certificate.

", + "SetupRequest$domainNames": "

The name of the domain and subdomains that the SSL/TLS certificate secures.

" + } + }, + "SetupExecutionDetails": { + "base": "

Returns details about the commands that were run.

", + "refs": { + "SetupExecutionDetailsList$member": null + } + }, + "SetupExecutionDetailsList": { + "base": null, + "refs": { + "SetupHistory$executionDetails": "

Describes the full details of the request.

" + } + }, + "SetupHistory": { + "base": "

Returns a list of the commands that were ran on the target resource.

The status of each command is also returned.

", + "refs": { + "setupHistoryList$member": null + } + }, + "SetupHistoryPageToken": { + "base": null, + "refs": { + "GetSetupHistoryRequest$pageToken": "

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetSetupHistory request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

", + "GetSetupHistoryResult$nextPageToken": "

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetSetupHistory request and specify the next page token using the pageToken parameter.

" + } + }, + "SetupHistoryResource": { + "base": "

The Lightsail resource that SetupHistory was ran on.

", + "refs": { + "SetupHistory$resource": "

The target resource name for the request.

" + } + }, + "SetupInstanceHttpsRequest": { + "base": null, + "refs": { + } + }, + "SetupInstanceHttpsResult": { + "base": null, + "refs": { + } + }, + "SetupRequest": { + "base": "

Returns information that was submitted during the SetupInstanceHttps request. Email information is redacted for privacy.

", + "refs": { + "SetupHistory$request": "

Information about the specified request.

" + } + }, + "SetupStatus": { + "base": null, + "refs": { + "SetupExecutionDetails$status": "

The status of the SetupInstanceHttps request.

", + "SetupHistory$status": "

The status of the request.

" + } + }, "StartGUISessionRequest": { "base": null, "refs": { @@ -4146,7 +4250,7 @@ "InstancePortState$ipv6Cidrs": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

", "InstancePortState$cidrListAliases": "

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

", "LightsailDistribution$alternativeDomainNames": "

The alternate domain names of the distribution.

", - "LoadBalancerTlsCertificate$subjectAlternativeNames": "

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.

", + "LoadBalancerTlsCertificate$subjectAlternativeNames": "

An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) for the certificate.

", "LoadBalancerTlsPolicy$protocols": "

The protocols used in a given TLS security policy.

", "LoadBalancerTlsPolicy$ciphers": "

The ciphers used by the TLS security policy.

The ciphers are listed in order of preference.

", "PortInfo$cidrs": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

Examples:

  • To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

  • To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

", @@ -4166,8 +4270,8 @@ "SubjectAlternativeNameList": { "base": null, "refs": { - "Certificate$subjectAlternativeNames": "

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

", - "CreateCertificateRequest$subjectAlternativeNames": "

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.

You can specify a maximum of nine alternate domains (in addition to the primary domain name).

Wildcard domain entries (e.g., *.example.com) are not supported.

" + "Certificate$subjectAlternativeNames": "

An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) of the certificate.

", + "CreateCertificateRequest$subjectAlternativeNames": "

An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) for the certificate.

You can specify a maximum of nine alternate domains (in addition to the primary domain name).

Wildcard domain entries (*.example.com) are not supported.

" } }, "Tag": { @@ -4438,8 +4542,8 @@ "GetBucketsRequest$includeConnectedResources": "

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

", "GetBundlesRequest$includeInactive": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

", "GetKeyPairsRequest$includeDefaultKeyPair": "

A Boolean value that indicates whether to include the default key pair in the response of your request.

", - "GetRegionsRequest$includeAvailabilityZones": "

A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-2a.

", - "GetRegionsRequest$includeRelationalDatabaseAvailabilityZones": "

A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., us-east-2a).

", + "GetRegionsRequest$includeAvailabilityZones": "

A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: us-east-2a.

", + "GetRegionsRequest$includeRelationalDatabaseAvailabilityZones": "

A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (us-east-2a).

", "GetRelationalDatabaseBundlesRequest$includeInactive": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

", "GetRelationalDatabaseLogEventsRequest$startFromHead": "

Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log.

For PostgreSQL, the default value of false is the only option available.

", "Instance$isStaticIp": "

A Boolean value indicating whether this instance has a static IP assigned to it.

", @@ -4491,13 +4595,13 @@ "base": null, "refs": { "BucketBundle$price": "

The monthly price of the bundle, in US dollars.

", - "Bundle$price": "

The price in US dollars (e.g., 5.0) of the bundle.

", - "Bundle$ramSizeInGb": "

The amount of RAM in GB (e.g., 2.0).

", + "Bundle$price": "

The price in US dollars (5.0) of the bundle.

", + "Bundle$ramSizeInGb": "

The amount of RAM in GB (2.0).

", "ContainerServicePower$price": "

The monthly price of the power in USD.

", "ContainerServicePower$cpuCount": "

The number of vCPUs included in the power.

", "ContainerServicePower$ramSizeInGb": "

The amount of RAM (in GB) of the power.

", "DistributionBundle$price": "

The monthly price, in US dollars, of the bundle.

", - "InstanceHardware$ramSizeInGb": "

The amount of RAM in GB on the instance (e.g., 1.0).

", + "InstanceHardware$ramSizeInGb": "

The amount of RAM in GB on the instance (1.0).

", "RelationalDatabaseBundle$price": "

The cost of the database bundle in US currency.

", "RelationalDatabaseBundle$ramSizeInGb": "

The amount of RAM in GB (for example, 2.0) for the database bundle.

", "RelationalDatabaseHardware$ramSizeInGb": "

The amount of RAM in GB for the database.

" @@ -4512,25 +4616,25 @@ "Blueprint$minPower": "

The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.

", "BucketBundle$storagePerMonthInGb": "

The storage size of the bundle, in GB.

", "BucketBundle$transferPerMonthInGb": "

The monthly network transfer quota of the bundle.

", - "Bundle$cpuCount": "

The number of vCPUs included in the bundle (e.g., 2).

", - "Bundle$diskSizeInGb": "

The size of the SSD (e.g., 30).

", - "Bundle$power": "

A numeric value that represents the power of the bundle (e.g., 500). You can use the bundle's power value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.

", - "Bundle$transferPerMonthInGb": "

The data transfer rate per month in GB (e.g., 2000).

", + "Bundle$cpuCount": "

The number of vCPUs included in the bundle (2).

", + "Bundle$diskSizeInGb": "

The size of the SSD (30).

", + "Bundle$power": "

A numeric value that represents the power of the bundle (500). You can use the bundle's power value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.

", + "Bundle$transferPerMonthInGb": "

The data transfer rate per month in GB (2000).

", "ContainerServiceDeployment$version": "

The version number of the deployment.

", "ContainerServiceEndpoint$containerPort": "

The port of the specified container to which traffic is forwarded to.

", "ContainerServiceHealthCheckConfig$healthyThreshold": "

The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

", "ContainerServiceHealthCheckConfig$unhealthyThreshold": "

The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

", "ContainerServiceHealthCheckConfig$timeoutSeconds": "

The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

", "ContainerServiceHealthCheckConfig$intervalSeconds": "

The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

", - "CreateDiskFromSnapshotRequest$sizeInGb": "

The size of the disk in GB (e.g., 32).

", - "CreateDiskRequest$sizeInGb": "

The size of the disk in GB (e.g., 32).

", + "CreateDiskFromSnapshotRequest$sizeInGb": "

The size of the disk in GB (32).

", + "CreateDiskRequest$sizeInGb": "

The size of the disk in GB (32).

", "CreateGUISessionAccessDetailsResult$percentageComplete": "

The percentage of completion for the operation.

", "Disk$sizeInGb": "

The size of the disk in GB.

", "Disk$iops": "

The input/output operations per second (IOPS) of the disk.

", - "Disk$gbInUse": "

(Deprecated) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

", - "DiskInfo$sizeInGb": "

The size of the disk in GB (e.g., 32).

", + "Disk$gbInUse": "

(Discontinued) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.

", + "DiskInfo$sizeInGb": "

The size of the disk in GB (32).

", "DiskSnapshot$sizeInGb": "

The size of the disk in GB.

", - "DiskSnapshotInfo$sizeInGb": "

The size of the disk in GB (e.g., 32).

", + "DiskSnapshotInfo$sizeInGb": "

The size of the disk in GB (32).

", "DistributionBundle$transferPerMonthInGb": "

The monthly network transfer quota of the bundle.

", "EndpointRequest$containerPort": "

The port of the container to which traffic is forwarded to.

", "GetRelationalDatabaseEventsRequest$durationInMinutes": "

The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.

Default: 60

The minimum is 1 and the maximum is 14 days (20160 minutes).

", @@ -4560,6 +4664,12 @@ "CacheSettings$maximumTTL": "

The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

" } }, + "setupHistoryList": { + "base": null, + "refs": { + "GetSetupHistoryResult$setupHistory": "

The historical information that's returned.

" + } + }, "string": { "base": null, "refs": { @@ -4578,16 +4688,16 @@ "AddOn$threshold": "

The trigger threshold of the action.

This add-on only applies to Lightsail for Research resources.

", "AddOn$duration": "

The amount of idle time in minutes after which your virtual computer will automatically stop.

This add-on only applies to Lightsail for Research resources.

", "Alarm$supportCode": "

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

", - "AttachedDisk$path": "

The path of the disk (e.g., /dev/xvdf).

", + "AttachedDisk$path": "

The path of the disk (/dev/xvdf).

", "AutoSnapshotDetails$date": "

The date of the automatic snapshot in YYYY-MM-DD format.

", "Blueprint$description": "

The description of the blueprint.

", - "Blueprint$version": "

The version number of the operating system, application, or stack (e.g., 2016.03.0).

", + "Blueprint$version": "

The version number of the operating system, application, or stack ( 2016.03.0).

", "Blueprint$versionCode": "

The version code.

", "Blueprint$productUrl": "

The product URL to learn more about the image or blueprint.

", "Blueprint$licenseUrl": "

The end-user license agreement URL for the image or blueprint.

", "BucketState$message": "

A message that describes the state of the bucket.

", - "Bundle$instanceType": "

The Amazon EC2 instance type (e.g., t2.micro).

", - "Bundle$name": "

A friendly name for the bundle (e.g., Micro).

", + "Bundle$instanceType": "

The Amazon EC2 instance type (t2.micro).

", + "Bundle$name": "

A friendly name for the bundle (Micro).

", "CacheBehaviorPerPath$path": "

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

  • Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

    var/www/html/

  • Specify the following file to cache only the index page in the document root of an Apache web server.

    var/www/html/index.html

  • Specify the following to cache only the .html files in the document root of an Apache web server.

    var/www/html/*.html

  • Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

    var/www/html/images/*.jpg

    var/www/html/images/*.png

    var/www/html/images/*.gif

    Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

    var/www/html/images/

", "Certificate$supportCode": "

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

", "ContactMethod$supportCode": "

The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.

", @@ -4605,8 +4715,8 @@ "ContainerServiceLogEvent$message": "

The message of the container service log event.

", "ContainerServiceMetadataEntry$key": null, "ContainerServiceMetadataEntry$value": null, - "ContainerServicePower$powerId": "

The ID of the power (e.g., nano-1).

", - "ContainerServicePower$name": "

The friendly name of the power (e.g., nano).

", + "ContainerServicePower$powerId": "

The ID of the power (nano-1).

", + "ContainerServicePower$name": "

The friendly name of the power (nano).

", "ContainerServicePublicDomains$key": null, "ContainerServicePublicDomainsList$member": null, "ContainerServiceRegistryLogin$username": "

The container service registry username to use to push container images to the container image registry of a Lightsail account.

", @@ -4625,7 +4735,7 @@ "CreateInstancesFromSnapshotRequest$restoreDate": "

The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

  • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

", "CreateInstancesRequest$availabilityZone": "

The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

", "CreateInstancesRequest$userData": "

A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

", - "CreateLoadBalancerRequest$healthCheckPath": "

The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., \"/\").

You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

", + "CreateLoadBalancerRequest$healthCheckPath": "

The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (\"/\").

You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

", "CreateLoadBalancerRequest$tlsPolicyName": "

The name of the TLS policy to apply to the load balancer.

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

", "CreateRelationalDatabaseFromSnapshotRequest$availabilityZone": "

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

", "CreateRelationalDatabaseFromSnapshotRequest$relationalDatabaseBundleId": "

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.

", @@ -4640,7 +4750,7 @@ "DeleteKeyPairRequest$expectedFingerprint": "

The RSA fingerprint of the Lightsail default key pair to delete.

The expectedFingerprint parameter is required only when specifying to delete a Lightsail default key pair.

", "Disk$supportCode": "

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

", "Disk$path": "

The disk path.

", - "Disk$attachmentState": "

(Deprecated) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

", + "Disk$attachmentState": "

(Discontinued) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now discontinued, but still included in the response. Use isAttached instead.

", "DiskInfo$name": "

The disk name.

", "DiskSnapshot$supportCode": "

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

", "DiskSnapshot$progress": "

The progress of the snapshot.

", @@ -4648,7 +4758,7 @@ "DistributionBundle$name": "

The name of the distribution bundle.

", "DnsRecordCreationState$message": "

The message that describes the reason for the status code.

", "Domain$supportCode": "

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

", - "DomainEntry$target": "

The target IP address (e.g., 192.0.2.0), or AWS name server (e.g., ns-111.awsdns-22.com.).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.

", + "DomainEntry$target": "

The target IP address (192.0.2.0), or AWS name server (ns-111.awsdns-22.com.).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.

", "DomainEntryOptions$value": null, "EndpointRequest$containerName": "

The name of the container for the endpoint.

", "Environment$key": null, @@ -4693,7 +4803,7 @@ "GetLoadBalancersRequest$pageToken": "

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetLoadBalancers request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

", "GetLoadBalancersResult$nextPageToken": "

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetLoadBalancers request and specify the next page token using the pageToken parameter.

", "GetOperationsForResourceRequest$pageToken": "

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetOperationsForResource request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

", - "GetOperationsForResourceResult$nextPageCount": "

(Deprecated) Returns the number of pages of results that remain.

In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated, and the API returns the next page token parameter instead.

", + "GetOperationsForResourceResult$nextPageCount": "

(Discontinued) Returns the number of pages of results that remain.

In releases prior to June 12, 2017, this parameter returned null by the API. It is now discontinued, and the API returns the next page token parameter instead.

", "GetOperationsForResourceResult$nextPageToken": "

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetOperationsForResource request and specify the next page token using the pageToken parameter.

", "GetOperationsRequest$pageToken": "

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetOperations request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

", "GetOperationsResult$nextPageToken": "

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetOperations request and specify the next page token using the pageToken parameter.

", @@ -4720,9 +4830,9 @@ "HostKeyAttributes$fingerprintSHA1": "

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

  • Example of an SHA-1 SSH fingerprint:

    SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0

  • Example of an SHA-1 RDP fingerprint:

    af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45

", "HostKeyAttributes$fingerprintSHA256": "

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

  • Example of an SHA-256 SSH fingerprint:

    SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o

  • Example of an SHA-256 RDP fingerprint:

    03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68

", "Instance$supportCode": "

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

", - "InstanceAccessDetails$certKey": "

For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.

", + "InstanceAccessDetails$certKey": "

For SSH access, the public key to use when accessing your instance For OpenSSH clients (command line SSH), you should save this value to tempkey-cert.pub.

", "InstanceAccessDetails$password": "

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you create an instance using any key pair other than the default (LightsailDefaultKeyPair), password will always be an empty string.

If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

", - "InstanceAccessDetails$privateKey": "

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).

", + "InstanceAccessDetails$privateKey": "

For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this value to tempkey).

", "InstanceAccessDetails$username": "

The user name to use when logging in to the Amazon Lightsail instance.

", "InstanceEntry$userData": "

A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg.

", "InstanceEntry$availabilityZone": "

The Availability Zone for the new Amazon EC2 instance.

", @@ -4730,9 +4840,9 @@ "InstancePortInfo$commonName": "

The common name of the port information.

", "InstanceSnapshot$supportCode": "

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

", "InstanceSnapshot$progress": "

The progress of the snapshot.

This is populated only for disk snapshots, and is null for instance snapshots.

", - "InstanceSnapshot$fromBlueprintId": "

The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.

", - "InstanceSnapshot$fromBundleId": "

The bundle ID from which you created the snapshot (e.g., micro_1_0).

", - "InstanceState$name": "

The state of the instance (e.g., running or pending).

", + "InstanceSnapshot$fromBlueprintId": "

The blueprint ID from which you created the snapshot (os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.

", + "InstanceSnapshot$fromBundleId": "

The bundle ID from which you created the snapshot (micro_1_0).

", + "InstanceState$name": "

The state of the instance (running or pending).

", "InvalidInputException$code": null, "InvalidInputException$docs": null, "InvalidInputException$message": null, @@ -4754,7 +4864,7 @@ "NotFoundException$docs": null, "NotFoundException$message": null, "NotFoundException$tip": null, - "Operation$operationDetails": "

Details about the operation (e.g., Debian-1GB-Ohio-1).

", + "Operation$operationDetails": "

Details about the operation (Debian-1GB-Ohio-1).

", "Operation$errorCode": "

The error code.

", "Operation$errorDetails": "

The error details.

", "OperationFailureException$code": null, @@ -4766,9 +4876,9 @@ "PendingModifiedRelationalDatabaseValues$engineVersion": "

The database engine version.

", "PortMap$key": null, "R53HostedZoneDeletionState$message": "

The message that describes the reason for the status code.

", - "Region$continentCode": "

The continent code (e.g., NA, meaning North America).

", - "Region$description": "

The description of the Amazon Web Services Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).

", - "Region$displayName": "

The display name (e.g., Ohio).

", + "Region$continentCode": "

The continent code (NA, meaning North America).

", + "Region$description": "

The description of the Amazon Web Services Region (This region is recommended to serve users in the eastern United States and eastern Canada).

", + "Region$displayName": "

The display name (Ohio).

", "RegisterContainerImageRequest$digest": "

The digest of the container image to be registered.

", "RelationalDatabase$supportCode": "

The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

", "RelationalDatabase$masterDatabaseName": "

The name of the master database created when the Lightsail database resource is created.

", @@ -4800,6 +4910,10 @@ "ServiceException$docs": null, "ServiceException$message": null, "ServiceException$tip": null, + "SetupExecutionDetails$command": "

The command that was executed.

", + "SetupExecutionDetails$standardError": "

The text written by the command to stderr.

", + "SetupExecutionDetails$standardOutput": "

The text written by the command to stdout.

", + "SetupExecutionDetails$version": "

The current version of the script..

", "StaticIp$supportCode": "

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

", "StopInstanceOnIdleRequest$threshold": "

The value to compare with the duration.

", "StopInstanceOnIdleRequest$duration": "

The amount of idle time in minutes after which your virtual computer will automatically stop.

", @@ -4823,7 +4937,7 @@ "GetInstanceMetricDataRequest$endTime": "

The end time of the time period.

", "GetLoadBalancerMetricDataRequest$startTime": "

The start time of the period.

", "GetLoadBalancerMetricDataRequest$endTime": "

The end time of the period.

", - "MetricDatapoint$timestamp": "

The timestamp (e.g., 1479816991.349).

" + "MetricDatapoint$timestamp": "

The timestamp (1479816991.349).

" } } } diff --git a/src/data/lightsail/2016-11-28/docs-2.json.php b/src/data/lightsail/2016-11-28/docs-2.json.php index 75bed0034e..1840ad67e9 100644 --- a/src/data/lightsail/2016-11-28/docs-2.json.php +++ b/src/data/lightsail/2016-11-28/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.

You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.

', 'operations' => [ 'AllocateStaticIp' => '

Allocates a static IP address.

', 'AttachCertificateToDistribution' => '

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.

Use the CreateCertificate action to create a certificate that you can attach to your distribution.

Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

', 'AttachDisk' => '

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.

', 'AttachInstancesToLoadBalancer' => '

Attaches one or more Lightsail instances to a load balancer.

After some time, the instances are attached to the load balancer and the health check status is available.

The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Developer Guide.

', 'AttachLoadBalancerTlsCertificate' => '

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).

Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate.

The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'AttachStaticIp' => '

Attaches a static IP address to a specific Amazon Lightsail instance.

', 'CloseInstancePublicPorts' => '

Closes ports for a specific Amazon Lightsail instance.

The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.

', 'CopySnapshot' => '

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.

When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.

', 'CreateBucket' => '

Creates an Amazon Lightsail bucket.

A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'CreateBucketAccessKey' => '

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.

', 'CreateCertificate' => '

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.

After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service.

Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

', 'CreateCloudFormationStack' => '

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created.

Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.

', 'CreateContactMethod' => '

Creates an email or SMS text message contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

', 'CreateContainerService' => '

Creates an Amazon Lightsail container service.

A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.

', 'CreateContainerServiceDeployment' => '

Creates a deployment for your Amazon Lightsail container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

', 'CreateContainerServiceRegistryLogin' => '

Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you\'re logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.

You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.

After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.

This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

', 'CreateDisk' => '

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDiskFromSnapshot' => '

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDiskSnapshot' => '

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.

You can also use this operation to create a snapshot of an instance\'s system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance\'s system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDistribution' => '

Creates an Amazon Lightsail content delivery network (CDN) distribution.

A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.

', 'CreateDomain' => '

Creates a domain resource for the specified domain (e.g., example.com).

The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDomainEntry' => '

Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateGUISessionAccessDetails' => '

Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer\'s application. The secondary URL initiates a web-based NICE DCV session to the virtual computer\'s operating session.

Use StartGUISession to open the session.

', 'CreateInstanceSnapshot' => '

Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.

The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateInstances' => '

Creates one or more Amazon Lightsail instances.

The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide.

', 'CreateInstancesFromSnapshot' => '

Creates one or more new instances from a manual or automatic snapshot of an instance.

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateKeyPair' => '

Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.

The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateLoadBalancer' => '

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.

When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.

The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateLoadBalancerTlsCertificate' => '

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateRelationalDatabase' => '

Creates a new database in Amazon Lightsail.

The create relational database operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateRelationalDatabaseFromSnapshot' => '

Creates a new database from an existing database snapshot in Amazon Lightsail.

You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.

The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateRelationalDatabaseSnapshot' => '

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.

The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteAlarm' => '

Deletes an alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

', 'DeleteAutoSnapshot' => '

Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteBucket' => '

Deletes a Amazon Lightsail bucket.

When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.

', 'DeleteBucketAccessKey' => '

Deletes an access key for the specified Amazon Lightsail bucket.

We recommend that you delete an access key if the secret access key is compromised.

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'DeleteCertificate' => '

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.

Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.

', 'DeleteContactMethod' => '

Deletes a contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

', 'DeleteContainerImage' => '

Deletes a container image that is registered to your Amazon Lightsail container service.

', 'DeleteContainerService' => '

Deletes your Amazon Lightsail container service.

', 'DeleteDisk' => '

Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).

The disk may remain in the deleting state for several minutes.

The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteDiskSnapshot' => '

Deletes the specified disk snapshot.

When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.

The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteDistribution' => '

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

', 'DeleteDomain' => '

Deletes the specified domain recordset and all of its domain records.

The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteDomainEntry' => '

Deletes a specific domain entry.

The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteInstance' => '

Deletes an Amazon Lightsail instance.

The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteInstanceSnapshot' => '

Deletes a specific snapshot of a virtual private server (or instance).

The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteKeyPair' => '

Deletes the specified key pair by removing the public key from Amazon Lightsail.

You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.

The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteKnownHostKeys' => '

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.

Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.

', 'DeleteLoadBalancer' => '

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.

The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteLoadBalancerTlsCertificate' => '

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteRelationalDatabase' => '

Deletes a database in Amazon Lightsail.

The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteRelationalDatabaseSnapshot' => '

Deletes a database snapshot in Amazon Lightsail.

The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'DetachCertificateFromDistribution' => '

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.

', 'DetachDisk' => '

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.

The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.

', 'DetachInstancesFromLoadBalancer' => '

Detaches the specified instances from a Lightsail load balancer.

This operation waits until the instances are no longer needed before they are detached from the load balancer.

The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'DetachStaticIp' => '

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

', 'DisableAddOn' => '

Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

', 'DownloadDefaultKeyPair' => '

Downloads the regional Amazon Lightsail default key pair.

This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.

', 'EnableAddOn' => '

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

', 'ExportSnapshot' => '

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.

The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Amazon Lightsail Developer Guide.

Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.

', 'GetActiveNames' => '

Returns the names of all active (not deleted) resources.

', 'GetAlarms' => '

Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

', 'GetAutoSnapshots' => '

Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

', 'GetBlueprints' => '

Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

', 'GetBucketAccessKeys' => '

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.

', 'GetBucketBundles' => '

Returns the bundles that you can apply to a Amazon Lightsail bucket.

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to update the bundle for a bucket.

', 'GetBucketMetricData' => '

Returns the data points of a specific metric for an Amazon Lightsail bucket.

Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.

', 'GetBuckets' => '

Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'GetBundles' => '

Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.

A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.

Bundles are referred to as instance plans in the Lightsail console.

', 'GetCertificates' => '

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

To get a summary of a certificate, omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

', 'GetCloudFormationStackRecords' => '

Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.

', 'GetContactMethods' => '

Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

', 'GetContainerAPIMetadata' => '

Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.

', 'GetContainerImages' => '

Returns the container images that are registered to your Amazon Lightsail container service.

If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.

', 'GetContainerLog' => '

Returns the log events of a container of your Amazon Lightsail container service.

If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.

Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.

', 'GetContainerServiceDeployments' => '

Returns the deployments for your Amazon Lightsail container service

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.

A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.

', 'GetContainerServiceMetricData' => '

Returns the data points of a specific metric of your Amazon Lightsail container service.

Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

', 'GetContainerServicePowers' => '

Returns the list of powers that can be specified for your Amazon Lightsail container services.

The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.

', 'GetContainerServices' => '

Returns information about one or more of your Amazon Lightsail container services.

', 'GetCostEstimate' => '

Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.

', 'GetDisk' => '

Returns information about a specific block storage disk.

', 'GetDiskSnapshot' => '

Returns information about a specific block storage disk snapshot.

', 'GetDiskSnapshots' => '

Returns information about all block storage disk snapshots in your AWS account and region.

', 'GetDisks' => '

Returns information about all block storage disks in your AWS account and region.

', 'GetDistributionBundles' => '

Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.

A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

', 'GetDistributionLatestCacheReset' => '

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.

', 'GetDistributionMetricData' => '

Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

', 'GetDistributions' => '

Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.

', 'GetDomain' => '

Returns information about a specific domain recordset.

', 'GetDomains' => '

Returns a list of all domains in the user\'s account.

', 'GetExportSnapshotRecords' => '

Returns all export snapshot records created as a result of the export snapshot operation.

An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the CreateCloudFormationStack action.

', 'GetInstance' => '

Returns information about a specific Amazon Lightsail instance, which is a virtual private server.

', 'GetInstanceAccessDetails' => '

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

', 'GetInstanceMetricData' => '

Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

', 'GetInstancePortStates' => '

Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

', 'GetInstanceSnapshot' => '

Returns information about a specific instance snapshot.

', 'GetInstanceSnapshots' => '

Returns all instance snapshots for the user\'s account.

', 'GetInstanceState' => '

Returns the state of a specific instance. Works on one instance at a time.

', 'GetInstances' => '

Returns information about all Amazon Lightsail virtual private servers, or instances.

', 'GetKeyPair' => '

Returns information about a specific key pair.

', 'GetKeyPairs' => '

Returns information about all key pairs in the user\'s account.

', 'GetLoadBalancer' => '

Returns information about the specified Lightsail load balancer.

', 'GetLoadBalancerMetricData' => '

Returns information about health metrics for your Lightsail load balancer.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

', 'GetLoadBalancerTlsCertificates' => '

Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.

', 'GetLoadBalancerTlsPolicies' => '

Returns a list of TLS security policies that you can apply to Lightsail load balancers.

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

', 'GetLoadBalancers' => '

Returns information about all load balancers in an account.

', 'GetOperation' => '

Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.

', 'GetOperations' => '

Returns information about all operations.

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.

', 'GetOperationsForResource' => '

Gets operations for a specific resource (e.g., an instance or a static IP).

', 'GetRegions' => '

Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.

', 'GetRelationalDatabase' => '

Returns information about a specific database in Amazon Lightsail.

', 'GetRelationalDatabaseBlueprints' => '

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

You can use a blueprint ID to create a new database that runs a specific database engine.

', 'GetRelationalDatabaseBundles' => '

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.

You can use a bundle ID to create a new database with explicit performance specifications.

', 'GetRelationalDatabaseEvents' => '

Returns a list of events for a specific database in Amazon Lightsail.

', 'GetRelationalDatabaseLogEvents' => '

Returns a list of log events for a database in Amazon Lightsail.

', 'GetRelationalDatabaseLogStreams' => '

Returns a list of available log streams for a specific database in Amazon Lightsail.

', 'GetRelationalDatabaseMasterUserPassword' => '

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

', 'GetRelationalDatabaseMetricData' => '

Returns the data points of the specified metric for a database in Amazon Lightsail.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

', 'GetRelationalDatabaseParameters' => '

Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.

In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.

', 'GetRelationalDatabaseSnapshot' => '

Returns information about a specific database snapshot in Amazon Lightsail.

', 'GetRelationalDatabaseSnapshots' => '

Returns information about all of your database snapshots in Amazon Lightsail.

', 'GetRelationalDatabases' => '

Returns information about all of your databases in Amazon Lightsail.

', 'GetStaticIp' => '

Returns information about an Amazon Lightsail static IP.

', 'GetStaticIps' => '

Returns information about all static IPs in the user\'s account.

', 'ImportKeyPair' => '

Imports a public SSH key from a specific key pair.

', 'IsVpcPeered' => '

Returns a Boolean value indicating whether your Lightsail VPC is peered.

', 'OpenInstancePublicPorts' => '

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.

The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.

', 'PeerVpc' => '

Peers the Lightsail VPC with the user\'s default VPC.

', 'PutAlarm' => '

Creates or updates an alarm, and associates it with the specified metric.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.

', 'PutInstancePublicPorts' => '

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports.

The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.

', 'RebootInstance' => '

Restarts a specific instance.

The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

', 'RebootRelationalDatabase' => '

Restarts a specific database in Amazon Lightsail.

The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'RegisterContainerImage' => '

Registers a container image to your Amazon Lightsail container service.

This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

', 'ReleaseStaticIp' => '

Deletes a specific static IP from your account.

', 'ResetDistributionCache' => '

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.

After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.

', 'SendContactMethodVerification' => '

Sends a verification request to an email contact method to ensure it\'s owned by the requester. SMS contact methods don\'t need to be verified.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.

Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.

', 'SetIpAddressType' => '

Sets the IP address type for an Amazon Lightsail resource.

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.

', 'SetResourceAccessForBucket' => '

Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.

', 'StartGUISession' => '

Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.

', 'StartInstance' => '

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

', 'StartRelationalDatabase' => '

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.

The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'StopGUISession' => '

Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.

', 'StopInstance' => '

Stops a specific Amazon Lightsail instance that is currently running.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

', 'StopRelationalDatabase' => '

Stops a specific database that is currently running in Amazon Lightsail.

The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'TagResource' => '

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide.

The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide.

', 'TestAlarm' => '

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

', 'UnpeerVpc' => '

Unpeers the Lightsail VPC from the user\'s default VPC.

', 'UntagResource' => '

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.

The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide.

', 'UpdateBucket' => '

Updates an existing Amazon Lightsail bucket.

Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.

', 'UpdateBucketBundle' => '

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket\'s bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update a bucket\'s bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket\'s bundle.

Update a bucket\'s bundle if it\'s consistently going over its storage space or data transfer quota, or if a bucket\'s usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket\'s bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.

', 'UpdateContainerService' => '

Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.

', 'UpdateDistribution' => '

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

Use this action to update the configuration of your existing distribution.

', 'UpdateDistributionBundle' => '

Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.

A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

Update your distribution\'s bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.

You can update your distribution\'s bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution\'s bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution\'s bundle.

', 'UpdateDomainEntry' => '

Updates a domain recordset after it is created.

The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

', 'UpdateInstanceMetadataOptions' => '

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance or GetInstances API operation initially responds with a state of pending. After the parameter modifications are successfully applied, the state changes to applied in subsequent GetInstance or GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.

', 'UpdateLoadBalancerAttribute' => '

Updates the specified attribute for a load balancer. You can only update one attribute at a time.

The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'UpdateRelationalDatabase' => '

Allows the update of one or more attributes of a database in Amazon Lightsail.

Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database\'s predefined maintenance window.

The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'UpdateRelationalDatabaseParameters' => '

Allows the update of one or more parameters of a database in Amazon Lightsail.

Parameter updates don\'t cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.

The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

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

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

', 'refs' => [], ], 'AccessDirection' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$accessDirection' => '

The access direction (inbound or outbound).

Lightsail currently supports only inbound access direction.

', ], ], 'AccessKey' => [ 'base' => '

Describes an access key for an Amazon Lightsail bucket.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.

', 'refs' => [ 'AccessKeyList$member' => NULL, 'CreateBucketAccessKeyResult$accessKey' => '

An object that describes the access key that is created.

', ], ], 'AccessKeyLastUsed' => [ 'base' => '

Describes the last time an access key was used.

This object does not include data in the response of a CreateBucketAccessKey action.

', 'refs' => [ 'AccessKey$lastUsed' => '

An object that describes the last time the access key was used.

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

', ], ], 'AccessKeyList' => [ 'base' => NULL, 'refs' => [ 'GetBucketAccessKeysResult$accessKeys' => '

An object that describes the access keys for the specified bucket.

', ], ], 'AccessReceiverList' => [ 'base' => NULL, 'refs' => [ 'Bucket$resourcesReceivingAccess' => '

An array of objects that describe Lightsail instances that have access to the bucket.

Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

', ], ], 'AccessRules' => [ 'base' => '

Describes the anonymous access permissions for an Amazon Lightsail bucket and its objects.

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the

Amazon Lightsail Developer Guide.

', 'refs' => [ 'Bucket$accessRules' => '

An object that describes the access rules of the bucket.

', 'UpdateBucketRequest$accessRules' => '

An object that sets the public accessibility of objects in the specified bucket.

', ], ], 'AccessType' => [ 'base' => NULL, 'refs' => [ 'AccessRules$getObject' => '

Specifies the anonymous access to all objects in a bucket.

The following options can be specified:

  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

    If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

    If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

', ], ], 'AccountLevelBpaSync' => [ 'base' => '

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access (BPA) feature for your Lightsail buckets.

The account-level BPA feature of Amazon S3 provides centralized controls to limit public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and object permissions that are configured. Lightsail buckets take into account the Amazon S3 account-level BPA configuration when allowing or denying public access. To do this, Lightsail periodically fetches the account-level BPA configuration from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'GetBucketsResult$accountLevelBpaSync' => '

An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.

For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

', ], ], 'AccountLevelBpaSyncStatus' => [ 'base' => NULL, 'refs' => [ 'AccountLevelBpaSync$status' => '

The status of the account-level BPA synchronization.

The following statuses are possible:

  • InSync - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to your Lightsail buckets.

  • NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.

  • Failed - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.

  • Defaulted - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to active.

You might need to complete further actions if the status is Failed or Defaulted. The message parameter provides more information for those statuses.

', ], ], 'AccountSetupInProgressException' => [ 'base' => '

Lightsail throws this exception when an account is still in the setup in progress state.

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

Describes an add-on that is enabled for an Amazon Lightsail resource.

', 'refs' => [ 'AddOnList$member' => NULL, ], ], 'AddOnList' => [ 'base' => NULL, 'refs' => [ 'Disk$addOns' => '

An array of objects representing the add-ons enabled on the disk.

', 'Instance$addOns' => '

An array of objects representing the add-ons enabled on the instance.

', ], ], 'AddOnRequest' => [ 'base' => '

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page.

', 'refs' => [ 'AddOnRequestList$member' => NULL, 'EnableAddOnRequest$addOnRequest' => '

An array of strings representing the add-on to enable or modify.

', ], ], 'AddOnRequestList' => [ 'base' => NULL, 'refs' => [ 'CreateDiskFromSnapshotRequest$addOns' => '

An array of objects that represent the add-ons to enable for the new disk.

', 'CreateDiskRequest$addOns' => '

An array of objects that represent the add-ons to enable for the new disk.

', 'CreateInstancesFromSnapshotRequest$addOns' => '

An array of objects representing the add-ons to enable for the new instance.

', 'CreateInstancesRequest$addOns' => '

An array of objects representing the add-ons to enable for the new instance.

', ], ], 'AddOnType' => [ 'base' => NULL, 'refs' => [ 'AddOnRequest$addOnType' => '

The add-on type.

', 'DisableAddOnRequest$addOnType' => '

The add-on type to disable.

', ], ], 'Alarm' => [ 'base' => '

Describes an alarm.

An alarm is a way to monitor your Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.

', 'refs' => [ 'AlarmsList$member' => NULL, ], ], 'AlarmState' => [ 'base' => NULL, 'refs' => [ 'Alarm$state' => '

The current state of the alarm.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

', 'NotificationTriggerList$member' => NULL, 'TestAlarmRequest$state' => '

The alarm state to test.

An alarm has the following possible states that can be tested:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

', ], ], 'AlarmsList' => [ 'base' => NULL, 'refs' => [ 'GetAlarmsResult$alarms' => '

An array of objects that describe the alarms.

', ], ], 'AllocateStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocateStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'AppCategory' => [ 'base' => NULL, 'refs' => [ 'AppCategoryList$member' => NULL, 'Blueprint$appCategory' => '

Virtual computer blueprints that are supported by Lightsail for Research.

This parameter only applies to Lightsail for Research resources.

', 'GetBlueprintsRequest$appCategory' => '

Returns a list of blueprints that are specific to Lightsail for Research.

You must use this parameter to view Lightsail for Research blueprints.

', 'GetBundlesRequest$appCategory' => '

Returns a list of bundles that are specific to Lightsail for Research.

You must use this parameter to view Lightsail for Research bundles.

', ], ], 'AppCategoryList' => [ 'base' => NULL, 'refs' => [ 'Bundle$supportedAppCategories' => '

Virtual computer blueprints that are supported by a Lightsail for Research bundle.

This parameter only applies to Lightsail for Research resources.

', ], ], 'AttachCertificateToDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachCertificateToDistributionResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachInstancesToLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachInstancesToLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTlsCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTlsCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachedDisk' => [ 'base' => '

Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot.

', 'refs' => [ 'AttachedDiskList$member' => NULL, ], ], 'AttachedDiskList' => [ 'base' => NULL, 'refs' => [ 'AutoSnapshotDetails$fromAttachedDisks' => '

An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created.

', ], ], 'AttachedDiskMap' => [ 'base' => NULL, 'refs' => [ 'CreateInstancesFromSnapshotRequest$attachedDiskMapping' => '

An object containing information about one or more disk mappings.

', ], ], 'AutoMountStatus' => [ 'base' => NULL, 'refs' => [ 'Disk$autoMountStatus' => '

The status of automatically mounting a storage disk to a virtual computer.

This parameter only applies to Lightsail for Research resources.

', ], ], 'AutoSnapshotAddOnRequest' => [ 'base' => '

Describes a request to enable or modify the automatic snapshot add-on for an Amazon Lightsail instance or disk.

When you modify the automatic snapshot time for a resource, it is typically effective immediately except under the following conditions:

  • If an automatic snapshot has been created for the current day, and you change the snapshot time to a later time of day, then the new snapshot time will be effective the following day. This ensures that two snapshots are not created for the current day.

  • If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to an earlier time of day, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day.

  • If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to a time that is within 30 minutes from your current time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.

  • If an automatic snapshot is scheduled to be created within 30 minutes from your current time and you change the snapshot time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.

', 'refs' => [ 'AddOnRequest$autoSnapshotAddOnRequest' => '

An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.

', ], ], 'AutoSnapshotDate' => [ 'base' => NULL, 'refs' => [ 'DeleteAutoSnapshotRequest$date' => '

The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the get auto snapshots operation to get the available automatic snapshots for a resource.

', ], ], 'AutoSnapshotDetails' => [ 'base' => '

Describes an automatic snapshot.

', 'refs' => [ 'AutoSnapshotDetailsList$member' => NULL, ], ], 'AutoSnapshotDetailsList' => [ 'base' => NULL, 'refs' => [ 'GetAutoSnapshotsResult$autoSnapshots' => '

An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.

', ], ], 'AutoSnapshotStatus' => [ 'base' => NULL, 'refs' => [ 'AutoSnapshotDetails$status' => '

The status of the automatic snapshot.

', ], ], 'AvailabilityZone' => [ 'base' => '

Describes an Availability Zone. This is returned only as part of a GetRegions request.

', 'refs' => [ 'AvailabilityZoneList$member' => NULL, ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'Region$availabilityZones' => '

The Availability Zones. Follows the format us-east-2a (case-sensitive).

', 'Region$relationalDatabaseAvailabilityZones' => '

The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).

', ], ], 'BPAStatusMessage' => [ 'base' => NULL, 'refs' => [ 'AccountLevelBpaSync$message' => '

A message that provides a reason for a Failed or Defaulted synchronization status.

The following messages are possible:

  • SYNC_ON_HOLD - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.

  • DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to active until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.

  • DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.

  • Unknown - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.

', ], ], 'Base64' => [ 'base' => NULL, 'refs' => [ 'CreateKeyPairResult$publicKeyBase64' => '

A base64-encoded public key of the ssh-rsa type.

', 'CreateKeyPairResult$privateKeyBase64' => '

A base64-encoded RSA private key.

', 'DownloadDefaultKeyPairResult$publicKeyBase64' => '

A base64-encoded public key of the ssh-rsa type.

', 'DownloadDefaultKeyPairResult$privateKeyBase64' => '

A base64-encoded RSA private key.

', 'ImportKeyPairRequest$publicKeyBase64' => '

A base64-encoded public key of the ssh-rsa type.

', 'KeyPair$fingerprint' => '

The RSA fingerprint of the key pair.

', ], ], 'BehaviorEnum' => [ 'base' => NULL, 'refs' => [ 'CacheBehavior$behavior' => '

The cache behavior of the distribution.

The following cache behaviors can be specified:

  • cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn\'t change depending on who views it, or for websites that don\'t use cookies, headers, or query strings to personalize content.

  • dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution\'s CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.

', 'CacheBehaviorPerPath$behavior' => '

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

  • cache - This behavior caches the specified path.

  • dont-cache - This behavior doesn\'t cache the specified path.

', ], ], 'Blueprint' => [ 'base' => '

Describes a blueprint (a virtual private server image).

', 'refs' => [ 'BlueprintList$member' => NULL, ], ], 'BlueprintList' => [ 'base' => NULL, 'refs' => [ 'GetBlueprintsResult$blueprints' => '

An array of key-value pairs that contains information about the available blueprints.

', ], ], 'BlueprintType' => [ 'base' => NULL, 'refs' => [ 'Blueprint$type' => '

The type of the blueprint (e.g., os or app).

', ], ], 'Bucket' => [ 'base' => '

Describes an Amazon Lightsail bucket.

', 'refs' => [ 'BucketList$member' => NULL, 'CreateBucketResult$bucket' => '

An object that describes the bucket that is created.

', 'UpdateBucketResult$bucket' => '

An object that describes the bucket that is updated.

', ], ], 'BucketAccessLogConfig' => [ 'base' => '

Describes the access log configuration for a bucket in the Amazon Lightsail object storage service.

For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'Bucket$accessLogConfig' => '

An object that describes the access log configuration for the bucket.

', 'UpdateBucketRequest$accessLogConfig' => '

An object that describes the access log configuration for the bucket.

', ], ], 'BucketAccessLogPrefix' => [ 'base' => NULL, 'refs' => [ 'BucketAccessLogConfig$prefix' => '

The optional object prefix for the bucket access log.

The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a logs/ prefix, then each log object will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).

This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.

', ], ], 'BucketBundle' => [ 'base' => '

Describes the specifications of a bundle that can be applied to an Amazon Lightsail bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

', 'refs' => [ 'BucketBundleList$member' => NULL, ], ], 'BucketBundleList' => [ 'base' => NULL, 'refs' => [ 'GetBucketBundlesResult$bundles' => '

An object that describes bucket bundles.

', ], ], 'BucketList' => [ 'base' => NULL, 'refs' => [ 'GetBucketsResult$buckets' => '

An array of objects that describe buckets.

', ], ], 'BucketMetricName' => [ 'base' => NULL, 'refs' => [ 'GetBucketMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

These bucket metrics are reported once per day.

  • BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Maximum.

    Unit: The published unit is Bytes.

  • NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Count.

', 'GetBucketMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'Bucket$name' => '

The name of the bucket.

', 'BucketAccessLogConfig$destination' => '

The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.

This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.

', 'CreateBucketAccessKeyRequest$bucketName' => '

The name of the bucket that the new access key will belong to, and grant access to.

', 'CreateBucketRequest$bucketName' => '

The name for the bucket.

For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'DeleteBucketAccessKeyRequest$bucketName' => '

The name of the bucket that the access key belongs to.

', 'DeleteBucketRequest$bucketName' => '

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

', 'GetBucketAccessKeysRequest$bucketName' => '

The name of the bucket for which to return access keys.

', 'GetBucketMetricDataRequest$bucketName' => '

The name of the bucket for which to get metric data.

', 'GetBucketsRequest$bucketName' => '

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the Amazon Web Services Region where the request is made.

', 'SetResourceAccessForBucketRequest$bucketName' => '

The name of the bucket for which to set access to another Lightsail resource.

', 'UpdateBucketBundleRequest$bucketName' => '

The name of the bucket for which to update the bundle.

', 'UpdateBucketRequest$bucketName' => '

The name of the bucket to update.

', ], ], 'BucketState' => [ 'base' => '

Describes the state of an Amazon Lightsail bucket.

', 'refs' => [ 'Bucket$state' => '

An object that describes the state of the bucket.

', ], ], 'Bundle' => [ 'base' => '

Describes a bundle, which is a set of specs describing your virtual private server (or instance).

', 'refs' => [ 'BundleList$member' => NULL, ], ], 'BundleList' => [ 'base' => NULL, 'refs' => [ 'GetBundlesResult$bundles' => '

An array of key-value pairs that contains information about the available bundles.

', ], ], 'CacheBehavior' => [ 'base' => '

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

', 'refs' => [ 'CreateDistributionRequest$defaultCacheBehavior' => '

An object that describes the default cache behavior for the distribution.

', 'LightsailDistribution$defaultCacheBehavior' => '

An object that describes the default cache behavior of the distribution.

', 'UpdateDistributionRequest$defaultCacheBehavior' => '

An object that describes the default cache behavior for the distribution.

', ], ], 'CacheBehaviorList' => [ 'base' => NULL, 'refs' => [ 'CreateDistributionRequest$cacheBehaviors' => '

An array of objects that describe the per-path cache behavior for the distribution.

', 'LightsailDistribution$cacheBehaviors' => '

An array of objects that describe the per-path cache behavior of the distribution.

', 'UpdateDistributionRequest$cacheBehaviors' => '

An array of objects that describe the per-path cache behavior for the distribution.

', ], ], 'CacheBehaviorPerPath' => [ 'base' => '

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution\'s cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.

', 'refs' => [ 'CacheBehaviorList$member' => NULL, ], ], 'CacheSettings' => [ 'base' => '

Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.

These settings apply only to your distribution\'s cacheBehaviors (including the defaultCacheBehavior) that have a behavior of cache.

', 'refs' => [ 'CreateDistributionRequest$cacheBehaviorSettings' => '

An object that describes the cache behavior settings for the distribution.

', 'LightsailDistribution$cacheBehaviorSettings' => '

An object that describes the cache behavior settings of the distribution.

', 'UpdateDistributionRequest$cacheBehaviorSettings' => '

An object that describes the cache behavior settings for the distribution.

The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution\'s existing settings.

', ], ], 'Certificate' => [ 'base' => '

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

To get a summary of a certificate, use the GetCertificates action and omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

', 'refs' => [ 'CertificateSummary$certificateDetail' => '

An object that describes a certificate in detail.

', ], ], 'CertificateDomainValidationStatus' => [ 'base' => NULL, 'refs' => [ 'DomainValidationRecord$validationStatus' => '

The validation status of the record.

', ], ], 'CertificateName' => [ 'base' => NULL, 'refs' => [ 'Certificate$name' => '

The name of the certificate (e.g., my-certificate).

', 'CertificateSummary$certificateName' => '

The name of the certificate.

', 'CreateCertificateRequest$certificateName' => '

The name for the certificate.

', 'DeleteCertificateRequest$certificateName' => '

The name of the certificate to delete.

Use the GetCertificates action to get a list of certificate names that you can specify.

', 'GetCertificatesRequest$certificateName' => '

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.

', ], ], 'CertificateStatus' => [ 'base' => NULL, 'refs' => [ 'Certificate$status' => '

The validation status of the certificate.

', 'CertificateStatusList$member' => NULL, ], ], 'CertificateStatusList' => [ 'base' => NULL, 'refs' => [ 'GetCertificatesRequest$certificateStatuses' => '

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.

', ], ], 'CertificateSummary' => [ 'base' => '

Describes an Amazon Lightsail SSL/TLS certificate.

', 'refs' => [ 'CertificateSummaryList$member' => NULL, 'CreateCertificateResult$certificate' => '

An object that describes the certificate created.

', ], ], 'CertificateSummaryList' => [ 'base' => NULL, 'refs' => [ 'GetCertificatesResult$certificates' => '

An object that describes certificates.

', ], ], 'CloseInstancePublicPortsRequest' => [ 'base' => NULL, 'refs' => [], ], 'CloseInstancePublicPortsResult' => [ 'base' => NULL, 'refs' => [], ], 'CloudFormationStackRecord' => [ 'base' => '

Describes a CloudFormation stack record created as a result of the create cloud formation stack action.

A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

', 'refs' => [ 'CloudFormationStackRecordList$member' => NULL, ], ], 'CloudFormationStackRecordList' => [ 'base' => NULL, 'refs' => [ 'GetCloudFormationStackRecordsResult$cloudFormationStackRecords' => '

A list of objects describing the CloudFormation stack records.

', ], ], 'CloudFormationStackRecordSourceInfo' => [ 'base' => '

Describes the source of a CloudFormation stack record (i.e., the export snapshot record).

', 'refs' => [ 'CloudFormationStackRecordSourceInfoList$member' => NULL, ], ], 'CloudFormationStackRecordSourceInfoList' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecord$sourceInfo' => '

A list of objects describing the source of the CloudFormation stack record.

', ], ], 'CloudFormationStackRecordSourceType' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecordSourceInfo$resourceType' => '

The Lightsail resource type (e.g., ExportSnapshotRecord).

', ], ], 'ComparisonOperator' => [ 'base' => NULL, 'refs' => [ 'Alarm$comparisonOperator' => '

The arithmetic operation used when comparing the specified statistic and threshold.

', 'PutAlarmRequest$comparisonOperator' => '

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

', ], ], 'ContactMethod' => [ 'base' => '

Describes a contact method.

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.

', 'refs' => [ 'ContactMethodsList$member' => NULL, ], ], 'ContactMethodStatus' => [ 'base' => NULL, 'refs' => [ 'ContactMethod$status' => '

The current status of the contact method.

A contact method has the following possible status:

  • PendingVerification - The contact method has not yet been verified, and the verification has not yet expired.

  • Valid - The contact method has been verified.

  • InValid - An attempt was made to verify the contact method, but the verification has expired.

', ], ], 'ContactMethodVerificationProtocol' => [ 'base' => NULL, 'refs' => [ 'SendContactMethodVerificationRequest$protocol' => '

The protocol to verify, such as Email or SMS (text messaging).

', ], ], 'ContactMethodsList' => [ 'base' => NULL, 'refs' => [ 'GetContactMethodsResult$contactMethods' => '

An array of objects that describe the contact methods.

', ], ], 'ContactProtocol' => [ 'base' => NULL, 'refs' => [ 'ContactMethod$protocol' => '

The protocol of the contact method, such as email or SMS (text messaging).

', 'ContactProtocolsList$member' => NULL, 'CreateContactMethodRequest$protocol' => '

The protocol of the contact method, such as Email or SMS (text messaging).

The SMS protocol is supported only in the following Amazon Web Services Regions.

  • US East (N. Virginia) (us-east-1)

  • US West (Oregon) (us-west-2)

  • Europe (Ireland) (eu-west-1)

  • Asia Pacific (Tokyo) (ap-northeast-1)

  • Asia Pacific (Singapore) (ap-southeast-1)

  • Asia Pacific (Sydney) (ap-southeast-2)

For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

', 'DeleteContactMethodRequest$protocol' => '

The protocol that will be deleted, such as Email or SMS (text messaging).

To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol.

', ], ], 'ContactProtocolsList' => [ 'base' => NULL, 'refs' => [ 'Alarm$contactProtocols' => '

The contact protocols for the alarm, such as Email, SMS (text messaging), or both.

', 'GetContactMethodsRequest$protocols' => '

The protocols used to send notifications, such as Email, or SMS (text messaging).

Specify a protocol in your request to return information about a specific contact method protocol.

', 'PutAlarmRequest$contactProtocols' => '

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the Amazon Web Services Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an Amazon Web Services Region.

', ], ], 'Container' => [ 'base' => '

Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.

', 'refs' => [ 'ContainerMap$value' => NULL, ], ], 'ContainerImage' => [ 'base' => '

Describes a container image that is registered to an Amazon Lightsail container service.

', 'refs' => [ 'ContainerImageList$member' => NULL, 'RegisterContainerImageResult$containerImage' => '

An object that describes a container image that is registered to a Lightsail container service

', ], ], 'ContainerImageList' => [ 'base' => NULL, 'refs' => [ 'GetContainerImagesResult$containerImages' => '

An array of objects that describe container images that are registered to the container service.

', ], ], 'ContainerLabel' => [ 'base' => NULL, 'refs' => [ 'RegisterContainerImageRequest$label' => '

The label for the container image when it\'s registered to the container service.

Use a descriptive label that you can use to track the different versions of your registered container images.

Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the <imagelabel> portion of the following image name example:

  • :container-service-1.<imagelabel>.1

If the name of your container service is mycontainerservice, and the label that you specify is mystaticwebsite, then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1.

The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2. If you push and register another container image, the version number will be 3, and so on.

', ], ], 'ContainerMap' => [ 'base' => NULL, 'refs' => [ 'ContainerServiceDeployment$containers' => '

An object that describes the configuration for the containers of the deployment.

', 'ContainerServiceDeploymentRequest$containers' => '

An object that describes the configuration for the containers of the deployment.

', 'CreateContainerServiceDeploymentRequest$containers' => '

An object that describes the settings of the containers that will be launched on the container service.

', ], ], 'ContainerName' => [ 'base' => NULL, 'refs' => [ 'ContainerMap$key' => NULL, ], ], 'ContainerService' => [ 'base' => '

Describes an Amazon Lightsail container service.

', 'refs' => [ 'ContainerServiceList$member' => NULL, 'CreateContainerServiceDeploymentResult$containerService' => '

An object that describes a container service.

', 'CreateContainerServiceResult$containerService' => '

An object that describes a container service.

', 'UpdateContainerServiceResult$containerService' => '

An object that describes a container service.

', ], ], 'ContainerServiceDeployment' => [ 'base' => '

Describes a container deployment configuration of an Amazon Lightsail container service.

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

', 'refs' => [ 'ContainerService$currentDeployment' => '

An object that describes the current container deployment of the container service.

', 'ContainerService$nextDeployment' => '

An object that describes the next deployment of the container service.

This value is null when there is no deployment in a pending state.

', 'ContainerServiceDeploymentList$member' => NULL, ], ], 'ContainerServiceDeploymentList' => [ 'base' => NULL, 'refs' => [ 'GetContainerServiceDeploymentsResult$deployments' => '

An array of objects that describe deployments for a container service.

', ], ], 'ContainerServiceDeploymentRequest' => [ 'base' => '

Describes a container deployment configuration of an Amazon Lightsail container service.

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

', 'refs' => [ 'CreateContainerServiceRequest$deployment' => '

An object that describes a deployment for the container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

', ], ], 'ContainerServiceDeploymentState' => [ 'base' => NULL, 'refs' => [ 'ContainerServiceDeployment$state' => '

The state of the deployment.

A deployment can be in one of the following states:

  • Activating - The deployment is being created.

  • Active - The deployment was successfully created, and it\'s currently running on the container service. The container service can have only one deployment in an active state at a time.

  • Inactive - The deployment was previously successfully created, but it is not currently running on the container service.

  • Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.

', ], ], 'ContainerServiceECRImagePullerRole' => [ 'base' => '

Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'PrivateRegistryAccess$ecrImagePullerRole' => '

An object that describes the activation status of the role that you can use to grant a Lightsail container service access to Amazon ECR private repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also listed.

', ], ], 'ContainerServiceECRImagePullerRoleRequest' => [ 'base' => '

Describes a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'PrivateRegistryAccessRequest$ecrImagePullerRole' => '

An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

', ], ], 'ContainerServiceEndpoint' => [ 'base' => '

Describes the public endpoint configuration of a deployment of an Amazon Lightsail container service.

', 'refs' => [ 'ContainerServiceDeployment$publicEndpoint' => '

An object that describes the endpoint of the deployment.

', ], ], 'ContainerServiceHealthCheckConfig' => [ 'base' => '

Describes the health check configuration of an Amazon Lightsail container service.

', 'refs' => [ 'ContainerServiceEndpoint$healthCheck' => '

An object that describes the health check configuration of the container.

', 'EndpointRequest$healthCheck' => '

An object that describes the health check configuration of the container.

', ], ], 'ContainerServiceList' => [ 'base' => NULL, 'refs' => [ 'ContainerServicesListResult$containerServices' => '

An array of objects that describe one or more container services.

', ], ], 'ContainerServiceLogEvent' => [ 'base' => '

Describes the log events of a container of an Amazon Lightsail container service.

', 'refs' => [ 'ContainerServiceLogEventList$member' => NULL, ], ], 'ContainerServiceLogEventList' => [ 'base' => NULL, 'refs' => [ 'GetContainerLogResult$logEvents' => '

An array of objects that describe the log events of a container.

', ], ], 'ContainerServiceMetadataEntry' => [ 'base' => NULL, 'refs' => [ 'ContainerServiceMetadataEntryList$member' => NULL, ], ], 'ContainerServiceMetadataEntryList' => [ 'base' => NULL, 'refs' => [ 'GetContainerAPIMetadataResult$metadata' => '

Metadata about Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.

', ], ], 'ContainerServiceMetricName' => [ 'base' => NULL, 'refs' => [ 'GetContainerServiceMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

  • MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

', 'GetContainerServiceMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'ContainerServiceName' => [ 'base' => NULL, 'refs' => [ 'ContainerService$containerServiceName' => '

The name of the container service.

', 'CreateContainerServiceDeploymentRequest$serviceName' => '

The name of the container service for which to create the deployment.

', 'CreateContainerServiceRequest$serviceName' => '

The name for the container service.

The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it\'s located in the US East (Ohio) Amazon Web Services Region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com

The following are the requirements for container service names:

  • Must be unique within each Amazon Web Services Region in your Lightsail account.

  • Must contain 1 to 63 characters.

  • Must contain only alphanumeric characters and hyphens.

  • A hyphen (-) can separate words but cannot be at the start or end of the name.

', 'DeleteContainerImageRequest$serviceName' => '

The name of the container service for which to delete a registered container image.

', 'DeleteContainerServiceRequest$serviceName' => '

The name of the container service to delete.

', 'GetContainerImagesRequest$serviceName' => '

The name of the container service for which to return registered container images.

', 'GetContainerLogRequest$serviceName' => '

The name of the container service for which to get a container log.

', 'GetContainerServiceDeploymentsRequest$serviceName' => '

The name of the container service for which to return deployments.

', 'GetContainerServiceMetricDataRequest$serviceName' => '

The name of the container service for which to get metric data.

', 'GetContainerServicesRequest$serviceName' => '

The name of the container service for which to return information.

When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.

', 'RegisterContainerImageRequest$serviceName' => '

The name of the container service for which to register a container image.

', 'UpdateContainerServiceRequest$serviceName' => '

The name of the container service to update.

', ], ], 'ContainerServicePower' => [ 'base' => '

Describes the powers that can be specified for an Amazon Lightsail container service.

The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

', 'refs' => [ 'ContainerServicePowerList$member' => NULL, ], ], 'ContainerServicePowerList' => [ 'base' => NULL, 'refs' => [ 'GetContainerServicePowersResult$powers' => '

An array of objects that describe the powers that can be specified for a container service.

', ], ], 'ContainerServicePowerName' => [ 'base' => NULL, 'refs' => [ 'ContainerService$power' => '

The power specification of the container service.

The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

', 'CreateContainerServiceRequest$power' => '

The power specification for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

', 'UpdateContainerServiceRequest$power' => '

The power for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to view the specifications of each power option.

', ], ], 'ContainerServiceProtocol' => [ 'base' => NULL, 'refs' => [ 'PortMap$value' => NULL, ], ], 'ContainerServicePublicDomains' => [ 'base' => NULL, 'refs' => [ 'ContainerService$publicDomainNames' => '

The public domain name of the container service, such as example.com and www.example.com.

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

If you don\'t specify public domain names, then you can use the default domain of the container service.

You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service.

', 'CreateContainerServiceRequest$publicDomainNames' => '

The public domain names to use with the container service, such as example.com and www.example.com.

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

If you don\'t specify public domain names, then you can use the default domain of the container service.

You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

You can specify public domain names using a string to array map as shown in the example later on this page.

', 'UpdateContainerServiceRequest$publicDomainNames' => '

The public domain names to use with the container service, such as example.com and www.example.com.

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

If you don\'t specify public domain names, then you can use the default domain of the container service.

You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

You can specify public domain names using a string to array map as shown in the example later on this page.

', ], ], 'ContainerServicePublicDomainsList' => [ 'base' => NULL, 'refs' => [ 'ContainerServicePublicDomains$value' => NULL, ], ], 'ContainerServiceRegistryLogin' => [ 'base' => '

Describes the sign-in credentials for the container image registry of an Amazon Lightsail account.

', 'refs' => [ 'CreateContainerServiceRegistryLoginResult$registryLogin' => '

An object that describes the log in information for the container service registry of your Lightsail account.

', ], ], 'ContainerServiceScale' => [ 'base' => NULL, 'refs' => [ 'ContainerService$scale' => '

The scale specification of the container service.

The scale specifies the allocated compute nodes of the container service.

', 'CreateContainerServiceRequest$scale' => '

The scale specification for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

', 'UpdateContainerServiceRequest$scale' => '

The scale for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

', ], ], 'ContainerServiceState' => [ 'base' => NULL, 'refs' => [ 'ContainerService$state' => '

The current state of the container service.

The following container service states are possible:

  • PENDING - The container service is being created.

  • READY - The container service is running but it does not have an active container deployment.

  • DEPLOYING - The container service is launching a container deployment.

  • RUNNING - The container service is running and it has an active container deployment.

  • UPDATING - The container service capacity or its custom domains are being updated.

  • DELETING - The container service is being deleted.

  • DISABLED - The container service is disabled, and its active deployment and containers, if any, are shut down.

', ], ], 'ContainerServiceStateDetail' => [ 'base' => '

Describes the current state of a container service.

', 'refs' => [ 'ContainerService$stateDetail' => '

An object that describes the current state of the container service.

The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

', ], ], 'ContainerServiceStateDetailCode' => [ 'base' => NULL, 'refs' => [ 'ContainerServiceStateDetail$code' => '

The state code of the container service.

The following state codes are possible:

  • The following state codes are possible if your container service is in a DEPLOYING or UPDATING state:

    • CREATING_SYSTEM_RESOURCES - The system resources for your container service are being created.

    • CREATING_NETWORK_INFRASTRUCTURE - The network infrastructure for your container service are being created.

    • PROVISIONING_CERTIFICATE - The SSL/TLS certificate for your container service is being created.

    • PROVISIONING_SERVICE - Your container service is being provisioned.

    • CREATING_DEPLOYMENT - Your deployment is being created on your container service.

    • EVALUATING_HEALTH_CHECK - The health of your deployment is being evaluated.

    • ACTIVATING_DEPLOYMENT - Your deployment is being activated.

  • The following state codes are possible if your container service is in a PENDING state:

    • CERTIFICATE_LIMIT_EXCEEDED - The SSL/TLS certificate required for your container service exceeds the maximum number of certificates allowed for your account.

    • UNKNOWN_ERROR - An error was experienced when your container service was being created.

', ], ], 'ContainerServicesListResult' => [ 'base' => NULL, 'refs' => [], ], 'CookieObject' => [ 'base' => '

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.

For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.

', 'refs' => [ 'CacheSettings$forwardedCookies' => '

An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.

', ], ], 'CopySnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CopySnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CostEstimate' => [ 'base' => '

Describes the estimated cost for resources in your Lightsail for Research account.

', 'refs' => [ 'CostEstimates$member' => NULL, ], ], 'CostEstimates' => [ 'base' => NULL, 'refs' => [ 'ResourceBudgetEstimate$costEstimates' => '

The cost estimate for the specified budget.

', ], ], 'CreateBucketAccessKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBucketAccessKeyResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBucketResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateCloudFormationStackRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCloudFormationStackResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateContactMethodRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContactMethodResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceDeploymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceDeploymentResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceRegistryLoginRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceRegistryLoginResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskFromSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDistributionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainEntryRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainEntryResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateGUISessionAccessDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGUISessionAccessDetailsResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstanceSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstanceSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstancesFromSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstancesFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstancesResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateKeyPairResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateLoadBalancerTlsCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLoadBalancerTlsCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseFromSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'Currency' => [ 'base' => NULL, 'refs' => [ 'EstimateByTime$currency' => '

The currency of the estimate in USD.

', ], ], 'DeleteAlarmRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAlarmResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAutoSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAutoSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketAccessKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketAccessKeyResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactMethodRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactMethodResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContainerImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContainerImageResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContainerServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContainerServiceResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDiskSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDiskSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDistributionResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainEntryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainEntryResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKeyPairResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKnownHostKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKnownHostKeysResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoadBalancerTlsCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoadBalancerTlsCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRelationalDatabaseSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRelationalDatabaseSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DestinationInfo' => [ 'base' => '

Describes the destination of a record.

', 'refs' => [ 'CloudFormationStackRecord$destinationInfo' => '

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.

', 'ExportSnapshotRecord$destinationInfo' => '

A list of objects describing the destination of the export snapshot record.

', ], ], 'DetachCertificateFromDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachCertificateFromDistributionResult' => [ 'base' => NULL, 'refs' => [], ], 'DetachDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesFromLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesFromLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'DetachStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'DisableAddOnRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisableAddOnResult' => [ 'base' => NULL, 'refs' => [], ], 'Disk' => [ 'base' => '

Describes a block storage disk.

', 'refs' => [ 'DiskList$member' => NULL, 'GetDiskResult$disk' => '

An object containing information about the disk.

', ], ], 'DiskInfo' => [ 'base' => '

Describes a disk.

', 'refs' => [ 'DiskInfoList$member' => NULL, ], ], 'DiskInfoList' => [ 'base' => NULL, 'refs' => [ 'InstanceSnapshotInfo$fromDiskInfo' => '

A list of objects describing the disks that were attached to the source instance.

', ], ], 'DiskList' => [ 'base' => NULL, 'refs' => [ 'GetDisksResult$disks' => '

An array of objects containing information about all block storage disks.

', 'InstanceHardware$disks' => '

The disks attached to the instance.

', 'InstanceSnapshot$fromAttachedDisks' => '

An array of disk objects containing information about all block storage disks.

', ], ], 'DiskMap' => [ 'base' => '

Describes a block storage disk mapping.

', 'refs' => [ 'DiskMapList$member' => NULL, ], ], 'DiskMapList' => [ 'base' => NULL, 'refs' => [ 'AttachedDiskMap$value' => NULL, ], ], 'DiskSnapshot' => [ 'base' => '

Describes a block storage disk snapshot.

', 'refs' => [ 'DiskSnapshotList$member' => NULL, 'GetDiskSnapshotResult$diskSnapshot' => '

An object containing information about the disk snapshot.

', ], ], 'DiskSnapshotInfo' => [ 'base' => '

Describes a disk snapshot.

', 'refs' => [ 'ExportSnapshotRecordSourceInfo$diskSnapshotInfo' => '

A list of objects describing a disk snapshot.

', ], ], 'DiskSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetDiskSnapshotsResult$diskSnapshots' => '

An array of objects containing information about all block storage disk snapshots.

', ], ], 'DiskSnapshotState' => [ 'base' => NULL, 'refs' => [ 'DiskSnapshot$state' => '

The status of the disk snapshot operation.

', ], ], 'DiskState' => [ 'base' => NULL, 'refs' => [ 'Disk$state' => '

Describes the status of the disk.

', ], ], 'DistributionBundle' => [ 'base' => '

Describes the specifications of a distribution bundle.

', 'refs' => [ 'DistributionBundleList$member' => NULL, ], ], 'DistributionBundleList' => [ 'base' => NULL, 'refs' => [ 'GetDistributionBundlesResult$bundles' => '

An object that describes a distribution bundle.

', ], ], 'DistributionList' => [ 'base' => NULL, 'refs' => [ 'GetDistributionsResult$distributions' => '

An array of objects that describe your distributions.

', ], ], 'DistributionMetricName' => [ 'base' => NULL, 'refs' => [ 'GetDistributionMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • TotalErrorRate - The percentage of all viewer requests for which the response\'s HTTP status code was 4xx or 5xx.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 4xxErrorRate - The percentage of all viewer requests for which the response\'s HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 5xxErrorRate - The percentage of all viewer requests for which the response\'s HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

', 'GetDistributionMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'DnsRecordCreationState' => [ 'base' => '

Describes the creation state of the canonical name (CNAME) records that are automatically added by Amazon Lightsail to the DNS of a domain to validate domain ownership for an SSL/TLS certificate.

When you create an SSL/TLS certificate for a Lightsail resource, you must add a set of CNAME records to the DNS of the domains for the certificate to validate that you own the domains. Lightsail can automatically add the CNAME records to the DNS of the domain if the DNS zone for the domain exists within your Lightsail account. If automatic record addition fails, or if you manage the DNS of your domain using a third-party service, then you must manually add the CNAME records to the DNS of your domain. For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'DomainValidationRecord$dnsRecordCreationState' => '

An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.

', ], ], 'DnsRecordCreationStateCode' => [ 'base' => NULL, 'refs' => [ 'DnsRecordCreationState$code' => '

The status code for the automated DNS record creation.

Following are the possible values:

  • SUCCEEDED - The validation records were successfully added to the domain.

  • STARTED - The automatic DNS record creation has started.

  • FAILED - The validation records failed to be added to the domain.

', ], ], 'Domain' => [ 'base' => '

Describes a domain where you are storing recordsets.

', 'refs' => [ 'DomainList$member' => NULL, 'GetDomainResult$domain' => '

An array of key-value pairs containing information about your get domain request.

', ], ], 'DomainEntry' => [ 'base' => '

Describes a domain recordset entry.

', 'refs' => [ 'CreateDomainEntryRequest$domainEntry' => '

An array of key-value pairs containing information about the domain entry request.

', 'DeleteDomainEntryRequest$domainEntry' => '

An array of key-value pairs containing information about your domain entries.

', 'DomainEntryList$member' => NULL, 'UpdateDomainEntryRequest$domainEntry' => '

An array of key-value pairs containing information about the domain entry.

', ], ], 'DomainEntryList' => [ 'base' => NULL, 'refs' => [ 'Domain$domainEntries' => '

An array of key-value pairs containing information about the domain entries.

', ], ], 'DomainEntryOptions' => [ 'base' => NULL, 'refs' => [ 'DomainEntry$options' => '

(Deprecated) The options for the domain entry.

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

', ], ], 'DomainEntryOptionsKeys' => [ 'base' => NULL, 'refs' => [ 'DomainEntryOptions$key' => NULL, ], ], 'DomainEntryType' => [ 'base' => NULL, 'refs' => [ 'DomainEntry$type' => '

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:

  • A

  • AAAA

  • CNAME

  • MX

  • NS

  • SOA

  • SRV

  • TXT

', ], ], 'DomainList' => [ 'base' => NULL, 'refs' => [ 'GetDomainsResult$domains' => '

An array of key-value pairs containing information about each of the domain entries in the user\'s account.

', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'Certificate$domainName' => '

The domain name of the certificate.

', 'CertificateSummary$domainName' => '

The domain name of the certificate.

', 'CreateCertificateRequest$domainName' => '

The domain name (e.g., example.com) for the certificate.

', 'CreateDomainEntryRequest$domainName' => '

The domain name (e.g., example.com) for which you want to create the domain entry.

', 'CreateDomainRequest$domainName' => '

The domain name to manage (e.g., example.com).

', 'CreateLoadBalancerRequest$certificateDomainName' => '

The domain name with which your certificate is associated (e.g., example.com).

If you specify certificateDomainName, then certificateName is required (and vice-versa).

', 'CreateLoadBalancerTlsCertificateRequest$certificateDomainName' => '

The domain name (e.g., example.com) for your SSL/TLS certificate.

', 'DeleteDomainEntryRequest$domainName' => '

The name of the domain entry to delete.

', 'DeleteDomainRequest$domainName' => '

The specific domain name to delete.

', 'DomainEntry$name' => '

The name of the domain.

', 'DomainNameList$member' => NULL, 'DomainValidationRecord$domainName' => '

The domain name of the certificate validation record. For example, example.com or www.example.com.

', 'GetDomainRequest$domainName' => '

The domain name for which your want to return information about.

', 'LoadBalancerTlsCertificate$domainName' => '

The domain name for your SSL/TLS certificate.

', 'LoadBalancerTlsCertificateDomainValidationOption$domainName' => '

The fully qualified domain name in the certificate request.

', 'LoadBalancerTlsCertificateDomainValidationRecord$domainName' => '

The domain name against which your SSL/TLS certificate was validated.

', 'SubjectAlternativeNameList$member' => NULL, 'UpdateDomainEntryRequest$domainName' => '

The name of the domain recordset to update.

', ], ], 'DomainNameList' => [ 'base' => NULL, 'refs' => [ 'CreateLoadBalancerRequest$certificateAlternativeNames' => '

The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com).

', 'CreateLoadBalancerTlsCertificateRequest$certificateAlternativeNames' => '

An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com).

', ], ], 'DomainValidationRecord' => [ 'base' => '

Describes the domain name system (DNS) records that you must add to the DNS of your registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate.

', 'refs' => [ 'DomainValidationRecordList$member' => NULL, ], ], 'DomainValidationRecordList' => [ 'base' => NULL, 'refs' => [ 'Certificate$domainValidationRecords' => '

An array of objects that describe the domain validation records of the certificate.

', 'RenewalSummary$domainValidationRecords' => '

An array of objects that describe the domain validation records of the certificate.

', ], ], 'DownloadDefaultKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'DownloadDefaultKeyPairResult' => [ 'base' => NULL, 'refs' => [], ], 'EligibleToRenew' => [ 'base' => NULL, 'refs' => [ 'Certificate$eligibleToRenew' => '

The renewal eligibility of the certificate.

', ], ], 'EnableAddOnRequest' => [ 'base' => NULL, 'refs' => [], ], 'EnableAddOnResult' => [ 'base' => NULL, 'refs' => [], ], 'EndpointRequest' => [ 'base' => '

Describes the settings of a public endpoint for an Amazon Lightsail container service.

', 'refs' => [ 'ContainerServiceDeploymentRequest$publicEndpoint' => '

An object that describes the endpoint of the deployment.

', 'CreateContainerServiceDeploymentRequest$publicEndpoint' => '

An object that describes the settings of the public endpoint for the container service.

', ], ], 'Environment' => [ 'base' => NULL, 'refs' => [ 'Container$environment' => '

The environment variables of the container.

', ], ], 'EstimateByTime' => [ 'base' => '

An estimate that\'s associated with a time period.

', 'refs' => [ 'EstimatesByTime$member' => NULL, ], ], 'EstimatesByTime' => [ 'base' => NULL, 'refs' => [ 'CostEstimate$resultsByTime' => '

The cost estimate result that\'s associated with a time period.

', ], ], 'ExportSnapshotRecord' => [ 'base' => '

Describes an export snapshot record.

', 'refs' => [ 'ExportSnapshotRecordList$member' => NULL, ], ], 'ExportSnapshotRecordList' => [ 'base' => NULL, 'refs' => [ 'GetExportSnapshotRecordsResult$exportSnapshotRecords' => '

A list of objects describing the export snapshot records.

', ], ], 'ExportSnapshotRecordSourceInfo' => [ 'base' => '

Describes the source of an export snapshot record.

', 'refs' => [ 'ExportSnapshotRecord$sourceInfo' => '

A list of objects describing the source of the export snapshot record.

', ], ], 'ExportSnapshotRecordSourceType' => [ 'base' => NULL, 'refs' => [ 'ExportSnapshotRecordSourceInfo$resourceType' => '

The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot).

', ], ], 'ExportSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'ExportSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'ForwardValues' => [ 'base' => NULL, 'refs' => [ 'CookieObject$option' => '

Specifies which cookies to forward to the distribution\'s origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

', 'HeaderObject$option' => '

The headers that you want your distribution to forward to your origin and base caching on.

You can configure your distribution to do one of the following:

  • all - Forward all headers to your origin.

  • none - Forward only the default headers.

  • allow-list - Forward only the headers you specify using the headersAllowList parameter.

', ], ], 'GetActiveNamesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetActiveNamesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetAlarmsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAlarmsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetAutoSnapshotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAutoSnapshotsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAccessKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAccessKeysResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketBundlesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketBundlesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBundlesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBundlesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetCertificatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCertificatesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetCloudFormationStackRecordsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCloudFormationStackRecordsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContactMethodsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContactMethodsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerAPIMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerAPIMetadataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerImagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerImagesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerLogRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerLogResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServiceDeploymentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServiceDeploymentsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServiceMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServiceMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServicePowersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServicePowersResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCostEstimateRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCostEstimateResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskSnapshotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskSnapshotsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDisksRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDisksResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionBundlesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionBundlesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionLatestCacheResetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionLatestCacheResetResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetExportSnapshotRecordsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetExportSnapshotRecordsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceAccessDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceAccessDetailsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstancePortStatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstancePortStatesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceSnapshotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceSnapshotsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceStateResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstancesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetKeyPairResult' => [ 'base' => NULL, 'refs' => [], ], 'GetKeyPairsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetKeyPairsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerTlsCertificatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerTlsCertificatesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerTlsPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerTlsPoliciesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancersResult' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationResult' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationsForResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRegionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRegionsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseBlueprintsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseBundlesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseBundlesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseEventsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseLogEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseLogEventsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseLogStreamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseLogStreamsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseMasterUserPasswordRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseMasterUserPasswordResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseParametersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseSnapshotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseSnapshotsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabasesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'GetStaticIpsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStaticIpsResult' => [ 'base' => NULL, 'refs' => [], ], 'HeaderEnum' => [ 'base' => NULL, 'refs' => [ 'HeaderForwardList$member' => NULL, ], ], 'HeaderForwardList' => [ 'base' => NULL, 'refs' => [ 'HeaderObject$headersAllowList' => '

The specific headers to forward to your distribution\'s origin.

', ], ], 'HeaderObject' => [ 'base' => '

Describes the request headers that a Lightsail distribution bases caching on.

For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value.

', 'refs' => [ 'CacheSettings$forwardedHeaders' => '

An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.

', ], ], 'HostKeyAttributes' => [ 'base' => '

Describes the public SSH host keys or the RDP certificate.

', 'refs' => [ 'HostKeysList$member' => NULL, ], ], 'HostKeysList' => [ 'base' => NULL, 'refs' => [ 'InstanceAccessDetails$hostKeys' => '

Describes the public SSH host keys or the RDP certificate.

', ], ], 'HttpEndpoint' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataOptions$httpEndpoint' => '

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

', 'UpdateInstanceMetadataOptionsRequest$httpEndpoint' => '

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

If you specify a value of disabled, you cannot access your instance metadata.

', ], ], 'HttpProtocolIpv6' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataOptions$httpProtocolIpv6' => '

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

', 'UpdateInstanceMetadataOptionsRequest$httpProtocolIpv6' => '

Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

', ], ], 'HttpTokens' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataOptions$httpTokens' => '

The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'UpdateInstanceMetadataOptionsRequest$httpTokens' => '

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

', ], ], 'IAMAccessKeyId' => [ 'base' => NULL, 'refs' => [ 'AccessKey$accessKeyId' => '

The ID of the access key.

', ], ], 'ImportKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportKeyPairResult' => [ 'base' => NULL, 'refs' => [], ], 'InUseResourceCount' => [ 'base' => NULL, 'refs' => [ 'Certificate$inUseResourceCount' => '

The number of Lightsail resources that the certificate is attached to.

', ], ], 'IncludeCertificateDetails' => [ 'base' => NULL, 'refs' => [ 'GetCertificatesRequest$includeCertificateDetails' => '

Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

', ], ], 'InputOrigin' => [ 'base' => '

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

', 'refs' => [ 'CreateDistributionRequest$origin' => '

An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

', 'UpdateDistributionRequest$origin' => '

An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

', ], ], 'Instance' => [ 'base' => '

Describes an instance (a virtual private server).

', 'refs' => [ 'GetInstanceResult$instance' => '

An array of key-value pairs containing information about the specified instance.

', 'InstanceList$member' => NULL, ], ], 'InstanceAccessDetails' => [ 'base' => '

The parameters for gaining temporary access to one of your Amazon Lightsail instances.

', 'refs' => [ 'GetInstanceAccessDetailsResult$accessDetails' => '

An array of key-value pairs containing information about a get instance access request.

', ], ], 'InstanceAccessProtocol' => [ 'base' => NULL, 'refs' => [ 'GetInstanceAccessDetailsRequest$protocol' => '

The protocol to use to connect to your instance. Defaults to ssh.

', 'InstanceAccessDetails$protocol' => '

The protocol for these Amazon Lightsail instance access details.

', ], ], 'InstanceEntry' => [ 'base' => '

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack operation.

', 'refs' => [ 'InstanceEntryList$member' => NULL, ], ], 'InstanceEntryList' => [ 'base' => NULL, 'refs' => [ 'CreateCloudFormationStackRequest$instances' => '

An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.

', ], ], 'InstanceHardware' => [ 'base' => '

Describes the hardware for the instance.

', 'refs' => [ 'Instance$hardware' => '

The size of the vCPU and the amount of RAM for the instance.

', ], ], 'InstanceHealthReason' => [ 'base' => NULL, 'refs' => [ 'InstanceHealthSummary$instanceHealthReason' => '

More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

If instanceHealth is initial, the instanceHealthReason value can be one of the following:

  • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

  • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

  • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Instance.Timeout - The health check requests timed out.

  • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

  • Lb.InternalError - The health checks failed due to an internal error.

If instanceHealth is unused, the instanceHealthReason value can be one of the following:

  • Instance.NotRegistered - The target instance is not registered with the target group.

  • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

  • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

  • Instance.InvalidState - The target is in the stopped or terminated state.

If instanceHealth is draining, the instanceHealthReason value can be one of the following:

  • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

', ], ], 'InstanceHealthState' => [ 'base' => NULL, 'refs' => [ 'InstanceHealthSummary$instanceHealth' => '

Describes the overall instance health. Valid values are below.

', ], ], 'InstanceHealthSummary' => [ 'base' => '

Describes information about the health of the instance.

', 'refs' => [ 'InstanceHealthSummaryList$member' => NULL, ], ], 'InstanceHealthSummaryList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$instanceHealthSummary' => '

An array of InstanceHealthSummary objects describing the health of the load balancer.

', ], ], 'InstanceList' => [ 'base' => NULL, 'refs' => [ 'GetInstancesResult$instances' => '

An array of key-value pairs containing information about your instances.

', ], ], 'InstanceMetadataOptions' => [ 'base' => '

The metadata options for the instance.

', 'refs' => [ 'Instance$metadataOptions' => '

The metadata options for the Amazon Lightsail instance.

', ], ], 'InstanceMetadataState' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataOptions$state' => '

The state of the metadata option changes.

The following states are possible:

  • pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.

  • applied - The metadata options have been successfully applied to the instance.

', ], ], 'InstanceMetricName' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance\'s BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

  • BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance\'s BurstCapacityPercentage metric reaches 100%.

    Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Seconds.

  • CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

  • NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Bytes.

  • NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Bytes.

  • StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • MetadataNoToken - Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn\'t use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

', 'GetInstanceMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'InstanceNetworking' => [ 'base' => '

Describes monthly data transfer rates and port information for an instance.

', 'refs' => [ 'Instance$networking' => '

Information about the public ports and monthly data transfer rates for the instance.

', ], ], 'InstancePlatform' => [ 'base' => NULL, 'refs' => [ 'Blueprint$platform' => '

The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.

', 'InstancePlatformList$member' => NULL, ], ], 'InstancePlatformList' => [ 'base' => NULL, 'refs' => [ 'Bundle$supportedPlatforms' => '

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX bundle.

', ], ], 'InstancePortInfo' => [ 'base' => '

Describes information about ports for an Amazon Lightsail instance.

', 'refs' => [ 'InstancePortInfoList$member' => NULL, ], ], 'InstancePortInfoList' => [ 'base' => NULL, 'refs' => [ 'InstanceNetworking$ports' => '

An array of key-value pairs containing information about the ports on the instance.

', ], ], 'InstancePortState' => [ 'base' => '

Describes open ports on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

', 'refs' => [ 'InstancePortStateList$member' => NULL, ], ], 'InstancePortStateList' => [ 'base' => NULL, 'refs' => [ 'GetInstancePortStatesResult$portStates' => '

An array of objects that describe the firewall port states for the specified instance.

', ], ], 'InstanceSnapshot' => [ 'base' => '

Describes an instance snapshot.

', 'refs' => [ 'GetInstanceSnapshotResult$instanceSnapshot' => '

An array of key-value pairs containing information about the results of your get instance snapshot request.

', 'InstanceSnapshotList$member' => NULL, ], ], 'InstanceSnapshotInfo' => [ 'base' => '

Describes an instance snapshot.

', 'refs' => [ 'ExportSnapshotRecordSourceInfo$instanceSnapshotInfo' => '

A list of objects describing an instance snapshot.

', ], ], 'InstanceSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetInstanceSnapshotsResult$instanceSnapshots' => '

An array of key-value pairs containing information about the results of your get instance snapshots request.

', ], ], 'InstanceSnapshotState' => [ 'base' => NULL, 'refs' => [ 'InstanceSnapshot$state' => '

The state the snapshot is in.

', ], ], 'InstanceState' => [ 'base' => '

Describes the virtual private server (or instance) status.

', 'refs' => [ 'GetInstanceStateResult$state' => '

The state of the instance.

', 'Instance$state' => '

The status code and the state (e.g., running) for the instance.

', ], ], 'InvalidInputException' => [ 'base' => '

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

', 'refs' => [], ], 'IpAddress' => [ 'base' => NULL, 'refs' => [ 'Instance$privateIpAddress' => '

The private IP address of the instance.

', 'Instance$publicIpAddress' => '

The public IP address of the instance.

', 'InstanceAccessDetails$ipAddress' => '

The public IP address of the Amazon Lightsail instance.

', 'StaticIp$ipAddress' => '

The static IP address.

', ], ], 'IpAddressType' => [ 'base' => NULL, 'refs' => [ 'CreateDistributionRequest$ipAddressType' => '

The IP address type for the distribution.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

', 'CreateInstancesFromSnapshotRequest$ipAddressType' => '

The IP address type for the instance.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

', 'CreateInstancesRequest$ipAddressType' => '

The IP address type for the instance.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

', 'CreateLoadBalancerRequest$ipAddressType' => '

The IP address type for the load balancer.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

', 'Instance$ipAddressType' => '

The IP address type of the instance.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

', 'LightsailDistribution$ipAddressType' => '

The IP address type of the distribution.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

', 'LoadBalancer$ipAddressType' => '

The IP address type of the load balancer.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

', 'SetIpAddressTypeRequest$ipAddressType' => '

The IP address type to set for the specified resource.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

', ], ], 'Ipv6Address' => [ 'base' => NULL, 'refs' => [ 'Ipv6AddressList$member' => NULL, ], ], 'Ipv6AddressList' => [ 'base' => NULL, 'refs' => [ 'Instance$ipv6Addresses' => '

The IPv6 addresses of the instance.

', ], ], 'IsVpcPeeredRequest' => [ 'base' => NULL, 'refs' => [], ], 'IsVpcPeeredResult' => [ 'base' => NULL, 'refs' => [], ], 'IsoDate' => [ 'base' => NULL, 'refs' => [ 'AccessKey$createdAt' => '

The timestamp when the access key was created.

', 'AccessKeyLastUsed$lastUsedDate' => '

The date and time when the access key was most recently used.

This value is null if the access key has not been used.

', 'AccountLevelBpaSync$lastSyncedAt' => '

The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized.

', 'Alarm$createdAt' => '

The timestamp when the alarm was created.

', 'AutoSnapshotDetails$createdAt' => '

The timestamp when the automatic snapshot was created.

', 'Bucket$createdAt' => '

The timestamp when the distribution was created.

', 'Certificate$createdAt' => '

The timestamp when the certificate was created.

', 'Certificate$issuedAt' => '

The timestamp when the certificate was issued.

', 'Certificate$notBefore' => '

The timestamp when the certificate is first valid.

', 'Certificate$notAfter' => '

The timestamp when the certificate expires.

', 'Certificate$revokedAt' => '

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

', 'CloudFormationStackRecord$createdAt' => '

The date when the CloudFormation stack record was created.

', 'ContactMethod$createdAt' => '

The timestamp when the contact method was created.

', 'ContainerImage$createdAt' => '

The timestamp when the container image was created.

', 'ContainerService$createdAt' => '

The timestamp when the container service was created.

', 'ContainerServiceDeployment$createdAt' => '

The timestamp when the deployment was created.

', 'ContainerServiceLogEvent$createdAt' => '

The timestamp when the container service log event was created.

', 'ContainerServiceRegistryLogin$expiresAt' => '

The timestamp of when the container image registry sign-in credentials expire.

The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials using the CreateContainerServiceRegistryLogin action.

', 'CreateRelationalDatabaseFromSnapshotRequest$restoreTime' => '

The date and time to restore your database from.

Constraints:

  • Must be before the latest restorable time for the database.

  • Cannot be specified if the use latest restorable time parameter is true.

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time.

', 'Disk$createdAt' => '

The date when the disk was created.

', 'DiskSnapshot$createdAt' => '

The date when the disk snapshot was created.

', 'Domain$createdAt' => '

The date when the domain recordset was created.

', 'DownloadDefaultKeyPairResult$createdAt' => '

The timestamp when the default key pair was created.

', 'ExportSnapshotRecord$createdAt' => '

The date when the export snapshot record was created.

', 'ExportSnapshotRecordSourceInfo$createdAt' => '

The date when the source instance or disk snapshot was created.

', 'GetBucketMetricDataRequest$startTime' => '

The timestamp indicating the earliest data to be returned.

', 'GetBucketMetricDataRequest$endTime' => '

The timestamp indicating the latest data to be returned.

', 'GetContainerLogRequest$startTime' => '

The start of the time interval for which to get log data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetContainerLogRequest$endTime' => '

The end of the time interval for which to get log data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetContainerServiceMetricDataRequest$startTime' => '

The start time of the time period.

', 'GetContainerServiceMetricDataRequest$endTime' => '

The end time of the time period.

', 'GetCostEstimateRequest$startTime' => '

The cost estimate start time.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetCostEstimateRequest$endTime' => '

The cost estimate end time.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetDistributionLatestCacheResetResult$createTime' => '

The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time format.

', 'GetRelationalDatabaseLogEventsRequest$startTime' => '

The start of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

', 'GetRelationalDatabaseLogEventsRequest$endTime' => '

The end of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

', 'GetRelationalDatabaseMasterUserPasswordResult$createdAt' => '

The timestamp when the specified version of the master user password was created.

', 'GetRelationalDatabaseMetricDataRequest$startTime' => '

The start of the time interval from which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

', 'GetRelationalDatabaseMetricDataRequest$endTime' => '

The end of the time interval from which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

', 'HostKeyAttributes$witnessedAt' => '

The time that the SSH host key or RDP certificate was recorded by Lightsail.

', 'HostKeyAttributes$notValidBefore' => '

The returned RDP certificate is valid after this point in time.

This value is listed only for RDP certificates.

', 'HostKeyAttributes$notValidAfter' => '

The returned RDP certificate is not valid after this point in time.

This value is listed only for RDP certificates.

', 'Instance$createdAt' => '

The timestamp when the instance was created (e.g., 1479734909.17) in Unix time format.

', 'InstanceAccessDetails$expiresAt' => '

For SSH access, the date on which the temporary keys expire.

', 'InstanceSnapshot$createdAt' => '

The timestamp when the snapshot was created (e.g., 1479907467.024).

', 'KeyPair$createdAt' => '

The timestamp when the key pair was created (e.g., 1479816991.349).

', 'LightsailDistribution$createdAt' => '

The timestamp when the distribution was created.

', 'LoadBalancer$createdAt' => '

The date when your load balancer was created.

', 'LoadBalancerTlsCertificate$createdAt' => '

The time when you created your SSL/TLS certificate.

', 'LoadBalancerTlsCertificate$issuedAt' => '

The time when the SSL/TLS certificate was issued.

', 'LoadBalancerTlsCertificate$notAfter' => '

The timestamp when the SSL/TLS certificate expires.

', 'LoadBalancerTlsCertificate$notBefore' => '

The timestamp when the SSL/TLS certificate is first valid.

', 'LoadBalancerTlsCertificate$revokedAt' => '

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

', 'LogEvent$createdAt' => '

The timestamp when the database log event was created.

', 'Operation$createdAt' => '

The timestamp when the operation was initialized (e.g., 1479816991.349).

', 'Operation$statusChangedAt' => '

The timestamp when the status was changed (e.g., 1479816991.349).

', 'PendingMaintenanceAction$currentApplyDate' => '

The effective date of the pending database maintenance action.

', 'RelationalDatabase$createdAt' => '

The timestamp when the database was created. Formatted in Unix time.

', 'RelationalDatabase$latestRestorableTime' => '

The latest point in time to which the database can be restored. Formatted in Unix time.

', 'RelationalDatabaseEvent$createdAt' => '

The timestamp when the database event was created.

', 'RelationalDatabaseSnapshot$createdAt' => '

The timestamp when the database snapshot was created.

', 'RenewalSummary$updatedAt' => '

The timestamp when the certificate was last updated.

', 'ResetDistributionCacheResult$createTime' => '

The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time format.

', 'ResourceBudgetEstimate$startTime' => '

The estimate start time.

', 'ResourceBudgetEstimate$endTime' => '

The estimate end time.

', 'StaticIp$createdAt' => '

The timestamp when the static IP was created (e.g., 1479735304.222).

', 'TimePeriod$start' => '

The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Lightsail for Research retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

', 'TimePeriod$end' => '

The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

', ], ], 'IssuerCA' => [ 'base' => NULL, 'refs' => [ 'Certificate$issuerCA' => '

The certificate authority that issued the certificate.

', ], ], 'KeyAlgorithm' => [ 'base' => NULL, 'refs' => [ 'Certificate$keyAlgorithm' => '

The algorithm used to generate the key pair (the public and private key) of the certificate.

', ], ], 'KeyPair' => [ 'base' => '

Describes an SSH key pair.

', 'refs' => [ 'CreateKeyPairResult$keyPair' => '

An array of key-value pairs containing information about the new key pair you just created.

', 'GetKeyPairResult$keyPair' => '

An array of key-value pairs containing information about the key pair.

', 'KeyPairList$member' => NULL, ], ], 'KeyPairList' => [ 'base' => NULL, 'refs' => [ 'GetKeyPairsResult$keyPairs' => '

An array of key-value pairs containing information about the key pairs.

', ], ], 'LightsailDistribution' => [ 'base' => '

Describes an Amazon Lightsail content delivery network (CDN) distribution.

', 'refs' => [ 'CreateDistributionResult$distribution' => '

An object that describes the distribution created.

', 'DistributionList$member' => NULL, ], ], 'LoadBalancer' => [ 'base' => '

Describes a load balancer.

', 'refs' => [ 'GetLoadBalancerResult$loadBalancer' => '

An object containing information about your load balancer.

', 'LoadBalancerList$member' => NULL, ], ], 'LoadBalancerAttributeName' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerConfigurationOptions$key' => NULL, 'UpdateLoadBalancerAttributeRequest$attributeName' => '

The name of the attribute you want to update.

', ], ], 'LoadBalancerConfigurationOptions' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$configurationOptions' => '

A string to string map of the configuration options for your load balancer. Valid values are listed below.

', ], ], 'LoadBalancerList' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancersResult$loadBalancers' => '

An array of LoadBalancer objects describing your load balancers.

', ], ], 'LoadBalancerMetricName' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancerMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

  • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Seconds.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • UnhealthyHostCount - The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

', 'GetLoadBalancerMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'LoadBalancerProtocol' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$protocol' => '

The protocol you have enabled for your load balancer. Valid values are below.

You can\'t just have HTTP_HTTPS, but you can have just HTTP.

', ], ], 'LoadBalancerState' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$state' => '

The status of your load balancer. Valid values are below.

', ], ], 'LoadBalancerTlsCertificate' => [ 'base' => '

Describes a load balancer SSL/TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

', 'refs' => [ 'LoadBalancerTlsCertificateList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDnsRecordCreationState' => [ 'base' => '

An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.

', 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationRecord$dnsRecordCreationState' => '

An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of a domain to validate domain ownership.

', ], ], 'LoadBalancerTlsCertificateDnsRecordCreationStateCode' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateDnsRecordCreationState$code' => '

The status code for the automated DNS record creation.

Following are the possible values:

  • SUCCEEDED - The validation records were successfully added.

  • STARTED - The automatic DNS record creation has started.

  • FAILED - The validation record addition failed.

', ], ], 'LoadBalancerTlsCertificateDomainStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationOption$validationStatus' => '

The status of the domain validation. Valid values are listed below.

', 'LoadBalancerTlsCertificateDomainValidationRecord$validationStatus' => '

The validation status. Valid values are listed below.

', ], ], 'LoadBalancerTlsCertificateDomainValidationOption' => [ 'base' => '

Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.

', 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationOptionList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDomainValidationOptionList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateRenewalSummary$domainValidationOptions' => '

Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail\'s managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.

', ], ], 'LoadBalancerTlsCertificateDomainValidationRecord' => [ 'base' => '

Describes the validation record of each domain name in the SSL/TLS certificate.

', 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationRecordList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDomainValidationRecordList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$domainValidationRecords' => '

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

', ], ], 'LoadBalancerTlsCertificateFailureReason' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$failureReason' => '

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

', ], ], 'LoadBalancerTlsCertificateList' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancerTlsCertificatesResult$tlsCertificates' => '

An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.

', ], ], 'LoadBalancerTlsCertificateRenewalStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateRenewalSummary$renewalStatus' => '

The renewal status of the certificate.

The following renewal status are possible:

  • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.

  • PendingValidation - Lightsail couldn\'t automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won\'t be renewed. Check to make sure your certificate\'s domain validation records exist in your domain\'s DNS, and that your certificate remains in use.

  • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

  • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

', ], ], 'LoadBalancerTlsCertificateRenewalSummary' => [ 'base' => '

Contains information about the status of Lightsail\'s managed renewal for the certificate.

The renewal status of the certificate.

The following renewal status are possible:

  • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names in the certificate. No further action is required.

  • PendingValidation - Lightsail couldn\'t automatically validate one or more domain names in the certificate. You must take action to validate these domain names or the certificate won\'t be renewed. If you used DNS validation, check to make sure your certificate\'s domain validation records exist in your domain\'s DNS, and that your certificate remains in use.

  • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

  • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

', 'refs' => [ 'LoadBalancerTlsCertificate$renewalSummary' => '

An object that describes the status of the certificate renewal managed by Lightsail.

', ], ], 'LoadBalancerTlsCertificateRevocationReason' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$revocationReason' => '

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

', ], ], 'LoadBalancerTlsCertificateStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$status' => '

The validation status of the SSL/TLS certificate. Valid values are below.

', ], ], 'LoadBalancerTlsCertificateSummary' => [ 'base' => '

Provides a summary of SSL/TLS certificate metadata.

', 'refs' => [ 'LoadBalancerTlsCertificateSummaryList$member' => NULL, ], ], 'LoadBalancerTlsCertificateSummaryList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$tlsCertificateSummaries' => '

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

', ], ], 'LoadBalancerTlsPolicy' => [ 'base' => '

Describes the TLS security policies that are available for Lightsail load balancers.

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'LoadBalancerTlsPolicyList$member' => NULL, ], ], 'LoadBalancerTlsPolicyList' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancerTlsPoliciesResult$tlsPolicies' => '

An array of objects that describe the TLS security policies that are available.

', ], ], 'LogEvent' => [ 'base' => '

Describes a database log event.

', 'refs' => [ 'LogEventList$member' => NULL, ], ], 'LogEventList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseLogEventsResult$resourceLogEvents' => '

An object describing the result of your get relational database log events request.

', ], ], 'MetricDatapoint' => [ 'base' => '

Describes the metric data point.

', 'refs' => [ 'MetricDatapointList$member' => NULL, ], ], 'MetricDatapointList' => [ 'base' => NULL, 'refs' => [ 'GetBucketMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', 'GetContainerServiceMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', 'GetDistributionMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', 'GetInstanceMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', 'GetLoadBalancerMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', 'GetRelationalDatabaseMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'Alarm$metricName' => '

The name of the metric associated with the alarm.

', 'PutAlarmRequest$metricName' => '

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

  • Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

  • Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

  • Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

', ], ], 'MetricPeriod' => [ 'base' => NULL, 'refs' => [ 'Alarm$period' => '

The period, in seconds, over which the statistic is applied.

', 'GetBucketMetricDataRequest$period' => '

The granularity, in seconds, of the returned data points.

Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.

', 'GetContainerServiceMetricDataRequest$period' => '

The granularity, in seconds, of the returned data points.

All container service metric data is available in 5-minute (300 seconds) granularity.

', 'GetDistributionMetricDataRequest$period' => '

The granularity, in seconds, for the metric data points that will be returned.

', 'GetInstanceMetricDataRequest$period' => '

The granularity, in seconds, of the returned data points.

The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All other instance metric data is available in 5-minute (300 seconds) granularity.

', 'GetLoadBalancerMetricDataRequest$period' => '

The granularity, in seconds, of the returned data points.

', 'GetRelationalDatabaseMetricDataRequest$period' => '

The granularity, in seconds, of the returned data points.

All relational database metric data is available in 1-minute (60 seconds) granularity.

', ], ], 'MetricStatistic' => [ 'base' => NULL, 'refs' => [ 'Alarm$statistic' => '

The statistic for the metric associated with the alarm.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'MetricStatisticList$member' => NULL, ], ], 'MetricStatisticList' => [ 'base' => NULL, 'refs' => [ 'GetBucketMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'GetContainerServiceMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'GetDistributionMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'GetInstanceMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'GetLoadBalancerMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'GetRelationalDatabaseMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', ], ], 'MetricUnit' => [ 'base' => NULL, 'refs' => [ 'Alarm$unit' => '

The unit of the metric associated with the alarm.

', 'GetBucketMetricDataRequest$unit' => '

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

', 'GetDistributionMetricDataRequest$unit' => '

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

', 'GetInstanceMetricDataRequest$unit' => '

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units to specify with each available metric, see the metricName parameter.

', 'GetLoadBalancerMetricDataRequest$unit' => '

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

', 'GetRelationalDatabaseMetricDataRequest$unit' => '

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

', 'MetricDatapoint$unit' => '

The unit.

', ], ], 'MonitoredResourceInfo' => [ 'base' => '

Describes resource being monitored by an alarm.

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.

', 'refs' => [ 'Alarm$monitoredResourceInfo' => '

An object that lists information about the resource monitored by the alarm.

', ], ], 'MonthlyTransfer' => [ 'base' => '

Describes the monthly data transfer in and out of your virtual private server (or instance).

', 'refs' => [ 'InstanceNetworking$monthlyTransfer' => '

The amount of data in GB allocated for monthly data transfers.

', ], ], 'NameServersUpdateState' => [ 'base' => '

Describes the state of the name server records update made by Amazon Lightsail to an Amazon Route 53 registered domain.

For more information, see DNS in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'RegisteredDomainDelegationInfo$nameServersUpdateState' => '

An object that describes the state of the name server records that are automatically added to the Route 53 domain by Lightsail.

', ], ], 'NameServersUpdateStateCode' => [ 'base' => NULL, 'refs' => [ 'NameServersUpdateState$code' => '

The status code for the name servers update.

Following are the possible values:

  • SUCCEEDED - The name server records were successfully updated.

  • PENDING - The name server record update is in progress.

  • FAILED - The name server record update failed.

  • STARTED - The automatic name server record update started.

', ], ], 'NetworkProtocol' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$protocol' => '

The IP protocol name.

The name can be one of the following:

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn\'t require reliable data stream service, use UDP instead.

  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.

  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don\'t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.

  • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

', 'InstancePortState$protocol' => '

The IP protocol name.

The name can be one of the following:

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn\'t require reliable data stream service, use UDP instead.

  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.

  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don\'t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.

  • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

', 'PortInfo$protocol' => '

The IP protocol name.

The name can be one of the following:

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn\'t require reliable data stream service, use UDP instead.

  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.

  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don\'t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.

  • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AccessKey$secretAccessKey' => '

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

', 'Alarm$arn' => '

The Amazon Resource Name (ARN) of the alarm.

', 'AttachDiskRequest$diskPath' => '

The disk path to expose to the instance (e.g., /dev/xvdf).

', 'AvailabilityZone$zoneName' => '

The name of the Availability Zone. The format is us-east-2a (case-sensitive).

', 'AvailabilityZone$state' => '

The state of the Availability Zone.

', 'Blueprint$blueprintId' => '

The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).

', 'Blueprint$group' => '

The group name of the blueprint (e.g., amazon-linux).

', 'Bucket$resourceType' => '

The Lightsail resource type of the bucket (for example, Bucket).

', 'Bucket$arn' => '

The Amazon Resource Name (ARN) of the bucket.

', 'Bucket$bundleId' => '

The ID of the bundle currently applied to the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to change the bundle of a bucket.

', 'Bucket$url' => '

The URL of the bucket.

', 'Bucket$supportCode' => '

The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.

', 'Bucket$objectVersioning' => '

Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

  • Enabled - Object versioning is enabled.

  • Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

  • NeverEnabled - Object versioning has never been enabled.

', 'BucketBundle$bundleId' => '

The ID of the bundle.

', 'BucketBundle$name' => '

The name of the bundle.

', 'BucketState$code' => '

The state code of the bucket.

The following codes are possible:

  • OK - The bucket is in a running state.

  • Unknown - Creation of the bucket might have timed-out. You might want to delete the bucket and create a new one.

', 'Bundle$bundleId' => '

The bundle ID (e.g., micro_1_0).

', 'CacheSettings$allowedHTTPMethods' => '

The HTTP methods that are processed and forwarded to the distribution\'s origin.

You can specify the following options:

  • GET,HEAD - The distribution forwards the GET and HEAD methods.

  • GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.

  • GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.

If you specify the third option, you might need to restrict access to your distribution\'s origin so users can\'t perform operations that you don\'t want them to. For example, you might not want users to have permission to delete objects from your origin.

', 'CacheSettings$cachedHTTPMethods' => '

The HTTP method responses that are cached by your distribution.

You can specify the following options:

  • GET,HEAD - The distribution caches responses to the GET and HEAD methods.

  • GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.

', 'Certificate$arn' => '

The Amazon Resource Name (ARN) of the certificate.

', 'CertificateSummary$certificateArn' => '

The Amazon Resource Name (ARN) of the certificate.

', 'CloudFormationStackRecord$arn' => '

The Amazon Resource Name (ARN) of the CloudFormation stack record.

', 'CloudFormationStackRecordSourceInfo$name' => '

The name of the record.

', 'CloudFormationStackRecordSourceInfo$arn' => '

The Amazon Resource Name (ARN) of the export snapshot record.

', 'ContactMethod$contactEndpoint' => '

The destination of the contact method, such as an email address or a mobile phone number.

', 'ContactMethod$arn' => '

The Amazon Resource Name (ARN) of the contact method.

', 'ContainerService$arn' => '

The Amazon Resource Name (ARN) of the container service.

', 'CostEstimate$usageType' => '

The types of usage that are included in the estimate, such as costs, usage, or data transfer.

', 'CreateBucketRequest$bundleId' => '

The ID of the bundle to use for the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

Use the UpdateBucketBundle action to change the bundle after the bucket is created.

', 'CreateDiskFromSnapshotRequest$availabilityZone' => '

The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

', 'CreateDiskRequest$availabilityZone' => '

The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.

Use the get regions operation to list the Availability Zones where Lightsail is currently available.

', 'CreateInstancesFromSnapshotRequest$bundleId' => '

The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

', 'CreateInstancesRequest$blueprintId' => '

The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints).

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

', 'CreateInstancesRequest$bundleId' => '

The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

', 'DeleteBucketAccessKeyRequest$accessKeyId' => '

The ID of the access key to delete.

Use the GetBucketAccessKeys action to get a list of access key IDs that you can specify.

', 'DestinationInfo$id' => '

The ID of the resource created at the destination.

', 'DestinationInfo$service' => '

The destination service of the record.

', 'Disk$arn' => '

The Amazon Resource Name (ARN) of the disk.

', 'DiskInfo$path' => '

The disk path.

', 'DiskMap$originalDiskPath' => '

The original disk path exposed to the instance (for example, /dev/sdh).

', 'DiskSnapshot$arn' => '

The Amazon Resource Name (ARN) of the disk snapshot.

', 'DiskSnapshot$fromDiskArn' => '

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

', 'DiskSnapshot$fromInstanceArn' => '

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

', 'Domain$arn' => '

The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

', 'DomainEntry$id' => '

The ID of the domain recordset entry.

', 'ExportSnapshotRecord$arn' => '

The Amazon Resource Name (ARN) of the export snapshot record.

', 'ExportSnapshotRecordSourceInfo$name' => '

The name of the source instance or disk snapshot.

', 'ExportSnapshotRecordSourceInfo$arn' => '

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

', 'ExportSnapshotRecordSourceInfo$fromResourceName' => '

The name of the snapshot\'s source instance or disk.

', 'ExportSnapshotRecordSourceInfo$fromResourceArn' => '

The Amazon Resource Name (ARN) of the snapshot\'s source instance or disk.

', 'GetOperationRequest$operationId' => '

A GUID used to identify the operation.

', 'Instance$arn' => '

The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

', 'Instance$blueprintId' => '

The blueprint ID (e.g., os_amlinux_2016_03).

', 'Instance$blueprintName' => '

The friendly name of the blueprint (e.g., Amazon Linux).

', 'Instance$bundleId' => '

The bundle for the instance (e.g., micro_1_0).

', 'Instance$username' => '

The user name for connecting to the instance (e.g., ec2-user).

', 'InstanceEntry$instanceType' => '

The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.

', 'InstanceSnapshot$arn' => '

The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

', 'InstanceSnapshot$fromInstanceArn' => '

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

', 'InstanceSnapshotInfo$fromBundleId' => '

The bundle ID from which the source instance was created (e.g., micro_1_0).

', 'InstanceSnapshotInfo$fromBlueprintId' => '

The blueprint ID from which the source instance (e.g., os_debian_8_3).

', 'KeyPair$arn' => '

The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

', 'LightsailDistribution$arn' => '

The Amazon Resource Name (ARN) of the distribution.

', 'LoadBalancer$arn' => '

The Amazon Resource Name (ARN) of the load balancer.

', 'LoadBalancer$dnsName' => '

The DNS name of your Lightsail load balancer.

', 'LoadBalancer$healthCheckPath' => '

The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

', 'LoadBalancerTlsCertificate$arn' => '

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

', 'LoadBalancerTlsCertificate$issuer' => '

The issuer of the certificate.

', 'LoadBalancerTlsCertificate$keyAlgorithm' => '

The algorithm used to generate the key pair (the public and private key).

', 'LoadBalancerTlsCertificate$serial' => '

The serial number of the certificate.

', 'LoadBalancerTlsCertificate$signatureAlgorithm' => '

The algorithm that was used to sign the certificate.

', 'LoadBalancerTlsCertificate$subject' => '

The name of the entity that is associated with the public key contained in the certificate.

', 'LoadBalancerTlsCertificateDomainValidationRecord$name' => '

A fully qualified domain name in the certificate. For example, example.com.

', 'LoadBalancerTlsCertificateDomainValidationRecord$type' => '

The type of validation record. For example, CNAME for domain validation.

', 'LoadBalancerTlsCertificateDomainValidationRecord$value' => '

The value for that type.

', 'Operation$id' => '

The ID of the operation.

', 'PartnerIdList$member' => NULL, 'PendingMaintenanceAction$action' => '

The type of pending database maintenance action.

', 'PendingMaintenanceAction$description' => '

Additional detail about the pending database maintenance action.

', 'RelationalDatabase$arn' => '

The Amazon Resource Name (ARN) of the database.

', 'RelationalDatabase$relationalDatabaseBlueprintId' => '

The blueprint ID for the database. A blueprint describes the major engine version of a database.

', 'RelationalDatabase$relationalDatabaseBundleId' => '

The bundle ID for the database. A bundle describes the performance specifications for your database.

', 'RelationalDatabase$state' => '

Describes the current state of the database.

', 'RelationalDatabase$engine' => '

The database software (for example, MySQL).

', 'RelationalDatabase$engineVersion' => '

The database engine version (for example, 5.7.23).

', 'RelationalDatabase$masterUsername' => '

The master user name of the database.

', 'RelationalDatabase$parameterApplyStatus' => '

The status of parameter updates for the database.

', 'RelationalDatabase$preferredBackupWindow' => '

The daily time range during which automated backups are created for the database (for example, 16:00-16:30).

', 'RelationalDatabase$preferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur on the database.

In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

', 'RelationalDatabaseEndpoint$address' => '

Specifies the DNS address of the database.

', 'RelationalDatabaseSnapshot$arn' => '

The Amazon Resource Name (ARN) of the database snapshot.

', 'RelationalDatabaseSnapshot$engine' => '

The software of the database snapshot (for example, MySQL)

', 'RelationalDatabaseSnapshot$engineVersion' => '

The database engine version for the database snapshot (for example, 5.7.23).

', 'RelationalDatabaseSnapshot$state' => '

The state of the database snapshot.

', 'RelationalDatabaseSnapshot$fromRelationalDatabaseName' => '

The name of the source database from which the database snapshot was created.

', 'RelationalDatabaseSnapshot$fromRelationalDatabaseArn' => '

The Amazon Resource Name (ARN) of the database from which the database snapshot was created.

', 'ResourceReceivingAccess$name' => '

The name of the Lightsail instance.

', 'ResourceReceivingAccess$resourceType' => '

The Lightsail resource type (for example, Instance).

', 'Session$name' => '

The session name.

', 'StaticIp$arn' => '

The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

', 'UpdateBucketBundleRequest$bundleId' => '

The ID of the new bundle to apply to the bucket.

Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

', 'UpdateBucketRequest$versioning' => '

Specifies whether to enable or suspend versioning of objects in the bucket.

The following options can be specified:

  • Enabled - Enables versioning of objects in the specified bucket.

  • Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.

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

Lightsail throws this exception when it cannot find a resource.

', 'refs' => [], ], 'NotificationTriggerList' => [ 'base' => NULL, 'refs' => [ 'Alarm$notificationTriggers' => '

The alarm states that trigger a notification.

', 'PutAlarmRequest$notificationTriggers' => '

The alarm states that trigger a notification.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

  • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

  • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don\'t specify this parameter.

', ], ], 'OpenInstancePublicPortsRequest' => [ 'base' => NULL, 'refs' => [], ], 'OpenInstancePublicPortsResult' => [ 'base' => NULL, 'refs' => [], ], 'Operation' => [ 'base' => '

Describes the API operation.

', 'refs' => [ 'AttachCertificateToDistributionResult$operation' => '

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CloseInstancePublicPortsResult$operation' => '

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDistributionResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDomainEntryResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDomainResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateKeyPairResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteDistributionResult$operation' => '

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteDomainEntryResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteDomainResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteKeyPairResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DetachCertificateFromDistributionResult$operation' => '

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'GetOperationResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'ImportKeyPairResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'OpenInstancePublicPortsResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'OperationList$member' => NULL, 'PeerVpcResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'PutInstancePublicPortsResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'ResetDistributionCacheResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UnpeerVpcResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateDistributionBundleResult$operation' => '

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateDistributionResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateInstanceMetadataOptionsResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', ], ], 'OperationFailureException' => [ 'base' => '

Lightsail throws this exception when an operation fails to execute.

', 'refs' => [], ], 'OperationList' => [ 'base' => NULL, 'refs' => [ 'AllocateStaticIpResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'AttachDiskResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'AttachInstancesToLoadBalancerResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'AttachLoadBalancerTlsCertificateResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

These SSL/TLS certificates are only usable by Lightsail load balancers. You can\'t get the certificate and use it for another purpose.

', 'AttachStaticIpResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CopySnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateBucketAccessKeyResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateBucketResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateCertificateResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateCloudFormationStackResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateContactMethodResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDiskFromSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDiskResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDiskSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateInstanceSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateInstancesFromSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateInstancesResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateLoadBalancerResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateLoadBalancerTlsCertificateResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateRelationalDatabaseFromSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateRelationalDatabaseSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteAlarmResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteAutoSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteBucketAccessKeyResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteBucketResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteCertificateResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteContactMethodResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteDiskResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteDiskSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteInstanceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteInstanceSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteKnownHostKeysResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteLoadBalancerResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteLoadBalancerTlsCertificateResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteRelationalDatabaseSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DetachDiskResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DetachInstancesFromLoadBalancerResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DetachStaticIpResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DisableAddOnResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'EnableAddOnResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'ExportSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'GetOperationsForResourceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'GetOperationsResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'PutAlarmResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'RebootInstanceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'RebootRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'ReleaseStaticIpResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'SendContactMethodVerificationResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'SetIpAddressTypeResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'SetResourceAccessForBucketResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'StartGUISessionResult$operations' => '

The available API operations.

', 'StartInstanceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'StartRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'StopGUISessionResult$operations' => '

The available API operations.

', 'StopInstanceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'StopRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'TagResourceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'TestAlarmResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UntagResourceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateBucketBundleResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateBucketResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateDomainEntryResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateLoadBalancerAttributeResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateRelationalDatabaseParametersResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', ], ], 'OperationStatus' => [ 'base' => NULL, 'refs' => [ 'Operation$status' => '

The status of the operation.

', ], ], 'OperationType' => [ 'base' => NULL, 'refs' => [ 'Operation$operationType' => '

The type of operation.

', ], ], 'Origin' => [ 'base' => '

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

', 'refs' => [ 'LightsailDistribution$origin' => '

An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

', ], ], 'OriginProtocolPolicyEnum' => [ 'base' => NULL, 'refs' => [ 'InputOrigin$protocolPolicy' => '

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

', 'Origin$protocolPolicy' => '

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

', ], ], 'PartnerIdList' => [ 'base' => NULL, 'refs' => [ 'Bucket$readonlyAccessAccounts' => '

An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

', 'UpdateBucketRequest$readonlyAccessAccounts' => '

An array of strings to specify the Amazon Web Services account IDs that can access the bucket.

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

', ], ], 'PasswordData' => [ 'base' => '

The password data for the Windows Server-based instance, including the ciphertext and the key pair name.

', 'refs' => [ 'InstanceAccessDetails$passwordData' => '

For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.

', ], ], 'PeerVpcRequest' => [ 'base' => NULL, 'refs' => [], ], 'PeerVpcResult' => [ 'base' => NULL, 'refs' => [], ], 'PendingMaintenanceAction' => [ 'base' => '

Describes a pending database maintenance action.

', 'refs' => [ 'PendingMaintenanceActionList$member' => NULL, ], ], 'PendingMaintenanceActionList' => [ 'base' => NULL, 'refs' => [ 'RelationalDatabase$pendingMaintenanceActions' => '

Describes the pending maintenance actions for the database.

', ], ], 'PendingModifiedRelationalDatabaseValues' => [ 'base' => '

Describes a pending database value modification.

', 'refs' => [ 'RelationalDatabase$pendingModifiedValues' => '

Describes pending database value modifications.

', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'CreateLoadBalancerRequest$instancePort' => '

The instance port where you\'re creating your load balancer.

', 'InstancePortInfo$fromPort' => '

The first port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'InstancePortInfo$toPort' => '

The last port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'InstancePortState$fromPort' => '

The first port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'InstancePortState$toPort' => '

The last port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'PortInfo$fromPort' => '

The first port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'PortInfo$toPort' => '

The last port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'PortList$member' => NULL, ], ], 'PortAccessType' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$accessType' => '

The type of access (Public or Private).

', ], ], 'PortInfo' => [ 'base' => '

Describes ports to open on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

', 'refs' => [ 'CloseInstancePublicPortsRequest$portInfo' => '

An object to describe the ports to close for the specified instance.

', 'OpenInstancePublicPortsRequest$portInfo' => '

An object to describe the ports to open for the specified instance.

', 'PortInfoList$member' => NULL, ], ], 'PortInfoList' => [ 'base' => NULL, 'refs' => [ 'PutInstancePublicPortsRequest$portInfos' => '

An array of objects to describe the ports to open for the specified instance.

', ], ], 'PortInfoSourceType' => [ 'base' => NULL, 'refs' => [ 'InstanceEntry$portInfoSource' => '

The port configuration to use for the new Amazon EC2 instance.

The following configuration options are available:

  • DEFAULT - Use the default firewall settings from the Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2.

  • INSTANCE - Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

  • NONE - Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

  • CLOSED - All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

If you configured lightsail-connect as a cidrListAliases on your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance.

', ], ], 'PortList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$publicPorts' => '

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

', ], ], 'PortMap' => [ 'base' => NULL, 'refs' => [ 'Container$ports' => '

The open firewall ports of the container.

', ], ], 'PortState' => [ 'base' => NULL, 'refs' => [ 'InstancePortState$state' => '

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

', ], ], 'PricingUnit' => [ 'base' => NULL, 'refs' => [ 'EstimateByTime$pricingUnit' => '

The unit of measurement that\'s used for the cost estimate.

', ], ], 'PrivateRegistryAccess' => [ 'base' => '

Describes the configuration for an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'ContainerService$privateRegistryAccess' => '

An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', ], ], 'PrivateRegistryAccessRequest' => [ 'base' => '

Describes a request to configure an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'CreateContainerServiceRequest$privateRegistryAccess' => '

An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', 'UpdateContainerServiceRequest$privateRegistryAccess' => '

An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', ], ], 'PutAlarmRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAlarmResult' => [ 'base' => NULL, 'refs' => [], ], 'PutInstancePublicPortsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutInstancePublicPortsResult' => [ 'base' => NULL, 'refs' => [], ], 'QueryStringObject' => [ 'base' => '

Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.

For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.

', 'refs' => [ 'CacheSettings$forwardedQueryStrings' => '

An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.

', ], ], 'R53HostedZoneDeletionState' => [ 'base' => '

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone.

', 'refs' => [ 'RegisteredDomainDelegationInfo$r53HostedZoneDeletionState' => '

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone.

', ], ], 'R53HostedZoneDeletionStateCode' => [ 'base' => NULL, 'refs' => [ 'R53HostedZoneDeletionState$code' => '

The status code for the deletion state.

Following are the possible values:

  • SUCCEEDED - The hosted zone was successfully deleted.

  • PENDING - The hosted zone deletion is in progress.

  • FAILED - The hosted zone deletion failed.

  • STARTED - The hosted zone deletion started.

', ], ], 'RebootInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RebootInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'RebootRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'RebootRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'RecordState' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecord$state' => '

The current state of the CloudFormation stack record.

', 'ExportSnapshotRecord$state' => '

The state of the export snapshot record.

', ], ], 'Region' => [ 'base' => '

Describes the Amazon Web Services Region.

', 'refs' => [ 'RegionList$member' => NULL, ], ], 'RegionList' => [ 'base' => NULL, 'refs' => [ 'GetRegionsResult$regions' => '

An array of key-value pairs containing information about your get regions request.

', ], ], 'RegionName' => [ 'base' => NULL, 'refs' => [ 'CopySnapshotRequest$sourceRegion' => '

The Amazon Web Services Region where the source manual or automatic snapshot is located.

', 'InputOrigin$regionName' => '

The AWS Region name of the origin resource.

', 'Origin$regionName' => '

The AWS Region name of the origin resource.

', 'Region$name' => '

The region name (e.g., us-east-2).

', 'ResourceLocation$regionName' => '

The Amazon Web Services Region name.

', ], ], 'RegisterContainerImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerImageResult' => [ 'base' => NULL, 'refs' => [], ], 'RegisteredDomainDelegationInfo' => [ 'base' => '

Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail.

When you delegate an Amazon Route 53 registered domain to Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You no longer use the Route 53 hosted zone to manage the DNS of the domain. To delegate the domain, Lightsail automatically updates the domain\'s name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the domain.

All of the following conditions must be true for automatic domain delegation to be successful:

  • The registered domain must be in the same Amazon Web Services account as the Lightsail account making the request.

  • The user or entity making the request must have permission to manage domains in Route 53.

  • The Route 53 hosted zone for the domain must be empty. It cannot contain DNS records other than start of authority (SOA) and name server records.

If automatic domain delegation fails, or if you manage the DNS of your domain using a service other than Route 53, then you must manually add the Lightsail DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domain’s records in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'Domain$registeredDomainDelegationInfo' => '

An object that describes the state of the Route 53 domain delegation to a Lightsail DNS zone.

', ], ], 'RelationalDatabase' => [ 'base' => '

Describes a database.

', 'refs' => [ 'GetRelationalDatabaseResult$relationalDatabase' => '

An object describing the specified database.

', 'RelationalDatabaseList$member' => NULL, ], ], 'RelationalDatabaseBlueprint' => [ 'base' => '

Describes a database image, or blueprint. A blueprint describes the major engine version of a database.

', 'refs' => [ 'RelationalDatabaseBlueprintList$member' => NULL, ], ], 'RelationalDatabaseBlueprintList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseBlueprintsResult$blueprints' => '

An object describing the result of your get relational database blueprints request.

', ], ], 'RelationalDatabaseBundle' => [ 'base' => '

Describes a database bundle. A bundle describes the performance specifications of the database.

', 'refs' => [ 'RelationalDatabaseBundleList$member' => NULL, ], ], 'RelationalDatabaseBundleList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseBundlesResult$bundles' => '

An object describing the result of your get relational database bundles request.

', ], ], 'RelationalDatabaseEndpoint' => [ 'base' => '

Describes an endpoint for a database.

', 'refs' => [ 'RelationalDatabase$masterEndpoint' => '

The master endpoint for the database.

', ], ], 'RelationalDatabaseEngine' => [ 'base' => NULL, 'refs' => [ 'RelationalDatabaseBlueprint$engine' => '

The database software of the database blueprint (for example, MySQL).

', ], ], 'RelationalDatabaseEvent' => [ 'base' => '

Describes an event for a database.

', 'refs' => [ 'RelationalDatabaseEventList$member' => NULL, ], ], 'RelationalDatabaseEventList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseEventsResult$relationalDatabaseEvents' => '

An object describing the result of your get relational database events request.

', ], ], 'RelationalDatabaseHardware' => [ 'base' => '

Describes the hardware of a database.

', 'refs' => [ 'RelationalDatabase$hardware' => '

Describes the hardware of the database.

', ], ], 'RelationalDatabaseList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabasesResult$relationalDatabases' => '

An object describing the result of your get relational databases request.

', ], ], 'RelationalDatabaseMetricName' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

  • CPUUtilization - The percentage of CPU utilization currently in use on the database.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

  • DatabaseConnections - The number of database connections in use.

    Statistics: The most useful statistics are Maximum and Sum.

    Unit: The published unit is Count.

  • DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • FreeStorageSpace - The amount of available storage space.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Bytes.

  • NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Bytes/Second.

  • NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Bytes/Second.

', 'GetRelationalDatabaseMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'RelationalDatabaseParameter' => [ 'base' => '

Describes the parameters of a database.

', 'refs' => [ 'RelationalDatabaseParameterList$member' => NULL, ], ], 'RelationalDatabaseParameterList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseParametersResult$parameters' => '

An object describing the result of your get relational database parameters request.

', 'UpdateRelationalDatabaseParametersRequest$parameters' => '

The database parameters to update.

', ], ], 'RelationalDatabasePasswordVersion' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseMasterUserPasswordRequest$passwordVersion' => '

The password version to return.

Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively. Specifying PENDING returns the newest version of the password that will rotate to CURRENT. After the PENDING password rotates to CURRENT, the PENDING password is no longer available.

Default: CURRENT

', ], ], 'RelationalDatabaseSnapshot' => [ 'base' => '

Describes a database snapshot.

', 'refs' => [ 'GetRelationalDatabaseSnapshotResult$relationalDatabaseSnapshot' => '

An object describing the specified database snapshot.

', 'RelationalDatabaseSnapshotList$member' => NULL, ], ], 'RelationalDatabaseSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseSnapshotsResult$relationalDatabaseSnapshots' => '

An object describing the result of your get relational database snapshots request.

', ], ], 'ReleaseStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReleaseStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'RenewalStatus' => [ 'base' => NULL, 'refs' => [ 'RenewalSummary$renewalStatus' => '

The renewal status of the certificate.

The following renewal status are possible:

  • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.

  • PendingValidation - Lightsail couldn\'t automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won\'t be renewed. Check to make sure your certificate\'s domain validation records exist in your domain\'s DNS, and that your certificate remains in use.

  • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

  • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

', ], ], 'RenewalStatusReason' => [ 'base' => NULL, 'refs' => [ 'RenewalSummary$renewalStatusReason' => '

The reason for the renewal status of the certificate.

', ], ], 'RenewalSummary' => [ 'base' => '

Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.

', 'refs' => [ 'Certificate$renewalSummary' => '

An object that describes the status of the certificate renewal managed by Lightsail.

', ], ], 'RequestFailureReason' => [ 'base' => NULL, 'refs' => [ 'Certificate$requestFailureReason' => '

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the Amazon Web Services Support Center to contact Amazon Web Services Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the Amazon Web Services Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

', ], ], 'ResetDistributionCacheRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetDistributionCacheResult' => [ 'base' => NULL, 'refs' => [], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'MonitoredResourceInfo$arn' => '

The Amazon Resource Name (ARN) of the resource being monitored.

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

', ], ], 'ResourceBucketAccess' => [ 'base' => NULL, 'refs' => [ 'SetResourceAccessForBucketRequest$access' => '

The access setting.

The following access settings are available:

  • allow - Allows access to the bucket and its objects.

  • deny - Denies access to the bucket and its objects. Use this setting to remove access for a resource previously set to allow.

', ], ], 'ResourceBudgetEstimate' => [ 'base' => '

Describes the estimated cost or usage that a budget tracks.

', 'refs' => [ 'ResourcesBudgetEstimate$member' => NULL, ], ], 'ResourceLocation' => [ 'base' => '

Describes the resource location.

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

An object that lists information about the location of the alarm.

', 'Bucket$location' => '

An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

', 'CloudFormationStackRecord$location' => '

A list of objects describing the Availability Zone and Amazon Web Services Region of the CloudFormation stack record.

', 'ContactMethod$location' => '

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

', 'ContainerService$location' => '

An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

', 'Disk$location' => '

The AWS Region and Availability Zone where the disk is located.

', 'DiskSnapshot$location' => '

The AWS Region and Availability Zone where the disk snapshot was created.

', 'Domain$location' => '

The AWS Region and Availability Zones where the domain recordset was created.

', 'ExportSnapshotRecord$location' => '

The AWS Region and Availability Zone where the export snapshot record is located.

', 'Instance$location' => '

The region name and Availability Zone where the instance is located.

', 'InstanceSnapshot$location' => '

The region name and Availability Zone where you created the snapshot.

', 'KeyPair$location' => '

The region name and Availability Zone where the key pair was created.

', 'LightsailDistribution$location' => '

An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.

Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

', 'LoadBalancer$location' => '

The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

', 'LoadBalancerTlsCertificate$location' => '

The Amazon Web Services Region and Availability Zone where you created your certificate.

', 'Operation$location' => '

The Amazon Web Services Region and Availability Zone.

', 'RelationalDatabase$location' => '

The Region name and Availability Zone where the database is located.

', 'RelationalDatabaseSnapshot$location' => '

The Region name and Availability Zone where the database snapshot is located.

', 'StaticIp$location' => '

The region and Availability Zone where the static IP was created.

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'Alarm$name' => '

The name of the alarm.

', 'AllocateStaticIpRequest$staticIpName' => '

The name of the static IP address.

', 'AttachCertificateToDistributionRequest$distributionName' => '

The name of the distribution that the certificate will be attached to.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'AttachCertificateToDistributionRequest$certificateName' => '

The name of the certificate to attach to a distribution.

Only certificates with a status of ISSUED can be attached to a distribution.

Use the GetCertificates action to get a list of certificate names that you can specify.

This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com.

', 'AttachDiskRequest$diskName' => '

The unique Lightsail disk name (e.g., my-disk).

', 'AttachDiskRequest$instanceName' => '

The name of the Lightsail instance where you want to utilize the storage disk.

', 'AttachInstancesToLoadBalancerRequest$loadBalancerName' => '

The name of the load balancer.

', 'AttachLoadBalancerTlsCertificateRequest$loadBalancerName' => '

The name of the load balancer to which you want to associate the SSL/TLS certificate.

', 'AttachLoadBalancerTlsCertificateRequest$certificateName' => '

The name of your SSL/TLS certificate.

', 'AttachStaticIpRequest$staticIpName' => '

The name of the static IP.

', 'AttachStaticIpRequest$instanceName' => '

The instance name to which you want to attach the static IP address.

', 'AttachedDiskMap$key' => NULL, 'Blueprint$name' => '

The friendly name of the blueprint (e.g., Amazon Linux).

', 'CloseInstancePublicPortsRequest$instanceName' => '

The name of the instance for which to close ports.

', 'CloudFormationStackRecord$name' => '

The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID.

', 'ContactMethod$name' => '

The name of the contact method.

', 'CopySnapshotRequest$sourceSnapshotName' => '

The name of the source manual snapshot to copy.

Constraint:

  • Define this parameter only when copying a manual snapshot as another manual snapshot.

', 'CopySnapshotRequest$targetSnapshotName' => '

The name of the new manual snapshot to be created as a copy.

', 'CreateDiskFromSnapshotRequest$diskName' => '

The unique Lightsail disk name (e.g., my-disk).

', 'CreateDiskFromSnapshotRequest$diskSnapshotName' => '

The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk.

Constraint:

  • This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

', 'CreateDiskRequest$diskName' => '

The unique Lightsail disk name (e.g., my-disk).

', 'CreateDiskSnapshotRequest$diskName' => '

The unique name of the source disk (e.g., Disk-Virginia-1).

This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.

', 'CreateDiskSnapshotRequest$diskSnapshotName' => '

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.

', 'CreateDiskSnapshotRequest$instanceName' => '

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance\'s system volume is created.

This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.

', 'CreateDistributionRequest$distributionName' => '

The name for the distribution.

', 'CreateGUISessionAccessDetailsRequest$resourceName' => '

The resource name.

', 'CreateGUISessionAccessDetailsResult$resourceName' => '

The resource name.

', 'CreateInstanceSnapshotRequest$instanceSnapshotName' => '

The name for your new snapshot.

', 'CreateInstanceSnapshotRequest$instanceName' => '

The Lightsail instance on which to base your snapshot.

', 'CreateInstancesFromSnapshotRequest$instanceSnapshotName' => '

The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.

Constraint:

  • This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.

', 'CreateInstancesFromSnapshotRequest$keyPairName' => '

The name for your key pair.

', 'CreateInstancesRequest$customImageName' => '

(Deprecated) The name for your custom image.

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.

', 'CreateInstancesRequest$keyPairName' => '

The name of your key pair.

', 'CreateKeyPairRequest$keyPairName' => '

The name for your new key pair.

', 'CreateLoadBalancerRequest$loadBalancerName' => '

The name of your load balancer.

', 'CreateLoadBalancerRequest$certificateName' => '

The name of the SSL/TLS certificate.

If you specify certificateName, then certificateDomainName is required (and vice-versa).

', 'CreateLoadBalancerTlsCertificateRequest$loadBalancerName' => '

The load balancer name where you want to create the SSL/TLS certificate.

', 'CreateLoadBalancerTlsCertificateRequest$certificateName' => '

The SSL/TLS certificate name.

You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.

', 'CreateRelationalDatabaseFromSnapshotRequest$relationalDatabaseName' => '

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

', 'CreateRelationalDatabaseFromSnapshotRequest$relationalDatabaseSnapshotName' => '

The name of the database snapshot from which to create your new database.

', 'CreateRelationalDatabaseFromSnapshotRequest$sourceRelationalDatabaseName' => '

The name of the source database.

', 'CreateRelationalDatabaseRequest$relationalDatabaseName' => '

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

', 'CreateRelationalDatabaseSnapshotRequest$relationalDatabaseName' => '

The name of the database on which to base your new snapshot.

', 'CreateRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName' => '

The name for your new database snapshot.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

', 'DeleteAlarmRequest$alarmName' => '

The name of the alarm to delete.

', 'DeleteAutoSnapshotRequest$resourceName' => '

The name of the source instance or disk from which to delete the automatic snapshot.

', 'DeleteDiskRequest$diskName' => '

The unique name of the disk you want to delete (e.g., my-disk).

', 'DeleteDiskSnapshotRequest$diskSnapshotName' => '

The name of the disk snapshot you want to delete (e.g., my-disk-snapshot).

', 'DeleteDistributionRequest$distributionName' => '

The name of the distribution to delete.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'DeleteInstanceRequest$instanceName' => '

The name of the instance to delete.

', 'DeleteInstanceSnapshotRequest$instanceSnapshotName' => '

The name of the snapshot to delete.

', 'DeleteKeyPairRequest$keyPairName' => '

The name of the key pair to delete.

', 'DeleteKnownHostKeysRequest$instanceName' => '

The name of the instance for which you want to reset the host key or certificate.

', 'DeleteLoadBalancerRequest$loadBalancerName' => '

The name of the load balancer you want to delete.

', 'DeleteLoadBalancerTlsCertificateRequest$loadBalancerName' => '

The load balancer name.

', 'DeleteLoadBalancerTlsCertificateRequest$certificateName' => '

The SSL/TLS certificate name.

', 'DeleteRelationalDatabaseRequest$relationalDatabaseName' => '

The name of the database that you are deleting.

', 'DeleteRelationalDatabaseRequest$finalRelationalDatabaseSnapshotName' => '

The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.

Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

', 'DeleteRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName' => '

The name of the database snapshot that you are deleting.

', 'DetachCertificateFromDistributionRequest$distributionName' => '

The name of the distribution from which to detach the certificate.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'DetachDiskRequest$diskName' => '

The unique name of the disk you want to detach from your instance (e.g., my-disk).

', 'DetachInstancesFromLoadBalancerRequest$loadBalancerName' => '

The name of the Lightsail load balancer.

', 'DetachStaticIpRequest$staticIpName' => '

The name of the static IP to detach from the instance.

', 'DisableAddOnRequest$resourceName' => '

The name of the source resource for which to disable the add-on.

', 'Disk$name' => '

The unique name of the disk.

', 'Disk$attachedTo' => '

The resources to which the disk is attached.

', 'DiskMap$newDiskName' => '

The new disk name (e.g., my-new-disk).

', 'DiskSnapshot$name' => '

The name of the disk snapshot (e.g., my-disk-snapshot).

', 'DiskSnapshot$fromDiskName' => '

The unique name of the source disk from which the disk snapshot was created.

', 'DiskSnapshot$fromInstanceName' => '

The unique name of the source instance from which the disk (system volume) snapshot was created.

', 'Domain$name' => '

The name of the domain.

', 'EnableAddOnRequest$resourceName' => '

The name of the source resource for which to enable or modify the add-on.

', 'ExportSnapshotRecord$name' => '

The export snapshot record name.

', 'ExportSnapshotRequest$sourceSnapshotName' => '

The name of the instance or disk snapshot to be exported to Amazon EC2.

', 'GetAlarmsRequest$alarmName' => '

The name of the alarm.

Specify an alarm name to return information about a specific alarm.

', 'GetAlarmsRequest$monitoredResourceName' => '

The name of the Lightsail resource being monitored by the alarm.

Specify a monitored resource name to return information about all alarms for a specific resource.

', 'GetAutoSnapshotsRequest$resourceName' => '

The name of the source instance or disk from which to get automatic snapshot information.

', 'GetAutoSnapshotsResult$resourceName' => '

The name of the source instance or disk for the automatic snapshots.

', 'GetCostEstimateRequest$resourceName' => '

The resource name.

', 'GetDiskRequest$diskName' => '

The name of the disk (e.g., my-disk).

', 'GetDiskSnapshotRequest$diskSnapshotName' => '

The name of the disk snapshot (e.g., my-disk-snapshot).

', 'GetDistributionLatestCacheResetRequest$distributionName' => '

The name of the distribution for which to return the timestamp of the last cache reset.

Use the GetDistributions action to get a list of distribution names that you can specify.

When omitted, the response includes the latest cache reset timestamp of all your distributions.

', 'GetDistributionMetricDataRequest$distributionName' => '

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'GetDistributionsRequest$distributionName' => '

The name of the distribution for which to return information.

When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.

', 'GetInstanceAccessDetailsRequest$instanceName' => '

The name of the instance to access.

', 'GetInstanceMetricDataRequest$instanceName' => '

The name of the instance for which you want to get metrics data.

', 'GetInstancePortStatesRequest$instanceName' => '

The name of the instance for which to return firewall port states.

', 'GetInstanceRequest$instanceName' => '

The name of the instance.

', 'GetInstanceSnapshotRequest$instanceSnapshotName' => '

The name of the snapshot for which you are requesting information.

', 'GetInstanceStateRequest$instanceName' => '

The name of the instance to get state information about.

', 'GetKeyPairRequest$keyPairName' => '

The name of the key pair for which you are requesting information.

', 'GetLoadBalancerMetricDataRequest$loadBalancerName' => '

The name of the load balancer.

', 'GetLoadBalancerRequest$loadBalancerName' => '

The name of the load balancer.

', 'GetLoadBalancerTlsCertificatesRequest$loadBalancerName' => '

The name of the load balancer you associated with your SSL/TLS certificate.

', 'GetOperationsForResourceRequest$resourceName' => '

The name of the resource for which you are requesting information.

', 'GetRelationalDatabaseEventsRequest$relationalDatabaseName' => '

The name of the database from which to get events.

', 'GetRelationalDatabaseLogEventsRequest$relationalDatabaseName' => '

The name of your database for which to get log events.

', 'GetRelationalDatabaseLogStreamsRequest$relationalDatabaseName' => '

The name of your database for which to get log streams.

', 'GetRelationalDatabaseMasterUserPasswordRequest$relationalDatabaseName' => '

The name of your database for which to get the master user password.

', 'GetRelationalDatabaseMetricDataRequest$relationalDatabaseName' => '

The name of your database from which to get metric data.

', 'GetRelationalDatabaseParametersRequest$relationalDatabaseName' => '

The name of your database for which to get parameters.

', 'GetRelationalDatabaseRequest$relationalDatabaseName' => '

The name of the database that you are looking up.

', 'GetRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName' => '

The name of the database snapshot for which to get information.

', 'GetStaticIpRequest$staticIpName' => '

The name of the static IP in Lightsail.

', 'ImportKeyPairRequest$keyPairName' => '

The name of the key pair for which you want to import the public key.

', 'InputOrigin$name' => '

The name of the origin resource.

', 'Instance$name' => '

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

', 'Instance$sshKeyName' => '

The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).

', 'InstanceAccessDetails$instanceName' => '

The name of this Amazon Lightsail instance.

', 'InstanceEntry$sourceName' => '

The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.

Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack.

', 'InstanceHealthSummary$instanceName' => '

The name of the Lightsail instance for which you are requesting health check data.

', 'InstanceSnapshot$name' => '

The name of the snapshot.

', 'InstanceSnapshot$fromInstanceName' => '

The instance from which the snapshot was created.

', 'KeyPair$name' => '

The friendly name of the SSH key pair.

', 'LightsailDistribution$name' => '

The name of the distribution.

', 'LightsailDistribution$certificateName' => '

The name of the SSL/TLS certificate attached to the distribution, if any.

', 'LoadBalancer$name' => '

The name of the load balancer (e.g., my-load-balancer).

', 'LoadBalancer$tlsPolicyName' => '

The name of the TLS security policy for the load balancer.

', 'LoadBalancerTlsCertificate$name' => '

The name of the SSL/TLS certificate (e.g., my-certificate).

', 'LoadBalancerTlsCertificate$loadBalancerName' => '

The load balancer name where your SSL/TLS certificate is attached.

', 'LoadBalancerTlsCertificateSummary$name' => '

The name of the SSL/TLS certificate.

', 'LoadBalancerTlsPolicy$name' => '

The name of the TLS security policy.

', 'MonitoredResourceInfo$name' => '

The name of the Lightsail resource being monitored.

', 'OpenInstancePublicPortsRequest$instanceName' => '

The name of the instance for which to open ports.

', 'Operation$resourceName' => '

The resource name.

', 'Origin$name' => '

The name of the origin resource.

', 'PasswordData$keyPairName' => '

The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair).

If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair.

', 'PutAlarmRequest$alarmName' => '

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

', 'PutAlarmRequest$monitoredResourceName' => '

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

', 'PutInstancePublicPortsRequest$instanceName' => '

The name of the instance for which to open ports.

', 'RebootInstanceRequest$instanceName' => '

The name of the instance to reboot.

', 'RebootRelationalDatabaseRequest$relationalDatabaseName' => '

The name of your database to reboot.

', 'RelationalDatabase$name' => '

The unique name of the database resource in Lightsail.

', 'RelationalDatabaseEvent$resource' => '

The database that the database event relates to.

', 'RelationalDatabaseSnapshot$name' => '

The name of the database snapshot.

', 'ReleaseStaticIpRequest$staticIpName' => '

The name of the static IP to delete.

', 'ResetDistributionCacheRequest$distributionName' => '

The name of the distribution for which to reset cache.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'ResourceBudgetEstimate$resourceName' => '

The resource name.

', 'ResourceNameList$member' => NULL, 'SetIpAddressTypeRequest$resourceName' => '

The name of the resource for which to set the IP address type.

', 'SetResourceAccessForBucketRequest$resourceName' => '

The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state.

', 'StartGUISessionRequest$resourceName' => '

The resource name.

', 'StartInstanceRequest$instanceName' => '

The name of the instance (a virtual private server) to start.

', 'StartRelationalDatabaseRequest$relationalDatabaseName' => '

The name of your database to start.

', 'StaticIp$name' => '

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).

', 'StaticIp$attachedTo' => '

The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).

', 'StopGUISessionRequest$resourceName' => '

The resource name.

', 'StopInstanceRequest$instanceName' => '

The name of the instance (a virtual private server) to stop.

', 'StopRelationalDatabaseRequest$relationalDatabaseName' => '

The name of your database to stop.

', 'StopRelationalDatabaseRequest$relationalDatabaseSnapshotName' => '

The name of your new database snapshot to be created before stopping your database.

', 'TagResourceRequest$resourceName' => '

The name of the resource to which you are adding tags.

', 'TestAlarmRequest$alarmName' => '

The name of the alarm to test.

', 'UntagResourceRequest$resourceName' => '

The name of the resource from which you are removing a tag.

', 'UpdateDistributionBundleRequest$distributionName' => '

The name of the distribution for which to update the bundle.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'UpdateDistributionRequest$distributionName' => '

The name of the distribution to update.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'UpdateInstanceMetadataOptionsRequest$instanceName' => '

The name of the instance for which to update metadata parameters.

', 'UpdateLoadBalancerAttributeRequest$loadBalancerName' => '

The name of the load balancer that you want to modify (e.g., my-load-balancer.

', 'UpdateRelationalDatabaseParametersRequest$relationalDatabaseName' => '

The name of your database for which to update parameters.

', 'UpdateRelationalDatabaseRequest$relationalDatabaseName' => '

The name of your Lightsail database resource to update.

', ], ], 'ResourceNameList' => [ 'base' => NULL, 'refs' => [ 'AttachInstancesToLoadBalancerRequest$instanceNames' => '

An array of strings representing the instance name(s) you want to attach to your load balancer.

An instance must be running before you can attach it to your load balancer.

There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).

', 'DetachInstancesFromLoadBalancerRequest$instanceNames' => '

An array of strings containing the names of the instances you want to detach from the load balancer.

', ], ], 'ResourceReceivingAccess' => [ 'base' => '

Describes an Amazon Lightsail instance that has access to a Lightsail bucket.

', 'refs' => [ 'AccessReceiverList$member' => NULL, ], ], 'ResourceRecord' => [ 'base' => '

Describes the domain name system (DNS) records to add to your domain\'s DNS to validate it for an Amazon Lightsail certificate.

', 'refs' => [ 'DomainValidationRecord$resourceRecord' => '

An object that describes the DNS records to add to your domain\'s DNS to validate it for the certificate.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'Alarm$resourceType' => '

The Lightsail resource type (e.g., Alarm).

', 'CloudFormationStackRecord$resourceType' => '

The Lightsail resource type (e.g., CloudFormationStackRecord).

', 'ContactMethod$resourceType' => '

The Lightsail resource type (e.g., ContactMethod).

', 'ContainerService$resourceType' => '

The Lightsail resource type of the container service (i.e., ContainerService).

', 'Disk$resourceType' => '

The Lightsail resource type (e.g., Disk).

', 'DiskSnapshot$resourceType' => '

The Lightsail resource type (e.g., DiskSnapshot).

', 'Domain$resourceType' => '

The resource type.

', 'ExportSnapshotRecord$resourceType' => '

The Lightsail resource type (e.g., ExportSnapshotRecord).

', 'GetAutoSnapshotsResult$resourceType' => '

The resource type (e.g., Instance or Disk).

', 'Instance$resourceType' => '

The type of resource (usually Instance).

', 'InstanceSnapshot$resourceType' => '

The type of resource (usually InstanceSnapshot).

', 'KeyPair$resourceType' => '

The resource type (usually KeyPair).

', 'LightsailDistribution$resourceType' => '

The Lightsail resource type (e.g., Distribution).

', 'LoadBalancer$resourceType' => '

The resource type (e.g., LoadBalancer.

', 'LoadBalancerTlsCertificate$resourceType' => '

The resource type (e.g., LoadBalancerTlsCertificate).

  • Instance - A Lightsail instance (a virtual private server)

  • StaticIp - A static IP address

  • KeyPair - The key pair used to connect to a Lightsail instance

  • InstanceSnapshot - A Lightsail instance snapshot

  • Domain - A DNS zone

  • PeeredVpc - A peered VPC

  • LoadBalancer - A Lightsail load balancer

  • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer

  • Disk - A Lightsail block storage disk

  • DiskSnapshot - A block storage disk snapshot

', 'MonitoredResourceInfo$resourceType' => '

The Lightsail resource type of the resource being monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

', 'Operation$resourceType' => '

The resource type.

', 'Origin$resourceType' => '

The resource type of the origin resource (e.g., Instance).

', 'RelationalDatabase$resourceType' => '

The Lightsail resource type for the database (for example, RelationalDatabase).

', 'RelationalDatabaseSnapshot$resourceType' => '

The Lightsail resource type.

', 'ResourceBudgetEstimate$resourceType' => '

The type of resource the budget will track.

', 'SetIpAddressTypeRequest$resourceType' => '

The resource type.

The possible values are Distribution, Instance, and LoadBalancer.

Distribution-related APIs are available only in the N. Virginia (us-east-1) Amazon Web Services Region. Set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit distributions.

', 'StaticIp$resourceType' => '

The resource type (usually StaticIp).

', ], ], 'ResourcesBudgetEstimate' => [ 'base' => NULL, 'refs' => [ 'GetCostEstimateResult$resourcesBudgetEstimate' => '

Returns the estimate\'s forecasted cost or usage.

', ], ], 'RevocationReason' => [ 'base' => NULL, 'refs' => [ 'Certificate$revocationReason' => '

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

', ], ], 'SendContactMethodVerificationRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendContactMethodVerificationResult' => [ 'base' => NULL, 'refs' => [], ], 'SensitiveNonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Session$url' => '

The session URL.

', ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'CreateRelationalDatabaseRequest$masterUserPassword' => '

The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

', 'GetRelationalDatabaseMasterUserPasswordResult$masterUserPassword' => '

The master user password for the password version specified.

', 'UpdateRelationalDatabaseRequest$masterUserPassword' => '

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

', ], ], 'SerialNumber' => [ 'base' => NULL, 'refs' => [ 'Certificate$serialNumber' => '

The serial number of the certificate.

', ], ], 'ServiceException' => [ 'base' => '

A general service exception.

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

Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual computer’s operating system or application.

', 'refs' => [ 'Sessions$member' => NULL, ], ], 'Sessions' => [ 'base' => NULL, 'refs' => [ 'CreateGUISessionAccessDetailsResult$sessions' => '

Returns information about the specified NICE DCV GUI session.

', ], ], 'SetIpAddressTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetIpAddressTypeResult' => [ 'base' => NULL, 'refs' => [], ], 'SetResourceAccessForBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetResourceAccessForBucketResult' => [ 'base' => NULL, 'refs' => [], ], 'StartGUISessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartGUISessionResult' => [ 'base' => NULL, 'refs' => [], ], 'StartInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StartRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'StaticIp' => [ 'base' => '

Describes a static IP.

', 'refs' => [ 'GetStaticIpResult$staticIp' => '

An array of key-value pairs containing information about the requested static IP.

', 'StaticIpList$member' => NULL, ], ], 'StaticIpList' => [ 'base' => NULL, 'refs' => [ 'GetStaticIpsResult$staticIps' => '

An array of key-value pairs containing information about your get static IPs request.

', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'CreateGUISessionAccessDetailsResult$status' => '

The status of the operation.

', ], ], 'StatusType' => [ 'base' => NULL, 'refs' => [ 'AccessKey$status' => '

The status of the access key.

A status of Active means that the key is valid, while Inactive means it is not.

', ], ], 'StopGUISessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopGUISessionResult' => [ 'base' => NULL, 'refs' => [], ], 'StopInstanceOnIdleRequest' => [ 'base' => '

Describes a request to create or edit the StopInstanceOnIdle add-on.

This add-on only applies to Lightsail for Research resources.

', 'refs' => [ 'AddOnRequest$stopInstanceOnIdleRequest' => '

An object that represents additional parameters when enabling or modifying the StopInstanceOnIdle add-on.

This object only applies to Lightsail for Research resources.

', ], ], 'StopInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StopRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'Container$command' => '

The launch command for the container.

', 'CookieObject$cookiesAllowList' => '

The specific cookies to forward to your distribution\'s origin.

', 'CreateInstancesFromSnapshotRequest$instanceNames' => '

The names for your new instances.

', 'CreateInstancesRequest$instanceNames' => '

The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]

', 'GetActiveNamesResult$activeNames' => '

The list of active names returned by the get active names request.

', 'GetRelationalDatabaseLogStreamsResult$logStreams' => '

An object describing the result of your get relational database log streams request.

', 'InstancePortInfo$cidrs' => '

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'InstancePortInfo$ipv6Cidrs' => '

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'InstancePortInfo$cidrListAliases' => '

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

', 'InstancePortState$cidrs' => '

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'InstancePortState$ipv6Cidrs' => '

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'InstancePortState$cidrListAliases' => '

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

', 'LightsailDistribution$alternativeDomainNames' => '

The alternate domain names of the distribution.

', 'LoadBalancerTlsCertificate$subjectAlternativeNames' => '

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.

', 'LoadBalancerTlsPolicy$protocols' => '

The protocols used in a given TLS security policy.

', 'LoadBalancerTlsPolicy$ciphers' => '

The ciphers used by the TLS security policy.

The ciphers are listed in order of preference.

', 'PortInfo$cidrs' => '

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

Examples:

  • To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

  • To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'PortInfo$ipv6Cidrs' => '

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'PortInfo$cidrListAliases' => '

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

', 'QueryStringObject$queryStringsAllowList' => '

The specific query strings that the distribution forwards to the origin.

Your distribution will cache content based on the specified query strings.

If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.

', 'RelationalDatabaseEvent$eventCategories' => '

The category that the database event belongs to.

', ], ], 'StringMax256' => [ 'base' => NULL, 'refs' => [ 'CreateContactMethodRequest$contactEndpoint' => '

The destination of the contact method, such as an email address or a mobile phone number.

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.

', 'UpdateLoadBalancerAttributeRequest$attributeValue' => '

The value that you want to specify for the attribute name.

The following values are supported depending on what you specify for the attributeName request parameter:

  • If you specify HealthCheckPath for the attributeName request parameter, then the attributeValue request parameter must be the path to ping on the target (for example, /weather/us/wa/seattle).

  • If you specify SessionStickinessEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate session stickiness or false to deactivate session stickiness.

  • If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName request parameter, then the attributeValue request parameter must be an interger that represents the cookie duration in seconds.

  • If you specify HttpsRedirectionEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection.

  • If you specify TlsPolicyName for the attributeName request parameter, then the attributeValue request parameter must be the name of the TLS policy.

    Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

', ], ], 'SubjectAlternativeNameList' => [ 'base' => NULL, 'refs' => [ 'Certificate$subjectAlternativeNames' => '

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

', 'CreateCertificateRequest$subjectAlternativeNames' => '

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.

You can specify a maximum of nine alternate domains (in addition to the primary domain name).

Wildcard domain entries (e.g., *.example.com) are not supported.

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

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

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

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

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

The tag keys to delete from the specified resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'Bucket$tags' => '

The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'Certificate$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'CertificateSummary$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'ContainerService$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'CreateBucketRequest$tags' => '

The tag keys and optional values to add to the bucket during creation.

Use the TagResource action to tag the bucket after it\'s created.

', 'CreateCertificateRequest$tags' => '

The tag keys and optional values to add to the certificate during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateContainerServiceRequest$tags' => '

The tag keys and optional values to add to the container service during create.

Use the TagResource action to tag a resource after it\'s created.

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'CreateDiskFromSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateDiskRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateDiskSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateDistributionRequest$tags' => '

The tag keys and optional values to add to the distribution during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateDomainRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateInstanceSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateInstancesFromSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateInstancesRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateKeyPairRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateLoadBalancerRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateLoadBalancerTlsCertificateRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateRelationalDatabaseFromSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateRelationalDatabaseRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateRelationalDatabaseSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'Disk$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'DiskSnapshot$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'Domain$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'Instance$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'InstanceSnapshot$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'KeyPair$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'LightsailDistribution$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'LoadBalancer$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'LoadBalancerTlsCertificate$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'RelationalDatabase$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'RelationalDatabaseSnapshot$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'TagResourceRequest$tags' => '

The tag key and optional value.

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

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

', ], ], 'TestAlarmRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestAlarmResult' => [ 'base' => NULL, 'refs' => [], ], 'TimeOfDay' => [ 'base' => NULL, 'refs' => [ 'AddOn$snapshotTimeOfDay' => '

The daily time when an automatic snapshot is created.

The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).

The snapshot is automatically created between the time shown and up to 45 minutes after.

', 'AddOn$nextSnapshotTimeOfDay' => '

The next daily time an automatic snapshot will be created.

The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).

The snapshot is automatically created between the time shown and up to 45 minutes after.

', 'AutoSnapshotAddOnRequest$snapshotTimeOfDay' => '

The daily time when an automatic snapshot will be created.

Constraints:

  • Must be in HH:00 format, and in an hourly increment.

  • Specified in Coordinated Universal Time (UTC).

  • The snapshot will be automatically created between the time specified and up to 45 minutes after.

', ], ], 'TimePeriod' => [ 'base' => '

Sets the start date and end date for retrieving a cost estimate. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

', 'refs' => [ 'EstimateByTime$timePeriod' => '

The period of time, in days, that an estimate covers. The period has a start date and an end date. The start date must come before the end date.

', ], ], 'TreatMissingData' => [ 'base' => NULL, 'refs' => [ 'Alarm$treatMissingData' => '

Specifies how the alarm handles missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

  • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

  • ignore - Ignore the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

', 'PutAlarmRequest$treatMissingData' => '

Sets how this alarm will handle missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

  • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

  • ignore - Ignore the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

If treatMissingData is not specified, the default behavior of missing is used.

', ], ], 'UnauthenticatedException' => [ 'base' => '

Lightsail throws this exception when the user has not been authenticated.

', 'refs' => [], ], 'UnpeerVpcRequest' => [ 'base' => NULL, 'refs' => [], ], 'UnpeerVpcResult' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBucketBundleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBucketBundleResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBucketResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerServiceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDistributionBundleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDistributionBundleResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDistributionResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainEntryRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainEntryResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInstanceMetadataOptionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInstanceMetadataOptionsResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLoadBalancerAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLoadBalancerAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseParametersRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'boolean' => [ 'base' => NULL, 'refs' => [ 'AccessRules$allowPublicOverrides' => '

A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

', 'AccountLevelBpaSync$bpaImpactsLightsail' => '

A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.

', 'Alarm$notificationEnabled' => '

Indicates whether the alarm is enabled.

', 'AttachDiskRequest$autoMounting' => '

A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default value is False.

This value only applies to Lightsail for Research resources.

', 'Blueprint$isActive' => '

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

', 'Bucket$ableToUpdateBundle' => '

Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

You can update a bucket\'s bundle only one time within a monthly Amazon Web Services billing cycle.

Use the UpdateBucketBundle action to change a bucket\'s bundle.

', 'BucketAccessLogConfig$enabled' => '

A Boolean value that indicates whether bucket access logging is enabled for the bucket.

', 'BucketBundle$isActive' => '

Indicates whether the bundle is active. Use for a new or existing bucket.

', 'Bundle$isActive' => '

A Boolean value indicating whether the bundle is active.

', 'ContainerService$isDisabled' => '

A Boolean value indicating whether the container service is disabled.

', 'ContainerServiceECRImagePullerRole$isActive' => '

A Boolean value that indicates whether the role is activated.

', 'ContainerServiceECRImagePullerRoleRequest$isActive' => '

A Boolean value that indicates whether to activate the role.

', 'ContainerServicePower$isActive' => '

A Boolean value indicating whether the power is active and can be specified for container services.

', 'CopySnapshotRequest$useLatestRestorableAutoSnapshot' => '

A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.

Constraints:

  • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

  • Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateBucketRequest$enableObjectVersioning' => '

A Boolean value that indicates whether to enable versioning of objects in the bucket.

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'CreateDiskFromSnapshotRequest$useLatestRestorableAutoSnapshot' => '

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

  • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

  • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateInstancesFromSnapshotRequest$useLatestRestorableAutoSnapshot' => '

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

  • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

  • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateRelationalDatabaseFromSnapshotRequest$publiclyAccessible' => '

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

', 'CreateRelationalDatabaseFromSnapshotRequest$useLatestRestorableTime' => '

Specifies whether your database is restored from the latest backup time. A value of true restores from the latest backup time.

Default: false

Constraints: Cannot be specified if the restore time parameter is provided.

', 'CreateRelationalDatabaseRequest$publiclyAccessible' => '

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

', 'DeleteBucketRequest$forceDelete' => '

A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

  • The bucket is the origin of a distribution.

  • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.

  • The bucket has objects.

  • The bucket has access keys.

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

', 'DeleteDiskRequest$forceDeleteAddOns' => '

A Boolean value to indicate whether to delete all add-ons for the disk.

', 'DeleteInstanceRequest$forceDeleteAddOns' => '

A Boolean value to indicate whether to delete all add-ons for the instance.

', 'DeleteLoadBalancerTlsCertificateRequest$force' => '

When true, forces the deletion of an SSL/TLS certificate.

There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.

', 'DeleteRelationalDatabaseRequest$skipFinalSnapshot' => '

Determines whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted.

You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false.

Default: false

', 'Disk$isSystemDisk' => '

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

', 'Disk$isAttached' => '

A Boolean value indicating whether the disk is attached.

', 'DiskInfo$isSystemDisk' => '

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

', 'DiskSnapshot$isFromAutoSnapshot' => '

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

', 'DistributionBundle$isActive' => '

Indicates whether the bundle is active, and can be specified for a new or existing distribution.

', 'DomainEntry$isAlias' => '

When true, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another Amazon Web Services resource. You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other Amazon Web Services resource and routes traffic to that resource.

', 'GetBlueprintsRequest$includeInactive' => '

A Boolean value that indicates whether to include inactive (unavailable) blueprints in the response of your request.

', 'GetBucketBundlesRequest$includeInactive' => '

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

', 'GetBucketsRequest$includeConnectedResources' => '

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

', 'GetBundlesRequest$includeInactive' => '

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

', 'GetKeyPairsRequest$includeDefaultKeyPair' => '

A Boolean value that indicates whether to include the default key pair in the response of your request.

', 'GetRegionsRequest$includeAvailabilityZones' => '

A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-2a.

', 'GetRegionsRequest$includeRelationalDatabaseAvailabilityZones' => '

A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., us-east-2a).

', 'GetRelationalDatabaseBundlesRequest$includeInactive' => '

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

', 'GetRelationalDatabaseLogEventsRequest$startFromHead' => '

Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log.

For PostgreSQL, the default value of false is the only option available.

', 'Instance$isStaticIp' => '

A Boolean value indicating whether this instance has a static IP assigned to it.

', 'InstanceSnapshot$isFromAutoSnapshot' => '

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

', 'IsVpcPeeredResult$isPeered' => '

Returns true if the Lightsail VPC is peered; otherwise, false.

', 'LightsailDistribution$isEnabled' => '

Indicates whether the distribution is enabled.

', 'LightsailDistribution$ableToUpdateBundle' => '

Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.

Use the UpdateDistributionBundle action to change your distribution\'s bundle.

', 'LoadBalancer$httpsRedirectionEnabled' => '

A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.

', 'LoadBalancerTlsCertificate$isAttached' => '

When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

', 'LoadBalancerTlsCertificateSummary$isAttached' => '

When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

', 'LoadBalancerTlsPolicy$isDefault' => '

A Boolean value that indicates whether the TLS security policy is the default.

', 'Operation$isTerminal' => '

A Boolean value indicating whether the operation is terminal.

', 'PendingModifiedRelationalDatabaseValues$backupRetentionEnabled' => '

A Boolean value indicating whether automated backup retention is enabled.

', 'PutAlarmRequest$notificationEnabled' => '

Indicates whether the alarm is enabled.

Notifications are enabled by default if you don\'t specify this parameter.

', 'QueryStringObject$option' => '

Indicates whether the distribution forwards and caches based on query strings.

', 'RelationalDatabase$backupRetentionEnabled' => '

A Boolean value indicating whether automated backup retention is enabled for the database.

', 'RelationalDatabase$publiclyAccessible' => '

A Boolean value indicating whether the database is publicly accessible.

', 'RelationalDatabaseBlueprint$isEngineDefault' => '

A Boolean value indicating whether the engine version is the default for the database blueprint.

', 'RelationalDatabaseBundle$isEncrypted' => '

A Boolean value indicating whether the database bundle is encrypted.

', 'RelationalDatabaseBundle$isActive' => '

A Boolean value indicating whether the database bundle is active.

', 'RelationalDatabaseParameter$isModifiable' => '

A Boolean value indicating whether the parameter can be modified.

', 'Session$isPrimary' => '

When true, this Boolean value indicates the primary session for the specified resource.

', 'StaticIp$isAttached' => '

A Boolean value indicating whether the static IP is attached.

', 'StopInstanceRequest$force' => '

When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.

Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

', 'UpdateContainerServiceRequest$isDisabled' => '

A Boolean value to indicate whether the container service is disabled.

', 'UpdateDistributionRequest$isEnabled' => '

Indicates whether to enable the distribution.

', 'UpdateRelationalDatabaseRequest$rotateMasterUserPassword' => '

When true, the master user password is changed to a new strong password generated by Lightsail.

Use the get relational database master user password operation to get the new password.

', 'UpdateRelationalDatabaseRequest$enableBackupRetention' => '

When true, enables automated backup retention for your database.

Updates are applied during the next maintenance window because this can result in an outage.

', 'UpdateRelationalDatabaseRequest$disableBackupRetention' => '

When true, disables automated backup retention for your database.

Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

Updates are applied during the next maintenance window because this can result in an outage.

', 'UpdateRelationalDatabaseRequest$publiclyAccessible' => '

Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

', 'UpdateRelationalDatabaseRequest$applyImmediately' => '

When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

Default: false

', ], ], 'double' => [ 'base' => NULL, 'refs' => [ 'Alarm$threshold' => '

The value against which the specified statistic is compared.

', 'EstimateByTime$usageCost' => '

The amount of cost or usage that\'s measured for the cost estimate.

', 'EstimateByTime$unit' => '

The number of pricing units used to calculate the total number of hours. For example, 1 unit equals 1 hour.

', 'MetricDatapoint$average' => '

The average.

', 'MetricDatapoint$maximum' => '

The maximum.

', 'MetricDatapoint$minimum' => '

The minimum.

', 'MetricDatapoint$sampleCount' => '

The sample count.

', 'MetricDatapoint$sum' => '

The sum.

', 'PutAlarmRequest$threshold' => '

The value against which the specified statistic is compared.

', ], ], 'float' => [ 'base' => NULL, 'refs' => [ 'BucketBundle$price' => '

The monthly price of the bundle, in US dollars.

', 'Bundle$price' => '

The price in US dollars (e.g., 5.0) of the bundle.

', 'Bundle$ramSizeInGb' => '

The amount of RAM in GB (e.g., 2.0).

', 'ContainerServicePower$price' => '

The monthly price of the power in USD.

', 'ContainerServicePower$cpuCount' => '

The number of vCPUs included in the power.

', 'ContainerServicePower$ramSizeInGb' => '

The amount of RAM (in GB) of the power.

', 'DistributionBundle$price' => '

The monthly price, in US dollars, of the bundle.

', 'InstanceHardware$ramSizeInGb' => '

The amount of RAM in GB on the instance (e.g., 1.0).

', 'RelationalDatabaseBundle$price' => '

The cost of the database bundle in US currency.

', 'RelationalDatabaseBundle$ramSizeInGb' => '

The amount of RAM in GB (for example, 2.0) for the database bundle.

', 'RelationalDatabaseHardware$ramSizeInGb' => '

The amount of RAM in GB for the database.

', ], ], 'integer' => [ 'base' => NULL, 'refs' => [ 'Alarm$evaluationPeriods' => '

The number of periods over which data is compared to the specified threshold.

', 'Alarm$datapointsToAlarm' => '

The number of data points that must not within the specified threshold to trigger the alarm.

', 'AttachedDisk$sizeInGb' => '

The size of the disk in GB.

', 'Blueprint$minPower' => '

The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.

', 'BucketBundle$storagePerMonthInGb' => '

The storage size of the bundle, in GB.

', 'BucketBundle$transferPerMonthInGb' => '

The monthly network transfer quota of the bundle.

', 'Bundle$cpuCount' => '

The number of vCPUs included in the bundle (e.g., 2).

', 'Bundle$diskSizeInGb' => '

The size of the SSD (e.g., 30).

', 'Bundle$power' => '

A numeric value that represents the power of the bundle (e.g., 500). You can use the bundle\'s power value in conjunction with a blueprint\'s minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.

', 'Bundle$transferPerMonthInGb' => '

The data transfer rate per month in GB (e.g., 2000).

', 'ContainerServiceDeployment$version' => '

The version number of the deployment.

', 'ContainerServiceEndpoint$containerPort' => '

The port of the specified container to which traffic is forwarded to.

', 'ContainerServiceHealthCheckConfig$healthyThreshold' => '

The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

', 'ContainerServiceHealthCheckConfig$unhealthyThreshold' => '

The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

', 'ContainerServiceHealthCheckConfig$timeoutSeconds' => '

The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

', 'ContainerServiceHealthCheckConfig$intervalSeconds' => '

The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

', 'CreateDiskFromSnapshotRequest$sizeInGb' => '

The size of the disk in GB (e.g., 32).

', 'CreateDiskRequest$sizeInGb' => '

The size of the disk in GB (e.g., 32).

', 'CreateGUISessionAccessDetailsResult$percentageComplete' => '

The percentage of completion for the operation.

', 'Disk$sizeInGb' => '

The size of the disk in GB.

', 'Disk$iops' => '

The input/output operations per second (IOPS) of the disk.

', 'Disk$gbInUse' => '

(Deprecated) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

', 'DiskInfo$sizeInGb' => '

The size of the disk in GB (e.g., 32).

', 'DiskSnapshot$sizeInGb' => '

The size of the disk in GB.

', 'DiskSnapshotInfo$sizeInGb' => '

The size of the disk in GB (e.g., 32).

', 'DistributionBundle$transferPerMonthInGb' => '

The monthly network transfer quota of the bundle.

', 'EndpointRequest$containerPort' => '

The port of the container to which traffic is forwarded to.

', 'GetRelationalDatabaseEventsRequest$durationInMinutes' => '

The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.

Default: 60

The minimum is 1 and the maximum is 14 days (20160 minutes).

', 'InstanceHardware$cpuCount' => '

The number of vCPUs the instance has.

', 'InstanceMetadataOptions$httpPutResponseHopLimit' => '

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

', 'InstanceSnapshot$sizeInGb' => '

The size in GB of the SSD.

', 'InstanceState$code' => '

The status code for the instance.

', 'LoadBalancer$instancePort' => '

The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it\'s port 80. For HTTPS traffic, it\'s port 443.

', 'MonthlyTransfer$gbPerMonthAllocated' => '

The amount allocated per month (in GB).

', 'PutAlarmRequest$evaluationPeriods' => '

The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.

Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).

', 'PutAlarmRequest$datapointsToAlarm' => '

The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.

', 'RelationalDatabaseBundle$diskSizeInGb' => '

The size of the disk for the database bundle.

', 'RelationalDatabaseBundle$transferPerMonthInGb' => '

The data transfer rate per month in GB for the database bundle.

', 'RelationalDatabaseBundle$cpuCount' => '

The number of virtual CPUs (vCPUs) for the database bundle.

', 'RelationalDatabaseEndpoint$port' => '

Specifies the port that the database is listening on.

', 'RelationalDatabaseHardware$cpuCount' => '

The number of vCPUs for the database.

', 'RelationalDatabaseHardware$diskSizeInGb' => '

The size of the disk for the database.

', 'RelationalDatabaseSnapshot$sizeInGb' => '

The size of the disk in GB (for example, 32) for the database snapshot.

', 'UpdateInstanceMetadataOptionsRequest$httpPutResponseHopLimit' => '

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.

', ], ], 'long' => [ 'base' => NULL, 'refs' => [ 'CacheSettings$defaultTTL' => '

The default amount of time that objects stay in the distribution\'s cache before the distribution forwards another request to the origin to determine whether the content has been updated.

The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

', 'CacheSettings$minimumTTL' => '

The minimum amount of time that objects stay in the distribution\'s cache before the distribution forwards another request to the origin to determine whether the object has been updated.

A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.

', 'CacheSettings$maximumTTL' => '

The maximum amount of time that objects stay in the distribution\'s cache before the distribution forwards another request to the origin to determine whether the object has been updated.

The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

', ], ], 'string' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$code' => NULL, 'AccessDeniedException$docs' => NULL, 'AccessDeniedException$message' => NULL, 'AccessDeniedException$tip' => NULL, 'AccessKeyLastUsed$region' => '

The Amazon Web Services Region where this access key was most recently used.

This value is N/A if the access key has not been used.

', 'AccessKeyLastUsed$serviceName' => '

The name of the Amazon Web Services service with which this access key was most recently used.

This value is N/A if the access key has not been used.

', 'AccountSetupInProgressException$code' => NULL, 'AccountSetupInProgressException$docs' => NULL, 'AccountSetupInProgressException$message' => NULL, 'AccountSetupInProgressException$tip' => NULL, 'AddOn$name' => '

The name of the add-on.

', 'AddOn$status' => '

The status of the add-on.

', 'AddOn$threshold' => '

The trigger threshold of the action.

This add-on only applies to Lightsail for Research resources.

', 'AddOn$duration' => '

The amount of idle time in minutes after which your virtual computer will automatically stop.

This add-on only applies to Lightsail for Research resources.

', 'Alarm$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

', 'AttachedDisk$path' => '

The path of the disk (e.g., /dev/xvdf).

', 'AutoSnapshotDetails$date' => '

The date of the automatic snapshot in YYYY-MM-DD format.

', 'Blueprint$description' => '

The description of the blueprint.

', 'Blueprint$version' => '

The version number of the operating system, application, or stack (e.g., 2016.03.0).

', 'Blueprint$versionCode' => '

The version code.

', 'Blueprint$productUrl' => '

The product URL to learn more about the image or blueprint.

', 'Blueprint$licenseUrl' => '

The end-user license agreement URL for the image or blueprint.

', 'BucketState$message' => '

A message that describes the state of the bucket.

', 'Bundle$instanceType' => '

The Amazon EC2 instance type (e.g., t2.micro).

', 'Bundle$name' => '

A friendly name for the bundle (e.g., Micro).

', 'CacheBehaviorPerPath$path' => '

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

  • Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

    var/www/html/

  • Specify the following file to cache only the index page in the document root of an Apache web server.

    var/www/html/index.html

  • Specify the following to cache only the .html files in the document root of an Apache web server.

    var/www/html/*.html

  • Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

    var/www/html/images/*.jpg

    var/www/html/images/*.png

    var/www/html/images/*.gif

    Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

    var/www/html/images/

', 'Certificate$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

', 'ContactMethod$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.

', 'Container$image' => '

The name of the image used for the container.

Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third (3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.

Container images sourced from a public registry like Docker Hub don\'t start with a colon. For example, nginx:latest or nginx.

', 'ContainerImage$image' => '

The name of the container image.

', 'ContainerImage$digest' => '

The digest of the container image.

', 'ContainerService$powerId' => '

The ID of the power of the container service.

', 'ContainerService$principalArn' => '

The principal ARN of the container service.

The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your service permission to access resources in your standard Amazon Web Services account.

', 'ContainerService$privateDomainName' => '

The private domain name of the container service.

The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.

', 'ContainerService$url' => '

The publicly accessible URL of the container service.

If no public endpoint is specified in the currentDeployment, this URL returns a 404 response.

', 'ContainerServiceECRImagePullerRole$principalArn' => '

The Amazon Resource Name (ARN) of the role, if it is activated.

', 'ContainerServiceEndpoint$containerName' => '

The name of the container entry of the deployment that the endpoint configuration applies to.

', 'ContainerServiceHealthCheckConfig$path' => '

The path on the container on which to perform the health check. The default value is /.

', 'ContainerServiceHealthCheckConfig$successCodes' => '

The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

', 'ContainerServiceLogEvent$message' => '

The message of the container service log event.

', 'ContainerServiceMetadataEntry$key' => NULL, 'ContainerServiceMetadataEntry$value' => NULL, 'ContainerServicePower$powerId' => '

The ID of the power (e.g., nano-1).

', 'ContainerServicePower$name' => '

The friendly name of the power (e.g., nano).

', 'ContainerServicePublicDomains$key' => NULL, 'ContainerServicePublicDomainsList$member' => NULL, 'ContainerServiceRegistryLogin$username' => '

The container service registry username to use to push container images to the container image registry of a Lightsail account.

', 'ContainerServiceRegistryLogin$password' => '

The container service registry password to use to push container images to the container image registry of a Lightsail account

', 'ContainerServiceRegistryLogin$registry' => '

The address to use to push container images to the container image registry of a Lightsail account.

', 'ContainerServiceStateDetail$message' => '

A message that provides more information for the state code.

The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

', 'CopySnapshotRequest$sourceResourceName' => '

The name of the source instance or disk from which the source automatic snapshot was created.

Constraint:

', 'CopySnapshotRequest$restoreDate' => '

The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

  • Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDiskFromSnapshotRequest$sourceDiskName' => '

The name of the source disk from which the source automatic snapshot was created.

Constraints:

  • This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.

  • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDiskFromSnapshotRequest$restoreDate' => '

The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

  • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDistributionRequest$bundleId' => '

The bundle ID to use for the distribution.

A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.

Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

', 'CreateGUISessionAccessDetailsResult$failureReason' => '

The reason the operation failed.

', 'CreateInstancesFromSnapshotRequest$availabilityZone' => '

The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

', 'CreateInstancesFromSnapshotRequest$userData' => '

You can create a launch script that configures a server with additional user data. For example, apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

', 'CreateInstancesFromSnapshotRequest$sourceInstanceName' => '

The name of the source instance from which the source automatic snapshot was created.

Constraints:

  • This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.

  • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateInstancesFromSnapshotRequest$restoreDate' => '

The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

  • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateInstancesRequest$availabilityZone' => '

The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

', 'CreateInstancesRequest$userData' => '

A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

', 'CreateLoadBalancerRequest$healthCheckPath' => '

The path you provided to perform the load balancer health check. If you didn\'t specify a health check path, Lightsail uses the root path of your website (e.g., "/").

You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

', 'CreateLoadBalancerRequest$tlsPolicyName' => '

The name of the TLS policy to apply to the load balancer.

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

', 'CreateRelationalDatabaseFromSnapshotRequest$availabilityZone' => '

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

', 'CreateRelationalDatabaseFromSnapshotRequest$relationalDatabaseBundleId' => '

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.

', 'CreateRelationalDatabaseRequest$availabilityZone' => '

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

', 'CreateRelationalDatabaseRequest$relationalDatabaseBlueprintId' => '

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

', 'CreateRelationalDatabaseRequest$relationalDatabaseBundleId' => '

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

', 'CreateRelationalDatabaseRequest$masterDatabaseName' => '

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn\'t specified, no database is created in the database resource.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can\'t be a word reserved by the specified database engine.

    For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn\'t specified, a database named postgres is created in the database resource.

Constraints:

  • Must contain 1 to 63 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can\'t be a word reserved by the specified database engine.

    For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

', 'CreateRelationalDatabaseRequest$masterUsername' => '

The name for the master user.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

', 'CreateRelationalDatabaseRequest$preferredBackupWindow' => '

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service documentation.

Constraints:

  • Must be in the hh24:mi-hh24:mi format.

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'CreateRelationalDatabaseRequest$preferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur on your new database.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Constraints:

  • Must be in the ddd:hh24:mi-ddd:hh24:mi format.

  • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

', 'DeleteContainerImageRequest$image' => '

The name of the container image to delete from the container service.

Use the GetContainerImages action to get the name of the container images that are registered to a container service.

Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, :container-service-1.mystaticwebsite.1. Container images sourced from a public registry like Docker Hub don\'t start with a colon. For example, nginx:latest or nginx.

', 'DeleteKeyPairRequest$expectedFingerprint' => '

The RSA fingerprint of the Lightsail default key pair to delete.

The expectedFingerprint parameter is required only when specifying to delete a Lightsail default key pair.

', 'Disk$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'Disk$path' => '

The disk path.

', 'Disk$attachmentState' => '

(Deprecated) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

', 'DiskInfo$name' => '

The disk name.

', 'DiskSnapshot$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'DiskSnapshot$progress' => '

The progress of the snapshot.

', 'DistributionBundle$bundleId' => '

The ID of the bundle.

', 'DistributionBundle$name' => '

The name of the distribution bundle.

', 'DnsRecordCreationState$message' => '

The message that describes the reason for the status code.

', 'Domain$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'DomainEntry$target' => '

The target IP address (e.g., 192.0.2.0), or AWS name server (e.g., ns-111.awsdns-22.com.).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.

', 'DomainEntryOptions$value' => NULL, 'EndpointRequest$containerName' => '

The name of the container for the endpoint.

', 'Environment$key' => NULL, 'Environment$value' => NULL, 'GetActiveNamesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetActiveNames request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetActiveNamesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetActiveNames request and specify the next page token using the pageToken parameter.

', 'GetAlarmsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetAlarmsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetAlarms request and specify the next page token using the pageToken parameter.

', 'GetBlueprintsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBlueprints request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetBlueprintsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetBlueprints request and specify the next page token using the pageToken parameter.

', 'GetBucketsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetBucketsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetBuckets request and specify the next page token using the pageToken parameter.

', 'GetBundlesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetBundlesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetBundles request and specify the next page token using the pageToken parameter.

', 'GetCertificatesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetCertificates request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetCertificatesResult$nextPageToken' => '

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

', 'GetCloudFormationStackRecordsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetClouFormationStackRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetCloudFormationStackRecordsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetCloudFormationStackRecords request and specify the next page token using the pageToken parameter.

', 'GetContainerLogRequest$containerName' => '

The name of the container that is either running or previously ran on the container service for which to return a log.

', 'GetContainerLogRequest$filterPattern' => '

The pattern to use to filter the returned log events to a specific term.

The following are a few examples of filter patterns that you can specify:

  • To return all log events, specify a filter pattern of "".

  • To exclude log events that contain the ERROR term, and return all other log events, specify a filter pattern of "-ERROR".

  • To return log events that contain the ERROR term, specify a filter pattern of "ERROR".

  • To return log events that contain both the ERROR and Exception terms, specify a filter pattern of "ERROR Exception".

  • To return log events that contain the ERROR or the Exception term, specify a filter pattern of "?ERROR ?Exception".

', 'GetContainerLogRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetContainerLog request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetContainerLogResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetContainerLog request and specify the next page token using the pageToken parameter.

', 'GetDiskSnapshotsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDiskSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetDiskSnapshotsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDiskSnapshots request and specify the next page token using the pageToken parameter.

', 'GetDisksRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDisks request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetDisksResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter.

', 'GetDistributionLatestCacheResetResult$status' => '

The status of the last cache reset.

', 'GetDistributionsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDistributions request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetDistributionsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDistributions request and specify the next page token using the pageToken parameter.

', 'GetDomainsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDomains request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetDomainsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDomains request and specify the next page token using the pageToken parameter.

', 'GetExportSnapshotRecordsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetExportSnapshotRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetExportSnapshotRecordsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetExportSnapshotRecords request and specify the next page token using the pageToken parameter.

', 'GetInstanceSnapshotsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetInstanceSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetInstanceSnapshotsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetInstanceSnapshots request and specify the next page token using the pageToken parameter.

', 'GetInstancesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetInstances request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetInstancesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter.

', 'GetKeyPairsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetKeyPairsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter.

', 'GetLoadBalancerTlsPoliciesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetLoadBalancerTlsPolicies request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetLoadBalancerTlsPoliciesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetLoadBalancerTlsPolicies request and specify the next page token using the pageToken parameter.

', 'GetLoadBalancersRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetLoadBalancers request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetLoadBalancersResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetLoadBalancers request and specify the next page token using the pageToken parameter.

', 'GetOperationsForResourceRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetOperationsForResource request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetOperationsForResourceResult$nextPageCount' => '

(Deprecated) Returns the number of pages of results that remain.

In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated, and the API returns the next page token parameter instead.

', 'GetOperationsForResourceResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetOperationsForResource request and specify the next page token using the pageToken parameter.

', 'GetOperationsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetOperations request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetOperationsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetOperations request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabaseBlueprintsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseBlueprints request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseBlueprintsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseBlueprints request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabaseBundlesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseBundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseBundlesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseBundles request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabaseEventsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseEvents request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseEventsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseEvents request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabaseLogEventsRequest$logStreamName' => '

The name of the log stream.

Use the get relational database log streams operation to get a list of available log streams.

', 'GetRelationalDatabaseLogEventsRequest$pageToken' => '

The token to advance to the next or previous page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseLogEvents request. If your results are paginated, the response will return a next forward token and/or next backward token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseLogEventsResult$nextBackwardToken' => '

A token used for advancing to the previous page of results from your get relational database log events request.

', 'GetRelationalDatabaseLogEventsResult$nextForwardToken' => '

A token used for advancing to the next page of results from your get relational database log events request.

', 'GetRelationalDatabaseParametersRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseParameters request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseParametersResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseParameters request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabaseSnapshotsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseSnapshotsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseSnapshots request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabasesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabases request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabasesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabases request and specify the next page token using the pageToken parameter.

', 'GetStaticIpsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetStaticIps request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetStaticIpsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetStaticIps request and specify the next page token using the pageToken parameter.

', 'HostKeyAttributes$algorithm' => '

The SSH host key algorithm or the RDP certificate format.

For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the algorithm is always x509-cert.

', 'HostKeyAttributes$publicKey' => '

The public SSH host key or the RDP certificate.

', 'HostKeyAttributes$fingerprintSHA1' => '

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

  • Example of an SHA-1 SSH fingerprint:

    SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0

  • Example of an SHA-1 RDP fingerprint:

    af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45

', 'HostKeyAttributes$fingerprintSHA256' => '

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

  • Example of an SHA-256 SSH fingerprint:

    SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o

  • Example of an SHA-256 RDP fingerprint:

    03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68

', 'Instance$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'InstanceAccessDetails$certKey' => '

For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.

', 'InstanceAccessDetails$password' => '

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you create an instance using any key pair other than the default (LightsailDefaultKeyPair), password will always be an empty string.

If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

', 'InstanceAccessDetails$privateKey' => '

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).

', 'InstanceAccessDetails$username' => '

The user name to use when logging in to the Amazon Lightsail instance.

', 'InstanceEntry$userData' => '

A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg.

', 'InstanceEntry$availabilityZone' => '

The Availability Zone for the new Amazon EC2 instance.

', 'InstancePortInfo$accessFrom' => '

The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or Custom if a specific IP address or range of IP addresses is allowed.

', 'InstancePortInfo$commonName' => '

The common name of the port information.

', 'InstanceSnapshot$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'InstanceSnapshot$progress' => '

The progress of the snapshot.

This is populated only for disk snapshots, and is null for instance snapshots.

', 'InstanceSnapshot$fromBlueprintId' => '

The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.

', 'InstanceSnapshot$fromBundleId' => '

The bundle ID from which you created the snapshot (e.g., micro_1_0).

', 'InstanceState$name' => '

The state of the instance (e.g., running or pending).

', 'InvalidInputException$code' => NULL, 'InvalidInputException$docs' => NULL, 'InvalidInputException$message' => NULL, 'InvalidInputException$tip' => NULL, 'KeyPair$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'LightsailDistribution$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.

', 'LightsailDistribution$status' => '

The status of the distribution.

', 'LightsailDistribution$domainName' => '

The domain name of the distribution.

', 'LightsailDistribution$bundleId' => '

The ID of the bundle currently applied to the distribution.

', 'LightsailDistribution$originPublicDNS' => '

The public DNS of the origin.

', 'LoadBalancer$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

', 'LoadBalancerConfigurationOptions$value' => NULL, 'LoadBalancerTlsCertificate$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.

', 'LoadBalancerTlsCertificateDnsRecordCreationState$message' => '

The message that describes the reason for the status code.

', 'LoadBalancerTlsPolicy$description' => '

The description of the TLS security policy.

', 'LogEvent$message' => '

The message of the database log event.

', 'NameServersUpdateState$message' => '

The message that describes the reason for the status code.

', 'NotFoundException$code' => NULL, 'NotFoundException$docs' => NULL, 'NotFoundException$message' => NULL, 'NotFoundException$tip' => NULL, 'Operation$operationDetails' => '

Details about the operation (e.g., Debian-1GB-Ohio-1).

', 'Operation$errorCode' => '

The error code.

', 'Operation$errorDetails' => '

The error details.

', 'OperationFailureException$code' => NULL, 'OperationFailureException$docs' => NULL, 'OperationFailureException$message' => NULL, 'OperationFailureException$tip' => NULL, 'PasswordData$ciphertext' => '

The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available in the password field.

If you are using a custom key pair, you need to use your own means of decryption.

If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

', 'PendingModifiedRelationalDatabaseValues$masterUserPassword' => '

The password for the master user of the database.

', 'PendingModifiedRelationalDatabaseValues$engineVersion' => '

The database engine version.

', 'PortMap$key' => NULL, 'R53HostedZoneDeletionState$message' => '

The message that describes the reason for the status code.

', 'Region$continentCode' => '

The continent code (e.g., NA, meaning North America).

', 'Region$description' => '

The description of the Amazon Web Services Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).

', 'Region$displayName' => '

The display name (e.g., Ohio).

', 'RegisterContainerImageRequest$digest' => '

The digest of the container image to be registered.

', 'RelationalDatabase$supportCode' => '

The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'RelationalDatabase$masterDatabaseName' => '

The name of the master database created when the Lightsail database resource is created.

', 'RelationalDatabase$secondaryAvailabilityZone' => '

Describes the secondary Availability Zone of a high availability database.

The secondary database is used for failover support of a high availability database.

', 'RelationalDatabase$caCertificateIdentifier' => '

The certificate associated with the database.

', 'RelationalDatabaseBlueprint$blueprintId' => '

The ID for the database blueprint.

', 'RelationalDatabaseBlueprint$engineVersion' => '

The database engine version for the database blueprint (for example, 5.7.23).

', 'RelationalDatabaseBlueprint$engineDescription' => '

The description of the database engine for the database blueprint.

', 'RelationalDatabaseBlueprint$engineVersionDescription' => '

The description of the database engine version for the database blueprint.

', 'RelationalDatabaseBundle$bundleId' => '

The ID for the database bundle.

', 'RelationalDatabaseBundle$name' => '

The name for the database bundle.

', 'RelationalDatabaseEvent$message' => '

The message of the database event.

', 'RelationalDatabaseParameter$allowedValues' => '

Specifies the valid range of values for the parameter.

', 'RelationalDatabaseParameter$applyMethod' => '

Indicates when parameter updates are applied.

Can be immediate or pending-reboot.

', 'RelationalDatabaseParameter$applyType' => '

Specifies the engine-specific parameter type.

', 'RelationalDatabaseParameter$dataType' => '

Specifies the valid data type for the parameter.

', 'RelationalDatabaseParameter$description' => '

Provides a description of the parameter.

', 'RelationalDatabaseParameter$parameterName' => '

Specifies the name of the parameter.

', 'RelationalDatabaseParameter$parameterValue' => '

Specifies the value of the parameter.

', 'RelationalDatabaseSnapshot$supportCode' => '

The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'RelationalDatabaseSnapshot$fromRelationalDatabaseBundleId' => '

The bundle ID of the database from which the database snapshot was created.

', 'RelationalDatabaseSnapshot$fromRelationalDatabaseBlueprintId' => '

The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.

', 'ResetDistributionCacheResult$status' => '

The status of the reset cache request.

', 'ResourceLocation$availabilityZone' => '

The Availability Zone. Follows the format us-east-2a (case-sensitive).

', 'ResourceRecord$name' => '

The name of the record.

', 'ResourceRecord$type' => '

The DNS record type.

', 'ResourceRecord$value' => '

The value for the DNS record.

', 'ServiceException$code' => NULL, 'ServiceException$docs' => NULL, 'ServiceException$message' => NULL, 'ServiceException$tip' => NULL, 'StaticIp$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'StopInstanceOnIdleRequest$threshold' => '

The value to compare with the duration.

', 'StopInstanceOnIdleRequest$duration' => '

The amount of idle time in minutes after which your virtual computer will automatically stop.

', 'StringList$member' => NULL, 'UnauthenticatedException$code' => NULL, 'UnauthenticatedException$docs' => NULL, 'UnauthenticatedException$message' => NULL, 'UnauthenticatedException$tip' => NULL, 'UpdateDistributionBundleRequest$bundleId' => '

The bundle ID of the new bundle to apply to your distribution.

Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

', 'UpdateRelationalDatabaseRequest$preferredBackupWindow' => '

The daily time range during which automated backups are created for your database if automated backups are enabled.

Constraints:

  • Must be in the hh24:mi-hh24:mi format.

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'UpdateRelationalDatabaseRequest$preferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur on your database.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Constraints:

  • Must be in the ddd:hh24:mi-ddd:hh24:mi format.

  • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

', 'UpdateRelationalDatabaseRequest$caCertificateIdentifier' => '

Indicates the certificate that needs to be associated with the database.

', ], ], 'timestamp' => [ 'base' => NULL, 'refs' => [ 'GetDistributionMetricDataRequest$startTime' => '

The start of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetDistributionMetricDataRequest$endTime' => '

The end of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetInstanceMetricDataRequest$startTime' => '

The start time of the time period.

', 'GetInstanceMetricDataRequest$endTime' => '

The end time of the time period.

', 'GetLoadBalancerMetricDataRequest$startTime' => '

The start time of the period.

', 'GetLoadBalancerMetricDataRequest$endTime' => '

The end time of the period.

', 'MetricDatapoint$timestamp' => '

The timestamp (e.g., 1479816991.349).

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

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.

You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.

', 'operations' => [ 'AllocateStaticIp' => '

Allocates a static IP address.

', 'AttachCertificateToDistribution' => '

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.

Use the CreateCertificate action to create a certificate that you can attach to your distribution.

Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

', 'AttachDisk' => '

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.

', 'AttachInstancesToLoadBalancer' => '

Attaches one or more Lightsail instances to a load balancer.

After some time, the instances are attached to the load balancer and the health check status is available.

The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Developer Guide.

', 'AttachLoadBalancerTlsCertificate' => '

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).

Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate.

The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'AttachStaticIp' => '

Attaches a static IP address to a specific Amazon Lightsail instance.

', 'CloseInstancePublicPorts' => '

Closes ports for a specific Amazon Lightsail instance.

The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.

', 'CopySnapshot' => '

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.

When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.

', 'CreateBucket' => '

Creates an Amazon Lightsail bucket.

A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'CreateBucketAccessKey' => '

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.

', 'CreateCertificate' => '

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.

After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service.

Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

', 'CreateCloudFormationStack' => '

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created.

Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.

', 'CreateContactMethod' => '

Creates an email or SMS text message contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

', 'CreateContainerService' => '

Creates an Amazon Lightsail container service.

A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.

', 'CreateContainerServiceDeployment' => '

Creates a deployment for your Amazon Lightsail container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

', 'CreateContainerServiceRegistryLogin' => '

Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you\'re logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.

You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.

After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.

This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

', 'CreateDisk' => '

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).

The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDiskFromSnapshot' => '

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDiskSnapshot' => '

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.

You can also use this operation to create a snapshot of an instance\'s system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance\'s system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDistribution' => '

Creates an Amazon Lightsail content delivery network (CDN) distribution.

A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.

', 'CreateDomain' => '

Creates a domain resource for the specified domain (example.com).

The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDomainEntry' => '

Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateGUISessionAccessDetails' => '

Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer\'s application. The secondary URL initiates a web-based NICE DCV session to the virtual computer\'s operating session.

Use StartGUISession to open the session.

', 'CreateInstanceSnapshot' => '

Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.

The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateInstances' => '

Creates one or more Amazon Lightsail instances.

The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide.

', 'CreateInstancesFromSnapshot' => '

Creates one or more new instances from a manual or automatic snapshot of an instance.

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateKeyPair' => '

Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.

The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateLoadBalancer' => '

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.

When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.

The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateLoadBalancerTlsCertificate' => '

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateRelationalDatabase' => '

Creates a new database in Amazon Lightsail.

The create relational database operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateRelationalDatabaseFromSnapshot' => '

Creates a new database from an existing database snapshot in Amazon Lightsail.

You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.

The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateRelationalDatabaseSnapshot' => '

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.

The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteAlarm' => '

Deletes an alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

', 'DeleteAutoSnapshot' => '

Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteBucket' => '

Deletes a Amazon Lightsail bucket.

When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.

', 'DeleteBucketAccessKey' => '

Deletes an access key for the specified Amazon Lightsail bucket.

We recommend that you delete an access key if the secret access key is compromised.

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'DeleteCertificate' => '

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.

Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.

', 'DeleteContactMethod' => '

Deletes a contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

', 'DeleteContainerImage' => '

Deletes a container image that is registered to your Amazon Lightsail container service.

', 'DeleteContainerService' => '

Deletes your Amazon Lightsail container service.

', 'DeleteDisk' => '

Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).

The disk may remain in the deleting state for several minutes.

The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteDiskSnapshot' => '

Deletes the specified disk snapshot.

When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.

The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteDistribution' => '

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

', 'DeleteDomain' => '

Deletes the specified domain recordset and all of its domain records.

The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteDomainEntry' => '

Deletes a specific domain entry.

The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteInstance' => '

Deletes an Amazon Lightsail instance.

The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteInstanceSnapshot' => '

Deletes a specific snapshot of a virtual private server (or instance).

The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteKeyPair' => '

Deletes the specified key pair by removing the public key from Amazon Lightsail.

You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.

The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteKnownHostKeys' => '

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.

Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.

', 'DeleteLoadBalancer' => '

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.

The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteLoadBalancerTlsCertificate' => '

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteRelationalDatabase' => '

Deletes a database in Amazon Lightsail.

The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'DeleteRelationalDatabaseSnapshot' => '

Deletes a database snapshot in Amazon Lightsail.

The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'DetachCertificateFromDistribution' => '

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.

', 'DetachDisk' => '

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.

The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.

', 'DetachInstancesFromLoadBalancer' => '

Detaches the specified instances from a Lightsail load balancer.

This operation waits until the instances are no longer needed before they are detached from the load balancer.

The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'DetachStaticIp' => '

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

', 'DisableAddOn' => '

Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

', 'DownloadDefaultKeyPair' => '

Downloads the regional Amazon Lightsail default key pair.

This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.

', 'EnableAddOn' => '

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

', 'ExportSnapshot' => '

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.

The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Amazon Lightsail Developer Guide.

Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.

', 'GetActiveNames' => '

Returns the names of all active (not deleted) resources.

', 'GetAlarms' => '

Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

', 'GetAutoSnapshots' => '

Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

', 'GetBlueprints' => '

Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

', 'GetBucketAccessKeys' => '

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.

', 'GetBucketBundles' => '

Returns the bundles that you can apply to a Amazon Lightsail bucket.

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to update the bundle for a bucket.

', 'GetBucketMetricData' => '

Returns the data points of a specific metric for an Amazon Lightsail bucket.

Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.

', 'GetBuckets' => '

Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'GetBundles' => '

Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.

A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.

Bundles are referred to as instance plans in the Lightsail console.

', 'GetCertificates' => '

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

To get a summary of a certificate, omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

', 'GetCloudFormationStackRecords' => '

Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.

', 'GetContactMethods' => '

Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

', 'GetContainerAPIMetadata' => '

Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.

', 'GetContainerImages' => '

Returns the container images that are registered to your Amazon Lightsail container service.

If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.

', 'GetContainerLog' => '

Returns the log events of a container of your Amazon Lightsail container service.

If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.

Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.

', 'GetContainerServiceDeployments' => '

Returns the deployments for your Amazon Lightsail container service

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.

A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.

', 'GetContainerServiceMetricData' => '

Returns the data points of a specific metric of your Amazon Lightsail container service.

Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

', 'GetContainerServicePowers' => '

Returns the list of powers that can be specified for your Amazon Lightsail container services.

The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.

', 'GetContainerServices' => '

Returns information about one or more of your Amazon Lightsail container services.

', 'GetCostEstimate' => '

Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.

', 'GetDisk' => '

Returns information about a specific block storage disk.

', 'GetDiskSnapshot' => '

Returns information about a specific block storage disk snapshot.

', 'GetDiskSnapshots' => '

Returns information about all block storage disk snapshots in your AWS account and region.

', 'GetDisks' => '

Returns information about all block storage disks in your AWS account and region.

', 'GetDistributionBundles' => '

Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.

A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

', 'GetDistributionLatestCacheReset' => '

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.

', 'GetDistributionMetricData' => '

Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

', 'GetDistributions' => '

Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.

', 'GetDomain' => '

Returns information about a specific domain recordset.

', 'GetDomains' => '

Returns a list of all domains in the user\'s account.

', 'GetExportSnapshotRecords' => '

Returns all export snapshot records created as a result of the export snapshot operation.

An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the CreateCloudFormationStack action.

', 'GetInstance' => '

Returns information about a specific Amazon Lightsail instance, which is a virtual private server.

', 'GetInstanceAccessDetails' => '

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

', 'GetInstanceMetricData' => '

Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

', 'GetInstancePortStates' => '

Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

', 'GetInstanceSnapshot' => '

Returns information about a specific instance snapshot.

', 'GetInstanceSnapshots' => '

Returns all instance snapshots for the user\'s account.

', 'GetInstanceState' => '

Returns the state of a specific instance. Works on one instance at a time.

', 'GetInstances' => '

Returns information about all Amazon Lightsail virtual private servers, or instances.

', 'GetKeyPair' => '

Returns information about a specific key pair.

', 'GetKeyPairs' => '

Returns information about all key pairs in the user\'s account.

', 'GetLoadBalancer' => '

Returns information about the specified Lightsail load balancer.

', 'GetLoadBalancerMetricData' => '

Returns information about health metrics for your Lightsail load balancer.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

', 'GetLoadBalancerTlsCertificates' => '

Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.

', 'GetLoadBalancerTlsPolicies' => '

Returns a list of TLS security policies that you can apply to Lightsail load balancers.

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

', 'GetLoadBalancers' => '

Returns information about all load balancers in an account.

', 'GetOperation' => '

Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.

', 'GetOperations' => '

Returns information about all operations.

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.

', 'GetOperationsForResource' => '

Gets operations for a specific resource (an instance or a static IP).

', 'GetRegions' => '

Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.

', 'GetRelationalDatabase' => '

Returns information about a specific database in Amazon Lightsail.

', 'GetRelationalDatabaseBlueprints' => '

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

You can use a blueprint ID to create a new database that runs a specific database engine.

', 'GetRelationalDatabaseBundles' => '

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.

You can use a bundle ID to create a new database with explicit performance specifications.

', 'GetRelationalDatabaseEvents' => '

Returns a list of events for a specific database in Amazon Lightsail.

', 'GetRelationalDatabaseLogEvents' => '

Returns a list of log events for a database in Amazon Lightsail.

', 'GetRelationalDatabaseLogStreams' => '

Returns a list of available log streams for a specific database in Amazon Lightsail.

', 'GetRelationalDatabaseMasterUserPassword' => '

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

', 'GetRelationalDatabaseMetricData' => '

Returns the data points of the specified metric for a database in Amazon Lightsail.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

', 'GetRelationalDatabaseParameters' => '

Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.

In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.

', 'GetRelationalDatabaseSnapshot' => '

Returns information about a specific database snapshot in Amazon Lightsail.

', 'GetRelationalDatabaseSnapshots' => '

Returns information about all of your database snapshots in Amazon Lightsail.

', 'GetRelationalDatabases' => '

Returns information about all of your databases in Amazon Lightsail.

', 'GetSetupHistory' => '

Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance.

', 'GetStaticIp' => '

Returns information about an Amazon Lightsail static IP.

', 'GetStaticIps' => '

Returns information about all static IPs in the user\'s account.

', 'ImportKeyPair' => '

Imports a public SSH key from a specific key pair.

', 'IsVpcPeered' => '

Returns a Boolean value indicating whether your Lightsail VPC is peered.

', 'OpenInstancePublicPorts' => '

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.

The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.

', 'PeerVpc' => '

Peers the Lightsail VPC with the user\'s default VPC.

', 'PutAlarm' => '

Creates or updates an alarm, and associates it with the specified metric.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.

', 'PutInstancePublicPorts' => '

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports.

The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.

', 'RebootInstance' => '

Restarts a specific instance.

The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

', 'RebootRelationalDatabase' => '

Restarts a specific database in Amazon Lightsail.

The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'RegisterContainerImage' => '

Registers a container image to your Amazon Lightsail container service.

This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

', 'ReleaseStaticIp' => '

Deletes a specific static IP from your account.

', 'ResetDistributionCache' => '

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.

After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.

', 'SendContactMethodVerification' => '

Sends a verification request to an email contact method to ensure it\'s owned by the requester. SMS contact methods don\'t need to be verified.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.

Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.

', 'SetIpAddressType' => '

Sets the IP address type for an Amazon Lightsail resource.

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.

', 'SetResourceAccessForBucket' => '

Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.

', 'SetupInstanceHttps' => '

Creates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance.

If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length.

', 'StartGUISession' => '

Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.

', 'StartInstance' => '

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

', 'StartRelationalDatabase' => '

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.

The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'StopGUISession' => '

Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.

', 'StopInstance' => '

Stops a specific Amazon Lightsail instance that is currently running.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

', 'StopRelationalDatabase' => '

Stops a specific database that is currently running in Amazon Lightsail.

The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'TagResource' => '

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide.

The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide.

', 'TestAlarm' => '

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

', 'UnpeerVpc' => '

Unpeers the Lightsail VPC from the user\'s default VPC.

', 'UntagResource' => '

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.

The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide.

', 'UpdateBucket' => '

Updates an existing Amazon Lightsail bucket.

Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.

', 'UpdateBucketBundle' => '

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket\'s bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update a bucket\'s bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket\'s bundle.

Update a bucket\'s bundle if it\'s consistently going over its storage space or data transfer quota, or if a bucket\'s usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket\'s bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.

', 'UpdateContainerService' => '

Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.

', 'UpdateDistribution' => '

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

Use this action to update the configuration of your existing distribution.

', 'UpdateDistributionBundle' => '

Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.

A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

Update your distribution\'s bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.

You can update your distribution\'s bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution\'s bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution\'s bundle.

', 'UpdateDomainEntry' => '

Updates a domain recordset after it is created.

The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

', 'UpdateInstanceMetadataOptions' => '

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance or GetInstances API operation initially responds with a state of pending. After the parameter modifications are successfully applied, the state changes to applied in subsequent GetInstance or GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.

', 'UpdateLoadBalancerAttribute' => '

Updates the specified attribute for a load balancer. You can only update one attribute at a time.

The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

', 'UpdateRelationalDatabase' => '

Allows the update of one or more attributes of a database in Amazon Lightsail.

Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database\'s predefined maintenance window.

The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

', 'UpdateRelationalDatabaseParameters' => '

Allows the update of one or more parameters of a database in Amazon Lightsail.

Parameter updates don\'t cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.

The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

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

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

', 'refs' => [], ], 'AccessDirection' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$accessDirection' => '

The access direction (inbound or outbound).

Lightsail currently supports only inbound access direction.

', ], ], 'AccessKey' => [ 'base' => '

Describes an access key for an Amazon Lightsail bucket.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.

', 'refs' => [ 'AccessKeyList$member' => NULL, 'CreateBucketAccessKeyResult$accessKey' => '

An object that describes the access key that is created.

', ], ], 'AccessKeyLastUsed' => [ 'base' => '

Describes the last time an access key was used.

This object does not include data in the response of a CreateBucketAccessKey action.

', 'refs' => [ 'AccessKey$lastUsed' => '

An object that describes the last time the access key was used.

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

', ], ], 'AccessKeyList' => [ 'base' => NULL, 'refs' => [ 'GetBucketAccessKeysResult$accessKeys' => '

An object that describes the access keys for the specified bucket.

', ], ], 'AccessReceiverList' => [ 'base' => NULL, 'refs' => [ 'Bucket$resourcesReceivingAccess' => '

An array of objects that describe Lightsail instances that have access to the bucket.

Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

', ], ], 'AccessRules' => [ 'base' => '

Describes the anonymous access permissions for an Amazon Lightsail bucket and its objects.

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the

Amazon Lightsail Developer Guide.

', 'refs' => [ 'Bucket$accessRules' => '

An object that describes the access rules of the bucket.

', 'UpdateBucketRequest$accessRules' => '

An object that sets the public accessibility of objects in the specified bucket.

', ], ], 'AccessType' => [ 'base' => NULL, 'refs' => [ 'AccessRules$getObject' => '

Specifies the anonymous access to all objects in a bucket.

The following options can be specified:

  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

    If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

    If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

', ], ], 'AccountLevelBpaSync' => [ 'base' => '

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access (BPA) feature for your Lightsail buckets.

The account-level BPA feature of Amazon S3 provides centralized controls to limit public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and object permissions that are configured. Lightsail buckets take into account the Amazon S3 account-level BPA configuration when allowing or denying public access. To do this, Lightsail periodically fetches the account-level BPA configuration from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'GetBucketsResult$accountLevelBpaSync' => '

An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.

For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

', ], ], 'AccountLevelBpaSyncStatus' => [ 'base' => NULL, 'refs' => [ 'AccountLevelBpaSync$status' => '

The status of the account-level BPA synchronization.

The following statuses are possible:

  • InSync - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to your Lightsail buckets.

  • NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.

  • Failed - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.

  • Defaulted - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to active.

You might need to complete further actions if the status is Failed or Defaulted. The message parameter provides more information for those statuses.

', ], ], 'AccountSetupInProgressException' => [ 'base' => '

Lightsail throws this exception when an account is still in the setup in progress state.

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

Describes an add-on that is enabled for an Amazon Lightsail resource.

', 'refs' => [ 'AddOnList$member' => NULL, ], ], 'AddOnList' => [ 'base' => NULL, 'refs' => [ 'Disk$addOns' => '

An array of objects representing the add-ons enabled on the disk.

', 'Instance$addOns' => '

An array of objects representing the add-ons enabled on the instance.

', ], ], 'AddOnRequest' => [ 'base' => '

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page.

', 'refs' => [ 'AddOnRequestList$member' => NULL, 'EnableAddOnRequest$addOnRequest' => '

An array of strings representing the add-on to enable or modify.

', ], ], 'AddOnRequestList' => [ 'base' => NULL, 'refs' => [ 'CreateDiskFromSnapshotRequest$addOns' => '

An array of objects that represent the add-ons to enable for the new disk.

', 'CreateDiskRequest$addOns' => '

An array of objects that represent the add-ons to enable for the new disk.

', 'CreateInstancesFromSnapshotRequest$addOns' => '

An array of objects representing the add-ons to enable for the new instance.

', 'CreateInstancesRequest$addOns' => '

An array of objects representing the add-ons to enable for the new instance.

', ], ], 'AddOnType' => [ 'base' => NULL, 'refs' => [ 'AddOnRequest$addOnType' => '

The add-on type.

', 'DisableAddOnRequest$addOnType' => '

The add-on type to disable.

', ], ], 'Alarm' => [ 'base' => '

Describes an alarm.

An alarm is a way to monitor your Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.

', 'refs' => [ 'AlarmsList$member' => NULL, ], ], 'AlarmState' => [ 'base' => NULL, 'refs' => [ 'Alarm$state' => '

The current state of the alarm.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

', 'NotificationTriggerList$member' => NULL, 'TestAlarmRequest$state' => '

The alarm state to test.

An alarm has the following possible states that can be tested:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

', ], ], 'AlarmsList' => [ 'base' => NULL, 'refs' => [ 'GetAlarmsResult$alarms' => '

An array of objects that describe the alarms.

', ], ], 'AllocateStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocateStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'AppCategory' => [ 'base' => NULL, 'refs' => [ 'AppCategoryList$member' => NULL, 'Blueprint$appCategory' => '

Virtual computer blueprints that are supported by Lightsail for Research.

This parameter only applies to Lightsail for Research resources.

', 'GetBlueprintsRequest$appCategory' => '

Returns a list of blueprints that are specific to Lightsail for Research.

You must use this parameter to view Lightsail for Research blueprints.

', 'GetBundlesRequest$appCategory' => '

Returns a list of bundles that are specific to Lightsail for Research.

You must use this parameter to view Lightsail for Research bundles.

', ], ], 'AppCategoryList' => [ 'base' => NULL, 'refs' => [ 'Bundle$supportedAppCategories' => '

Virtual computer blueprints that are supported by a Lightsail for Research bundle.

This parameter only applies to Lightsail for Research resources.

', ], ], 'AttachCertificateToDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachCertificateToDistributionResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachInstancesToLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachInstancesToLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTlsCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachLoadBalancerTlsCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'AttachStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'AttachedDisk' => [ 'base' => '

Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot.

', 'refs' => [ 'AttachedDiskList$member' => NULL, ], ], 'AttachedDiskList' => [ 'base' => NULL, 'refs' => [ 'AutoSnapshotDetails$fromAttachedDisks' => '

An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created.

', ], ], 'AttachedDiskMap' => [ 'base' => NULL, 'refs' => [ 'CreateInstancesFromSnapshotRequest$attachedDiskMapping' => '

An object containing information about one or more disk mappings.

', ], ], 'AutoMountStatus' => [ 'base' => NULL, 'refs' => [ 'Disk$autoMountStatus' => '

The status of automatically mounting a storage disk to a virtual computer.

This parameter only applies to Lightsail for Research resources.

', ], ], 'AutoSnapshotAddOnRequest' => [ 'base' => '

Describes a request to enable or modify the automatic snapshot add-on for an Amazon Lightsail instance or disk.

When you modify the automatic snapshot time for a resource, it is typically effective immediately except under the following conditions:

  • If an automatic snapshot has been created for the current day, and you change the snapshot time to a later time of day, then the new snapshot time will be effective the following day. This ensures that two snapshots are not created for the current day.

  • If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to an earlier time of day, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day.

  • If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to a time that is within 30 minutes from your current time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.

  • If an automatic snapshot is scheduled to be created within 30 minutes from your current time and you change the snapshot time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.

', 'refs' => [ 'AddOnRequest$autoSnapshotAddOnRequest' => '

An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.

', ], ], 'AutoSnapshotDate' => [ 'base' => NULL, 'refs' => [ 'DeleteAutoSnapshotRequest$date' => '

The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the get auto snapshots operation to get the available automatic snapshots for a resource.

', ], ], 'AutoSnapshotDetails' => [ 'base' => '

Describes an automatic snapshot.

', 'refs' => [ 'AutoSnapshotDetailsList$member' => NULL, ], ], 'AutoSnapshotDetailsList' => [ 'base' => NULL, 'refs' => [ 'GetAutoSnapshotsResult$autoSnapshots' => '

An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.

', ], ], 'AutoSnapshotStatus' => [ 'base' => NULL, 'refs' => [ 'AutoSnapshotDetails$status' => '

The status of the automatic snapshot.

', ], ], 'AvailabilityZone' => [ 'base' => '

Describes an Availability Zone. This is returned only as part of a GetRegions request.

', 'refs' => [ 'AvailabilityZoneList$member' => NULL, ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'Region$availabilityZones' => '

The Availability Zones. Follows the format us-east-2a (case-sensitive).

', 'Region$relationalDatabaseAvailabilityZones' => '

The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).

', ], ], 'BPAStatusMessage' => [ 'base' => NULL, 'refs' => [ 'AccountLevelBpaSync$message' => '

A message that provides a reason for a Failed or Defaulted synchronization status.

The following messages are possible:

  • SYNC_ON_HOLD - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.

  • DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to active until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.

  • DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.

  • Unknown - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.

', ], ], 'Base64' => [ 'base' => NULL, 'refs' => [ 'CreateKeyPairResult$publicKeyBase64' => '

A base64-encoded public key of the ssh-rsa type.

', 'CreateKeyPairResult$privateKeyBase64' => '

A base64-encoded RSA private key.

', 'DownloadDefaultKeyPairResult$publicKeyBase64' => '

A base64-encoded public key of the ssh-rsa type.

', 'DownloadDefaultKeyPairResult$privateKeyBase64' => '

A base64-encoded RSA private key.

', 'ImportKeyPairRequest$publicKeyBase64' => '

A base64-encoded public key of the ssh-rsa type.

', 'KeyPair$fingerprint' => '

The RSA fingerprint of the key pair.

', ], ], 'BehaviorEnum' => [ 'base' => NULL, 'refs' => [ 'CacheBehavior$behavior' => '

The cache behavior of the distribution.

The following cache behaviors can be specified:

  • cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn\'t change depending on who views it, or for websites that don\'t use cookies, headers, or query strings to personalize content.

  • dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution\'s CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.

', 'CacheBehaviorPerPath$behavior' => '

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

  • cache - This behavior caches the specified path.

  • dont-cache - This behavior doesn\'t cache the specified path.

', ], ], 'Blueprint' => [ 'base' => '

Describes a blueprint (a virtual private server image).

', 'refs' => [ 'BlueprintList$member' => NULL, ], ], 'BlueprintList' => [ 'base' => NULL, 'refs' => [ 'GetBlueprintsResult$blueprints' => '

An array of key-value pairs that contains information about the available blueprints.

', ], ], 'BlueprintType' => [ 'base' => NULL, 'refs' => [ 'Blueprint$type' => '

The type of the blueprint (os or app).

', ], ], 'Bucket' => [ 'base' => '

Describes an Amazon Lightsail bucket.

', 'refs' => [ 'BucketList$member' => NULL, 'CreateBucketResult$bucket' => '

An object that describes the bucket that is created.

', 'UpdateBucketResult$bucket' => '

An object that describes the bucket that is updated.

', ], ], 'BucketAccessLogConfig' => [ 'base' => '

Describes the access log configuration for a bucket in the Amazon Lightsail object storage service.

For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'Bucket$accessLogConfig' => '

An object that describes the access log configuration for the bucket.

', 'UpdateBucketRequest$accessLogConfig' => '

An object that describes the access log configuration for the bucket.

', ], ], 'BucketAccessLogPrefix' => [ 'base' => NULL, 'refs' => [ 'BucketAccessLogConfig$prefix' => '

The optional object prefix for the bucket access log.

The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a logs/ prefix, then each log object will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).

This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.

', ], ], 'BucketBundle' => [ 'base' => '

Describes the specifications of a bundle that can be applied to an Amazon Lightsail bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

', 'refs' => [ 'BucketBundleList$member' => NULL, ], ], 'BucketBundleList' => [ 'base' => NULL, 'refs' => [ 'GetBucketBundlesResult$bundles' => '

An object that describes bucket bundles.

', ], ], 'BucketList' => [ 'base' => NULL, 'refs' => [ 'GetBucketsResult$buckets' => '

An array of objects that describe buckets.

', ], ], 'BucketMetricName' => [ 'base' => NULL, 'refs' => [ 'GetBucketMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

These bucket metrics are reported once per day.

  • BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Maximum.

    Unit: The published unit is Bytes.

  • NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Count.

', 'GetBucketMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'Bucket$name' => '

The name of the bucket.

', 'BucketAccessLogConfig$destination' => '

The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.

This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.

', 'CreateBucketAccessKeyRequest$bucketName' => '

The name of the bucket that the new access key will belong to, and grant access to.

', 'CreateBucketRequest$bucketName' => '

The name for the bucket.

For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'DeleteBucketAccessKeyRequest$bucketName' => '

The name of the bucket that the access key belongs to.

', 'DeleteBucketRequest$bucketName' => '

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

', 'GetBucketAccessKeysRequest$bucketName' => '

The name of the bucket for which to return access keys.

', 'GetBucketMetricDataRequest$bucketName' => '

The name of the bucket for which to get metric data.

', 'GetBucketsRequest$bucketName' => '

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the Amazon Web Services Region where the request is made.

', 'SetResourceAccessForBucketRequest$bucketName' => '

The name of the bucket for which to set access to another Lightsail resource.

', 'UpdateBucketBundleRequest$bucketName' => '

The name of the bucket for which to update the bundle.

', 'UpdateBucketRequest$bucketName' => '

The name of the bucket to update.

', ], ], 'BucketState' => [ 'base' => '

Describes the state of an Amazon Lightsail bucket.

', 'refs' => [ 'Bucket$state' => '

An object that describes the state of the bucket.

', ], ], 'Bundle' => [ 'base' => '

Describes a bundle, which is a set of specs describing your virtual private server (or instance).

', 'refs' => [ 'BundleList$member' => NULL, ], ], 'BundleList' => [ 'base' => NULL, 'refs' => [ 'GetBundlesResult$bundles' => '

An array of key-value pairs that contains information about the available bundles.

', ], ], 'CacheBehavior' => [ 'base' => '

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

', 'refs' => [ 'CreateDistributionRequest$defaultCacheBehavior' => '

An object that describes the default cache behavior for the distribution.

', 'LightsailDistribution$defaultCacheBehavior' => '

An object that describes the default cache behavior of the distribution.

', 'UpdateDistributionRequest$defaultCacheBehavior' => '

An object that describes the default cache behavior for the distribution.

', ], ], 'CacheBehaviorList' => [ 'base' => NULL, 'refs' => [ 'CreateDistributionRequest$cacheBehaviors' => '

An array of objects that describe the per-path cache behavior for the distribution.

', 'LightsailDistribution$cacheBehaviors' => '

An array of objects that describe the per-path cache behavior of the distribution.

', 'UpdateDistributionRequest$cacheBehaviors' => '

An array of objects that describe the per-path cache behavior for the distribution.

', ], ], 'CacheBehaviorPerPath' => [ 'base' => '

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution\'s cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.

', 'refs' => [ 'CacheBehaviorList$member' => NULL, ], ], 'CacheSettings' => [ 'base' => '

Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.

These settings apply only to your distribution\'s cacheBehaviors (including the defaultCacheBehavior) that have a behavior of cache.

', 'refs' => [ 'CreateDistributionRequest$cacheBehaviorSettings' => '

An object that describes the cache behavior settings for the distribution.

', 'LightsailDistribution$cacheBehaviorSettings' => '

An object that describes the cache behavior settings of the distribution.

', 'UpdateDistributionRequest$cacheBehaviorSettings' => '

An object that describes the cache behavior settings for the distribution.

The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution\'s existing settings.

', ], ], 'Certificate' => [ 'base' => '

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

To get a summary of a certificate, use the GetCertificates action and omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

', 'refs' => [ 'CertificateSummary$certificateDetail' => '

An object that describes a certificate in detail.

', ], ], 'CertificateDomainValidationStatus' => [ 'base' => NULL, 'refs' => [ 'DomainValidationRecord$validationStatus' => '

The validation status of the record.

', ], ], 'CertificateName' => [ 'base' => NULL, 'refs' => [ 'Certificate$name' => '

The name of the certificate (my-certificate).

', 'CertificateSummary$certificateName' => '

The name of the certificate.

', 'CreateCertificateRequest$certificateName' => '

The name for the certificate.

', 'DeleteCertificateRequest$certificateName' => '

The name of the certificate to delete.

Use the GetCertificates action to get a list of certificate names that you can specify.

', 'GetCertificatesRequest$certificateName' => '

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.

', ], ], 'CertificateProvider' => [ 'base' => NULL, 'refs' => [ 'SetupInstanceHttpsRequest$certificateProvider' => '

The certificate authority that issues the SSL/TLS certificate.

', 'SetupRequest$certificateProvider' => '

The Certificate Authority (CA) that issues the SSL/TLS certificate.

', ], ], 'CertificateStatus' => [ 'base' => NULL, 'refs' => [ 'Certificate$status' => '

The validation status of the certificate.

', 'CertificateStatusList$member' => NULL, ], ], 'CertificateStatusList' => [ 'base' => NULL, 'refs' => [ 'GetCertificatesRequest$certificateStatuses' => '

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.

', ], ], 'CertificateSummary' => [ 'base' => '

Describes an Amazon Lightsail SSL/TLS certificate.

', 'refs' => [ 'CertificateSummaryList$member' => NULL, 'CreateCertificateResult$certificate' => '

An object that describes the certificate created.

', ], ], 'CertificateSummaryList' => [ 'base' => NULL, 'refs' => [ 'GetCertificatesResult$certificates' => '

An object that describes certificates.

', ], ], 'CloseInstancePublicPortsRequest' => [ 'base' => NULL, 'refs' => [], ], 'CloseInstancePublicPortsResult' => [ 'base' => NULL, 'refs' => [], ], 'CloudFormationStackRecord' => [ 'base' => '

Describes a CloudFormation stack record created as a result of the create cloud formation stack action.

A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

', 'refs' => [ 'CloudFormationStackRecordList$member' => NULL, ], ], 'CloudFormationStackRecordList' => [ 'base' => NULL, 'refs' => [ 'GetCloudFormationStackRecordsResult$cloudFormationStackRecords' => '

A list of objects describing the CloudFormation stack records.

', ], ], 'CloudFormationStackRecordSourceInfo' => [ 'base' => '

Describes the source of a CloudFormation stack record (i.e., the export snapshot record).

', 'refs' => [ 'CloudFormationStackRecordSourceInfoList$member' => NULL, ], ], 'CloudFormationStackRecordSourceInfoList' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecord$sourceInfo' => '

A list of objects describing the source of the CloudFormation stack record.

', ], ], 'CloudFormationStackRecordSourceType' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecordSourceInfo$resourceType' => '

The Lightsail resource type (ExportSnapshotRecord).

', ], ], 'ComparisonOperator' => [ 'base' => NULL, 'refs' => [ 'Alarm$comparisonOperator' => '

The arithmetic operation used when comparing the specified statistic and threshold.

', 'PutAlarmRequest$comparisonOperator' => '

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

', ], ], 'ContactMethod' => [ 'base' => '

Describes a contact method.

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.

', 'refs' => [ 'ContactMethodsList$member' => NULL, ], ], 'ContactMethodStatus' => [ 'base' => NULL, 'refs' => [ 'ContactMethod$status' => '

The current status of the contact method.

A contact method has the following possible status:

  • PendingVerification - The contact method has not yet been verified, and the verification has not yet expired.

  • Valid - The contact method has been verified.

  • InValid - An attempt was made to verify the contact method, but the verification has expired.

', ], ], 'ContactMethodVerificationProtocol' => [ 'base' => NULL, 'refs' => [ 'SendContactMethodVerificationRequest$protocol' => '

The protocol to verify, such as Email or SMS (text messaging).

', ], ], 'ContactMethodsList' => [ 'base' => NULL, 'refs' => [ 'GetContactMethodsResult$contactMethods' => '

An array of objects that describe the contact methods.

', ], ], 'ContactProtocol' => [ 'base' => NULL, 'refs' => [ 'ContactMethod$protocol' => '

The protocol of the contact method, such as email or SMS (text messaging).

', 'ContactProtocolsList$member' => NULL, 'CreateContactMethodRequest$protocol' => '

The protocol of the contact method, such as Email or SMS (text messaging).

The SMS protocol is supported only in the following Amazon Web Services Regions.

  • US East (N. Virginia) (us-east-1)

  • US West (Oregon) (us-west-2)

  • Europe (Ireland) (eu-west-1)

  • Asia Pacific (Tokyo) (ap-northeast-1)

  • Asia Pacific (Singapore) (ap-southeast-1)

  • Asia Pacific (Sydney) (ap-southeast-2)

For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

', 'DeleteContactMethodRequest$protocol' => '

The protocol that will be deleted, such as Email or SMS (text messaging).

To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol.

', ], ], 'ContactProtocolsList' => [ 'base' => NULL, 'refs' => [ 'Alarm$contactProtocols' => '

The contact protocols for the alarm, such as Email, SMS (text messaging), or both.

', 'GetContactMethodsRequest$protocols' => '

The protocols used to send notifications, such as Email, or SMS (text messaging).

Specify a protocol in your request to return information about a specific contact method protocol.

', 'PutAlarmRequest$contactProtocols' => '

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the Amazon Web Services Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an Amazon Web Services Region.

', ], ], 'Container' => [ 'base' => '

Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.

', 'refs' => [ 'ContainerMap$value' => NULL, ], ], 'ContainerImage' => [ 'base' => '

Describes a container image that is registered to an Amazon Lightsail container service.

', 'refs' => [ 'ContainerImageList$member' => NULL, 'RegisterContainerImageResult$containerImage' => '

An object that describes a container image that is registered to a Lightsail container service

', ], ], 'ContainerImageList' => [ 'base' => NULL, 'refs' => [ 'GetContainerImagesResult$containerImages' => '

An array of objects that describe container images that are registered to the container service.

', ], ], 'ContainerLabel' => [ 'base' => NULL, 'refs' => [ 'RegisterContainerImageRequest$label' => '

The label for the container image when it\'s registered to the container service.

Use a descriptive label that you can use to track the different versions of your registered container images.

Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the <imagelabel> portion of the following image name example:

  • :container-service-1.<imagelabel>.1

If the name of your container service is mycontainerservice, and the label that you specify is mystaticwebsite, then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1.

The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2. If you push and register another container image, the version number will be 3, and so on.

', ], ], 'ContainerMap' => [ 'base' => NULL, 'refs' => [ 'ContainerServiceDeployment$containers' => '

An object that describes the configuration for the containers of the deployment.

', 'ContainerServiceDeploymentRequest$containers' => '

An object that describes the configuration for the containers of the deployment.

', 'CreateContainerServiceDeploymentRequest$containers' => '

An object that describes the settings of the containers that will be launched on the container service.

', ], ], 'ContainerName' => [ 'base' => NULL, 'refs' => [ 'ContainerMap$key' => NULL, ], ], 'ContainerService' => [ 'base' => '

Describes an Amazon Lightsail container service.

', 'refs' => [ 'ContainerServiceList$member' => NULL, 'CreateContainerServiceDeploymentResult$containerService' => '

An object that describes a container service.

', 'CreateContainerServiceResult$containerService' => '

An object that describes a container service.

', 'UpdateContainerServiceResult$containerService' => '

An object that describes a container service.

', ], ], 'ContainerServiceDeployment' => [ 'base' => '

Describes a container deployment configuration of an Amazon Lightsail container service.

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

', 'refs' => [ 'ContainerService$currentDeployment' => '

An object that describes the current container deployment of the container service.

', 'ContainerService$nextDeployment' => '

An object that describes the next deployment of the container service.

This value is null when there is no deployment in a pending state.

', 'ContainerServiceDeploymentList$member' => NULL, ], ], 'ContainerServiceDeploymentList' => [ 'base' => NULL, 'refs' => [ 'GetContainerServiceDeploymentsResult$deployments' => '

An array of objects that describe deployments for a container service.

', ], ], 'ContainerServiceDeploymentRequest' => [ 'base' => '

Describes a container deployment configuration of an Amazon Lightsail container service.

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

', 'refs' => [ 'CreateContainerServiceRequest$deployment' => '

An object that describes a deployment for the container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

', ], ], 'ContainerServiceDeploymentState' => [ 'base' => NULL, 'refs' => [ 'ContainerServiceDeployment$state' => '

The state of the deployment.

A deployment can be in one of the following states:

  • ACTIVATING - The deployment is being created.

  • ACTIVE - The deployment was successfully created, and it\'s currently running on the container service. The container service can have only one deployment in an active state at a time.

  • INACTIVE - The deployment was previously successfully created, but it is not currently running on the container service.

  • FAILED - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.

', ], ], 'ContainerServiceECRImagePullerRole' => [ 'base' => '

Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'PrivateRegistryAccess$ecrImagePullerRole' => '

An object that describes the activation status of the role that you can use to grant a Lightsail container service access to Amazon ECR private repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also listed.

', ], ], 'ContainerServiceECRImagePullerRoleRequest' => [ 'base' => '

Describes a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'PrivateRegistryAccessRequest$ecrImagePullerRole' => '

An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

', ], ], 'ContainerServiceEndpoint' => [ 'base' => '

Describes the public endpoint configuration of a deployment of an Amazon Lightsail container service.

', 'refs' => [ 'ContainerServiceDeployment$publicEndpoint' => '

An object that describes the endpoint of the deployment.

', ], ], 'ContainerServiceHealthCheckConfig' => [ 'base' => '

Describes the health check configuration of an Amazon Lightsail container service.

', 'refs' => [ 'ContainerServiceEndpoint$healthCheck' => '

An object that describes the health check configuration of the container.

', 'EndpointRequest$healthCheck' => '

An object that describes the health check configuration of the container.

', ], ], 'ContainerServiceList' => [ 'base' => NULL, 'refs' => [ 'ContainerServicesListResult$containerServices' => '

An array of objects that describe one or more container services.

', ], ], 'ContainerServiceLogEvent' => [ 'base' => '

Describes the log events of a container of an Amazon Lightsail container service.

', 'refs' => [ 'ContainerServiceLogEventList$member' => NULL, ], ], 'ContainerServiceLogEventList' => [ 'base' => NULL, 'refs' => [ 'GetContainerLogResult$logEvents' => '

An array of objects that describe the log events of a container.

', ], ], 'ContainerServiceMetadataEntry' => [ 'base' => NULL, 'refs' => [ 'ContainerServiceMetadataEntryList$member' => NULL, ], ], 'ContainerServiceMetadataEntryList' => [ 'base' => NULL, 'refs' => [ 'GetContainerAPIMetadataResult$metadata' => '

Metadata about Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.

', ], ], 'ContainerServiceMetricName' => [ 'base' => NULL, 'refs' => [ 'GetContainerServiceMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

  • MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

', 'GetContainerServiceMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'ContainerServiceName' => [ 'base' => NULL, 'refs' => [ 'ContainerService$containerServiceName' => '

The name of the container service.

', 'CreateContainerServiceDeploymentRequest$serviceName' => '

The name of the container service for which to create the deployment.

', 'CreateContainerServiceRequest$serviceName' => '

The name for the container service.

The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it\'s located in the US East (Ohio) Amazon Web Services Region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com

The following are the requirements for container service names:

  • Must be unique within each Amazon Web Services Region in your Lightsail account.

  • Must contain 1 to 63 characters.

  • Must contain only alphanumeric characters and hyphens.

  • A hyphen (-) can separate words but cannot be at the start or end of the name.

', 'DeleteContainerImageRequest$serviceName' => '

The name of the container service for which to delete a registered container image.

', 'DeleteContainerServiceRequest$serviceName' => '

The name of the container service to delete.

', 'GetContainerImagesRequest$serviceName' => '

The name of the container service for which to return registered container images.

', 'GetContainerLogRequest$serviceName' => '

The name of the container service for which to get a container log.

', 'GetContainerServiceDeploymentsRequest$serviceName' => '

The name of the container service for which to return deployments.

', 'GetContainerServiceMetricDataRequest$serviceName' => '

The name of the container service for which to get metric data.

', 'GetContainerServicesRequest$serviceName' => '

The name of the container service for which to return information.

When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.

', 'RegisterContainerImageRequest$serviceName' => '

The name of the container service for which to register a container image.

', 'UpdateContainerServiceRequest$serviceName' => '

The name of the container service to update.

', ], ], 'ContainerServicePower' => [ 'base' => '

Describes the powers that can be specified for an Amazon Lightsail container service.

The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

', 'refs' => [ 'ContainerServicePowerList$member' => NULL, ], ], 'ContainerServicePowerList' => [ 'base' => NULL, 'refs' => [ 'GetContainerServicePowersResult$powers' => '

An array of objects that describe the powers that can be specified for a container service.

', ], ], 'ContainerServicePowerName' => [ 'base' => NULL, 'refs' => [ 'ContainerService$power' => '

The power specification of the container service.

The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

', 'CreateContainerServiceRequest$power' => '

The power specification for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

', 'UpdateContainerServiceRequest$power' => '

The power for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to view the specifications of each power option.

', ], ], 'ContainerServiceProtocol' => [ 'base' => NULL, 'refs' => [ 'PortMap$value' => NULL, ], ], 'ContainerServicePublicDomains' => [ 'base' => NULL, 'refs' => [ 'ContainerService$publicDomainNames' => '

The public domain name of the container service, such as example.com and www.example.com.

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

If you don\'t specify public domain names, then you can use the default domain of the container service.

You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service.

', 'CreateContainerServiceRequest$publicDomainNames' => '

The public domain names to use with the container service, such as example.com and www.example.com.

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

If you don\'t specify public domain names, then you can use the default domain of the container service.

You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

You can specify public domain names using a string to array map as shown in the example later on this page.

', 'UpdateContainerServiceRequest$publicDomainNames' => '

The public domain names to use with the container service, such as example.com and www.example.com.

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

If you don\'t specify public domain names, then you can use the default domain of the container service.

You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

You can specify public domain names using a string to array map as shown in the example later on this page.

', ], ], 'ContainerServicePublicDomainsList' => [ 'base' => NULL, 'refs' => [ 'ContainerServicePublicDomains$value' => NULL, ], ], 'ContainerServiceRegistryLogin' => [ 'base' => '

Describes the sign-in credentials for the container image registry of an Amazon Lightsail account.

', 'refs' => [ 'CreateContainerServiceRegistryLoginResult$registryLogin' => '

An object that describes the log in information for the container service registry of your Lightsail account.

', ], ], 'ContainerServiceScale' => [ 'base' => NULL, 'refs' => [ 'ContainerService$scale' => '

The scale specification of the container service.

The scale specifies the allocated compute nodes of the container service.

', 'CreateContainerServiceRequest$scale' => '

The scale specification for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

', 'UpdateContainerServiceRequest$scale' => '

The scale for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

', ], ], 'ContainerServiceState' => [ 'base' => NULL, 'refs' => [ 'ContainerService$state' => '

The current state of the container service.

The following container service states are possible:

  • PENDING - The container service is being created.

  • READY - The container service is running but it does not have an active container deployment.

  • DEPLOYING - The container service is launching a container deployment.

  • RUNNING - The container service is running and it has an active container deployment.

  • UPDATING - The container service capacity or its custom domains are being updated.

  • DELETING - The container service is being deleted.

  • DISABLED - The container service is disabled, and its active deployment and containers, if any, are shut down.

', ], ], 'ContainerServiceStateDetail' => [ 'base' => '

Describes the current state of a container service.

', 'refs' => [ 'ContainerService$stateDetail' => '

An object that describes the current state of the container service.

The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

', ], ], 'ContainerServiceStateDetailCode' => [ 'base' => NULL, 'refs' => [ 'ContainerServiceStateDetail$code' => '

The state code of the container service.

The following state codes are possible:

  • The following state codes are possible if your container service is in a DEPLOYING or UPDATING state:

    • CREATING_SYSTEM_RESOURCES - The system resources for your container service are being created.

    • CREATING_NETWORK_INFRASTRUCTURE - The network infrastructure for your container service are being created.

    • PROVISIONING_CERTIFICATE - The SSL/TLS certificate for your container service is being created.

    • PROVISIONING_SERVICE - Your container service is being provisioned.

    • CREATING_DEPLOYMENT - Your deployment is being created on your container service.

    • EVALUATING_HEALTH_CHECK - The health of your deployment is being evaluated.

    • ACTIVATING_DEPLOYMENT - Your deployment is being activated.

  • The following state codes are possible if your container service is in a PENDING state:

    • CERTIFICATE_LIMIT_EXCEEDED - The SSL/TLS certificate required for your container service exceeds the maximum number of certificates allowed for your account.

    • UNKNOWN_ERROR - An error was experienced when your container service was being created.

', ], ], 'ContainerServicesListResult' => [ 'base' => NULL, 'refs' => [], ], 'CookieObject' => [ 'base' => '

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.

For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.

', 'refs' => [ 'CacheSettings$forwardedCookies' => '

An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.

', ], ], 'CopySnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CopySnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CostEstimate' => [ 'base' => '

Describes the estimated cost for resources in your Lightsail for Research account.

', 'refs' => [ 'CostEstimates$member' => NULL, ], ], 'CostEstimates' => [ 'base' => NULL, 'refs' => [ 'ResourceBudgetEstimate$costEstimates' => '

The cost estimate for the specified budget.

', ], ], 'CreateBucketAccessKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBucketAccessKeyResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBucketResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateCloudFormationStackRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCloudFormationStackResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateContactMethodRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContactMethodResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceDeploymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceDeploymentResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceRegistryLoginRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceRegistryLoginResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContainerServiceResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskFromSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDiskSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDistributionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainEntryRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainEntryResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateGUISessionAccessDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGUISessionAccessDetailsResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstanceSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstanceSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstancesFromSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstancesFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstancesResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateKeyPairResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateLoadBalancerTlsCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLoadBalancerTlsCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseFromSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseFromSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRelationalDatabaseSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'Currency' => [ 'base' => NULL, 'refs' => [ 'EstimateByTime$currency' => '

The currency of the estimate in USD.

', ], ], 'DeleteAlarmRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAlarmResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAutoSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAutoSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketAccessKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketAccessKeyResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactMethodRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactMethodResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContainerImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContainerImageResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContainerServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContainerServiceResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDiskSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDiskSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDistributionResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainEntryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainEntryResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKeyPairResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKnownHostKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKnownHostKeysResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoadBalancerTlsCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLoadBalancerTlsCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRelationalDatabaseSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRelationalDatabaseSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'DestinationInfo' => [ 'base' => '

Describes the destination of a record.

', 'refs' => [ 'CloudFormationStackRecord$destinationInfo' => '

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.

', 'ExportSnapshotRecord$destinationInfo' => '

A list of objects describing the destination of the export snapshot record.

', ], ], 'DetachCertificateFromDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachCertificateFromDistributionResult' => [ 'base' => NULL, 'refs' => [], ], 'DetachDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesFromLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachInstancesFromLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'DetachStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'DetachStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'DisableAddOnRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisableAddOnResult' => [ 'base' => NULL, 'refs' => [], ], 'Disk' => [ 'base' => '

Describes a block storage disk.

', 'refs' => [ 'DiskList$member' => NULL, 'GetDiskResult$disk' => '

An object containing information about the disk.

', ], ], 'DiskInfo' => [ 'base' => '

Describes a disk.

', 'refs' => [ 'DiskInfoList$member' => NULL, ], ], 'DiskInfoList' => [ 'base' => NULL, 'refs' => [ 'InstanceSnapshotInfo$fromDiskInfo' => '

A list of objects describing the disks that were attached to the source instance.

', ], ], 'DiskList' => [ 'base' => NULL, 'refs' => [ 'GetDisksResult$disks' => '

An array of objects containing information about all block storage disks.

', 'InstanceHardware$disks' => '

The disks attached to the instance.

', 'InstanceSnapshot$fromAttachedDisks' => '

An array of disk objects containing information about all block storage disks.

', ], ], 'DiskMap' => [ 'base' => '

Describes a block storage disk mapping.

', 'refs' => [ 'DiskMapList$member' => NULL, ], ], 'DiskMapList' => [ 'base' => NULL, 'refs' => [ 'AttachedDiskMap$value' => NULL, ], ], 'DiskSnapshot' => [ 'base' => '

Describes a block storage disk snapshot.

', 'refs' => [ 'DiskSnapshotList$member' => NULL, 'GetDiskSnapshotResult$diskSnapshot' => '

An object containing information about the disk snapshot.

', ], ], 'DiskSnapshotInfo' => [ 'base' => '

Describes a disk snapshot.

', 'refs' => [ 'ExportSnapshotRecordSourceInfo$diskSnapshotInfo' => '

A list of objects describing a disk snapshot.

', ], ], 'DiskSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetDiskSnapshotsResult$diskSnapshots' => '

An array of objects containing information about all block storage disk snapshots.

', ], ], 'DiskSnapshotState' => [ 'base' => NULL, 'refs' => [ 'DiskSnapshot$state' => '

The status of the disk snapshot operation.

', ], ], 'DiskState' => [ 'base' => NULL, 'refs' => [ 'Disk$state' => '

Describes the status of the disk.

', ], ], 'DistributionBundle' => [ 'base' => '

Describes the specifications of a distribution bundle.

', 'refs' => [ 'DistributionBundleList$member' => NULL, ], ], 'DistributionBundleList' => [ 'base' => NULL, 'refs' => [ 'GetDistributionBundlesResult$bundles' => '

An object that describes a distribution bundle.

', ], ], 'DistributionList' => [ 'base' => NULL, 'refs' => [ 'GetDistributionsResult$distributions' => '

An array of objects that describe your distributions.

', ], ], 'DistributionMetricName' => [ 'base' => NULL, 'refs' => [ 'GetDistributionMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • TotalErrorRate - The percentage of all viewer requests for which the response\'s HTTP status code was 4xx or 5xx.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 4xxErrorRate - The percentage of all viewer requests for which the response\'s HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 5xxErrorRate - The percentage of all viewer requests for which the response\'s HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

', 'GetDistributionMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'DnsRecordCreationState' => [ 'base' => '

Describes the creation state of the canonical name (CNAME) records that are automatically added by Amazon Lightsail to the DNS of a domain to validate domain ownership for an SSL/TLS certificate.

When you create an SSL/TLS certificate for a Lightsail resource, you must add a set of CNAME records to the DNS of the domains for the certificate to validate that you own the domains. Lightsail can automatically add the CNAME records to the DNS of the domain if the DNS zone for the domain exists within your Lightsail account. If automatic record addition fails, or if you manage the DNS of your domain using a third-party service, then you must manually add the CNAME records to the DNS of your domain. For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'DomainValidationRecord$dnsRecordCreationState' => '

An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.

', ], ], 'DnsRecordCreationStateCode' => [ 'base' => NULL, 'refs' => [ 'DnsRecordCreationState$code' => '

The status code for the automated DNS record creation.

Following are the possible values:

  • SUCCEEDED - The validation records were successfully added to the domain.

  • STARTED - The automatic DNS record creation has started.

  • FAILED - The validation records failed to be added to the domain.

', ], ], 'Domain' => [ 'base' => '

Describes a domain where you are storing recordsets.

', 'refs' => [ 'DomainList$member' => NULL, 'GetDomainResult$domain' => '

An array of key-value pairs containing information about your get domain request.

', ], ], 'DomainEntry' => [ 'base' => '

Describes a domain recordset entry.

', 'refs' => [ 'CreateDomainEntryRequest$domainEntry' => '

An array of key-value pairs containing information about the domain entry request.

', 'DeleteDomainEntryRequest$domainEntry' => '

An array of key-value pairs containing information about your domain entries.

', 'DomainEntryList$member' => NULL, 'UpdateDomainEntryRequest$domainEntry' => '

An array of key-value pairs containing information about the domain entry.

', ], ], 'DomainEntryList' => [ 'base' => NULL, 'refs' => [ 'Domain$domainEntries' => '

An array of key-value pairs containing information about the domain entries.

', ], ], 'DomainEntryOptions' => [ 'base' => NULL, 'refs' => [ 'DomainEntry$options' => '

(Discontinued) The options for the domain entry.

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now discontinued.

', ], ], 'DomainEntryOptionsKeys' => [ 'base' => NULL, 'refs' => [ 'DomainEntryOptions$key' => NULL, ], ], 'DomainEntryType' => [ 'base' => NULL, 'refs' => [ 'DomainEntry$type' => '

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:

  • A

  • AAAA

  • CNAME

  • MX

  • NS

  • SOA

  • SRV

  • TXT

', ], ], 'DomainList' => [ 'base' => NULL, 'refs' => [ 'GetDomainsResult$domains' => '

An array of key-value pairs containing information about each of the domain entries in the user\'s account.

', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'Certificate$domainName' => '

The domain name of the certificate.

', 'CertificateSummary$domainName' => '

The domain name of the certificate.

', 'CreateCertificateRequest$domainName' => '

The domain name (example.com) for the certificate.

', 'CreateDomainEntryRequest$domainName' => '

The domain name (example.com) for which you want to create the domain entry.

', 'CreateDomainRequest$domainName' => '

The domain name to manage (example.com).

', 'CreateLoadBalancerRequest$certificateDomainName' => '

The domain name with which your certificate is associated (example.com).

If you specify certificateDomainName, then certificateName is required (and vice-versa).

', 'CreateLoadBalancerTlsCertificateRequest$certificateDomainName' => '

The domain name (example.com) for your SSL/TLS certificate.

', 'DeleteDomainEntryRequest$domainName' => '

The name of the domain entry to delete.

', 'DeleteDomainRequest$domainName' => '

The specific domain name to delete.

', 'DomainEntry$name' => '

The name of the domain.

', 'DomainNameList$member' => NULL, 'DomainValidationRecord$domainName' => '

The domain name of the certificate validation record. For example, example.com or www.example.com.

', 'GetDomainRequest$domainName' => '

The domain name for which your want to return information about.

', 'LoadBalancerTlsCertificate$domainName' => '

The domain name for your SSL/TLS certificate.

', 'LoadBalancerTlsCertificateDomainValidationOption$domainName' => '

The fully qualified domain name in the certificate request.

', 'LoadBalancerTlsCertificateDomainValidationRecord$domainName' => '

The domain name against which your SSL/TLS certificate was validated.

', 'SubjectAlternativeNameList$member' => NULL, 'UpdateDomainEntryRequest$domainName' => '

The name of the domain recordset to update.

', ], ], 'DomainNameList' => [ 'base' => NULL, 'refs' => [ 'CreateLoadBalancerRequest$certificateAlternativeNames' => '

The optional alternative domains and subdomains to use with your SSL/TLS certificate (www.example.com, example.com, m.example.com, blog.example.com).

', 'CreateLoadBalancerTlsCertificateRequest$certificateAlternativeNames' => '

An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (*.example.com).

', ], ], 'DomainValidationRecord' => [ 'base' => '

Describes the domain name system (DNS) records that you must add to the DNS of your registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate.

', 'refs' => [ 'DomainValidationRecordList$member' => NULL, ], ], 'DomainValidationRecordList' => [ 'base' => NULL, 'refs' => [ 'Certificate$domainValidationRecords' => '

An array of objects that describe the domain validation records of the certificate.

', 'RenewalSummary$domainValidationRecords' => '

An array of objects that describe the domain validation records of the certificate.

', ], ], 'DownloadDefaultKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'DownloadDefaultKeyPairResult' => [ 'base' => NULL, 'refs' => [], ], 'EligibleToRenew' => [ 'base' => NULL, 'refs' => [ 'Certificate$eligibleToRenew' => '

The renewal eligibility of the certificate.

', ], ], 'EmailAddress' => [ 'base' => NULL, 'refs' => [ 'SetupInstanceHttpsRequest$emailAddress' => '

The contact method for SSL/TLS certificate renewal alerts. You can enter one email address.

', ], ], 'EnableAddOnRequest' => [ 'base' => NULL, 'refs' => [], ], 'EnableAddOnResult' => [ 'base' => NULL, 'refs' => [], ], 'EndpointRequest' => [ 'base' => '

Describes the settings of a public endpoint for an Amazon Lightsail container service.

', 'refs' => [ 'ContainerServiceDeploymentRequest$publicEndpoint' => '

An object that describes the endpoint of the deployment.

', 'CreateContainerServiceDeploymentRequest$publicEndpoint' => '

An object that describes the settings of the public endpoint for the container service.

', ], ], 'Environment' => [ 'base' => NULL, 'refs' => [ 'Container$environment' => '

The environment variables of the container.

', ], ], 'EstimateByTime' => [ 'base' => '

An estimate that\'s associated with a time period.

', 'refs' => [ 'EstimatesByTime$member' => NULL, ], ], 'EstimatesByTime' => [ 'base' => NULL, 'refs' => [ 'CostEstimate$resultsByTime' => '

The cost estimate result that\'s associated with a time period.

', ], ], 'ExportSnapshotRecord' => [ 'base' => '

Describes an export snapshot record.

', 'refs' => [ 'ExportSnapshotRecordList$member' => NULL, ], ], 'ExportSnapshotRecordList' => [ 'base' => NULL, 'refs' => [ 'GetExportSnapshotRecordsResult$exportSnapshotRecords' => '

A list of objects describing the export snapshot records.

', ], ], 'ExportSnapshotRecordSourceInfo' => [ 'base' => '

Describes the source of an export snapshot record.

', 'refs' => [ 'ExportSnapshotRecord$sourceInfo' => '

A list of objects describing the source of the export snapshot record.

', ], ], 'ExportSnapshotRecordSourceType' => [ 'base' => NULL, 'refs' => [ 'ExportSnapshotRecordSourceInfo$resourceType' => '

The Lightsail resource type (InstanceSnapshot or DiskSnapshot).

', ], ], 'ExportSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'ExportSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'ForwardValues' => [ 'base' => NULL, 'refs' => [ 'CookieObject$option' => '

Specifies which cookies to forward to the distribution\'s origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

', 'HeaderObject$option' => '

The headers that you want your distribution to forward to your origin and base caching on.

You can configure your distribution to do one of the following:

  • all - Forward all headers to your origin.

  • none - Forward only the default headers.

  • allow-list - Forward only the headers you specify using the headersAllowList parameter.

', ], ], 'GetActiveNamesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetActiveNamesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetAlarmsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAlarmsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetAutoSnapshotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAutoSnapshotsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAccessKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAccessKeysResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketBundlesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketBundlesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBundlesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBundlesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetCertificatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCertificatesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetCloudFormationStackRecordsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCloudFormationStackRecordsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContactMethodsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContactMethodsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerAPIMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerAPIMetadataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerImagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerImagesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerLogRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerLogResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServiceDeploymentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServiceDeploymentsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServiceMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServiceMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServicePowersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServicePowersResult' => [ 'base' => NULL, 'refs' => [], ], 'GetContainerServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCostEstimateRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCostEstimateResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskSnapshotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDiskSnapshotsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDisksRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDisksResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionBundlesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionBundlesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionLatestCacheResetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionLatestCacheResetResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDistributionsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDomainsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetExportSnapshotRecordsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetExportSnapshotRecordsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceAccessDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceAccessDetailsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstancePortStatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstancePortStatesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceSnapshotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceSnapshotsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceStateResult' => [ 'base' => NULL, 'refs' => [], ], 'GetInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstancesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetKeyPairResult' => [ 'base' => NULL, 'refs' => [], ], 'GetKeyPairsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetKeyPairsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerTlsCertificatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerTlsCertificatesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerTlsPoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancerTlsPoliciesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLoadBalancersResult' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationResult' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationsForResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOperationsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRegionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRegionsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseBlueprintsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseBundlesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseBundlesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseEventsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseLogEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseLogEventsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseLogStreamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseLogStreamsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseMasterUserPasswordRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseMasterUserPasswordResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseMetricDataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseParametersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseSnapshotResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseSnapshotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabaseSnapshotsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRelationalDatabasesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetSetupHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSetupHistoryResult' => [ 'base' => NULL, 'refs' => [], ], 'GetStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'GetStaticIpsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStaticIpsResult' => [ 'base' => NULL, 'refs' => [], ], 'HeaderEnum' => [ 'base' => NULL, 'refs' => [ 'HeaderForwardList$member' => NULL, ], ], 'HeaderForwardList' => [ 'base' => NULL, 'refs' => [ 'HeaderObject$headersAllowList' => '

The specific headers to forward to your distribution\'s origin.

', ], ], 'HeaderObject' => [ 'base' => '

Describes the request headers that a Lightsail distribution bases caching on.

For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value.

', 'refs' => [ 'CacheSettings$forwardedHeaders' => '

An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.

', ], ], 'HostKeyAttributes' => [ 'base' => '

Describes the public SSH host keys or the RDP certificate.

', 'refs' => [ 'HostKeysList$member' => NULL, ], ], 'HostKeysList' => [ 'base' => NULL, 'refs' => [ 'InstanceAccessDetails$hostKeys' => '

Describes the public SSH host keys or the RDP certificate.

', ], ], 'HttpEndpoint' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataOptions$httpEndpoint' => '

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

', 'UpdateInstanceMetadataOptionsRequest$httpEndpoint' => '

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

If you specify a value of disabled, you cannot access your instance metadata.

', ], ], 'HttpProtocolIpv6' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataOptions$httpProtocolIpv6' => '

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

', 'UpdateInstanceMetadataOptionsRequest$httpProtocolIpv6' => '

Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

', ], ], 'HttpTokens' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataOptions$httpTokens' => '

The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'UpdateInstanceMetadataOptionsRequest$httpTokens' => '

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

', ], ], 'IAMAccessKeyId' => [ 'base' => NULL, 'refs' => [ 'AccessKey$accessKeyId' => '

The ID of the access key.

', ], ], 'ImportKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportKeyPairResult' => [ 'base' => NULL, 'refs' => [], ], 'InUseResourceCount' => [ 'base' => NULL, 'refs' => [ 'Certificate$inUseResourceCount' => '

The number of Lightsail resources that the certificate is attached to.

', ], ], 'IncludeCertificateDetails' => [ 'base' => NULL, 'refs' => [ 'GetCertificatesRequest$includeCertificateDetails' => '

Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

', ], ], 'InputOrigin' => [ 'base' => '

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, container service, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

', 'refs' => [ 'CreateDistributionRequest$origin' => '

An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

', 'UpdateDistributionRequest$origin' => '

An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

', ], ], 'Instance' => [ 'base' => '

Describes an instance (a virtual private server).

', 'refs' => [ 'GetInstanceResult$instance' => '

An array of key-value pairs containing information about the specified instance.

', 'InstanceList$member' => NULL, ], ], 'InstanceAccessDetails' => [ 'base' => '

The parameters for gaining temporary access to one of your Amazon Lightsail instances.

', 'refs' => [ 'GetInstanceAccessDetailsResult$accessDetails' => '

An array of key-value pairs containing information about a get instance access request.

', ], ], 'InstanceAccessProtocol' => [ 'base' => NULL, 'refs' => [ 'GetInstanceAccessDetailsRequest$protocol' => '

The protocol to use to connect to your instance. Defaults to ssh.

', 'InstanceAccessDetails$protocol' => '

The protocol for these Amazon Lightsail instance access details.

', ], ], 'InstanceEntry' => [ 'base' => '

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack operation.

', 'refs' => [ 'InstanceEntryList$member' => NULL, ], ], 'InstanceEntryList' => [ 'base' => NULL, 'refs' => [ 'CreateCloudFormationStackRequest$instances' => '

An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.

', ], ], 'InstanceHardware' => [ 'base' => '

Describes the hardware for the instance.

', 'refs' => [ 'Instance$hardware' => '

The size of the vCPU and the amount of RAM for the instance.

', ], ], 'InstanceHealthReason' => [ 'base' => NULL, 'refs' => [ 'InstanceHealthSummary$instanceHealthReason' => '

More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

If instanceHealth is initial, the instanceHealthReason value can be one of the following:

  • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

  • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

  • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Instance.Timeout - The health check requests timed out.

  • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

  • Lb.InternalError - The health checks failed due to an internal error.

If instanceHealth is unused, the instanceHealthReason value can be one of the following:

  • Instance.NotRegistered - The target instance is not registered with the target group.

  • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

  • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

  • Instance.InvalidState - The target is in the stopped or terminated state.

If instanceHealth is draining, the instanceHealthReason value can be one of the following:

  • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

', ], ], 'InstanceHealthState' => [ 'base' => NULL, 'refs' => [ 'InstanceHealthSummary$instanceHealth' => '

Describes the overall instance health. Valid values are below.

', ], ], 'InstanceHealthSummary' => [ 'base' => '

Describes information about the health of the instance.

', 'refs' => [ 'InstanceHealthSummaryList$member' => NULL, ], ], 'InstanceHealthSummaryList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$instanceHealthSummary' => '

An array of InstanceHealthSummary objects describing the health of the load balancer.

', ], ], 'InstanceList' => [ 'base' => NULL, 'refs' => [ 'GetInstancesResult$instances' => '

An array of key-value pairs containing information about your instances.

', ], ], 'InstanceMetadataOptions' => [ 'base' => '

The metadata options for the instance.

', 'refs' => [ 'Instance$metadataOptions' => '

The metadata options for the Amazon Lightsail instance.

', ], ], 'InstanceMetadataState' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataOptions$state' => '

The state of the metadata option changes.

The following states are possible:

  • pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.

  • applied - The metadata options have been successfully applied to the instance.

', ], ], 'InstanceMetricName' => [ 'base' => NULL, 'refs' => [ 'GetInstanceMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance\'s BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

  • BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance\'s BurstCapacityPercentage metric reaches 100%.

    Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Seconds.

  • CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

  • NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Bytes.

  • NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Bytes.

  • StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • MetadataNoToken - Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn\'t use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

', 'GetInstanceMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'InstanceNetworking' => [ 'base' => '

Describes monthly data transfer rates and port information for an instance.

', 'refs' => [ 'Instance$networking' => '

Information about the public ports and monthly data transfer rates for the instance.

', ], ], 'InstancePlatform' => [ 'base' => NULL, 'refs' => [ 'Blueprint$platform' => '

The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.

', 'InstancePlatformList$member' => NULL, ], ], 'InstancePlatformList' => [ 'base' => NULL, 'refs' => [ 'Bundle$supportedPlatforms' => '

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX bundle.

', ], ], 'InstancePortInfo' => [ 'base' => '

Describes information about ports for an Amazon Lightsail instance.

', 'refs' => [ 'InstancePortInfoList$member' => NULL, ], ], 'InstancePortInfoList' => [ 'base' => NULL, 'refs' => [ 'InstanceNetworking$ports' => '

An array of key-value pairs containing information about the ports on the instance.

', ], ], 'InstancePortState' => [ 'base' => '

Describes open ports on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

', 'refs' => [ 'InstancePortStateList$member' => NULL, ], ], 'InstancePortStateList' => [ 'base' => NULL, 'refs' => [ 'GetInstancePortStatesResult$portStates' => '

An array of objects that describe the firewall port states for the specified instance.

', ], ], 'InstanceSnapshot' => [ 'base' => '

Describes an instance snapshot.

', 'refs' => [ 'GetInstanceSnapshotResult$instanceSnapshot' => '

An array of key-value pairs containing information about the results of your get instance snapshot request.

', 'InstanceSnapshotList$member' => NULL, ], ], 'InstanceSnapshotInfo' => [ 'base' => '

Describes an instance snapshot.

', 'refs' => [ 'ExportSnapshotRecordSourceInfo$instanceSnapshotInfo' => '

A list of objects describing an instance snapshot.

', ], ], 'InstanceSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetInstanceSnapshotsResult$instanceSnapshots' => '

An array of key-value pairs containing information about the results of your get instance snapshots request.

', ], ], 'InstanceSnapshotState' => [ 'base' => NULL, 'refs' => [ 'InstanceSnapshot$state' => '

The state the snapshot is in.

', ], ], 'InstanceState' => [ 'base' => '

Describes the virtual private server (or instance) status.

', 'refs' => [ 'GetInstanceStateResult$state' => '

The state of the instance.

', 'Instance$state' => '

The status code and the state (running) for the instance.

', ], ], 'InvalidInputException' => [ 'base' => '

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

', 'refs' => [], ], 'IpAddress' => [ 'base' => NULL, 'refs' => [ 'Instance$privateIpAddress' => '

The private IP address of the instance.

', 'Instance$publicIpAddress' => '

The public IP address of the instance.

', 'InstanceAccessDetails$ipAddress' => '

The public IP address of the Amazon Lightsail instance.

', 'StaticIp$ipAddress' => '

The static IP address.

', ], ], 'IpAddressType' => [ 'base' => NULL, 'refs' => [ 'CreateDistributionRequest$ipAddressType' => '

The IP address type for the distribution.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

', 'CreateInstancesFromSnapshotRequest$ipAddressType' => '

The IP address type for the instance.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

', 'CreateInstancesRequest$ipAddressType' => '

The IP address type for the instance.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

', 'CreateLoadBalancerRequest$ipAddressType' => '

The IP address type for the load balancer.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

', 'Instance$ipAddressType' => '

The IP address type of the instance.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

', 'LightsailDistribution$ipAddressType' => '

The IP address type of the distribution.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

', 'LoadBalancer$ipAddressType' => '

The IP address type of the load balancer.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

', 'SetIpAddressTypeRequest$ipAddressType' => '

The IP address type to set for the specified resource.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

', ], ], 'Ipv6Address' => [ 'base' => NULL, 'refs' => [ 'Ipv6AddressList$member' => NULL, ], ], 'Ipv6AddressList' => [ 'base' => NULL, 'refs' => [ 'Instance$ipv6Addresses' => '

The IPv6 addresses of the instance.

', ], ], 'IsVpcPeeredRequest' => [ 'base' => NULL, 'refs' => [], ], 'IsVpcPeeredResult' => [ 'base' => NULL, 'refs' => [], ], 'IsoDate' => [ 'base' => NULL, 'refs' => [ 'AccessKey$createdAt' => '

The timestamp when the access key was created.

', 'AccessKeyLastUsed$lastUsedDate' => '

The date and time when the access key was most recently used.

This value is null if the access key has not been used.

', 'AccountLevelBpaSync$lastSyncedAt' => '

The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized.

', 'Alarm$createdAt' => '

The timestamp when the alarm was created.

', 'AutoSnapshotDetails$createdAt' => '

The timestamp when the automatic snapshot was created.

', 'Bucket$createdAt' => '

The timestamp when the distribution was created.

', 'Certificate$createdAt' => '

The timestamp when the certificate was created.

', 'Certificate$issuedAt' => '

The timestamp when the certificate was issued.

', 'Certificate$notBefore' => '

The timestamp when the certificate is first valid.

', 'Certificate$notAfter' => '

The timestamp when the certificate expires.

', 'Certificate$revokedAt' => '

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

', 'CloudFormationStackRecord$createdAt' => '

The date when the CloudFormation stack record was created.

', 'ContactMethod$createdAt' => '

The timestamp when the contact method was created.

', 'ContainerImage$createdAt' => '

The timestamp when the container image was created.

', 'ContainerService$createdAt' => '

The timestamp when the container service was created.

', 'ContainerServiceDeployment$createdAt' => '

The timestamp when the deployment was created.

', 'ContainerServiceLogEvent$createdAt' => '

The timestamp when the container service log event was created.

', 'ContainerServiceRegistryLogin$expiresAt' => '

The timestamp of when the container image registry sign-in credentials expire.

The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials using the CreateContainerServiceRegistryLogin action.

', 'CreateRelationalDatabaseFromSnapshotRequest$restoreTime' => '

The date and time to restore your database from.

Constraints:

  • Must be before the latest restorable time for the database.

  • Cannot be specified if the use latest restorable time parameter is true.

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time.

', 'Disk$createdAt' => '

The date when the disk was created.

', 'DiskSnapshot$createdAt' => '

The date when the disk snapshot was created.

', 'Domain$createdAt' => '

The date when the domain recordset was created.

', 'DownloadDefaultKeyPairResult$createdAt' => '

The timestamp when the default key pair was created.

', 'ExportSnapshotRecord$createdAt' => '

The date when the export snapshot record was created.

', 'ExportSnapshotRecordSourceInfo$createdAt' => '

The date when the source instance or disk snapshot was created.

', 'GetBucketMetricDataRequest$startTime' => '

The timestamp indicating the earliest data to be returned.

', 'GetBucketMetricDataRequest$endTime' => '

The timestamp indicating the latest data to be returned.

', 'GetContainerLogRequest$startTime' => '

The start of the time interval for which to get log data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetContainerLogRequest$endTime' => '

The end of the time interval for which to get log data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetContainerServiceMetricDataRequest$startTime' => '

The start time of the time period.

', 'GetContainerServiceMetricDataRequest$endTime' => '

The end time of the time period.

', 'GetCostEstimateRequest$startTime' => '

The cost estimate start time.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetCostEstimateRequest$endTime' => '

The cost estimate end time.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetDistributionLatestCacheResetResult$createTime' => '

The timestamp of the last cache reset (1479734909.17) in Unix time format.

', 'GetRelationalDatabaseLogEventsRequest$startTime' => '

The start of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

', 'GetRelationalDatabaseLogEventsRequest$endTime' => '

The end of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

', 'GetRelationalDatabaseMasterUserPasswordResult$createdAt' => '

The timestamp when the specified version of the master user password was created.

', 'GetRelationalDatabaseMetricDataRequest$startTime' => '

The start of the time interval from which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

', 'GetRelationalDatabaseMetricDataRequest$endTime' => '

The end of the time interval from which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

', 'HostKeyAttributes$witnessedAt' => '

The time that the SSH host key or RDP certificate was recorded by Lightsail.

', 'HostKeyAttributes$notValidBefore' => '

The returned RDP certificate is valid after this point in time.

This value is listed only for RDP certificates.

', 'HostKeyAttributes$notValidAfter' => '

The returned RDP certificate is not valid after this point in time.

This value is listed only for RDP certificates.

', 'Instance$createdAt' => '

The timestamp when the instance was created (1479734909.17) in Unix time format.

', 'InstanceAccessDetails$expiresAt' => '

For SSH access, the date on which the temporary keys expire.

', 'InstanceSnapshot$createdAt' => '

The timestamp when the snapshot was created (1479907467.024).

', 'KeyPair$createdAt' => '

The timestamp when the key pair was created (1479816991.349).

', 'LightsailDistribution$createdAt' => '

The timestamp when the distribution was created.

', 'LoadBalancer$createdAt' => '

The date when your load balancer was created.

', 'LoadBalancerTlsCertificate$createdAt' => '

The time when you created your SSL/TLS certificate.

', 'LoadBalancerTlsCertificate$issuedAt' => '

The time when the SSL/TLS certificate was issued.

', 'LoadBalancerTlsCertificate$notAfter' => '

The timestamp when the SSL/TLS certificate expires.

', 'LoadBalancerTlsCertificate$notBefore' => '

The timestamp when the SSL/TLS certificate is first valid.

', 'LoadBalancerTlsCertificate$revokedAt' => '

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

', 'LogEvent$createdAt' => '

The timestamp when the database log event was created.

', 'Operation$createdAt' => '

The timestamp when the operation was initialized (1479816991.349).

', 'Operation$statusChangedAt' => '

The timestamp when the status was changed (1479816991.349).

', 'PendingMaintenanceAction$currentApplyDate' => '

The effective date of the pending database maintenance action.

', 'RelationalDatabase$createdAt' => '

The timestamp when the database was created. Formatted in Unix time.

', 'RelationalDatabase$latestRestorableTime' => '

The latest point in time to which the database can be restored. Formatted in Unix time.

', 'RelationalDatabaseEvent$createdAt' => '

The timestamp when the database event was created.

', 'RelationalDatabaseSnapshot$createdAt' => '

The timestamp when the database snapshot was created.

', 'RenewalSummary$updatedAt' => '

The timestamp when the certificate was last updated.

', 'ResetDistributionCacheResult$createTime' => '

The timestamp of the reset cache request (1479734909.17) in Unix time format.

', 'ResourceBudgetEstimate$startTime' => '

The estimate start time.

', 'ResourceBudgetEstimate$endTime' => '

The estimate end time.

', 'SetupExecutionDetails$dateTime' => '

The timestamp for when the request was run.

', 'SetupHistoryResource$createdAt' => '

The timestamp for when the resource was created.

', 'StaticIp$createdAt' => '

The timestamp when the static IP was created (1479735304.222).

', 'TimePeriod$start' => '

The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Lightsail for Research retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

', 'TimePeriod$end' => '

The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

', ], ], 'IssuerCA' => [ 'base' => NULL, 'refs' => [ 'Certificate$issuerCA' => '

The certificate authority that issued the certificate.

', ], ], 'KeyAlgorithm' => [ 'base' => NULL, 'refs' => [ 'Certificate$keyAlgorithm' => '

The algorithm used to generate the key pair (the public and private key) of the certificate.

', ], ], 'KeyPair' => [ 'base' => '

Describes an SSH key pair.

', 'refs' => [ 'CreateKeyPairResult$keyPair' => '

An array of key-value pairs containing information about the new key pair you just created.

', 'GetKeyPairResult$keyPair' => '

An array of key-value pairs containing information about the key pair.

', 'KeyPairList$member' => NULL, ], ], 'KeyPairList' => [ 'base' => NULL, 'refs' => [ 'GetKeyPairsResult$keyPairs' => '

An array of key-value pairs containing information about the key pairs.

', ], ], 'LightsailDistribution' => [ 'base' => '

Describes an Amazon Lightsail content delivery network (CDN) distribution.

', 'refs' => [ 'CreateDistributionResult$distribution' => '

An object that describes the distribution created.

', 'DistributionList$member' => NULL, ], ], 'LoadBalancer' => [ 'base' => '

Describes a load balancer.

', 'refs' => [ 'GetLoadBalancerResult$loadBalancer' => '

An object containing information about your load balancer.

', 'LoadBalancerList$member' => NULL, ], ], 'LoadBalancerAttributeName' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerConfigurationOptions$key' => NULL, 'UpdateLoadBalancerAttributeRequest$attributeName' => '

The name of the attribute you want to update.

', ], ], 'LoadBalancerConfigurationOptions' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$configurationOptions' => '

A string to string map of the configuration options for your load balancer. Valid values are listed below.

', ], ], 'LoadBalancerList' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancersResult$loadBalancers' => '

An array of LoadBalancer objects describing your load balancers.

', ], ], 'LoadBalancerMetricName' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancerMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

  • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Seconds.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • UnhealthyHostCount - The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

', 'GetLoadBalancerMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'LoadBalancerProtocol' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$protocol' => '

The protocol you have enabled for your load balancer. Valid values are below.

You can\'t just have HTTP_HTTPS, but you can have just HTTP.

', ], ], 'LoadBalancerState' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$state' => '

The status of your load balancer. Valid values are below.

', ], ], 'LoadBalancerTlsCertificate' => [ 'base' => '

Describes a load balancer SSL/TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

', 'refs' => [ 'LoadBalancerTlsCertificateList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDnsRecordCreationState' => [ 'base' => '

An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.

', 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationRecord$dnsRecordCreationState' => '

An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of a domain to validate domain ownership.

', ], ], 'LoadBalancerTlsCertificateDnsRecordCreationStateCode' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateDnsRecordCreationState$code' => '

The status code for the automated DNS record creation.

Following are the possible values:

  • SUCCEEDED - The validation records were successfully added.

  • STARTED - The automatic DNS record creation has started.

  • FAILED - The validation record addition failed.

', ], ], 'LoadBalancerTlsCertificateDomainStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationOption$validationStatus' => '

The status of the domain validation. Valid values are listed below.

', 'LoadBalancerTlsCertificateDomainValidationRecord$validationStatus' => '

The validation status. Valid values are listed below.

', ], ], 'LoadBalancerTlsCertificateDomainValidationOption' => [ 'base' => '

Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.

', 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationOptionList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDomainValidationOptionList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateRenewalSummary$domainValidationOptions' => '

Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail\'s managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.

', ], ], 'LoadBalancerTlsCertificateDomainValidationRecord' => [ 'base' => '

Describes the validation record of each domain name in the SSL/TLS certificate.

', 'refs' => [ 'LoadBalancerTlsCertificateDomainValidationRecordList$member' => NULL, ], ], 'LoadBalancerTlsCertificateDomainValidationRecordList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$domainValidationRecords' => '

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

', ], ], 'LoadBalancerTlsCertificateFailureReason' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$failureReason' => '

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

', ], ], 'LoadBalancerTlsCertificateList' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancerTlsCertificatesResult$tlsCertificates' => '

An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.

', ], ], 'LoadBalancerTlsCertificateRenewalStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificateRenewalSummary$renewalStatus' => '

The renewal status of the certificate.

The following renewal status are possible:

  • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.

  • PendingValidation - Lightsail couldn\'t automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won\'t be renewed. Check to make sure your certificate\'s domain validation records exist in your domain\'s DNS, and that your certificate remains in use.

  • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

  • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

', ], ], 'LoadBalancerTlsCertificateRenewalSummary' => [ 'base' => '

Contains information about the status of Lightsail\'s managed renewal for the certificate.

The renewal status of the certificate.

The following renewal status are possible:

  • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names in the certificate. No further action is required.

  • PendingValidation - Lightsail couldn\'t automatically validate one or more domain names in the certificate. You must take action to validate these domain names or the certificate won\'t be renewed. If you used DNS validation, check to make sure your certificate\'s domain validation records exist in your domain\'s DNS, and that your certificate remains in use.

  • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

  • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

', 'refs' => [ 'LoadBalancerTlsCertificate$renewalSummary' => '

An object that describes the status of the certificate renewal managed by Lightsail.

', ], ], 'LoadBalancerTlsCertificateRevocationReason' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$revocationReason' => '

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

', ], ], 'LoadBalancerTlsCertificateStatus' => [ 'base' => NULL, 'refs' => [ 'LoadBalancerTlsCertificate$status' => '

The validation status of the SSL/TLS certificate. Valid values are below.

', ], ], 'LoadBalancerTlsCertificateSummary' => [ 'base' => '

Provides a summary of SSL/TLS certificate metadata.

', 'refs' => [ 'LoadBalancerTlsCertificateSummaryList$member' => NULL, ], ], 'LoadBalancerTlsCertificateSummaryList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$tlsCertificateSummaries' => '

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

', ], ], 'LoadBalancerTlsPolicy' => [ 'base' => '

Describes the TLS security policies that are available for Lightsail load balancers.

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'LoadBalancerTlsPolicyList$member' => NULL, ], ], 'LoadBalancerTlsPolicyList' => [ 'base' => NULL, 'refs' => [ 'GetLoadBalancerTlsPoliciesResult$tlsPolicies' => '

An array of objects that describe the TLS security policies that are available.

', ], ], 'LogEvent' => [ 'base' => '

Describes a database log event.

', 'refs' => [ 'LogEventList$member' => NULL, ], ], 'LogEventList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseLogEventsResult$resourceLogEvents' => '

An object describing the result of your get relational database log events request.

', ], ], 'MetricDatapoint' => [ 'base' => '

Describes the metric data point.

', 'refs' => [ 'MetricDatapointList$member' => NULL, ], ], 'MetricDatapointList' => [ 'base' => NULL, 'refs' => [ 'GetBucketMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', 'GetContainerServiceMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', 'GetDistributionMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', 'GetInstanceMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', 'GetLoadBalancerMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', 'GetRelationalDatabaseMetricDataResult$metricData' => '

An array of objects that describe the metric data returned.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'Alarm$metricName' => '

The name of the metric associated with the alarm.

', 'PutAlarmRequest$metricName' => '

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

  • Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

  • Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

  • Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

', ], ], 'MetricPeriod' => [ 'base' => NULL, 'refs' => [ 'Alarm$period' => '

The period, in seconds, over which the statistic is applied.

', 'GetBucketMetricDataRequest$period' => '

The granularity, in seconds, of the returned data points.

Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.

', 'GetContainerServiceMetricDataRequest$period' => '

The granularity, in seconds, of the returned data points.

All container service metric data is available in 5-minute (300 seconds) granularity.

', 'GetDistributionMetricDataRequest$period' => '

The granularity, in seconds, for the metric data points that will be returned.

', 'GetInstanceMetricDataRequest$period' => '

The granularity, in seconds, of the returned data points.

The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All other instance metric data is available in 5-minute (300 seconds) granularity.

', 'GetLoadBalancerMetricDataRequest$period' => '

The granularity, in seconds, of the returned data points.

', 'GetRelationalDatabaseMetricDataRequest$period' => '

The granularity, in seconds, of the returned data points.

All relational database metric data is available in 1-minute (60 seconds) granularity.

', ], ], 'MetricStatistic' => [ 'base' => NULL, 'refs' => [ 'Alarm$statistic' => '

The statistic for the metric associated with the alarm.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'MetricStatisticList$member' => NULL, ], ], 'MetricStatisticList' => [ 'base' => NULL, 'refs' => [ 'GetBucketMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'GetContainerServiceMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'GetDistributionMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'GetInstanceMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'GetLoadBalancerMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', 'GetRelationalDatabaseMetricDataRequest$statistics' => '

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

', ], ], 'MetricUnit' => [ 'base' => NULL, 'refs' => [ 'Alarm$unit' => '

The unit of the metric associated with the alarm.

', 'GetBucketMetricDataRequest$unit' => '

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

', 'GetDistributionMetricDataRequest$unit' => '

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

', 'GetInstanceMetricDataRequest$unit' => '

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units to specify with each available metric, see the metricName parameter.

', 'GetLoadBalancerMetricDataRequest$unit' => '

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

', 'GetRelationalDatabaseMetricDataRequest$unit' => '

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

', 'MetricDatapoint$unit' => '

The unit.

', ], ], 'MonitoredResourceInfo' => [ 'base' => '

Describes resource being monitored by an alarm.

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.

', 'refs' => [ 'Alarm$monitoredResourceInfo' => '

An object that lists information about the resource monitored by the alarm.

', ], ], 'MonthlyTransfer' => [ 'base' => '

Describes the monthly data transfer in and out of your virtual private server (or instance).

', 'refs' => [ 'InstanceNetworking$monthlyTransfer' => '

The amount of data in GB allocated for monthly data transfers.

', ], ], 'NameServersUpdateState' => [ 'base' => '

Describes the state of the name server records update made by Amazon Lightsail to an Amazon Route 53 registered domain.

For more information, see DNS in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'RegisteredDomainDelegationInfo$nameServersUpdateState' => '

An object that describes the state of the name server records that are automatically added to the Route 53 domain by Lightsail.

', ], ], 'NameServersUpdateStateCode' => [ 'base' => NULL, 'refs' => [ 'NameServersUpdateState$code' => '

The status code for the name servers update.

Following are the possible values:

  • SUCCEEDED - The name server records were successfully updated.

  • PENDING - The name server record update is in progress.

  • FAILED - The name server record update failed.

  • STARTED - The automatic name server record update started.

', ], ], 'NetworkProtocol' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$protocol' => '

The IP protocol name.

The name can be one of the following:

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn\'t require reliable data stream service, use UDP instead.

  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.

  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don\'t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.

  • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

', 'InstancePortState$protocol' => '

The IP protocol name.

The name can be one of the following:

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn\'t require reliable data stream service, use UDP instead.

  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.

  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don\'t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.

  • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

', 'PortInfo$protocol' => '

The IP protocol name.

The name can be one of the following:

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn\'t require reliable data stream service, use UDP instead.

  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.

  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don\'t require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.

  • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'AccessKey$secretAccessKey' => '

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

', 'Alarm$arn' => '

The Amazon Resource Name (ARN) of the alarm.

', 'AttachDiskRequest$diskPath' => '

The disk path to expose to the instance (/dev/xvdf).

', 'AvailabilityZone$zoneName' => '

The name of the Availability Zone. The format is us-east-2a (case-sensitive).

', 'AvailabilityZone$state' => '

The state of the Availability Zone.

', 'Blueprint$blueprintId' => '

The ID for the virtual private server image (app_wordpress_4_4 or app_lamp_7_0).

', 'Blueprint$group' => '

The group name of the blueprint (amazon-linux).

', 'Bucket$resourceType' => '

The Lightsail resource type of the bucket.

', 'Bucket$arn' => '

The Amazon Resource Name (ARN) of the bucket.

', 'Bucket$bundleId' => '

The ID of the bundle currently applied to the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to change the bundle of a bucket.

', 'Bucket$url' => '

The URL of the bucket.

', 'Bucket$supportCode' => '

The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.

', 'Bucket$objectVersioning' => '

Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

  • Enabled - Object versioning is enabled.

  • Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

  • NeverEnabled - Object versioning has never been enabled.

', 'BucketBundle$bundleId' => '

The ID of the bundle.

', 'BucketBundle$name' => '

The name of the bundle.

', 'BucketState$code' => '

The state code of the bucket.

The following codes are possible:

  • OK - The bucket is in a running state.

  • Unknown - Creation of the bucket might have timed-out. You might want to delete the bucket and create a new one.

', 'Bundle$bundleId' => '

The bundle ID (micro_1_0).

', 'CacheSettings$allowedHTTPMethods' => '

The HTTP methods that are processed and forwarded to the distribution\'s origin.

You can specify the following options:

  • GET,HEAD - The distribution forwards the GET and HEAD methods.

  • GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.

  • GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.

If you specify the third option, you might need to restrict access to your distribution\'s origin so users can\'t perform operations that you don\'t want them to. For example, you might not want users to have permission to delete objects from your origin.

', 'CacheSettings$cachedHTTPMethods' => '

The HTTP method responses that are cached by your distribution.

You can specify the following options:

  • GET,HEAD - The distribution caches responses to the GET and HEAD methods.

  • GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.

', 'Certificate$arn' => '

The Amazon Resource Name (ARN) of the certificate.

', 'CertificateSummary$certificateArn' => '

The Amazon Resource Name (ARN) of the certificate.

', 'CloudFormationStackRecord$arn' => '

The Amazon Resource Name (ARN) of the CloudFormation stack record.

', 'CloudFormationStackRecordSourceInfo$name' => '

The name of the record.

', 'CloudFormationStackRecordSourceInfo$arn' => '

The Amazon Resource Name (ARN) of the export snapshot record.

', 'ContactMethod$contactEndpoint' => '

The destination of the contact method, such as an email address or a mobile phone number.

', 'ContactMethod$arn' => '

The Amazon Resource Name (ARN) of the contact method.

', 'ContainerService$arn' => '

The Amazon Resource Name (ARN) of the container service.

', 'CostEstimate$usageType' => '

The types of usage that are included in the estimate, such as costs, usage, or data transfer.

', 'CreateBucketRequest$bundleId' => '

The ID of the bundle to use for the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

Use the UpdateBucketBundle action to change the bundle after the bucket is created.

', 'CreateDiskFromSnapshotRequest$availabilityZone' => '

The Availability Zone where you want to create the disk (us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

', 'CreateDiskRequest$availabilityZone' => '

The Availability Zone where you want to create the disk (us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.

Use the get regions operation to list the Availability Zones where Lightsail is currently available.

', 'CreateInstancesFromSnapshotRequest$bundleId' => '

The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_1_0).

', 'CreateInstancesRequest$blueprintId' => '

The ID for a virtual private server image (app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints).

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

', 'CreateInstancesRequest$bundleId' => '

The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_1_0).

', 'DeleteBucketAccessKeyRequest$accessKeyId' => '

The ID of the access key to delete.

Use the GetBucketAccessKeys action to get a list of access key IDs that you can specify.

', 'DestinationInfo$id' => '

The ID of the resource created at the destination.

', 'DestinationInfo$service' => '

The destination service of the record.

', 'Disk$arn' => '

The Amazon Resource Name (ARN) of the disk.

', 'DiskInfo$path' => '

The disk path.

', 'DiskMap$originalDiskPath' => '

The original disk path exposed to the instance (for example, /dev/sdh).

', 'DiskSnapshot$arn' => '

The Amazon Resource Name (ARN) of the disk snapshot.

', 'DiskSnapshot$fromDiskArn' => '

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

', 'DiskSnapshot$fromInstanceArn' => '

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

', 'Domain$arn' => '

The Amazon Resource Name (ARN) of the domain recordset (arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

', 'DomainEntry$id' => '

The ID of the domain recordset entry.

', 'ExportSnapshotRecord$arn' => '

The Amazon Resource Name (ARN) of the export snapshot record.

', 'ExportSnapshotRecordSourceInfo$name' => '

The name of the source instance or disk snapshot.

', 'ExportSnapshotRecordSourceInfo$arn' => '

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

', 'ExportSnapshotRecordSourceInfo$fromResourceName' => '

The name of the snapshot\'s source instance or disk.

', 'ExportSnapshotRecordSourceInfo$fromResourceArn' => '

The Amazon Resource Name (ARN) of the snapshot\'s source instance or disk.

', 'GetOperationRequest$operationId' => '

A GUID used to identify the operation.

', 'Instance$arn' => '

The Amazon Resource Name (ARN) of the instance (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

', 'Instance$blueprintId' => '

The blueprint ID (os_amlinux_2016_03).

', 'Instance$blueprintName' => '

The friendly name of the blueprint (Amazon Linux).

', 'Instance$bundleId' => '

The bundle for the instance (micro_1_0).

', 'Instance$username' => '

The user name for connecting to the instance (ec2-user).

', 'InstanceEntry$instanceType' => '

The instance type (t2.micro) to use for the new Amazon EC2 instance.

', 'InstanceSnapshot$arn' => '

The Amazon Resource Name (ARN) of the snapshot (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

', 'InstanceSnapshot$fromInstanceArn' => '

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

', 'InstanceSnapshotInfo$fromBundleId' => '

The bundle ID from which the source instance was created (micro_1_0).

', 'InstanceSnapshotInfo$fromBlueprintId' => '

The blueprint ID from which the source instance (os_debian_8_3).

', 'KeyPair$arn' => '

The Amazon Resource Name (ARN) of the key pair (arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

', 'LightsailDistribution$arn' => '

The Amazon Resource Name (ARN) of the distribution.

', 'LoadBalancer$arn' => '

The Amazon Resource Name (ARN) of the load balancer.

', 'LoadBalancer$dnsName' => '

The DNS name of your Lightsail load balancer.

', 'LoadBalancer$healthCheckPath' => '

The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

', 'LoadBalancerTlsCertificate$arn' => '

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

', 'LoadBalancerTlsCertificate$issuer' => '

The issuer of the certificate.

', 'LoadBalancerTlsCertificate$keyAlgorithm' => '

The algorithm used to generate the key pair (the public and private key).

', 'LoadBalancerTlsCertificate$serial' => '

The serial number of the certificate.

', 'LoadBalancerTlsCertificate$signatureAlgorithm' => '

The algorithm that was used to sign the certificate.

', 'LoadBalancerTlsCertificate$subject' => '

The name of the entity that is associated with the public key contained in the certificate.

', 'LoadBalancerTlsCertificateDomainValidationRecord$name' => '

A fully qualified domain name in the certificate. For example, example.com.

', 'LoadBalancerTlsCertificateDomainValidationRecord$type' => '

The type of validation record. For example, CNAME for domain validation.

', 'LoadBalancerTlsCertificateDomainValidationRecord$value' => '

The value for that type.

', 'Operation$id' => '

The ID of the operation.

', 'PartnerIdList$member' => NULL, 'PendingMaintenanceAction$action' => '

The type of pending database maintenance action.

', 'PendingMaintenanceAction$description' => '

Additional detail about the pending database maintenance action.

', 'RelationalDatabase$arn' => '

The Amazon Resource Name (ARN) of the database.

', 'RelationalDatabase$relationalDatabaseBlueprintId' => '

The blueprint ID for the database. A blueprint describes the major engine version of a database.

', 'RelationalDatabase$relationalDatabaseBundleId' => '

The bundle ID for the database. A bundle describes the performance specifications for your database.

', 'RelationalDatabase$state' => '

Describes the current state of the database.

', 'RelationalDatabase$engine' => '

The database software (for example, MySQL).

', 'RelationalDatabase$engineVersion' => '

The database engine version (for example, 5.7.23).

', 'RelationalDatabase$masterUsername' => '

The master user name of the database.

', 'RelationalDatabase$parameterApplyStatus' => '

The status of parameter updates for the database.

', 'RelationalDatabase$preferredBackupWindow' => '

The daily time range during which automated backups are created for the database (for example, 16:00-16:30).

', 'RelationalDatabase$preferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur on the database.

In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

', 'RelationalDatabaseEndpoint$address' => '

Specifies the DNS address of the database.

', 'RelationalDatabaseSnapshot$arn' => '

The Amazon Resource Name (ARN) of the database snapshot.

', 'RelationalDatabaseSnapshot$engine' => '

The software of the database snapshot (for example, MySQL)

', 'RelationalDatabaseSnapshot$engineVersion' => '

The database engine version for the database snapshot (for example, 5.7.23).

', 'RelationalDatabaseSnapshot$state' => '

The state of the database snapshot.

', 'RelationalDatabaseSnapshot$fromRelationalDatabaseName' => '

The name of the source database from which the database snapshot was created.

', 'RelationalDatabaseSnapshot$fromRelationalDatabaseArn' => '

The Amazon Resource Name (ARN) of the database from which the database snapshot was created.

', 'ResourceReceivingAccess$name' => '

The name of the Lightsail instance.

', 'ResourceReceivingAccess$resourceType' => '

The Lightsail resource type (for example, Instance).

', 'Session$name' => '

The session name.

', 'SetupExecutionDetails$name' => '

The name of the target resource.

', 'SetupHistory$operationId' => '

A GUID that\'s used to identify the operation.

', 'SetupHistoryResource$arn' => '

The Amazon Resource Name (ARN) of the Lightsail resource.

', 'StaticIp$arn' => '

The Amazon Resource Name (ARN) of the static IP (arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

', 'UpdateBucketBundleRequest$bundleId' => '

The ID of the new bundle to apply to the bucket.

Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

', 'UpdateBucketRequest$versioning' => '

Specifies whether to enable or suspend versioning of objects in the bucket.

The following options can be specified:

  • Enabled - Enables versioning of objects in the specified bucket.

  • Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.

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

Lightsail throws this exception when it cannot find a resource.

', 'refs' => [], ], 'NotificationTriggerList' => [ 'base' => NULL, 'refs' => [ 'Alarm$notificationTriggers' => '

The alarm states that trigger a notification.

', 'PutAlarmRequest$notificationTriggers' => '

The alarm states that trigger a notification.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

  • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

  • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don\'t specify this parameter.

', ], ], 'OpenInstancePublicPortsRequest' => [ 'base' => NULL, 'refs' => [], ], 'OpenInstancePublicPortsResult' => [ 'base' => NULL, 'refs' => [], ], 'Operation' => [ 'base' => '

Describes the API operation.

', 'refs' => [ 'AttachCertificateToDistributionResult$operation' => '

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CloseInstancePublicPortsResult$operation' => '

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDistributionResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDomainEntryResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDomainResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateKeyPairResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteDistributionResult$operation' => '

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteDomainEntryResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteDomainResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteKeyPairResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DetachCertificateFromDistributionResult$operation' => '

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'GetOperationResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'ImportKeyPairResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'OpenInstancePublicPortsResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'OperationList$member' => NULL, 'PeerVpcResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'PutInstancePublicPortsResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'ResetDistributionCacheResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UnpeerVpcResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateDistributionBundleResult$operation' => '

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateDistributionResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateInstanceMetadataOptionsResult$operation' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', ], ], 'OperationFailureException' => [ 'base' => '

Lightsail throws this exception when an operation fails to execute.

', 'refs' => [], ], 'OperationList' => [ 'base' => NULL, 'refs' => [ 'AllocateStaticIpResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'AttachDiskResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'AttachInstancesToLoadBalancerResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'AttachLoadBalancerTlsCertificateResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

These SSL/TLS certificates are only usable by Lightsail load balancers. You can\'t get the certificate and use it for another purpose.

', 'AttachStaticIpResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CopySnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateBucketAccessKeyResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateBucketResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateCertificateResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateCloudFormationStackResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateContactMethodResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDiskFromSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDiskResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateDiskSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateInstanceSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateInstancesFromSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateInstancesResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateLoadBalancerResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateLoadBalancerTlsCertificateResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateRelationalDatabaseFromSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'CreateRelationalDatabaseSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteAlarmResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteAutoSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteBucketAccessKeyResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteBucketResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteCertificateResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteContactMethodResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteDiskResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteDiskSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteInstanceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteInstanceSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteKnownHostKeysResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteLoadBalancerResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteLoadBalancerTlsCertificateResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DeleteRelationalDatabaseSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DetachDiskResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DetachInstancesFromLoadBalancerResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DetachStaticIpResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'DisableAddOnResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'EnableAddOnResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'ExportSnapshotResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'GetOperationsForResourceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'GetOperationsResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'PutAlarmResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'RebootInstanceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'RebootRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'ReleaseStaticIpResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'SendContactMethodVerificationResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'SetIpAddressTypeResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'SetResourceAccessForBucketResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'SetupInstanceHttpsResult$operations' => '

The available API operations for SetupInstanceHttps.

', 'StartGUISessionResult$operations' => '

The available API operations.

', 'StartInstanceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'StartRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'StopGUISessionResult$operations' => '

The available API operations.

', 'StopInstanceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'StopRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'TagResourceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'TestAlarmResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UntagResourceResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateBucketBundleResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateBucketResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateDomainEntryResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateLoadBalancerAttributeResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateRelationalDatabaseParametersResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', 'UpdateRelationalDatabaseResult$operations' => '

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

', ], ], 'OperationStatus' => [ 'base' => NULL, 'refs' => [ 'Operation$status' => '

The status of the operation.

', ], ], 'OperationType' => [ 'base' => NULL, 'refs' => [ 'Operation$operationType' => '

The type of operation.

', ], ], 'Origin' => [ 'base' => '

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

', 'refs' => [ 'LightsailDistribution$origin' => '

An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

', ], ], 'OriginProtocolPolicyEnum' => [ 'base' => NULL, 'refs' => [ 'InputOrigin$protocolPolicy' => '

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

', 'Origin$protocolPolicy' => '

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

', ], ], 'PartnerIdList' => [ 'base' => NULL, 'refs' => [ 'Bucket$readonlyAccessAccounts' => '

An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

', 'UpdateBucketRequest$readonlyAccessAccounts' => '

An array of strings to specify the Amazon Web Services account IDs that can access the bucket.

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

', ], ], 'PasswordData' => [ 'base' => '

The password data for the Windows Server-based instance, including the ciphertext and the key pair name.

', 'refs' => [ 'InstanceAccessDetails$passwordData' => '

For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.

', ], ], 'PeerVpcRequest' => [ 'base' => NULL, 'refs' => [], ], 'PeerVpcResult' => [ 'base' => NULL, 'refs' => [], ], 'PendingMaintenanceAction' => [ 'base' => '

Describes a pending database maintenance action.

', 'refs' => [ 'PendingMaintenanceActionList$member' => NULL, ], ], 'PendingMaintenanceActionList' => [ 'base' => NULL, 'refs' => [ 'RelationalDatabase$pendingMaintenanceActions' => '

Describes the pending maintenance actions for the database.

', ], ], 'PendingModifiedRelationalDatabaseValues' => [ 'base' => '

Describes a pending database value modification.

', 'refs' => [ 'RelationalDatabase$pendingModifiedValues' => '

Describes pending database value modifications.

', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'CreateLoadBalancerRequest$instancePort' => '

The instance port where you\'re creating your load balancer.

', 'InstancePortInfo$fromPort' => '

The first port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'InstancePortInfo$toPort' => '

The last port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'InstancePortState$fromPort' => '

The first port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'InstancePortState$toPort' => '

The last port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'PortInfo$fromPort' => '

The first port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'PortInfo$toPort' => '

The last port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

  • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

', 'PortList$member' => NULL, ], ], 'PortAccessType' => [ 'base' => NULL, 'refs' => [ 'InstancePortInfo$accessType' => '

The type of access (Public or Private).

', ], ], 'PortInfo' => [ 'base' => '

Describes ports to open on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

', 'refs' => [ 'CloseInstancePublicPortsRequest$portInfo' => '

An object to describe the ports to close for the specified instance.

', 'OpenInstancePublicPortsRequest$portInfo' => '

An object to describe the ports to open for the specified instance.

', 'PortInfoList$member' => NULL, ], ], 'PortInfoList' => [ 'base' => NULL, 'refs' => [ 'PutInstancePublicPortsRequest$portInfos' => '

An array of objects to describe the ports to open for the specified instance.

', ], ], 'PortInfoSourceType' => [ 'base' => NULL, 'refs' => [ 'InstanceEntry$portInfoSource' => '

The port configuration to use for the new Amazon EC2 instance.

The following configuration options are available:

  • DEFAULT - Use the default firewall settings from the Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2.

  • INSTANCE - Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

  • NONE - Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

  • CLOSED - All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

If you configured lightsail-connect as a cidrListAliases on your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance.

', ], ], 'PortList' => [ 'base' => NULL, 'refs' => [ 'LoadBalancer$publicPorts' => '

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

', ], ], 'PortMap' => [ 'base' => NULL, 'refs' => [ 'Container$ports' => '

The open firewall ports of the container.

', ], ], 'PortState' => [ 'base' => NULL, 'refs' => [ 'InstancePortState$state' => '

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

', ], ], 'PricingUnit' => [ 'base' => NULL, 'refs' => [ 'EstimateByTime$pricingUnit' => '

The unit of measurement that\'s used for the cost estimate.

', ], ], 'PrivateRegistryAccess' => [ 'base' => '

Describes the configuration for an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'ContainerService$privateRegistryAccess' => '

An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', ], ], 'PrivateRegistryAccessRequest' => [ 'base' => '

Describes a request to configure an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'CreateContainerServiceRequest$privateRegistryAccess' => '

An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', 'UpdateContainerServiceRequest$privateRegistryAccess' => '

An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

', ], ], 'PutAlarmRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAlarmResult' => [ 'base' => NULL, 'refs' => [], ], 'PutInstancePublicPortsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutInstancePublicPortsResult' => [ 'base' => NULL, 'refs' => [], ], 'QueryStringObject' => [ 'base' => '

Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.

For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.

', 'refs' => [ 'CacheSettings$forwardedQueryStrings' => '

An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.

', ], ], 'R53HostedZoneDeletionState' => [ 'base' => '

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone.

', 'refs' => [ 'RegisteredDomainDelegationInfo$r53HostedZoneDeletionState' => '

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone.

', ], ], 'R53HostedZoneDeletionStateCode' => [ 'base' => NULL, 'refs' => [ 'R53HostedZoneDeletionState$code' => '

The status code for the deletion state.

Following are the possible values:

  • SUCCEEDED - The hosted zone was successfully deleted.

  • PENDING - The hosted zone deletion is in progress.

  • FAILED - The hosted zone deletion failed.

  • STARTED - The hosted zone deletion started.

', ], ], 'RebootInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RebootInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'RebootRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'RebootRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'RecordState' => [ 'base' => NULL, 'refs' => [ 'CloudFormationStackRecord$state' => '

The current state of the CloudFormation stack record.

', 'ExportSnapshotRecord$state' => '

The state of the export snapshot record.

', ], ], 'Region' => [ 'base' => '

Describes the Amazon Web Services Region.

', 'refs' => [ 'RegionList$member' => NULL, ], ], 'RegionList' => [ 'base' => NULL, 'refs' => [ 'GetRegionsResult$regions' => '

An array of key-value pairs containing information about your get regions request.

', ], ], 'RegionName' => [ 'base' => NULL, 'refs' => [ 'CopySnapshotRequest$sourceRegion' => '

The Amazon Web Services Region where the source manual or automatic snapshot is located.

', 'InputOrigin$regionName' => '

The AWS Region name of the origin resource.

', 'Origin$regionName' => '

The AWS Region name of the origin resource.

', 'Region$name' => '

The region name (us-east-2).

', 'ResourceLocation$regionName' => '

The Amazon Web Services Region name.

', ], ], 'RegisterContainerImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerImageResult' => [ 'base' => NULL, 'refs' => [], ], 'RegisteredDomainDelegationInfo' => [ 'base' => '

Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail.

When you delegate an Amazon Route 53 registered domain to Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You no longer use the Route 53 hosted zone to manage the DNS of the domain. To delegate the domain, Lightsail automatically updates the domain\'s name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the domain.

All of the following conditions must be true for automatic domain delegation to be successful:

  • The registered domain must be in the same Amazon Web Services account as the Lightsail account making the request.

  • The user or entity making the request must have permission to manage domains in Route 53.

  • The Route 53 hosted zone for the domain must be empty. It cannot contain DNS records other than start of authority (SOA) and name server records.

If automatic domain delegation fails, or if you manage the DNS of your domain using a service other than Route 53, then you must manually add the Lightsail DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domain’s records in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'refs' => [ 'Domain$registeredDomainDelegationInfo' => '

An object that describes the state of the Route 53 domain delegation to a Lightsail DNS zone.

', ], ], 'RelationalDatabase' => [ 'base' => '

Describes a database.

', 'refs' => [ 'GetRelationalDatabaseResult$relationalDatabase' => '

An object describing the specified database.

', 'RelationalDatabaseList$member' => NULL, ], ], 'RelationalDatabaseBlueprint' => [ 'base' => '

Describes a database image, or blueprint. A blueprint describes the major engine version of a database.

', 'refs' => [ 'RelationalDatabaseBlueprintList$member' => NULL, ], ], 'RelationalDatabaseBlueprintList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseBlueprintsResult$blueprints' => '

An object describing the result of your get relational database blueprints request.

', ], ], 'RelationalDatabaseBundle' => [ 'base' => '

Describes a database bundle. A bundle describes the performance specifications of the database.

', 'refs' => [ 'RelationalDatabaseBundleList$member' => NULL, ], ], 'RelationalDatabaseBundleList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseBundlesResult$bundles' => '

An object describing the result of your get relational database bundles request.

', ], ], 'RelationalDatabaseEndpoint' => [ 'base' => '

Describes an endpoint for a database.

', 'refs' => [ 'RelationalDatabase$masterEndpoint' => '

The master endpoint for the database.

', ], ], 'RelationalDatabaseEngine' => [ 'base' => NULL, 'refs' => [ 'RelationalDatabaseBlueprint$engine' => '

The database software of the database blueprint (for example, MySQL).

', ], ], 'RelationalDatabaseEvent' => [ 'base' => '

Describes an event for a database.

', 'refs' => [ 'RelationalDatabaseEventList$member' => NULL, ], ], 'RelationalDatabaseEventList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseEventsResult$relationalDatabaseEvents' => '

An object describing the result of your get relational database events request.

', ], ], 'RelationalDatabaseHardware' => [ 'base' => '

Describes the hardware of a database.

', 'refs' => [ 'RelationalDatabase$hardware' => '

Describes the hardware of the database.

', ], ], 'RelationalDatabaseList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabasesResult$relationalDatabases' => '

An object describing the result of your get relational databases request.

', ], ], 'RelationalDatabaseMetricName' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseMetricDataRequest$metricName' => '

The metric for which you want to return information.

Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

  • CPUUtilization - The percentage of CPU utilization currently in use on the database.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

  • DatabaseConnections - The number of database connections in use.

    Statistics: The most useful statistics are Maximum and Sum.

    Unit: The published unit is Count.

  • DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • FreeStorageSpace - The amount of available storage space.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Bytes.

  • NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Bytes/Second.

  • NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Bytes/Second.

', 'GetRelationalDatabaseMetricDataResult$metricName' => '

The name of the metric returned.

', ], ], 'RelationalDatabaseParameter' => [ 'base' => '

Describes the parameters of a database.

', 'refs' => [ 'RelationalDatabaseParameterList$member' => NULL, ], ], 'RelationalDatabaseParameterList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseParametersResult$parameters' => '

An object describing the result of your get relational database parameters request.

', 'UpdateRelationalDatabaseParametersRequest$parameters' => '

The database parameters to update.

', ], ], 'RelationalDatabasePasswordVersion' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseMasterUserPasswordRequest$passwordVersion' => '

The password version to return.

Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively. Specifying PENDING returns the newest version of the password that will rotate to CURRENT. After the PENDING password rotates to CURRENT, the PENDING password is no longer available.

Default: CURRENT

', ], ], 'RelationalDatabaseSnapshot' => [ 'base' => '

Describes a database snapshot.

', 'refs' => [ 'GetRelationalDatabaseSnapshotResult$relationalDatabaseSnapshot' => '

An object describing the specified database snapshot.

', 'RelationalDatabaseSnapshotList$member' => NULL, ], ], 'RelationalDatabaseSnapshotList' => [ 'base' => NULL, 'refs' => [ 'GetRelationalDatabaseSnapshotsResult$relationalDatabaseSnapshots' => '

An object describing the result of your get relational database snapshots request.

', ], ], 'ReleaseStaticIpRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReleaseStaticIpResult' => [ 'base' => NULL, 'refs' => [], ], 'RenewalStatus' => [ 'base' => NULL, 'refs' => [ 'RenewalSummary$renewalStatus' => '

The renewal status of the certificate.

The following renewal status are possible:

  • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.

  • PendingValidation - Lightsail couldn\'t automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won\'t be renewed. Check to make sure your certificate\'s domain validation records exist in your domain\'s DNS, and that your certificate remains in use.

  • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

  • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

', ], ], 'RenewalStatusReason' => [ 'base' => NULL, 'refs' => [ 'RenewalSummary$renewalStatusReason' => '

The reason for the renewal status of the certificate.

', ], ], 'RenewalSummary' => [ 'base' => '

Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.

', 'refs' => [ 'Certificate$renewalSummary' => '

An object that describes the status of the certificate renewal managed by Lightsail.

', ], ], 'RequestFailureReason' => [ 'base' => NULL, 'refs' => [ 'Certificate$requestFailureReason' => '

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the Amazon Web Services Support Center to contact Amazon Web Services Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the Amazon Web Services Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

', ], ], 'ResetDistributionCacheRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetDistributionCacheResult' => [ 'base' => NULL, 'refs' => [], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'MonitoredResourceInfo$arn' => '

The Amazon Resource Name (ARN) of the resource being monitored.

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

', ], ], 'ResourceBucketAccess' => [ 'base' => NULL, 'refs' => [ 'SetResourceAccessForBucketRequest$access' => '

The access setting.

The following access settings are available:

  • allow - Allows access to the bucket and its objects.

  • deny - Denies access to the bucket and its objects. Use this setting to remove access for a resource previously set to allow.

', ], ], 'ResourceBudgetEstimate' => [ 'base' => '

Describes the estimated cost or usage that a budget tracks.

', 'refs' => [ 'ResourcesBudgetEstimate$member' => NULL, ], ], 'ResourceLocation' => [ 'base' => '

Describes the resource location.

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

An object that lists information about the location of the alarm.

', 'Bucket$location' => '

An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

', 'CloudFormationStackRecord$location' => '

A list of objects describing the Availability Zone and Amazon Web Services Region of the CloudFormation stack record.

', 'ContactMethod$location' => '

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

', 'ContainerService$location' => '

An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

', 'Disk$location' => '

The AWS Region and Availability Zone where the disk is located.

', 'DiskSnapshot$location' => '

The AWS Region and Availability Zone where the disk snapshot was created.

', 'Domain$location' => '

The AWS Region and Availability Zones where the domain recordset was created.

', 'ExportSnapshotRecord$location' => '

The AWS Region and Availability Zone where the export snapshot record is located.

', 'Instance$location' => '

The region name and Availability Zone where the instance is located.

', 'InstanceSnapshot$location' => '

The region name and Availability Zone where you created the snapshot.

', 'KeyPair$location' => '

The region name and Availability Zone where the key pair was created.

', 'LightsailDistribution$location' => '

An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.

Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

', 'LoadBalancer$location' => '

The AWS Region where your load balancer was created (us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

', 'LoadBalancerTlsCertificate$location' => '

The Amazon Web Services Region and Availability Zone where you created your certificate.

', 'Operation$location' => '

The Amazon Web Services Region and Availability Zone.

', 'RelationalDatabase$location' => '

The Region name and Availability Zone where the database is located.

', 'RelationalDatabaseSnapshot$location' => '

The Region name and Availability Zone where the database snapshot is located.

', 'SetupHistoryResource$location' => NULL, 'StaticIp$location' => '

The region and Availability Zone where the static IP was created.

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'Alarm$name' => '

The name of the alarm.

', 'AllocateStaticIpRequest$staticIpName' => '

The name of the static IP address.

', 'AttachCertificateToDistributionRequest$distributionName' => '

The name of the distribution that the certificate will be attached to.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'AttachCertificateToDistributionRequest$certificateName' => '

The name of the certificate to attach to a distribution.

Only certificates with a status of ISSUED can be attached to a distribution.

Use the GetCertificates action to get a list of certificate names that you can specify.

This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com.

', 'AttachDiskRequest$diskName' => '

The unique Lightsail disk name (my-disk).

', 'AttachDiskRequest$instanceName' => '

The name of the Lightsail instance where you want to utilize the storage disk.

', 'AttachInstancesToLoadBalancerRequest$loadBalancerName' => '

The name of the load balancer.

', 'AttachLoadBalancerTlsCertificateRequest$loadBalancerName' => '

The name of the load balancer to which you want to associate the SSL/TLS certificate.

', 'AttachLoadBalancerTlsCertificateRequest$certificateName' => '

The name of your SSL/TLS certificate.

', 'AttachStaticIpRequest$staticIpName' => '

The name of the static IP.

', 'AttachStaticIpRequest$instanceName' => '

The instance name to which you want to attach the static IP address.

', 'AttachedDiskMap$key' => NULL, 'Blueprint$name' => '

The friendly name of the blueprint (Amazon Linux).

', 'CloseInstancePublicPortsRequest$instanceName' => '

The name of the instance for which to close ports.

', 'CloudFormationStackRecord$name' => '

The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID.

', 'ContactMethod$name' => '

The name of the contact method.

', 'CopySnapshotRequest$sourceSnapshotName' => '

The name of the source manual snapshot to copy.

Constraint:

  • Define this parameter only when copying a manual snapshot as another manual snapshot.

', 'CopySnapshotRequest$targetSnapshotName' => '

The name of the new manual snapshot to be created as a copy.

', 'CreateDiskFromSnapshotRequest$diskName' => '

The unique Lightsail disk name (my-disk).

', 'CreateDiskFromSnapshotRequest$diskSnapshotName' => '

The name of the disk snapshot (my-snapshot) from which to create the new storage disk.

Constraint:

  • This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

', 'CreateDiskRequest$diskName' => '

The unique Lightsail disk name (my-disk).

', 'CreateDiskSnapshotRequest$diskName' => '

The unique name of the source disk (Disk-Virginia-1).

This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.

', 'CreateDiskSnapshotRequest$diskSnapshotName' => '

The name of the destination disk snapshot (my-disk-snapshot) based on the source disk.

', 'CreateDiskSnapshotRequest$instanceName' => '

The unique name of the source instance (Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance\'s system volume is created.

This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.

', 'CreateDistributionRequest$distributionName' => '

The name for the distribution.

', 'CreateGUISessionAccessDetailsRequest$resourceName' => '

The resource name.

', 'CreateGUISessionAccessDetailsResult$resourceName' => '

The resource name.

', 'CreateInstanceSnapshotRequest$instanceSnapshotName' => '

The name for your new snapshot.

', 'CreateInstanceSnapshotRequest$instanceName' => '

The Lightsail instance on which to base your snapshot.

', 'CreateInstancesFromSnapshotRequest$instanceSnapshotName' => '

The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.

Constraint:

  • This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.

', 'CreateInstancesFromSnapshotRequest$keyPairName' => '

The name for your key pair.

', 'CreateInstancesRequest$customImageName' => '

(Discontinued) The name for your custom image.

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.

', 'CreateInstancesRequest$keyPairName' => '

The name of your key pair.

', 'CreateKeyPairRequest$keyPairName' => '

The name for your new key pair.

', 'CreateLoadBalancerRequest$loadBalancerName' => '

The name of your load balancer.

', 'CreateLoadBalancerRequest$certificateName' => '

The name of the SSL/TLS certificate.

If you specify certificateName, then certificateDomainName is required (and vice-versa).

', 'CreateLoadBalancerTlsCertificateRequest$loadBalancerName' => '

The load balancer name where you want to create the SSL/TLS certificate.

', 'CreateLoadBalancerTlsCertificateRequest$certificateName' => '

The SSL/TLS certificate name.

You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.

', 'CreateRelationalDatabaseFromSnapshotRequest$relationalDatabaseName' => '

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

', 'CreateRelationalDatabaseFromSnapshotRequest$relationalDatabaseSnapshotName' => '

The name of the database snapshot from which to create your new database.

', 'CreateRelationalDatabaseFromSnapshotRequest$sourceRelationalDatabaseName' => '

The name of the source database.

', 'CreateRelationalDatabaseRequest$relationalDatabaseName' => '

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

', 'CreateRelationalDatabaseSnapshotRequest$relationalDatabaseName' => '

The name of the database on which to base your new snapshot.

', 'CreateRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName' => '

The name for your new database snapshot.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

', 'DeleteAlarmRequest$alarmName' => '

The name of the alarm to delete.

', 'DeleteAutoSnapshotRequest$resourceName' => '

The name of the source instance or disk from which to delete the automatic snapshot.

', 'DeleteDiskRequest$diskName' => '

The unique name of the disk you want to delete (my-disk).

', 'DeleteDiskSnapshotRequest$diskSnapshotName' => '

The name of the disk snapshot you want to delete (my-disk-snapshot).

', 'DeleteDistributionRequest$distributionName' => '

The name of the distribution to delete.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'DeleteInstanceRequest$instanceName' => '

The name of the instance to delete.

', 'DeleteInstanceSnapshotRequest$instanceSnapshotName' => '

The name of the snapshot to delete.

', 'DeleteKeyPairRequest$keyPairName' => '

The name of the key pair to delete.

', 'DeleteKnownHostKeysRequest$instanceName' => '

The name of the instance for which you want to reset the host key or certificate.

', 'DeleteLoadBalancerRequest$loadBalancerName' => '

The name of the load balancer you want to delete.

', 'DeleteLoadBalancerTlsCertificateRequest$loadBalancerName' => '

The load balancer name.

', 'DeleteLoadBalancerTlsCertificateRequest$certificateName' => '

The SSL/TLS certificate name.

', 'DeleteRelationalDatabaseRequest$relationalDatabaseName' => '

The name of the database that you are deleting.

', 'DeleteRelationalDatabaseRequest$finalRelationalDatabaseSnapshotName' => '

The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.

Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

', 'DeleteRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName' => '

The name of the database snapshot that you are deleting.

', 'DetachCertificateFromDistributionRequest$distributionName' => '

The name of the distribution from which to detach the certificate.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'DetachDiskRequest$diskName' => '

The unique name of the disk you want to detach from your instance (my-disk).

', 'DetachInstancesFromLoadBalancerRequest$loadBalancerName' => '

The name of the Lightsail load balancer.

', 'DetachStaticIpRequest$staticIpName' => '

The name of the static IP to detach from the instance.

', 'DisableAddOnRequest$resourceName' => '

The name of the source resource for which to disable the add-on.

', 'Disk$name' => '

The unique name of the disk.

', 'Disk$attachedTo' => '

The resources to which the disk is attached.

', 'DiskMap$newDiskName' => '

The new disk name (my-new-disk).

', 'DiskSnapshot$name' => '

The name of the disk snapshot (my-disk-snapshot).

', 'DiskSnapshot$fromDiskName' => '

The unique name of the source disk from which the disk snapshot was created.

', 'DiskSnapshot$fromInstanceName' => '

The unique name of the source instance from which the disk (system volume) snapshot was created.

', 'Domain$name' => '

The name of the domain.

', 'EnableAddOnRequest$resourceName' => '

The name of the source resource for which to enable or modify the add-on.

', 'ExportSnapshotRecord$name' => '

The export snapshot record name.

', 'ExportSnapshotRequest$sourceSnapshotName' => '

The name of the instance or disk snapshot to be exported to Amazon EC2.

', 'GetAlarmsRequest$alarmName' => '

The name of the alarm.

Specify an alarm name to return information about a specific alarm.

', 'GetAlarmsRequest$monitoredResourceName' => '

The name of the Lightsail resource being monitored by the alarm.

Specify a monitored resource name to return information about all alarms for a specific resource.

', 'GetAutoSnapshotsRequest$resourceName' => '

The name of the source instance or disk from which to get automatic snapshot information.

', 'GetAutoSnapshotsResult$resourceName' => '

The name of the source instance or disk for the automatic snapshots.

', 'GetCostEstimateRequest$resourceName' => '

The resource name.

', 'GetDiskRequest$diskName' => '

The name of the disk (my-disk).

', 'GetDiskSnapshotRequest$diskSnapshotName' => '

The name of the disk snapshot (my-disk-snapshot).

', 'GetDistributionLatestCacheResetRequest$distributionName' => '

The name of the distribution for which to return the timestamp of the last cache reset.

Use the GetDistributions action to get a list of distribution names that you can specify.

When omitted, the response includes the latest cache reset timestamp of all your distributions.

', 'GetDistributionMetricDataRequest$distributionName' => '

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'GetDistributionsRequest$distributionName' => '

The name of the distribution for which to return information.

When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.

', 'GetInstanceAccessDetailsRequest$instanceName' => '

The name of the instance to access.

', 'GetInstanceMetricDataRequest$instanceName' => '

The name of the instance for which you want to get metrics data.

', 'GetInstancePortStatesRequest$instanceName' => '

The name of the instance for which to return firewall port states.

', 'GetInstanceRequest$instanceName' => '

The name of the instance.

', 'GetInstanceSnapshotRequest$instanceSnapshotName' => '

The name of the snapshot for which you are requesting information.

', 'GetInstanceStateRequest$instanceName' => '

The name of the instance to get state information about.

', 'GetKeyPairRequest$keyPairName' => '

The name of the key pair for which you are requesting information.

', 'GetLoadBalancerMetricDataRequest$loadBalancerName' => '

The name of the load balancer.

', 'GetLoadBalancerRequest$loadBalancerName' => '

The name of the load balancer.

', 'GetLoadBalancerTlsCertificatesRequest$loadBalancerName' => '

The name of the load balancer you associated with your SSL/TLS certificate.

', 'GetOperationsForResourceRequest$resourceName' => '

The name of the resource for which you are requesting information.

', 'GetRelationalDatabaseEventsRequest$relationalDatabaseName' => '

The name of the database from which to get events.

', 'GetRelationalDatabaseLogEventsRequest$relationalDatabaseName' => '

The name of your database for which to get log events.

', 'GetRelationalDatabaseLogStreamsRequest$relationalDatabaseName' => '

The name of your database for which to get log streams.

', 'GetRelationalDatabaseMasterUserPasswordRequest$relationalDatabaseName' => '

The name of your database for which to get the master user password.

', 'GetRelationalDatabaseMetricDataRequest$relationalDatabaseName' => '

The name of your database from which to get metric data.

', 'GetRelationalDatabaseParametersRequest$relationalDatabaseName' => '

The name of your database for which to get parameters.

', 'GetRelationalDatabaseRequest$relationalDatabaseName' => '

The name of the database that you are looking up.

', 'GetRelationalDatabaseSnapshotRequest$relationalDatabaseSnapshotName' => '

The name of the database snapshot for which to get information.

', 'GetSetupHistoryRequest$resourceName' => '

The name of the resource for which you are requesting information.

', 'GetStaticIpRequest$staticIpName' => '

The name of the static IP in Lightsail.

', 'ImportKeyPairRequest$keyPairName' => '

The name of the key pair for which you want to import the public key.

', 'InputOrigin$name' => '

The name of the origin resource.

', 'Instance$name' => '

The name the user gave the instance (Amazon_Linux-1GB-Ohio-1).

', 'Instance$sshKeyName' => '

The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).

', 'InstanceAccessDetails$instanceName' => '

The name of this Amazon Lightsail instance.

', 'InstanceEntry$sourceName' => '

The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.

Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack.

', 'InstanceHealthSummary$instanceName' => '

The name of the Lightsail instance for which you are requesting health check data.

', 'InstanceSnapshot$name' => '

The name of the snapshot.

', 'InstanceSnapshot$fromInstanceName' => '

The instance from which the snapshot was created.

', 'KeyPair$name' => '

The friendly name of the SSH key pair.

', 'LightsailDistribution$name' => '

The name of the distribution.

', 'LightsailDistribution$certificateName' => '

The name of the SSL/TLS certificate attached to the distribution, if any.

', 'LoadBalancer$name' => '

The name of the load balancer (my-load-balancer).

', 'LoadBalancer$tlsPolicyName' => '

The name of the TLS security policy for the load balancer.

', 'LoadBalancerTlsCertificate$name' => '

The name of the SSL/TLS certificate (my-certificate).

', 'LoadBalancerTlsCertificate$loadBalancerName' => '

The load balancer name where your SSL/TLS certificate is attached.

', 'LoadBalancerTlsCertificateSummary$name' => '

The name of the SSL/TLS certificate.

', 'LoadBalancerTlsPolicy$name' => '

The name of the TLS security policy.

', 'MonitoredResourceInfo$name' => '

The name of the Lightsail resource being monitored.

', 'OpenInstancePublicPortsRequest$instanceName' => '

The name of the instance for which to open ports.

', 'Operation$resourceName' => '

The resource name.

', 'Origin$name' => '

The name of the origin resource.

', 'PasswordData$keyPairName' => '

The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair).

If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair.

', 'PutAlarmRequest$alarmName' => '

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

', 'PutAlarmRequest$monitoredResourceName' => '

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

', 'PutInstancePublicPortsRequest$instanceName' => '

The name of the instance for which to open ports.

', 'RebootInstanceRequest$instanceName' => '

The name of the instance to reboot.

', 'RebootRelationalDatabaseRequest$relationalDatabaseName' => '

The name of your database to reboot.

', 'RelationalDatabase$name' => '

The unique name of the database resource in Lightsail.

', 'RelationalDatabaseEvent$resource' => '

The database that the database event relates to.

', 'RelationalDatabaseSnapshot$name' => '

The name of the database snapshot.

', 'ReleaseStaticIpRequest$staticIpName' => '

The name of the static IP to delete.

', 'ResetDistributionCacheRequest$distributionName' => '

The name of the distribution for which to reset cache.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'ResourceBudgetEstimate$resourceName' => '

The resource name.

', 'ResourceNameList$member' => NULL, 'SetIpAddressTypeRequest$resourceName' => '

The name of the resource for which to set the IP address type.

', 'SetResourceAccessForBucketRequest$resourceName' => '

The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state.

', 'SetupHistoryResource$name' => '

The name of the Lightsail resource.

', 'SetupInstanceHttpsRequest$instanceName' => '

The name of the Lightsail instance.

', 'SetupRequest$instanceName' => '

The name of the Lightsail instance.

', 'StartGUISessionRequest$resourceName' => '

The resource name.

', 'StartInstanceRequest$instanceName' => '

The name of the instance (a virtual private server) to start.

', 'StartRelationalDatabaseRequest$relationalDatabaseName' => '

The name of your database to start.

', 'StaticIp$name' => '

The name of the static IP (StaticIP-Ohio-EXAMPLE).

', 'StaticIp$attachedTo' => '

The instance where the static IP is attached (Amazon_Linux-1GB-Ohio-1).

', 'StopGUISessionRequest$resourceName' => '

The resource name.

', 'StopInstanceRequest$instanceName' => '

The name of the instance (a virtual private server) to stop.

', 'StopRelationalDatabaseRequest$relationalDatabaseName' => '

The name of your database to stop.

', 'StopRelationalDatabaseRequest$relationalDatabaseSnapshotName' => '

The name of your new database snapshot to be created before stopping your database.

', 'TagResourceRequest$resourceName' => '

The name of the resource to which you are adding tags.

', 'TestAlarmRequest$alarmName' => '

The name of the alarm to test.

', 'UntagResourceRequest$resourceName' => '

The name of the resource from which you are removing a tag.

', 'UpdateDistributionBundleRequest$distributionName' => '

The name of the distribution for which to update the bundle.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'UpdateDistributionRequest$distributionName' => '

The name of the distribution to update.

Use the GetDistributions action to get a list of distribution names that you can specify.

', 'UpdateInstanceMetadataOptionsRequest$instanceName' => '

The name of the instance for which to update metadata parameters.

', 'UpdateLoadBalancerAttributeRequest$loadBalancerName' => '

The name of the load balancer that you want to modify (my-load-balancer.

', 'UpdateRelationalDatabaseParametersRequest$relationalDatabaseName' => '

The name of your database for which to update parameters.

', 'UpdateRelationalDatabaseRequest$relationalDatabaseName' => '

The name of your Lightsail database resource to update.

', ], ], 'ResourceNameList' => [ 'base' => NULL, 'refs' => [ 'AttachInstancesToLoadBalancerRequest$instanceNames' => '

An array of strings representing the instance name(s) you want to attach to your load balancer.

An instance must be running before you can attach it to your load balancer.

There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).

', 'DetachInstancesFromLoadBalancerRequest$instanceNames' => '

An array of strings containing the names of the instances you want to detach from the load balancer.

', ], ], 'ResourceReceivingAccess' => [ 'base' => '

Describes an Amazon Lightsail instance that has access to a Lightsail bucket.

', 'refs' => [ 'AccessReceiverList$member' => NULL, ], ], 'ResourceRecord' => [ 'base' => '

Describes the domain name system (DNS) records to add to your domain\'s DNS to validate it for an Amazon Lightsail certificate.

', 'refs' => [ 'DomainValidationRecord$resourceRecord' => '

An object that describes the DNS records to add to your domain\'s DNS to validate it for the certificate.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'Alarm$resourceType' => '

The Lightsail resource type of the alarm.

', 'CloudFormationStackRecord$resourceType' => '

The Lightsail resource type (CloudFormationStackRecord).

', 'ContactMethod$resourceType' => '

The Lightsail resource type of the contact method.

', 'ContainerService$resourceType' => '

The Lightsail resource type of the container service.

', 'Disk$resourceType' => '

The Lightsail resource type (Disk).

', 'DiskSnapshot$resourceType' => '

The Lightsail resource type (DiskSnapshot).

', 'Domain$resourceType' => '

The resource type.

', 'ExportSnapshotRecord$resourceType' => '

The Lightsail resource type (ExportSnapshotRecord).

', 'GetAutoSnapshotsResult$resourceType' => '

The resource type of the automatic snapshot. The possible values are Instance, and Disk.

', 'Instance$resourceType' => '

The type of resource (usually Instance).

', 'InstanceSnapshot$resourceType' => '

The type of resource (usually InstanceSnapshot).

', 'KeyPair$resourceType' => '

The resource type (usually KeyPair).

', 'LightsailDistribution$resourceType' => '

The Lightsail resource type (Distribution).

', 'LoadBalancer$resourceType' => '

The resource type (LoadBalancer.

', 'LoadBalancerTlsCertificate$resourceType' => '

The resource type (LoadBalancerTlsCertificate).

  • Instance - A Lightsail instance (a virtual private server)

  • StaticIp - A static IP address

  • KeyPair - The key pair used to connect to a Lightsail instance

  • InstanceSnapshot - A Lightsail instance snapshot

  • Domain - A DNS zone

  • PeeredVpc - A peered VPC

  • LoadBalancer - A Lightsail load balancer

  • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer

  • Disk - A Lightsail block storage disk

  • DiskSnapshot - A block storage disk snapshot

', 'MonitoredResourceInfo$resourceType' => '

The Lightsail resource type of the resource being monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

', 'Operation$resourceType' => '

The resource type.

', 'Origin$resourceType' => '

The resource type of the origin resource (Instance).

', 'RelationalDatabase$resourceType' => '

The Lightsail resource type for the database (for example, RelationalDatabase).

', 'RelationalDatabaseSnapshot$resourceType' => '

The Lightsail resource type.

', 'ResourceBudgetEstimate$resourceType' => '

The type of resource the budget will track.

', 'SetIpAddressTypeRequest$resourceType' => '

The resource type.

The resource values are Distribution, Instance, and LoadBalancer.

Distribution-related APIs are available only in the N. Virginia (us-east-1) Amazon Web Services Region. Set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit distributions.

', 'SetupHistoryResource$resourceType' => '

The Lightsail resource type. For example, Instance.

', 'StaticIp$resourceType' => '

The resource type (usually StaticIp).

', ], ], 'ResourcesBudgetEstimate' => [ 'base' => NULL, 'refs' => [ 'GetCostEstimateResult$resourcesBudgetEstimate' => '

Returns the estimate\'s forecasted cost or usage.

', ], ], 'RevocationReason' => [ 'base' => NULL, 'refs' => [ 'Certificate$revocationReason' => '

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

', ], ], 'SendContactMethodVerificationRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendContactMethodVerificationResult' => [ 'base' => NULL, 'refs' => [], ], 'SensitiveNonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Session$url' => '

The session URL.

', ], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'CreateRelationalDatabaseRequest$masterUserPassword' => '

The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

', 'GetRelationalDatabaseMasterUserPasswordResult$masterUserPassword' => '

The master user password for the password version specified.

', 'UpdateRelationalDatabaseRequest$masterUserPassword' => '

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

MySQL

Constraints: Must contain from 8 to 41 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

', ], ], 'SerialNumber' => [ 'base' => NULL, 'refs' => [ 'Certificate$serialNumber' => '

The serial number of the certificate.

', ], ], 'ServiceException' => [ 'base' => '

A general service exception.

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

Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual computer’s operating system or application.

', 'refs' => [ 'Sessions$member' => NULL, ], ], 'Sessions' => [ 'base' => NULL, 'refs' => [ 'CreateGUISessionAccessDetailsResult$sessions' => '

Returns information about the specified NICE DCV GUI session.

', ], ], 'SetIpAddressTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetIpAddressTypeResult' => [ 'base' => NULL, 'refs' => [], ], 'SetResourceAccessForBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetResourceAccessForBucketResult' => [ 'base' => NULL, 'refs' => [], ], 'SetupDomainName' => [ 'base' => NULL, 'refs' => [ 'SetupDomainNameList$member' => NULL, ], ], 'SetupDomainNameList' => [ 'base' => NULL, 'refs' => [ 'SetupInstanceHttpsRequest$domainNames' => '

The name of the domain and subdomains that were specified for the SSL/TLS certificate.

', 'SetupRequest$domainNames' => '

The name of the domain and subdomains that the SSL/TLS certificate secures.

', ], ], 'SetupExecutionDetails' => [ 'base' => '

Returns details about the commands that were run.

', 'refs' => [ 'SetupExecutionDetailsList$member' => NULL, ], ], 'SetupExecutionDetailsList' => [ 'base' => NULL, 'refs' => [ 'SetupHistory$executionDetails' => '

Describes the full details of the request.

', ], ], 'SetupHistory' => [ 'base' => '

Returns a list of the commands that were ran on the target resource.

The status of each command is also returned.

', 'refs' => [ 'setupHistoryList$member' => NULL, ], ], 'SetupHistoryPageToken' => [ 'base' => NULL, 'refs' => [ 'GetSetupHistoryRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetSetupHistory request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetSetupHistoryResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetSetupHistory request and specify the next page token using the pageToken parameter.

', ], ], 'SetupHistoryResource' => [ 'base' => '

The Lightsail resource that SetupHistory was ran on.

', 'refs' => [ 'SetupHistory$resource' => '

The target resource name for the request.

', ], ], 'SetupInstanceHttpsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SetupInstanceHttpsResult' => [ 'base' => NULL, 'refs' => [], ], 'SetupRequest' => [ 'base' => '

Returns information that was submitted during the SetupInstanceHttps request. Email information is redacted for privacy.

', 'refs' => [ 'SetupHistory$request' => '

Information about the specified request.

', ], ], 'SetupStatus' => [ 'base' => NULL, 'refs' => [ 'SetupExecutionDetails$status' => '

The status of the SetupInstanceHttps request.

', 'SetupHistory$status' => '

The status of the request.

', ], ], 'StartGUISessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartGUISessionResult' => [ 'base' => NULL, 'refs' => [], ], 'StartInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StartRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'StaticIp' => [ 'base' => '

Describes a static IP.

', 'refs' => [ 'GetStaticIpResult$staticIp' => '

An array of key-value pairs containing information about the requested static IP.

', 'StaticIpList$member' => NULL, ], ], 'StaticIpList' => [ 'base' => NULL, 'refs' => [ 'GetStaticIpsResult$staticIps' => '

An array of key-value pairs containing information about your get static IPs request.

', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'CreateGUISessionAccessDetailsResult$status' => '

The status of the operation.

', ], ], 'StatusType' => [ 'base' => NULL, 'refs' => [ 'AccessKey$status' => '

The status of the access key.

A status of Active means that the key is valid, while Inactive means it is not.

', ], ], 'StopGUISessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopGUISessionResult' => [ 'base' => NULL, 'refs' => [], ], 'StopInstanceOnIdleRequest' => [ 'base' => '

Describes a request to create or edit the StopInstanceOnIdle add-on.

This add-on only applies to Lightsail for Research resources.

', 'refs' => [ 'AddOnRequest$stopInstanceOnIdleRequest' => '

An object that represents additional parameters when enabling or modifying the StopInstanceOnIdle add-on.

This object only applies to Lightsail for Research resources.

', ], ], 'StopInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInstanceResult' => [ 'base' => NULL, 'refs' => [], ], 'StopRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'Container$command' => '

The launch command for the container.

', 'CookieObject$cookiesAllowList' => '

The specific cookies to forward to your distribution\'s origin.

', 'CreateInstancesFromSnapshotRequest$instanceNames' => '

The names for your new instances.

', 'CreateInstancesRequest$instanceNames' => '

The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]

', 'GetActiveNamesResult$activeNames' => '

The list of active names returned by the get active names request.

', 'GetRelationalDatabaseLogStreamsResult$logStreams' => '

An object describing the result of your get relational database log streams request.

', 'InstancePortInfo$cidrs' => '

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'InstancePortInfo$ipv6Cidrs' => '

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'InstancePortInfo$cidrListAliases' => '

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

', 'InstancePortState$cidrs' => '

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'InstancePortState$ipv6Cidrs' => '

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'InstancePortState$cidrListAliases' => '

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

', 'LightsailDistribution$alternativeDomainNames' => '

The alternate domain names of the distribution.

', 'LoadBalancerTlsCertificate$subjectAlternativeNames' => '

An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) for the certificate.

', 'LoadBalancerTlsPolicy$protocols' => '

The protocols used in a given TLS security policy.

', 'LoadBalancerTlsPolicy$ciphers' => '

The ciphers used by the TLS security policy.

The ciphers are listed in order of preference.

', 'PortInfo$cidrs' => '

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

Examples:

  • To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

  • To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'PortInfo$ipv6Cidrs' => '

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

', 'PortInfo$cidrListAliases' => '

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

', 'QueryStringObject$queryStringsAllowList' => '

The specific query strings that the distribution forwards to the origin.

Your distribution will cache content based on the specified query strings.

If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.

', 'RelationalDatabaseEvent$eventCategories' => '

The category that the database event belongs to.

', ], ], 'StringMax256' => [ 'base' => NULL, 'refs' => [ 'CreateContactMethodRequest$contactEndpoint' => '

The destination of the contact method, such as an email address or a mobile phone number.

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.

', 'UpdateLoadBalancerAttributeRequest$attributeValue' => '

The value that you want to specify for the attribute name.

The following values are supported depending on what you specify for the attributeName request parameter:

  • If you specify HealthCheckPath for the attributeName request parameter, then the attributeValue request parameter must be the path to ping on the target (for example, /weather/us/wa/seattle).

  • If you specify SessionStickinessEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate session stickiness or false to deactivate session stickiness.

  • If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName request parameter, then the attributeValue request parameter must be an interger that represents the cookie duration in seconds.

  • If you specify HttpsRedirectionEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection.

  • If you specify TlsPolicyName for the attributeName request parameter, then the attributeValue request parameter must be the name of the TLS policy.

    Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

', ], ], 'SubjectAlternativeNameList' => [ 'base' => NULL, 'refs' => [ 'Certificate$subjectAlternativeNames' => '

An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) of the certificate.

', 'CreateCertificateRequest$subjectAlternativeNames' => '

An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) for the certificate.

You can specify a maximum of nine alternate domains (in addition to the primary domain name).

Wildcard domain entries (*.example.com) are not supported.

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

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

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

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

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

The tag keys to delete from the specified resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'Bucket$tags' => '

The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'Certificate$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'CertificateSummary$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'ContainerService$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'CreateBucketRequest$tags' => '

The tag keys and optional values to add to the bucket during creation.

Use the TagResource action to tag the bucket after it\'s created.

', 'CreateCertificateRequest$tags' => '

The tag keys and optional values to add to the certificate during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateContainerServiceRequest$tags' => '

The tag keys and optional values to add to the container service during create.

Use the TagResource action to tag a resource after it\'s created.

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'CreateDiskFromSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateDiskRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateDiskSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateDistributionRequest$tags' => '

The tag keys and optional values to add to the distribution during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateDomainRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateInstanceSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateInstancesFromSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateInstancesRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateKeyPairRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateLoadBalancerRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateLoadBalancerTlsCertificateRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateRelationalDatabaseFromSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateRelationalDatabaseRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'CreateRelationalDatabaseSnapshotRequest$tags' => '

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it\'s created.

', 'Disk$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'DiskSnapshot$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'Domain$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'Instance$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'InstanceSnapshot$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'KeyPair$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'LightsailDistribution$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'LoadBalancer$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'LoadBalancerTlsCertificate$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'RelationalDatabase$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'RelationalDatabaseSnapshot$tags' => '

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

', 'TagResourceRequest$tags' => '

The tag key and optional value.

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

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

', ], ], 'TestAlarmRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestAlarmResult' => [ 'base' => NULL, 'refs' => [], ], 'TimeOfDay' => [ 'base' => NULL, 'refs' => [ 'AddOn$snapshotTimeOfDay' => '

The daily time when an automatic snapshot is created.

The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).

The snapshot is automatically created between the time shown and up to 45 minutes after.

', 'AddOn$nextSnapshotTimeOfDay' => '

The next daily time an automatic snapshot will be created.

The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).

The snapshot is automatically created between the time shown and up to 45 minutes after.

', 'AutoSnapshotAddOnRequest$snapshotTimeOfDay' => '

The daily time when an automatic snapshot will be created.

Constraints:

  • Must be in HH:00 format, and in an hourly increment.

  • Specified in Coordinated Universal Time (UTC).

  • The snapshot will be automatically created between the time specified and up to 45 minutes after.

', ], ], 'TimePeriod' => [ 'base' => '

Sets the start date and end date for retrieving a cost estimate. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

', 'refs' => [ 'EstimateByTime$timePeriod' => '

The period of time, in days, that an estimate covers. The period has a start date and an end date. The start date must come before the end date.

', ], ], 'TreatMissingData' => [ 'base' => NULL, 'refs' => [ 'Alarm$treatMissingData' => '

Specifies how the alarm handles missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

  • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

  • ignore - Ignore the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

', 'PutAlarmRequest$treatMissingData' => '

Sets how this alarm will handle missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

  • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

  • ignore - Ignore the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

If treatMissingData is not specified, the default behavior of missing is used.

', ], ], 'UnauthenticatedException' => [ 'base' => '

Lightsail throws this exception when the user has not been authenticated.

', 'refs' => [], ], 'UnpeerVpcRequest' => [ 'base' => NULL, 'refs' => [], ], 'UnpeerVpcResult' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBucketBundleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBucketBundleResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBucketResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerServiceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDistributionBundleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDistributionBundleResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDistributionResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainEntryRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainEntryResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInstanceMetadataOptionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInstanceMetadataOptionsResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLoadBalancerAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLoadBalancerAttributeResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseParametersRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseParametersResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRelationalDatabaseResult' => [ 'base' => NULL, 'refs' => [], ], 'boolean' => [ 'base' => NULL, 'refs' => [ 'AccessRules$allowPublicOverrides' => '

A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

', 'AccountLevelBpaSync$bpaImpactsLightsail' => '

A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.

', 'Alarm$notificationEnabled' => '

Indicates whether the alarm is enabled.

', 'AttachDiskRequest$autoMounting' => '

A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default value is False.

This value only applies to Lightsail for Research resources.

', 'Blueprint$isActive' => '

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

', 'Bucket$ableToUpdateBundle' => '

Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

You can update a bucket\'s bundle only one time within a monthly Amazon Web Services billing cycle.

Use the UpdateBucketBundle action to change a bucket\'s bundle.

', 'BucketAccessLogConfig$enabled' => '

A Boolean value that indicates whether bucket access logging is enabled for the bucket.

', 'BucketBundle$isActive' => '

Indicates whether the bundle is active. Use for a new or existing bucket.

', 'Bundle$isActive' => '

A Boolean value indicating whether the bundle is active.

', 'ContainerService$isDisabled' => '

A Boolean value indicating whether the container service is disabled.

', 'ContainerServiceECRImagePullerRole$isActive' => '

A Boolean value that indicates whether the role is activated.

', 'ContainerServiceECRImagePullerRoleRequest$isActive' => '

A Boolean value that indicates whether to activate the role.

', 'ContainerServicePower$isActive' => '

A Boolean value indicating whether the power is active and can be specified for container services.

', 'CopySnapshotRequest$useLatestRestorableAutoSnapshot' => '

A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.

Constraints:

  • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

  • Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateBucketRequest$enableObjectVersioning' => '

A Boolean value that indicates whether to enable versioning of objects in the bucket.

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

', 'CreateDiskFromSnapshotRequest$useLatestRestorableAutoSnapshot' => '

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

  • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

  • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateInstancesFromSnapshotRequest$useLatestRestorableAutoSnapshot' => '

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

  • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

  • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateRelationalDatabaseFromSnapshotRequest$publiclyAccessible' => '

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

', 'CreateRelationalDatabaseFromSnapshotRequest$useLatestRestorableTime' => '

Specifies whether your database is restored from the latest backup time. A value of true restores from the latest backup time.

Default: false

Constraints: Cannot be specified if the restore time parameter is provided.

', 'CreateRelationalDatabaseRequest$publiclyAccessible' => '

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

', 'DeleteBucketRequest$forceDelete' => '

A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

  • The bucket is the origin of a distribution.

  • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.

  • The bucket has objects.

  • The bucket has access keys.

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

', 'DeleteDiskRequest$forceDeleteAddOns' => '

A Boolean value to indicate whether to delete all add-ons for the disk.

', 'DeleteInstanceRequest$forceDeleteAddOns' => '

A Boolean value to indicate whether to delete all add-ons for the instance.

', 'DeleteLoadBalancerTlsCertificateRequest$force' => '

When true, forces the deletion of an SSL/TLS certificate.

There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.

', 'DeleteRelationalDatabaseRequest$skipFinalSnapshot' => '

Determines whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted.

You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false.

Default: false

', 'Disk$isSystemDisk' => '

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

', 'Disk$isAttached' => '

A Boolean value indicating whether the disk is attached.

', 'DiskInfo$isSystemDisk' => '

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

', 'DiskSnapshot$isFromAutoSnapshot' => '

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

', 'DistributionBundle$isActive' => '

Indicates whether the bundle is active, and can be specified for a new or existing distribution.

', 'DomainEntry$isAlias' => '

When true, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another Amazon Web Services resource. You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other Amazon Web Services resource and routes traffic to that resource.

', 'GetBlueprintsRequest$includeInactive' => '

A Boolean value that indicates whether to include inactive (unavailable) blueprints in the response of your request.

', 'GetBucketBundlesRequest$includeInactive' => '

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

', 'GetBucketsRequest$includeConnectedResources' => '

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

', 'GetBundlesRequest$includeInactive' => '

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

', 'GetKeyPairsRequest$includeDefaultKeyPair' => '

A Boolean value that indicates whether to include the default key pair in the response of your request.

', 'GetRegionsRequest$includeAvailabilityZones' => '

A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: us-east-2a.

', 'GetRegionsRequest$includeRelationalDatabaseAvailabilityZones' => '

A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (us-east-2a).

', 'GetRelationalDatabaseBundlesRequest$includeInactive' => '

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

', 'GetRelationalDatabaseLogEventsRequest$startFromHead' => '

Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log.

For PostgreSQL, the default value of false is the only option available.

', 'Instance$isStaticIp' => '

A Boolean value indicating whether this instance has a static IP assigned to it.

', 'InstanceSnapshot$isFromAutoSnapshot' => '

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

', 'IsVpcPeeredResult$isPeered' => '

Returns true if the Lightsail VPC is peered; otherwise, false.

', 'LightsailDistribution$isEnabled' => '

Indicates whether the distribution is enabled.

', 'LightsailDistribution$ableToUpdateBundle' => '

Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.

Use the UpdateDistributionBundle action to change your distribution\'s bundle.

', 'LoadBalancer$httpsRedirectionEnabled' => '

A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.

', 'LoadBalancerTlsCertificate$isAttached' => '

When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

', 'LoadBalancerTlsCertificateSummary$isAttached' => '

When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

', 'LoadBalancerTlsPolicy$isDefault' => '

A Boolean value that indicates whether the TLS security policy is the default.

', 'Operation$isTerminal' => '

A Boolean value indicating whether the operation is terminal.

', 'PendingModifiedRelationalDatabaseValues$backupRetentionEnabled' => '

A Boolean value indicating whether automated backup retention is enabled.

', 'PutAlarmRequest$notificationEnabled' => '

Indicates whether the alarm is enabled.

Notifications are enabled by default if you don\'t specify this parameter.

', 'QueryStringObject$option' => '

Indicates whether the distribution forwards and caches based on query strings.

', 'RelationalDatabase$backupRetentionEnabled' => '

A Boolean value indicating whether automated backup retention is enabled for the database.

', 'RelationalDatabase$publiclyAccessible' => '

A Boolean value indicating whether the database is publicly accessible.

', 'RelationalDatabaseBlueprint$isEngineDefault' => '

A Boolean value indicating whether the engine version is the default for the database blueprint.

', 'RelationalDatabaseBundle$isEncrypted' => '

A Boolean value indicating whether the database bundle is encrypted.

', 'RelationalDatabaseBundle$isActive' => '

A Boolean value indicating whether the database bundle is active.

', 'RelationalDatabaseParameter$isModifiable' => '

A Boolean value indicating whether the parameter can be modified.

', 'Session$isPrimary' => '

When true, this Boolean value indicates the primary session for the specified resource.

', 'StaticIp$isAttached' => '

A Boolean value indicating whether the static IP is attached.

', 'StopInstanceRequest$force' => '

When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.

Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

', 'UpdateContainerServiceRequest$isDisabled' => '

A Boolean value to indicate whether the container service is disabled.

', 'UpdateDistributionRequest$isEnabled' => '

Indicates whether to enable the distribution.

', 'UpdateRelationalDatabaseRequest$rotateMasterUserPassword' => '

When true, the master user password is changed to a new strong password generated by Lightsail.

Use the get relational database master user password operation to get the new password.

', 'UpdateRelationalDatabaseRequest$enableBackupRetention' => '

When true, enables automated backup retention for your database.

Updates are applied during the next maintenance window because this can result in an outage.

', 'UpdateRelationalDatabaseRequest$disableBackupRetention' => '

When true, disables automated backup retention for your database.

Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

Updates are applied during the next maintenance window because this can result in an outage.

', 'UpdateRelationalDatabaseRequest$publiclyAccessible' => '

Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

', 'UpdateRelationalDatabaseRequest$applyImmediately' => '

When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

Default: false

', ], ], 'double' => [ 'base' => NULL, 'refs' => [ 'Alarm$threshold' => '

The value against which the specified statistic is compared.

', 'EstimateByTime$usageCost' => '

The amount of cost or usage that\'s measured for the cost estimate.

', 'EstimateByTime$unit' => '

The number of pricing units used to calculate the total number of hours. For example, 1 unit equals 1 hour.

', 'MetricDatapoint$average' => '

The average.

', 'MetricDatapoint$maximum' => '

The maximum.

', 'MetricDatapoint$minimum' => '

The minimum.

', 'MetricDatapoint$sampleCount' => '

The sample count.

', 'MetricDatapoint$sum' => '

The sum.

', 'PutAlarmRequest$threshold' => '

The value against which the specified statistic is compared.

', ], ], 'float' => [ 'base' => NULL, 'refs' => [ 'BucketBundle$price' => '

The monthly price of the bundle, in US dollars.

', 'Bundle$price' => '

The price in US dollars (5.0) of the bundle.

', 'Bundle$ramSizeInGb' => '

The amount of RAM in GB (2.0).

', 'ContainerServicePower$price' => '

The monthly price of the power in USD.

', 'ContainerServicePower$cpuCount' => '

The number of vCPUs included in the power.

', 'ContainerServicePower$ramSizeInGb' => '

The amount of RAM (in GB) of the power.

', 'DistributionBundle$price' => '

The monthly price, in US dollars, of the bundle.

', 'InstanceHardware$ramSizeInGb' => '

The amount of RAM in GB on the instance (1.0).

', 'RelationalDatabaseBundle$price' => '

The cost of the database bundle in US currency.

', 'RelationalDatabaseBundle$ramSizeInGb' => '

The amount of RAM in GB (for example, 2.0) for the database bundle.

', 'RelationalDatabaseHardware$ramSizeInGb' => '

The amount of RAM in GB for the database.

', ], ], 'integer' => [ 'base' => NULL, 'refs' => [ 'Alarm$evaluationPeriods' => '

The number of periods over which data is compared to the specified threshold.

', 'Alarm$datapointsToAlarm' => '

The number of data points that must not within the specified threshold to trigger the alarm.

', 'AttachedDisk$sizeInGb' => '

The size of the disk in GB.

', 'Blueprint$minPower' => '

The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.

', 'BucketBundle$storagePerMonthInGb' => '

The storage size of the bundle, in GB.

', 'BucketBundle$transferPerMonthInGb' => '

The monthly network transfer quota of the bundle.

', 'Bundle$cpuCount' => '

The number of vCPUs included in the bundle (2).

', 'Bundle$diskSizeInGb' => '

The size of the SSD (30).

', 'Bundle$power' => '

A numeric value that represents the power of the bundle (500). You can use the bundle\'s power value in conjunction with a blueprint\'s minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.

', 'Bundle$transferPerMonthInGb' => '

The data transfer rate per month in GB (2000).

', 'ContainerServiceDeployment$version' => '

The version number of the deployment.

', 'ContainerServiceEndpoint$containerPort' => '

The port of the specified container to which traffic is forwarded to.

', 'ContainerServiceHealthCheckConfig$healthyThreshold' => '

The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

', 'ContainerServiceHealthCheckConfig$unhealthyThreshold' => '

The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

', 'ContainerServiceHealthCheckConfig$timeoutSeconds' => '

The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

', 'ContainerServiceHealthCheckConfig$intervalSeconds' => '

The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

', 'CreateDiskFromSnapshotRequest$sizeInGb' => '

The size of the disk in GB (32).

', 'CreateDiskRequest$sizeInGb' => '

The size of the disk in GB (32).

', 'CreateGUISessionAccessDetailsResult$percentageComplete' => '

The percentage of completion for the operation.

', 'Disk$sizeInGb' => '

The size of the disk in GB.

', 'Disk$iops' => '

The input/output operations per second (IOPS) of the disk.

', 'Disk$gbInUse' => '

(Discontinued) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.

', 'DiskInfo$sizeInGb' => '

The size of the disk in GB (32).

', 'DiskSnapshot$sizeInGb' => '

The size of the disk in GB.

', 'DiskSnapshotInfo$sizeInGb' => '

The size of the disk in GB (32).

', 'DistributionBundle$transferPerMonthInGb' => '

The monthly network transfer quota of the bundle.

', 'EndpointRequest$containerPort' => '

The port of the container to which traffic is forwarded to.

', 'GetRelationalDatabaseEventsRequest$durationInMinutes' => '

The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.

Default: 60

The minimum is 1 and the maximum is 14 days (20160 minutes).

', 'InstanceHardware$cpuCount' => '

The number of vCPUs the instance has.

', 'InstanceMetadataOptions$httpPutResponseHopLimit' => '

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

', 'InstanceSnapshot$sizeInGb' => '

The size in GB of the SSD.

', 'InstanceState$code' => '

The status code for the instance.

', 'LoadBalancer$instancePort' => '

The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it\'s port 80. For HTTPS traffic, it\'s port 443.

', 'MonthlyTransfer$gbPerMonthAllocated' => '

The amount allocated per month (in GB).

', 'PutAlarmRequest$evaluationPeriods' => '

The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.

Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).

', 'PutAlarmRequest$datapointsToAlarm' => '

The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.

', 'RelationalDatabaseBundle$diskSizeInGb' => '

The size of the disk for the database bundle.

', 'RelationalDatabaseBundle$transferPerMonthInGb' => '

The data transfer rate per month in GB for the database bundle.

', 'RelationalDatabaseBundle$cpuCount' => '

The number of virtual CPUs (vCPUs) for the database bundle.

', 'RelationalDatabaseEndpoint$port' => '

Specifies the port that the database is listening on.

', 'RelationalDatabaseHardware$cpuCount' => '

The number of vCPUs for the database.

', 'RelationalDatabaseHardware$diskSizeInGb' => '

The size of the disk for the database.

', 'RelationalDatabaseSnapshot$sizeInGb' => '

The size of the disk in GB (for example, 32) for the database snapshot.

', 'UpdateInstanceMetadataOptionsRequest$httpPutResponseHopLimit' => '

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.

', ], ], 'long' => [ 'base' => NULL, 'refs' => [ 'CacheSettings$defaultTTL' => '

The default amount of time that objects stay in the distribution\'s cache before the distribution forwards another request to the origin to determine whether the content has been updated.

The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

', 'CacheSettings$minimumTTL' => '

The minimum amount of time that objects stay in the distribution\'s cache before the distribution forwards another request to the origin to determine whether the object has been updated.

A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.

', 'CacheSettings$maximumTTL' => '

The maximum amount of time that objects stay in the distribution\'s cache before the distribution forwards another request to the origin to determine whether the object has been updated.

The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

', ], ], 'setupHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetSetupHistoryResult$setupHistory' => '

The historical information that\'s returned.

', ], ], 'string' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$code' => NULL, 'AccessDeniedException$docs' => NULL, 'AccessDeniedException$message' => NULL, 'AccessDeniedException$tip' => NULL, 'AccessKeyLastUsed$region' => '

The Amazon Web Services Region where this access key was most recently used.

This value is N/A if the access key has not been used.

', 'AccessKeyLastUsed$serviceName' => '

The name of the Amazon Web Services service with which this access key was most recently used.

This value is N/A if the access key has not been used.

', 'AccountSetupInProgressException$code' => NULL, 'AccountSetupInProgressException$docs' => NULL, 'AccountSetupInProgressException$message' => NULL, 'AccountSetupInProgressException$tip' => NULL, 'AddOn$name' => '

The name of the add-on.

', 'AddOn$status' => '

The status of the add-on.

', 'AddOn$threshold' => '

The trigger threshold of the action.

This add-on only applies to Lightsail for Research resources.

', 'AddOn$duration' => '

The amount of idle time in minutes after which your virtual computer will automatically stop.

This add-on only applies to Lightsail for Research resources.

', 'Alarm$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

', 'AttachedDisk$path' => '

The path of the disk (/dev/xvdf).

', 'AutoSnapshotDetails$date' => '

The date of the automatic snapshot in YYYY-MM-DD format.

', 'Blueprint$description' => '

The description of the blueprint.

', 'Blueprint$version' => '

The version number of the operating system, application, or stack ( 2016.03.0).

', 'Blueprint$versionCode' => '

The version code.

', 'Blueprint$productUrl' => '

The product URL to learn more about the image or blueprint.

', 'Blueprint$licenseUrl' => '

The end-user license agreement URL for the image or blueprint.

', 'BucketState$message' => '

A message that describes the state of the bucket.

', 'Bundle$instanceType' => '

The Amazon EC2 instance type (t2.micro).

', 'Bundle$name' => '

A friendly name for the bundle (Micro).

', 'CacheBehaviorPerPath$path' => '

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

  • Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

    var/www/html/

  • Specify the following file to cache only the index page in the document root of an Apache web server.

    var/www/html/index.html

  • Specify the following to cache only the .html files in the document root of an Apache web server.

    var/www/html/*.html

  • Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

    var/www/html/images/*.jpg

    var/www/html/images/*.png

    var/www/html/images/*.gif

    Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

    var/www/html/images/

', 'Certificate$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

', 'ContactMethod$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.

', 'Container$image' => '

The name of the image used for the container.

Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third (3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.

Container images sourced from a public registry like Docker Hub don\'t start with a colon. For example, nginx:latest or nginx.

', 'ContainerImage$image' => '

The name of the container image.

', 'ContainerImage$digest' => '

The digest of the container image.

', 'ContainerService$powerId' => '

The ID of the power of the container service.

', 'ContainerService$principalArn' => '

The principal ARN of the container service.

The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your service permission to access resources in your standard Amazon Web Services account.

', 'ContainerService$privateDomainName' => '

The private domain name of the container service.

The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.

', 'ContainerService$url' => '

The publicly accessible URL of the container service.

If no public endpoint is specified in the currentDeployment, this URL returns a 404 response.

', 'ContainerServiceECRImagePullerRole$principalArn' => '

The Amazon Resource Name (ARN) of the role, if it is activated.

', 'ContainerServiceEndpoint$containerName' => '

The name of the container entry of the deployment that the endpoint configuration applies to.

', 'ContainerServiceHealthCheckConfig$path' => '

The path on the container on which to perform the health check. The default value is /.

', 'ContainerServiceHealthCheckConfig$successCodes' => '

The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

', 'ContainerServiceLogEvent$message' => '

The message of the container service log event.

', 'ContainerServiceMetadataEntry$key' => NULL, 'ContainerServiceMetadataEntry$value' => NULL, 'ContainerServicePower$powerId' => '

The ID of the power (nano-1).

', 'ContainerServicePower$name' => '

The friendly name of the power (nano).

', 'ContainerServicePublicDomains$key' => NULL, 'ContainerServicePublicDomainsList$member' => NULL, 'ContainerServiceRegistryLogin$username' => '

The container service registry username to use to push container images to the container image registry of a Lightsail account.

', 'ContainerServiceRegistryLogin$password' => '

The container service registry password to use to push container images to the container image registry of a Lightsail account

', 'ContainerServiceRegistryLogin$registry' => '

The address to use to push container images to the container image registry of a Lightsail account.

', 'ContainerServiceStateDetail$message' => '

A message that provides more information for the state code.

The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

', 'CopySnapshotRequest$sourceResourceName' => '

The name of the source instance or disk from which the source automatic snapshot was created.

Constraint:

', 'CopySnapshotRequest$restoreDate' => '

The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

  • Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDiskFromSnapshotRequest$sourceDiskName' => '

The name of the source disk from which the source automatic snapshot was created.

Constraints:

  • This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.

  • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDiskFromSnapshotRequest$restoreDate' => '

The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

  • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateDistributionRequest$bundleId' => '

The bundle ID to use for the distribution.

A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.

Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

', 'CreateGUISessionAccessDetailsResult$failureReason' => '

The reason the operation failed.

', 'CreateInstancesFromSnapshotRequest$availabilityZone' => '

The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

', 'CreateInstancesFromSnapshotRequest$userData' => '

You can create a launch script that configures a server with additional user data. For example, apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

', 'CreateInstancesFromSnapshotRequest$sourceInstanceName' => '

The name of the source instance from which the source automatic snapshot was created.

Constraints:

  • This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.

  • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateInstancesFromSnapshotRequest$restoreDate' => '

The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

  • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

', 'CreateInstancesRequest$availabilityZone' => '

The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

', 'CreateInstancesRequest$userData' => '

A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

', 'CreateLoadBalancerRequest$healthCheckPath' => '

The path you provided to perform the load balancer health check. If you didn\'t specify a health check path, Lightsail uses the root path of your website ("/").

You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

', 'CreateLoadBalancerRequest$tlsPolicyName' => '

The name of the TLS policy to apply to the load balancer.

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

', 'CreateRelationalDatabaseFromSnapshotRequest$availabilityZone' => '

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

', 'CreateRelationalDatabaseFromSnapshotRequest$relationalDatabaseBundleId' => '

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.

', 'CreateRelationalDatabaseRequest$availabilityZone' => '

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

', 'CreateRelationalDatabaseRequest$relationalDatabaseBlueprintId' => '

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

', 'CreateRelationalDatabaseRequest$relationalDatabaseBundleId' => '

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

', 'CreateRelationalDatabaseRequest$masterDatabaseName' => '

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn\'t specified, no database is created in the database resource.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can\'t be a word reserved by the specified database engine.

    For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn\'t specified, a database named postgres is created in the database resource.

Constraints:

  • Must contain 1 to 63 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

  • Can\'t be a word reserved by the specified database engine.

    For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

', 'CreateRelationalDatabaseRequest$masterUsername' => '

The name for the master user.

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers. Can contain underscores.

  • First character must be a letter.

  • Can\'t be a reserved word for the chosen database engine.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

', 'CreateRelationalDatabaseRequest$preferredBackupWindow' => '

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service documentation.

Constraints:

  • Must be in the hh24:mi-hh24:mi format.

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'CreateRelationalDatabaseRequest$preferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur on your new database.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Constraints:

  • Must be in the ddd:hh24:mi-ddd:hh24:mi format.

  • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

', 'DeleteContainerImageRequest$image' => '

The name of the container image to delete from the container service.

Use the GetContainerImages action to get the name of the container images that are registered to a container service.

Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, :container-service-1.mystaticwebsite.1. Container images sourced from a public registry like Docker Hub don\'t start with a colon. For example, nginx:latest or nginx.

', 'DeleteKeyPairRequest$expectedFingerprint' => '

The RSA fingerprint of the Lightsail default key pair to delete.

The expectedFingerprint parameter is required only when specifying to delete a Lightsail default key pair.

', 'Disk$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'Disk$path' => '

The disk path.

', 'Disk$attachmentState' => '

(Discontinued) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now discontinued, but still included in the response. Use isAttached instead.

', 'DiskInfo$name' => '

The disk name.

', 'DiskSnapshot$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'DiskSnapshot$progress' => '

The progress of the snapshot.

', 'DistributionBundle$bundleId' => '

The ID of the bundle.

', 'DistributionBundle$name' => '

The name of the distribution bundle.

', 'DnsRecordCreationState$message' => '

The message that describes the reason for the status code.

', 'Domain$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'DomainEntry$target' => '

The target IP address (192.0.2.0), or AWS name server (ns-111.awsdns-22.com.).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.

', 'DomainEntryOptions$value' => NULL, 'EndpointRequest$containerName' => '

The name of the container for the endpoint.

', 'Environment$key' => NULL, 'Environment$value' => NULL, 'GetActiveNamesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetActiveNames request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetActiveNamesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetActiveNames request and specify the next page token using the pageToken parameter.

', 'GetAlarmsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetAlarmsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetAlarms request and specify the next page token using the pageToken parameter.

', 'GetBlueprintsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBlueprints request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetBlueprintsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetBlueprints request and specify the next page token using the pageToken parameter.

', 'GetBucketsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetBucketsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetBuckets request and specify the next page token using the pageToken parameter.

', 'GetBundlesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetBundlesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetBundles request and specify the next page token using the pageToken parameter.

', 'GetCertificatesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetCertificates request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetCertificatesResult$nextPageToken' => '

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

', 'GetCloudFormationStackRecordsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetClouFormationStackRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetCloudFormationStackRecordsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetCloudFormationStackRecords request and specify the next page token using the pageToken parameter.

', 'GetContainerLogRequest$containerName' => '

The name of the container that is either running or previously ran on the container service for which to return a log.

', 'GetContainerLogRequest$filterPattern' => '

The pattern to use to filter the returned log events to a specific term.

The following are a few examples of filter patterns that you can specify:

  • To return all log events, specify a filter pattern of "".

  • To exclude log events that contain the ERROR term, and return all other log events, specify a filter pattern of "-ERROR".

  • To return log events that contain the ERROR term, specify a filter pattern of "ERROR".

  • To return log events that contain both the ERROR and Exception terms, specify a filter pattern of "ERROR Exception".

  • To return log events that contain the ERROR or the Exception term, specify a filter pattern of "?ERROR ?Exception".

', 'GetContainerLogRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetContainerLog request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetContainerLogResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetContainerLog request and specify the next page token using the pageToken parameter.

', 'GetDiskSnapshotsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDiskSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetDiskSnapshotsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDiskSnapshots request and specify the next page token using the pageToken parameter.

', 'GetDisksRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDisks request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetDisksResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter.

', 'GetDistributionLatestCacheResetResult$status' => '

The status of the last cache reset.

', 'GetDistributionsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDistributions request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetDistributionsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDistributions request and specify the next page token using the pageToken parameter.

', 'GetDomainsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDomains request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetDomainsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDomains request and specify the next page token using the pageToken parameter.

', 'GetExportSnapshotRecordsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetExportSnapshotRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetExportSnapshotRecordsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetExportSnapshotRecords request and specify the next page token using the pageToken parameter.

', 'GetInstanceSnapshotsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetInstanceSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetInstanceSnapshotsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetInstanceSnapshots request and specify the next page token using the pageToken parameter.

', 'GetInstancesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetInstances request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetInstancesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter.

', 'GetKeyPairsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetKeyPairsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter.

', 'GetLoadBalancerTlsPoliciesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetLoadBalancerTlsPolicies request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetLoadBalancerTlsPoliciesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetLoadBalancerTlsPolicies request and specify the next page token using the pageToken parameter.

', 'GetLoadBalancersRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetLoadBalancers request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetLoadBalancersResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetLoadBalancers request and specify the next page token using the pageToken parameter.

', 'GetOperationsForResourceRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetOperationsForResource request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetOperationsForResourceResult$nextPageCount' => '

(Discontinued) Returns the number of pages of results that remain.

In releases prior to June 12, 2017, this parameter returned null by the API. It is now discontinued, and the API returns the next page token parameter instead.

', 'GetOperationsForResourceResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetOperationsForResource request and specify the next page token using the pageToken parameter.

', 'GetOperationsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetOperations request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetOperationsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetOperations request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabaseBlueprintsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseBlueprints request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseBlueprintsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseBlueprints request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabaseBundlesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseBundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseBundlesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseBundles request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabaseEventsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseEvents request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseEventsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseEvents request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabaseLogEventsRequest$logStreamName' => '

The name of the log stream.

Use the get relational database log streams operation to get a list of available log streams.

', 'GetRelationalDatabaseLogEventsRequest$pageToken' => '

The token to advance to the next or previous page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseLogEvents request. If your results are paginated, the response will return a next forward token and/or next backward token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseLogEventsResult$nextBackwardToken' => '

A token used for advancing to the previous page of results from your get relational database log events request.

', 'GetRelationalDatabaseLogEventsResult$nextForwardToken' => '

A token used for advancing to the next page of results from your get relational database log events request.

', 'GetRelationalDatabaseParametersRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseParameters request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseParametersResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseParameters request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabaseSnapshotsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabaseSnapshotsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseSnapshots request and specify the next page token using the pageToken parameter.

', 'GetRelationalDatabasesRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabases request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetRelationalDatabasesResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabases request and specify the next page token using the pageToken parameter.

', 'GetStaticIpsRequest$pageToken' => '

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetStaticIps request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

', 'GetStaticIpsResult$nextPageToken' => '

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetStaticIps request and specify the next page token using the pageToken parameter.

', 'HostKeyAttributes$algorithm' => '

The SSH host key algorithm or the RDP certificate format.

For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the algorithm is always x509-cert.

', 'HostKeyAttributes$publicKey' => '

The public SSH host key or the RDP certificate.

', 'HostKeyAttributes$fingerprintSHA1' => '

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

  • Example of an SHA-1 SSH fingerprint:

    SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0

  • Example of an SHA-1 RDP fingerprint:

    af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45

', 'HostKeyAttributes$fingerprintSHA256' => '

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

  • Example of an SHA-256 SSH fingerprint:

    SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o

  • Example of an SHA-256 RDP fingerprint:

    03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68

', 'Instance$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'InstanceAccessDetails$certKey' => '

For SSH access, the public key to use when accessing your instance For OpenSSH clients (command line SSH), you should save this value to tempkey-cert.pub.

', 'InstanceAccessDetails$password' => '

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you create an instance using any key pair other than the default (LightsailDefaultKeyPair), password will always be an empty string.

If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

', 'InstanceAccessDetails$privateKey' => '

For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this value to tempkey).

', 'InstanceAccessDetails$username' => '

The user name to use when logging in to the Amazon Lightsail instance.

', 'InstanceEntry$userData' => '

A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg.

', 'InstanceEntry$availabilityZone' => '

The Availability Zone for the new Amazon EC2 instance.

', 'InstancePortInfo$accessFrom' => '

The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or Custom if a specific IP address or range of IP addresses is allowed.

', 'InstancePortInfo$commonName' => '

The common name of the port information.

', 'InstanceSnapshot$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'InstanceSnapshot$progress' => '

The progress of the snapshot.

This is populated only for disk snapshots, and is null for instance snapshots.

', 'InstanceSnapshot$fromBlueprintId' => '

The blueprint ID from which you created the snapshot (os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.

', 'InstanceSnapshot$fromBundleId' => '

The bundle ID from which you created the snapshot (micro_1_0).

', 'InstanceState$name' => '

The state of the instance (running or pending).

', 'InvalidInputException$code' => NULL, 'InvalidInputException$docs' => NULL, 'InvalidInputException$message' => NULL, 'InvalidInputException$tip' => NULL, 'KeyPair$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'LightsailDistribution$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.

', 'LightsailDistribution$status' => '

The status of the distribution.

', 'LightsailDistribution$domainName' => '

The domain name of the distribution.

', 'LightsailDistribution$bundleId' => '

The ID of the bundle currently applied to the distribution.

', 'LightsailDistribution$originPublicDNS' => '

The public DNS of the origin.

', 'LoadBalancer$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

', 'LoadBalancerConfigurationOptions$value' => NULL, 'LoadBalancerTlsCertificate$supportCode' => '

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.

', 'LoadBalancerTlsCertificateDnsRecordCreationState$message' => '

The message that describes the reason for the status code.

', 'LoadBalancerTlsPolicy$description' => '

The description of the TLS security policy.

', 'LogEvent$message' => '

The message of the database log event.

', 'NameServersUpdateState$message' => '

The message that describes the reason for the status code.

', 'NotFoundException$code' => NULL, 'NotFoundException$docs' => NULL, 'NotFoundException$message' => NULL, 'NotFoundException$tip' => NULL, 'Operation$operationDetails' => '

Details about the operation (Debian-1GB-Ohio-1).

', 'Operation$errorCode' => '

The error code.

', 'Operation$errorDetails' => '

The error details.

', 'OperationFailureException$code' => NULL, 'OperationFailureException$docs' => NULL, 'OperationFailureException$message' => NULL, 'OperationFailureException$tip' => NULL, 'PasswordData$ciphertext' => '

The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available in the password field.

If you are using a custom key pair, you need to use your own means of decryption.

If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

', 'PendingModifiedRelationalDatabaseValues$masterUserPassword' => '

The password for the master user of the database.

', 'PendingModifiedRelationalDatabaseValues$engineVersion' => '

The database engine version.

', 'PortMap$key' => NULL, 'R53HostedZoneDeletionState$message' => '

The message that describes the reason for the status code.

', 'Region$continentCode' => '

The continent code (NA, meaning North America).

', 'Region$description' => '

The description of the Amazon Web Services Region (This region is recommended to serve users in the eastern United States and eastern Canada).

', 'Region$displayName' => '

The display name (Ohio).

', 'RegisterContainerImageRequest$digest' => '

The digest of the container image to be registered.

', 'RelationalDatabase$supportCode' => '

The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'RelationalDatabase$masterDatabaseName' => '

The name of the master database created when the Lightsail database resource is created.

', 'RelationalDatabase$secondaryAvailabilityZone' => '

Describes the secondary Availability Zone of a high availability database.

The secondary database is used for failover support of a high availability database.

', 'RelationalDatabase$caCertificateIdentifier' => '

The certificate associated with the database.

', 'RelationalDatabaseBlueprint$blueprintId' => '

The ID for the database blueprint.

', 'RelationalDatabaseBlueprint$engineVersion' => '

The database engine version for the database blueprint (for example, 5.7.23).

', 'RelationalDatabaseBlueprint$engineDescription' => '

The description of the database engine for the database blueprint.

', 'RelationalDatabaseBlueprint$engineVersionDescription' => '

The description of the database engine version for the database blueprint.

', 'RelationalDatabaseBundle$bundleId' => '

The ID for the database bundle.

', 'RelationalDatabaseBundle$name' => '

The name for the database bundle.

', 'RelationalDatabaseEvent$message' => '

The message of the database event.

', 'RelationalDatabaseParameter$allowedValues' => '

Specifies the valid range of values for the parameter.

', 'RelationalDatabaseParameter$applyMethod' => '

Indicates when parameter updates are applied.

Can be immediate or pending-reboot.

', 'RelationalDatabaseParameter$applyType' => '

Specifies the engine-specific parameter type.

', 'RelationalDatabaseParameter$dataType' => '

Specifies the valid data type for the parameter.

', 'RelationalDatabaseParameter$description' => '

Provides a description of the parameter.

', 'RelationalDatabaseParameter$parameterName' => '

Specifies the name of the parameter.

', 'RelationalDatabaseParameter$parameterValue' => '

Specifies the value of the parameter.

', 'RelationalDatabaseSnapshot$supportCode' => '

The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'RelationalDatabaseSnapshot$fromRelationalDatabaseBundleId' => '

The bundle ID of the database from which the database snapshot was created.

', 'RelationalDatabaseSnapshot$fromRelationalDatabaseBlueprintId' => '

The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.

', 'ResetDistributionCacheResult$status' => '

The status of the reset cache request.

', 'ResourceLocation$availabilityZone' => '

The Availability Zone. Follows the format us-east-2a (case-sensitive).

', 'ResourceRecord$name' => '

The name of the record.

', 'ResourceRecord$type' => '

The DNS record type.

', 'ResourceRecord$value' => '

The value for the DNS record.

', 'ServiceException$code' => NULL, 'ServiceException$docs' => NULL, 'ServiceException$message' => NULL, 'ServiceException$tip' => NULL, 'SetupExecutionDetails$command' => '

The command that was executed.

', 'SetupExecutionDetails$standardError' => '

The text written by the command to stderr.

', 'SetupExecutionDetails$standardOutput' => '

The text written by the command to stdout.

', 'SetupExecutionDetails$version' => '

The current version of the script..

', 'StaticIp$supportCode' => '

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

', 'StopInstanceOnIdleRequest$threshold' => '

The value to compare with the duration.

', 'StopInstanceOnIdleRequest$duration' => '

The amount of idle time in minutes after which your virtual computer will automatically stop.

', 'StringList$member' => NULL, 'UnauthenticatedException$code' => NULL, 'UnauthenticatedException$docs' => NULL, 'UnauthenticatedException$message' => NULL, 'UnauthenticatedException$tip' => NULL, 'UpdateDistributionBundleRequest$bundleId' => '

The bundle ID of the new bundle to apply to your distribution.

Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

', 'UpdateRelationalDatabaseRequest$preferredBackupWindow' => '

The daily time range during which automated backups are created for your database if automated backups are enabled.

Constraints:

  • Must be in the hh24:mi-hh24:mi format.

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

', 'UpdateRelationalDatabaseRequest$preferredMaintenanceWindow' => '

The weekly time range during which system maintenance can occur on your database.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Constraints:

  • Must be in the ddd:hh24:mi-ddd:hh24:mi format.

  • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

', 'UpdateRelationalDatabaseRequest$caCertificateIdentifier' => '

Indicates the certificate that needs to be associated with the database.

', ], ], 'timestamp' => [ 'base' => NULL, 'refs' => [ 'GetDistributionMetricDataRequest$startTime' => '

The start of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetDistributionMetricDataRequest$endTime' => '

The end of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

', 'GetInstanceMetricDataRequest$startTime' => '

The start time of the time period.

', 'GetInstanceMetricDataRequest$endTime' => '

The end time of the time period.

', 'GetLoadBalancerMetricDataRequest$startTime' => '

The start time of the period.

', 'GetLoadBalancerMetricDataRequest$endTime' => '

The end time of the period.

', 'MetricDatapoint$timestamp' => '

The timestamp (1479816991.349).

', ], ], ],]; diff --git a/src/data/lightsail/2016-11-28/endpoint-rule-set-1.json b/src/data/lightsail/2016-11-28/endpoint-rule-set-1.json index 7780da4900..b10f120d25 100644 --- a/src/data/lightsail/2016-11-28/endpoint-rule-set-1.json +++ b/src/data/lightsail/2016-11-28/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,11 +212,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -231,14 +227,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,7 +250,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -272,7 +269,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -283,14 +279,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -301,9 +299,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/src/data/lightsail/2016-11-28/endpoint-rule-set-1.json.php b/src/data/lightsail/2016-11-28/endpoint-rule-set-1.json.php index bd4aecd1e7..b0bcb706bb 100644 --- a/src/data/lightsail/2016-11-28/endpoint-rule-set-1.json.php +++ b/src/data/lightsail/2016-11-28/endpoint-rule-set-1.json.php @@ -1,3 +1,3 @@ '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://lightsail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://lightsail.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ],]; +return [ 'version' => '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://lightsail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], true, ], ], ], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://lightsail.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ],]; diff --git a/src/data/opensearch/2021-01-01/api-2.json b/src/data/opensearch/2021-01-01/api-2.json index dfc336622b..8b197a1282 100644 --- a/src/data/opensearch/2021-01-01/api-2.json +++ b/src/data/opensearch/2021-01-01/api-2.json @@ -4048,7 +4048,8 @@ "type":"string", "enum":[ "Policy-Min-TLS-1-0-2019-07", - "Policy-Min-TLS-1-2-2019-07" + "Policy-Min-TLS-1-2-2019-07", + "Policy-Min-TLS-1-2-PFS-2023-10" ] }, "Tag":{ 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 79eb57b9b3..ab91ed8f07 100644 --- a/src/data/opensearch/2021-01-01/api-2.json.php +++ b/src/data/opensearch/2021-01-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2021-01-01', 'endpointPrefix' => 'es', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon OpenSearch Service', 'serviceId' => 'OpenSearch', 'signatureVersion' => 'v4', 'uid' => 'opensearch-2021-01-01', ], 'operations' => [ 'AcceptInboundConnection' => [ 'name' => 'AcceptInboundConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/accept', ], 'input' => [ 'shape' => 'AcceptInboundConnectionRequest', ], 'output' => [ 'shape' => 'AcceptInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'AddDataSource' => [ 'name' => 'AddDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource', ], 'input' => [ 'shape' => 'AddDataSourceRequest', ], 'output' => [ 'shape' => 'AddDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/tags', ], 'input' => [ 'shape' => 'AddTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'AssociatePackage' => [ 'name' => 'AssociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/associate/{PackageID}/{DomainName}', ], 'input' => [ 'shape' => 'AssociatePackageRequest', ], 'output' => [ 'shape' => 'AssociatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'AuthorizeVpcEndpointAccess' => [ 'name' => 'AuthorizeVpcEndpointAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/authorizeVpcEndpointAccess', ], 'input' => [ 'shape' => 'AuthorizeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'AuthorizeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'CancelServiceSoftwareUpdate' => [ 'name' => 'CancelServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/serviceSoftwareUpdate/cancel', ], 'input' => [ 'shape' => 'CancelServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'CancelServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateOutboundConnection' => [ 'name' => 'CreateOutboundConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection', ], 'input' => [ 'shape' => 'CreateOutboundConnectionRequest', ], 'output' => [ 'shape' => 'CreateOutboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'CreatePackage' => [ 'name' => 'CreatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages', ], 'input' => [ 'shape' => 'CreatePackageRequest', ], 'output' => [ 'shape' => 'CreatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateVpcEndpoint' => [ 'name' => 'CreateVpcEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints', ], 'input' => [ 'shape' => 'CreateVpcEndpointRequest', ], 'output' => [ 'shape' => 'CreateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DeleteDataSource' => [ 'name' => 'DeleteDataSource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'DeleteDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'output' => [ 'shape' => 'DeleteDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteInboundConnection' => [ 'name' => 'DeleteInboundConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteInboundConnectionRequest', ], 'output' => [ 'shape' => 'DeleteInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeleteOutboundConnection' => [ 'name' => 'DeleteOutboundConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteOutboundConnectionRequest', ], 'output' => [ 'shape' => 'DeleteOutboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeletePackage' => [ 'name' => 'DeletePackage', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/packages/{PackageID}', ], 'input' => [ 'shape' => 'DeletePackageRequest', ], 'output' => [ 'shape' => 'DeletePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteVpcEndpoint' => [ 'name' => 'DeleteVpcEndpoint', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/{VpcEndpointId}', ], 'input' => [ 'shape' => 'DeleteVpcEndpointRequest', ], 'output' => [ 'shape' => 'DeleteVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainAutoTunes' => [ 'name' => 'DescribeDomainAutoTunes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/autoTunes', ], 'input' => [ 'shape' => 'DescribeDomainAutoTunesRequest', ], 'output' => [ 'shape' => 'DescribeDomainAutoTunesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainChangeProgress' => [ 'name' => 'DescribeDomainChangeProgress', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/progress', ], 'input' => [ 'shape' => 'DescribeDomainChangeProgressRequest', ], 'output' => [ 'shape' => 'DescribeDomainChangeProgressResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainConfig' => [ 'name' => 'DescribeDomainConfig', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'DescribeDomainConfigRequest', ], 'output' => [ 'shape' => 'DescribeDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainHealth' => [ 'name' => 'DescribeDomainHealth', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/health', ], 'input' => [ 'shape' => 'DescribeDomainHealthRequest', ], 'output' => [ 'shape' => 'DescribeDomainHealthResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeDomainNodes' => [ 'name' => 'DescribeDomainNodes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/nodes', ], 'input' => [ 'shape' => 'DescribeDomainNodesRequest', ], 'output' => [ 'shape' => 'DescribeDomainNodesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'DescribeDomains' => [ 'name' => 'DescribeDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain-info', ], 'input' => [ 'shape' => 'DescribeDomainsRequest', ], 'output' => [ 'shape' => 'DescribeDomainsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDryRunProgress' => [ 'name' => 'DescribeDryRunProgress', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dryRun', ], 'input' => [ 'shape' => 'DescribeDryRunProgressRequest', ], 'output' => [ 'shape' => 'DescribeDryRunProgressResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeInboundConnections' => [ 'name' => 'DescribeInboundConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/search', ], 'input' => [ 'shape' => 'DescribeInboundConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeInboundConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeInstanceTypeLimits' => [ 'name' => 'DescribeInstanceTypeLimits', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/instanceTypeLimits/{EngineVersion}/{InstanceType}', ], 'input' => [ 'shape' => 'DescribeInstanceTypeLimitsRequest', ], 'output' => [ 'shape' => 'DescribeInstanceTypeLimitsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeOutboundConnections' => [ 'name' => 'DescribeOutboundConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection/search', ], 'input' => [ 'shape' => 'DescribeOutboundConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeOutboundConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribePackages' => [ 'name' => 'DescribePackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/describe', ], 'input' => [ 'shape' => 'DescribePackagesRequest', ], 'output' => [ 'shape' => 'DescribePackagesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeReservedInstanceOfferings' => [ 'name' => 'DescribeReservedInstanceOfferings', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/reservedInstanceOfferings', ], 'input' => [ 'shape' => 'DescribeReservedInstanceOfferingsRequest', ], 'output' => [ 'shape' => 'DescribeReservedInstanceOfferingsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], ], ], 'DescribeReservedInstances' => [ 'name' => 'DescribeReservedInstances', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/reservedInstances', ], 'input' => [ 'shape' => 'DescribeReservedInstancesRequest', ], 'output' => [ 'shape' => 'DescribeReservedInstancesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeVpcEndpoints' => [ 'name' => 'DescribeVpcEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/describe', ], 'input' => [ 'shape' => 'DescribeVpcEndpointsRequest', ], 'output' => [ 'shape' => 'DescribeVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DissociatePackage' => [ 'name' => 'DissociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/dissociate/{PackageID}/{DomainName}', ], 'input' => [ 'shape' => 'DissociatePackageRequest', ], 'output' => [ 'shape' => 'DissociatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'GetCompatibleVersions' => [ 'name' => 'GetCompatibleVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/compatibleVersions', ], 'input' => [ 'shape' => 'GetCompatibleVersionsRequest', ], 'output' => [ 'shape' => 'GetCompatibleVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'GetDataSource' => [ 'name' => 'GetDataSource', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'GetDataSourceRequest', ], 'output' => [ 'shape' => 'GetDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'GetDomainMaintenanceStatus' => [ 'name' => 'GetDomainMaintenanceStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance', ], 'input' => [ 'shape' => 'GetDomainMaintenanceStatusRequest', ], 'output' => [ 'shape' => 'GetDomainMaintenanceStatusResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'GetPackageVersionHistory' => [ 'name' => 'GetPackageVersionHistory', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/packages/{PackageID}/history', ], 'input' => [ 'shape' => 'GetPackageVersionHistoryRequest', ], 'output' => [ 'shape' => 'GetPackageVersionHistoryResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetUpgradeHistory' => [ 'name' => 'GetUpgradeHistory', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain/{DomainName}/history', ], 'input' => [ 'shape' => 'GetUpgradeHistoryRequest', ], 'output' => [ 'shape' => 'GetUpgradeHistoryResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'GetUpgradeStatus' => [ 'name' => 'GetUpgradeStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain/{DomainName}/status', ], 'input' => [ 'shape' => 'GetUpgradeStatusRequest', ], 'output' => [ 'shape' => 'GetUpgradeStatusResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListDataSources' => [ 'name' => 'ListDataSources', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource', ], 'input' => [ 'shape' => 'ListDataSourcesRequest', ], 'output' => [ 'shape' => 'ListDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'ListDomainMaintenances' => [ 'name' => 'ListDomainMaintenances', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenances', ], 'input' => [ 'shape' => 'ListDomainMaintenancesRequest', ], 'output' => [ 'shape' => 'ListDomainMaintenancesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'ListDomainNames' => [ 'name' => 'ListDomainNames', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/domain', ], 'input' => [ 'shape' => 'ListDomainNamesRequest', ], 'output' => [ 'shape' => 'ListDomainNamesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListDomainsForPackage' => [ 'name' => 'ListDomainsForPackage', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/packages/{PackageID}/domains', ], 'input' => [ 'shape' => 'ListDomainsForPackageRequest', ], 'output' => [ 'shape' => 'ListDomainsForPackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListInstanceTypeDetails' => [ 'name' => 'ListInstanceTypeDetails', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/instanceTypeDetails/{EngineVersion}', ], 'input' => [ 'shape' => 'ListInstanceTypeDetailsRequest', ], 'output' => [ 'shape' => 'ListInstanceTypeDetailsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackagesForDomain' => [ 'name' => 'ListPackagesForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/domain/{DomainName}/packages', ], 'input' => [ 'shape' => 'ListPackagesForDomainRequest', ], 'output' => [ 'shape' => 'ListPackagesForDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListScheduledActions' => [ 'name' => 'ListScheduledActions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/scheduledActions', ], 'input' => [ 'shape' => 'ListScheduledActionsRequest', ], 'output' => [ 'shape' => 'ListScheduledActionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/tags/', ], 'input' => [ 'shape' => 'ListTagsRequest', ], 'output' => [ 'shape' => 'ListTagsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListVersions' => [ 'name' => 'ListVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/versions', ], 'input' => [ 'shape' => 'ListVersionsRequest', ], 'output' => [ 'shape' => 'ListVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListVpcEndpointAccess' => [ 'name' => 'ListVpcEndpointAccess', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/listVpcEndpointAccess', ], 'input' => [ 'shape' => 'ListVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'ListVpcEndpoints' => [ 'name' => 'ListVpcEndpoints', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'ListVpcEndpointsForDomain' => [ 'name' => 'ListVpcEndpointsForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsForDomainRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsForDomainResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'BaseException', ], ], ], 'PurchaseReservedInstanceOffering' => [ 'name' => 'PurchaseReservedInstanceOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/purchaseReservedInstanceOffering', ], 'input' => [ 'shape' => 'PurchaseReservedInstanceOfferingRequest', ], 'output' => [ 'shape' => 'PurchaseReservedInstanceOfferingResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RejectInboundConnection' => [ 'name' => 'RejectInboundConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/reject', ], 'input' => [ 'shape' => 'RejectInboundConnectionRequest', ], 'output' => [ 'shape' => 'RejectInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'RemoveTags' => [ 'name' => 'RemoveTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/tags-removal', ], 'input' => [ 'shape' => 'RemoveTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RevokeVpcEndpointAccess' => [ 'name' => 'RevokeVpcEndpointAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/revokeVpcEndpointAccess', ], 'input' => [ 'shape' => 'RevokeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'RevokeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'StartDomainMaintenance' => [ 'name' => 'StartDomainMaintenance', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance', ], 'input' => [ 'shape' => 'StartDomainMaintenanceRequest', ], 'output' => [ 'shape' => 'StartDomainMaintenanceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'StartServiceSoftwareUpdate' => [ 'name' => 'StartServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/serviceSoftwareUpdate/start', ], 'input' => [ 'shape' => 'StartServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'StartServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateDataSource' => [ 'name' => 'UpdateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'UpdateDataSourceRequest', ], 'output' => [ 'shape' => 'UpdateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'UpdateDomainConfig' => [ 'name' => 'UpdateDomainConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'UpdateDomainConfigRequest', ], 'output' => [ 'shape' => 'UpdateDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdatePackage' => [ 'name' => 'UpdatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/update', ], 'input' => [ 'shape' => 'UpdatePackageRequest', ], 'output' => [ 'shape' => 'UpdatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateScheduledAction' => [ 'name' => 'UpdateScheduledAction', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/scheduledAction/update', ], 'input' => [ 'shape' => 'UpdateScheduledActionRequest', ], 'output' => [ 'shape' => 'UpdateScheduledActionResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'SlotNotAvailableException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateVpcEndpoint' => [ 'name' => 'UpdateVpcEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/update', ], 'input' => [ 'shape' => 'UpdateVpcEndpointRequest', ], 'output' => [ 'shape' => 'UpdateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'BaseException', ], ], ], 'UpgradeDomain' => [ 'name' => 'UpgradeDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain', ], 'input' => [ 'shape' => 'UpgradeDomainRequest', ], 'output' => [ 'shape' => 'UpgradeDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], ], 'shapes' => [ 'ARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '.*', ], 'AWSAccount' => [ 'type' => 'string', 'pattern' => '^[0-9]+$', ], 'AWSDomainInformation' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'OwnerId' => [ 'shape' => 'OwnerId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Region' => [ 'shape' => 'Region', ], ], ], 'AcceptInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'AcceptInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccessPoliciesStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'PolicyDocument', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'ActionSeverity' => [ 'type' => 'string', 'enum' => [ 'HIGH', 'MEDIUM', 'LOW', ], ], 'ActionStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_UPDATE', 'IN_PROGRESS', 'FAILED', 'COMPLETED', 'NOT_ELIGIBLE', 'ELIGIBLE', ], ], 'ActionType' => [ 'type' => 'string', 'enum' => [ 'SERVICE_SOFTWARE_UPDATE', 'JVM_HEAP_SIZE_TUNING', 'JVM_YOUNG_GEN_TUNING', ], ], 'AddDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', 'DataSourceType', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'AddDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'AddTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagList', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'AdditionalLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'AdditionalLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalLimit', ], ], 'AdvancedOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'AdvancedOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AdvancedSecurityOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsOutput', ], 'AnonymousAuthDisableDate' => [ 'shape' => 'DisableTimestamp', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'MasterUserOptions' => [ 'shape' => 'MasterUserOptions', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsInput', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedSecurityOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AssociatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'DomainName', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'AssociatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetails' => [ 'shape' => 'DomainPackageDetails', ], ], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Account', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Account' => [ 'shape' => 'AWSAccount', ], ], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'type' => 'structure', 'required' => [ 'AuthorizedPrincipal', ], 'members' => [ 'AuthorizedPrincipal' => [ 'shape' => 'AuthorizedPrincipal', ], ], ], 'AuthorizedPrincipal' => [ 'type' => 'structure', 'members' => [ 'PrincipalType' => [ 'shape' => 'PrincipalType', ], 'Principal' => [ 'shape' => 'String', ], ], ], 'AuthorizedPrincipalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthorizedPrincipal', ], ], 'AutoTune' => [ 'type' => 'structure', 'members' => [ 'AutoTuneType' => [ 'shape' => 'AutoTuneType', ], 'AutoTuneDetails' => [ 'shape' => 'AutoTuneDetails', ], ], ], 'AutoTuneDate' => [ 'type' => 'timestamp', ], 'AutoTuneDesiredState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'AutoTuneDetails' => [ 'type' => 'structure', 'members' => [ 'ScheduledAutoTuneDetails' => [ 'shape' => 'ScheduledAutoTuneDetails', ], ], ], 'AutoTuneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTune', ], ], 'AutoTuneMaintenanceSchedule' => [ 'type' => 'structure', 'members' => [ 'StartAt' => [ 'shape' => 'StartAt', ], 'Duration' => [ 'shape' => 'Duration', ], 'CronExpressionForRecurrence' => [ 'shape' => 'String', ], ], ], 'AutoTuneMaintenanceScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTuneMaintenanceSchedule', ], 'max' => 100, ], 'AutoTuneOptions' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'RollbackOnDisable' => [ 'shape' => 'RollbackOnDisable', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsInput' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'AutoTuneState', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'AutoTuneOptions', ], 'Status' => [ 'shape' => 'AutoTuneStatus', ], ], ], 'AutoTuneState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', 'ENABLE_IN_PROGRESS', 'DISABLE_IN_PROGRESS', 'DISABLED_AND_ROLLBACK_SCHEDULED', 'DISABLED_AND_ROLLBACK_IN_PROGRESS', 'DISABLED_AND_ROLLBACK_COMPLETE', 'DISABLED_AND_ROLLBACK_ERROR', 'ERROR', ], ], 'AutoTuneStatus' => [ 'type' => 'structure', 'required' => [ 'CreationDate', 'UpdateDate', 'State', ], 'members' => [ 'CreationDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateVersion' => [ 'shape' => 'UIntValue', ], 'State' => [ 'shape' => 'AutoTuneState', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'PendingDeletion' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneType' => [ 'type' => 'string', 'enum' => [ 'SCHEDULED_ACTION', ], ], 'AvailabilityZone' => [ 'type' => 'string', 'max' => 15, 'min' => 1, ], 'AvailabilityZoneInfo' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneName' => [ 'shape' => 'AvailabilityZone', ], 'ZoneStatus' => [ 'shape' => 'ZoneStatus', ], 'ConfiguredDataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'AvailableDataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'TotalShards' => [ 'shape' => 'NumberOfShards', ], 'TotalUnAssignedShards' => [ 'shape' => 'NumberOfShards', ], ], ], 'AvailabilityZoneInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZoneInfo', ], ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', ], ], 'BackendRole' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'BaseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'CancelServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], ], ], 'CancelServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'ChangeProgressDetails' => [ 'type' => 'structure', 'members' => [ 'ChangeId' => [ 'shape' => 'GUID', ], 'Message' => [ 'shape' => 'Message', ], ], ], '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', ], ], ], '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', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConnectionAlias' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '[a-zA-Z][a-zA-Z0-9\\-\\_]+', ], 'ConnectionId' => [ 'type' => 'string', 'max' => 256, 'min' => 10, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'ConnectionMode' => [ 'type' => 'string', 'enum' => [ 'DIRECT', 'VPC_ENDPOINT', ], ], 'ConnectionProperties' => [ 'type' => 'structure', 'members' => [ 'Endpoint' => [ 'shape' => 'Endpoint', ], 'CrossClusterSearch' => [ 'shape' => 'CrossClusterSearchConnectionProperties', ], ], ], 'ConnectionStatusMessage' => [ 'type' => 'string', ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'EngineVersion' => [ 'shape' => 'VersionString', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCOptions', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsInput', ], 'TagList' => [ 'shape' => 'TagList', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsInput', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], ], ], 'CreateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'CreateOutboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'LocalDomainInfo', 'RemoteDomainInfo', 'ConnectionAlias', ], 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], 'ConnectionProperties' => [ 'shape' => 'ConnectionProperties', ], ], ], 'CreateOutboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionStatus' => [ 'shape' => 'OutboundConnectionStatus', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], 'ConnectionProperties' => [ 'shape' => 'ConnectionProperties', ], ], ], 'CreatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageName', 'PackageType', 'PackageSource', ], 'members' => [ 'PackageName' => [ 'shape' => 'PackageName', ], 'PackageType' => [ 'shape' => 'PackageType', ], 'PackageDescription' => [ 'shape' => 'PackageDescription', ], 'PackageSource' => [ 'shape' => 'PackageSource', ], ], ], 'CreatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'CreateVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'DomainArn', 'VpcOptions', ], 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'VpcOptions' => [ 'shape' => 'VPCOptions', ], 'ClientToken' => [ 'shape' => 'ClientToken', ], ], ], 'CreateVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoint', ], 'members' => [ 'VpcEndpoint' => [ 'shape' => 'VpcEndpoint', ], ], ], 'CreatedAt' => [ 'type' => 'timestamp', ], 'CrossClusterSearchConnectionProperties' => [ 'type' => 'structure', 'members' => [ 'SkipUnavailable' => [ 'shape' => 'SkipUnavailableStatus', ], ], ], 'DataSourceDescription' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$', ], 'DataSourceDetails' => [ 'type' => 'structure', 'members' => [ 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'DataSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceDetails', ], ], 'DataSourceName' => [ 'type' => 'string', 'max' => 80, 'min' => 3, 'pattern' => '[a-z][a-z0-9_]+', ], 'DataSourceType' => [ 'type' => 'structure', 'members' => [ 'S3GlueDataCatalog' => [ 'shape' => 'S3GlueDataCatalog', ], ], 'union' => true, ], 'DeleteDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], ], ], 'DeleteDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DeleteDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'DeleteInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'DeleteOutboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteOutboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'OutboundConnection', ], ], ], 'DeletePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], ], ], 'DeletePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'DeleteVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointId', ], 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', 'location' => 'uri', 'locationName' => 'VpcEndpointId', ], ], ], 'DeleteVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummary', ], 'members' => [ 'VpcEndpointSummary' => [ 'shape' => 'VpcEndpointSummary', ], ], ], 'DependencyFailureException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 424, ], 'exception' => true, ], 'DeploymentCloseDateTimeStamp' => [ 'type' => 'timestamp', ], 'DeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_UPDATE', 'IN_PROGRESS', 'COMPLETED', 'NOT_ELIGIBLE', 'ELIGIBLE', ], ], 'DeploymentType' => [ 'type' => 'string', 'max' => 128, 'min' => 2, ], 'DescribeDomainAutoTunesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeDomainAutoTunesResponse' => [ 'type' => 'structure', 'members' => [ 'AutoTunes' => [ 'shape' => 'AutoTuneList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeDomainChangeProgressRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ChangeId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'changeid', ], ], ], 'DescribeDomainChangeProgressResponse' => [ 'type' => 'structure', 'members' => [ 'ChangeProgressStatus' => [ 'shape' => 'ChangeProgressStatusDetails', ], ], ], 'DescribeDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'DomainConfig', ], ], ], 'DescribeDomainHealthRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainHealthResponse' => [ 'type' => 'structure', 'members' => [ 'DomainState' => [ 'shape' => 'DomainState', ], 'AvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'ActiveAvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'StandByAvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'DataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'DedicatedMaster' => [ 'shape' => 'Boolean', ], 'MasterEligibleNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'WarmNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'MasterNode' => [ 'shape' => 'MasterNodeStatus', ], 'ClusterHealth' => [ 'shape' => 'DomainHealth', ], 'TotalShards' => [ 'shape' => 'NumberOfShards', ], 'TotalUnAssignedShards' => [ 'shape' => 'NumberOfShards', ], 'EnvironmentInformation' => [ 'shape' => 'EnvironmentInfoList', ], ], ], 'DescribeDomainNodesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainNodesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainNodesStatusList' => [ 'shape' => 'DomainNodesStatusList', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatus', ], 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'DescribeDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'DomainNames', ], 'members' => [ 'DomainNames' => [ 'shape' => 'DomainNameList', ], ], ], 'DescribeDomainsResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatusList', ], 'members' => [ 'DomainStatusList' => [ 'shape' => 'DomainStatusList', ], ], ], 'DescribeDryRunProgressRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'DryRunId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'dryRunId', ], 'LoadDryRunConfig' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'loadDryRunConfig', ], ], ], 'DescribeDryRunProgressResponse' => [ 'type' => 'structure', 'members' => [ 'DryRunProgressStatus' => [ 'shape' => 'DryRunProgressStatus', ], 'DryRunConfig' => [ 'shape' => 'DomainStatus', ], 'DryRunResults' => [ 'shape' => 'DryRunResults', ], ], ], 'DescribeInboundConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeInboundConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'Connections' => [ 'shape' => 'InboundConnections', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeInstanceTypeLimitsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'EngineVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', 'location' => 'uri', 'locationName' => 'InstanceType', ], 'EngineVersion' => [ 'shape' => 'VersionString', 'location' => 'uri', 'locationName' => 'EngineVersion', ], ], ], 'DescribeInstanceTypeLimitsResponse' => [ 'type' => 'structure', 'members' => [ 'LimitsByRole' => [ 'shape' => 'LimitsByRole', ], ], ], 'DescribeOutboundConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOutboundConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'Connections' => [ 'shape' => 'OutboundConnections', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePackagesFilter' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'DescribePackagesFilterName', ], 'Value' => [ 'shape' => 'DescribePackagesFilterValues', ], ], ], 'DescribePackagesFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribePackagesFilter', ], ], 'DescribePackagesFilterName' => [ 'type' => 'string', 'enum' => [ 'PackageID', 'PackageName', 'PackageStatus', 'PackageType', 'EngineVersion', ], ], 'DescribePackagesFilterValue' => [ 'type' => 'string', 'pattern' => '^[0-9a-zA-Z\\*\\.\\_\\\\\\/\\?-]+$', ], 'DescribePackagesFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribePackagesFilterValue', ], 'min' => 1, ], 'DescribePackagesRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'DescribePackagesFilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePackagesResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetailsList' => [ 'shape' => 'PackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeReservedInstanceOfferingsRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'offeringId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedInstanceOfferingsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ReservedInstanceOfferings' => [ 'shape' => 'ReservedInstanceOfferingList', ], ], ], 'DescribeReservedInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'reservationId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', ], 'ReservedInstances' => [ 'shape' => 'ReservedInstanceList', ], ], ], 'DescribeVpcEndpointsRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointIds', ], 'members' => [ 'VpcEndpointIds' => [ 'shape' => 'VpcEndpointIdList', ], ], ], 'DescribeVpcEndpointsResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoints', 'VpcEndpointErrors', ], 'members' => [ 'VpcEndpoints' => [ 'shape' => 'VpcEndpoints', ], 'VpcEndpointErrors' => [ 'shape' => 'VpcEndpointErrorList', ], ], ], 'Description' => [ 'type' => 'string', ], 'DisableTimestamp' => [ 'type' => 'timestamp', ], 'DisabledOperationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'DissociatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'DomainName', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DissociatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetails' => [ 'shape' => 'DomainPackageDetails', ], ], ], 'DomainArn' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:[a-z]+:[a-z0-9\\-]+:[0-9]+:domain\\/[a-z0-9\\-]+', ], 'DomainConfig' => [ 'type' => 'structure', 'members' => [ 'EngineVersion' => [ 'shape' => 'VersionStatus', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfigStatus', ], 'EBSOptions' => [ 'shape' => 'EBSOptionsStatus', ], 'AccessPolicies' => [ 'shape' => 'AccessPoliciesStatus', ], 'IPAddressType' => [ 'shape' => 'IPAddressTypeStatus', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptionsStatus', ], 'VPCOptions' => [ 'shape' => 'VPCDerivedInfoStatus', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptionsStatus', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptionsStatus', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptionsStatus', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptionsStatus', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptionsStatus', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptionsStatus', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsStatus', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsStatus', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptionsStatus', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptionsStatus', ], ], ], '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', ], ], 'DomainState' => [ 'type' => 'string', 'enum' => [ 'Active', 'Processing', 'NotAvailable', ], ], 'DomainStatus' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'DomainName', 'ARN', 'ClusterConfig', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'ARN' => [ 'shape' => 'ARN', ], 'Created' => [ 'shape' => 'Boolean', ], 'Deleted' => [ 'shape' => 'Boolean', ], 'Endpoint' => [ 'shape' => 'ServiceUrl', ], 'EndpointV2' => [ 'shape' => 'ServiceUrl', ], 'Endpoints' => [ 'shape' => 'EndpointsMap', ], 'Processing' => [ 'shape' => 'Boolean', ], 'UpgradeProcessing' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'VersionString', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCDerivedInfo', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptions', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsOutput', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], ], ], '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}', ], 'GetCompatibleVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], ], ], 'GetCompatibleVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'CompatibleVersions' => [ 'shape' => 'CompatibleVersionsList', ], ], ], 'GetDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], ], ], 'GetDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'GetDomainMaintenanceStatusRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'MaintenanceId', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaintenanceId' => [ 'shape' => 'RequestId', 'location' => 'querystring', 'locationName' => 'maintenanceId', ], ], ], 'GetDomainMaintenanceStatusResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'MaintenanceStatus', ], 'StatusMessage' => [ 'shape' => 'MaintenanceStatusMessage', ], 'NodeId' => [ 'shape' => 'NodeId', ], 'Action' => [ 'shape' => 'MaintenanceType', ], 'CreatedAt' => [ 'shape' => 'UpdateTimestamp', ], 'UpdatedAt' => [ 'shape' => 'UpdateTimestamp', ], ], ], 'GetPackageVersionHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetPackageVersionHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageVersionHistoryList' => [ 'shape' => 'PackageVersionHistoryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetUpgradeHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetUpgradeHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeHistories' => [ 'shape' => 'UpgradeHistoryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetUpgradeStatusRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'GetUpgradeStatusResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeStep' => [ 'shape' => 'UpgradeStep', ], 'StepStatus' => [ 'shape' => 'UpgradeStatus', ], 'UpgradeName' => [ 'shape' => 'UpgradeName', ], ], ], 'IPAddressType' => [ 'type' => 'string', 'enum' => [ 'ipv4', 'dualstack', ], ], 'IPAddressTypeStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'IPAddressType', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'IdentityPoolId' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+:[0-9a-f-]+', ], 'InboundConnection' => [ 'type' => 'structure', 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionStatus' => [ 'shape' => 'InboundConnectionStatus', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], ], ], 'InboundConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'InboundConnectionStatusCode', ], 'Message' => [ 'shape' => 'ConnectionStatusMessage', ], ], ], 'InboundConnectionStatusCode' => [ 'type' => 'string', 'enum' => [ 'PENDING_ACCEPTANCE', 'APPROVED', 'PROVISIONING', 'ACTIVE', 'REJECTING', 'REJECTED', 'DELETING', 'DELETED', ], ], 'InboundConnections' => [ 'type' => 'list', 'member' => [ 'shape' => 'InboundConnection', ], ], 'InstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'InstanceCountLimits' => [ 'type' => 'structure', 'members' => [ 'MinimumInstanceCount' => [ 'shape' => 'MinimumInstanceCount', ], 'MaximumInstanceCount' => [ 'shape' => 'MaximumInstanceCount', ], ], ], 'InstanceLimits' => [ 'type' => 'structure', 'members' => [ 'InstanceCountLimits' => [ 'shape' => 'InstanceCountLimits', ], ], ], 'InstanceRole' => [ 'type' => 'string', ], 'InstanceRoleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceRole', ], ], 'InstanceTypeDetails' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'EncryptionEnabled' => [ 'shape' => 'Boolean', ], 'CognitoEnabled' => [ 'shape' => 'Boolean', ], 'AppLogsEnabled' => [ 'shape' => 'Boolean', ], 'AdvancedSecurityEnabled' => [ 'shape' => 'Boolean', ], 'WarmEnabled' => [ 'shape' => 'Boolean', ], 'InstanceRole' => [ 'shape' => 'InstanceRoleList', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], ], ], 'InstanceTypeDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceTypeDetails', ], ], 'InstanceTypeString' => [ 'type' => 'string', 'max' => 40, 'min' => 10, 'pattern' => '^.*\\..*\\.search$', ], 'Integer' => [ 'type' => 'integer', ], 'IntegerClass' => [ 'type' => 'integer', ], 'InternalException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'InvalidPaginationTokenException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidTypeException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'Issue' => [ 'type' => 'string', ], 'Issues' => [ 'type' => 'list', 'member' => [ 'shape' => 'Issue', ], ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '.*', ], 'LastUpdated' => [ 'type' => 'timestamp', ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'LimitName' => [ 'type' => 'string', ], 'LimitValue' => [ 'type' => 'string', ], 'LimitValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LimitValue', ], ], 'Limits' => [ 'type' => 'structure', 'members' => [ 'StorageTypes' => [ 'shape' => 'StorageTypeList', ], 'InstanceLimits' => [ 'shape' => 'InstanceLimits', ], 'AdditionalLimits' => [ 'shape' => 'AdditionalLimitList', ], ], ], 'LimitsByRole' => [ 'type' => 'map', 'key' => [ 'shape' => 'InstanceRole', ], 'value' => [ 'shape' => 'Limits', ], ], 'ListDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'ListDataSourcesResponse' => [ 'type' => 'structure', 'members' => [ 'DataSources' => [ 'shape' => 'DataSourceList', ], ], ], 'ListDomainMaintenancesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Action' => [ 'shape' => 'MaintenanceType', 'location' => 'querystring', 'locationName' => 'action', ], 'Status' => [ 'shape' => 'MaintenanceStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListDomainMaintenancesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainMaintenances' => [ 'shape' => 'DomainMaintenanceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDomainNamesRequest' => [ 'type' => 'structure', 'members' => [ 'EngineType' => [ 'shape' => 'EngineType', 'location' => 'querystring', 'locationName' => 'engineType', ], ], ], 'ListDomainNamesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainNames' => [ 'shape' => 'DomainInfoList', ], ], ], 'ListDomainsForPackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListDomainsForPackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetailsList' => [ 'shape' => 'DomainPackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListInstanceTypeDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'EngineVersion', ], 'members' => [ 'EngineVersion' => [ 'shape' => 'VersionString', 'location' => 'uri', 'locationName' => 'EngineVersion', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'RetrieveAZs' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'retrieveAZs', ], 'InstanceType' => [ 'shape' => 'InstanceTypeString', 'location' => 'querystring', 'locationName' => 'instanceType', ], ], ], 'ListInstanceTypeDetailsResponse' => [ 'type' => 'structure', 'members' => [ 'InstanceTypeDetails' => [ 'shape' => 'InstanceTypeDetailsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPackagesForDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListPackagesForDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetailsList' => [ 'shape' => 'DomainPackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListScheduledActionsRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListScheduledActionsResponse' => [ 'type' => 'structure', 'members' => [ 'ScheduledActions' => [ 'shape' => 'ScheduledActionsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'arn', ], ], ], 'ListTagsResponse' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'ListVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'Versions' => [ 'shape' => 'VersionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointAccessResponse' => [ 'type' => 'structure', 'required' => [ 'AuthorizedPrincipalList', 'NextToken', ], 'members' => [ 'AuthorizedPrincipalList' => [ 'shape' => 'AuthorizedPrincipalList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointsForDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointsForDomainResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummaryList', 'NextToken', ], 'members' => [ 'VpcEndpointSummaryList' => [ 'shape' => 'VpcEndpointSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointsResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummaryList', 'NextToken', ], 'members' => [ 'VpcEndpointSummaryList' => [ 'shape' => 'VpcEndpointSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'LogPublishingOption' => [ 'type' => 'structure', 'members' => [ 'CloudWatchLogsLogGroupArn' => [ 'shape' => 'CloudWatchLogsLogGroupArn', ], 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'LogPublishingOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'LogType', ], 'value' => [ 'shape' => 'LogPublishingOption', ], ], 'LogPublishingOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'LogPublishingOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'LogType' => [ 'type' => 'string', 'enum' => [ 'INDEX_SLOW_LOGS', 'SEARCH_SLOW_LOGS', 'ES_APPLICATION_LOGS', 'AUDIT_LOGS', ], ], 'Long' => [ 'type' => 'long', ], 'MaintenanceStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'TIMED_OUT', ], ], 'MaintenanceStatusMessage' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '^([\\s\\S]*)$', ], 'MaintenanceType' => [ 'type' => 'string', 'enum' => [ 'REBOOT_NODE', 'RESTART_SEARCH_PROCESS', 'RESTART_DASHBOARD', ], ], 'MasterNodeStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'UnAvailable', ], ], 'MasterUserOptions' => [ 'type' => 'structure', 'members' => [ 'MasterUserARN' => [ 'shape' => 'ARN', ], 'MasterUserName' => [ 'shape' => 'Username', ], 'MasterUserPassword' => [ 'shape' => 'Password', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, ], 'MaximumInstanceCount' => [ 'type' => 'integer', ], 'Message' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'MinimumInstanceCount' => [ 'type' => 'integer', ], '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', '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', ], ], 'PurchaseReservedInstanceOfferingRequest' => [ 'type' => 'structure', 'required' => [ 'ReservedInstanceOfferingId', 'ReservationName', ], 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', ], 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'InstanceCount' => [ 'shape' => 'InstanceCount', ], ], ], 'PurchaseReservedInstanceOfferingResponse' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceId' => [ 'shape' => 'GUID', ], 'ReservationName' => [ 'shape' => 'ReservationToken', ], ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'RecurringChargeAmount' => [ 'shape' => 'Double', ], 'RecurringChargeFrequency' => [ 'shape' => 'String', ], ], ], 'RecurringChargeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', ], ], 'ReferencePath' => [ 'type' => 'string', ], 'Region' => [ 'type' => 'string', 'max' => 30, 'min' => 5, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'RejectInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'RejectInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'RemoveTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagKeys', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagKeys' => [ 'shape' => 'StringList', ], ], ], 'RequestId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^([\\s\\S]*)$', ], 'ReservationToken' => [ 'type' => 'string', 'max' => 64, 'min' => 5, 'pattern' => '.*', ], 'ReservedInstance' => [ 'type' => 'structure', 'members' => [ 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'ReservedInstanceId' => [ 'shape' => 'GUID', ], 'BillingSubscriptionId' => [ 'shape' => 'Long', ], 'ReservedInstanceOfferingId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'StartTime' => [ 'shape' => 'UpdateTimestamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'State' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedInstance', ], ], 'ReservedInstanceOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedInstanceOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedInstanceOffering', ], ], 'ReservedInstancePaymentOption' => [ 'type' => 'string', 'enum' => [ 'ALL_UPFRONT', 'PARTIAL_UPFRONT', 'NO_UPFRONT', ], ], 'ResourceAlreadyExistsException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'RevokeVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Account', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Account' => [ 'shape' => 'AWSAccount', ], ], ], 'RevokeVpcEndpointAccessResponse' => [ 'type' => 'structure', 'members' => [], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*', ], 'RollbackOnDisable' => [ 'type' => 'string', 'enum' => [ 'NO_ROLLBACK', 'DEFAULT_ROLLBACK', ], ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, ], 'S3GlueDataCatalog' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'S3Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SAMLEntityId' => [ 'type' => 'string', 'max' => 512, 'min' => 8, ], 'SAMLIdp' => [ 'type' => 'structure', 'required' => [ 'MetadataContent', 'EntityId', ], 'members' => [ 'MetadataContent' => [ 'shape' => 'SAMLMetadata', ], 'EntityId' => [ 'shape' => 'SAMLEntityId', ], ], ], 'SAMLMetadata' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, ], 'SAMLOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'Idp' => [ 'shape' => 'SAMLIdp', ], 'MasterUserName' => [ 'shape' => 'Username', ], 'MasterBackendRole' => [ 'shape' => 'BackendRole', ], 'SubjectKey' => [ 'shape' => 'String', ], 'RolesKey' => [ 'shape' => 'String', ], 'SessionTimeoutMinutes' => [ 'shape' => 'IntegerClass', ], ], ], 'SAMLOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'Idp' => [ 'shape' => 'SAMLIdp', ], 'SubjectKey' => [ 'shape' => 'String', ], 'RolesKey' => [ 'shape' => 'String', ], 'SessionTimeoutMinutes' => [ 'shape' => 'IntegerClass', ], ], ], 'ScheduleAt' => [ 'type' => 'string', 'enum' => [ 'NOW', 'TIMESTAMP', 'OFF_PEAK_WINDOW', ], ], 'ScheduledAction' => [ 'type' => 'structure', 'required' => [ 'Id', 'Type', 'Severity', 'ScheduledTime', ], 'members' => [ 'Id' => [ 'shape' => 'String', ], 'Type' => [ 'shape' => 'ActionType', ], 'Severity' => [ 'shape' => 'ActionSeverity', ], 'ScheduledTime' => [ 'shape' => 'Long', ], 'Description' => [ 'shape' => 'String', ], 'ScheduledBy' => [ 'shape' => 'ScheduledBy', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Mandatory' => [ 'shape' => 'Boolean', ], 'Cancellable' => [ 'shape' => 'Boolean', ], ], ], 'ScheduledActionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScheduledAction', ], ], 'ScheduledAutoTuneActionType' => [ 'type' => 'string', 'enum' => [ 'JVM_HEAP_SIZE_TUNING', 'JVM_YOUNG_GEN_TUNING', ], ], 'ScheduledAutoTuneDescription' => [ 'type' => 'string', ], 'ScheduledAutoTuneDetails' => [ 'type' => 'structure', 'members' => [ 'Date' => [ 'shape' => 'AutoTuneDate', ], 'ActionType' => [ 'shape' => 'ScheduledAutoTuneActionType', ], 'Action' => [ 'shape' => 'ScheduledAutoTuneDescription', ], 'Severity' => [ 'shape' => 'ScheduledAutoTuneSeverityType', ], ], ], 'ScheduledAutoTuneSeverityType' => [ 'type' => 'string', 'enum' => [ 'LOW', 'MEDIUM', 'HIGH', ], ], 'ScheduledBy' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER', 'SYSTEM', ], ], 'ServiceSoftwareOptions' => [ 'type' => 'structure', 'members' => [ 'CurrentVersion' => [ 'shape' => 'String', ], 'NewVersion' => [ 'shape' => 'String', ], 'UpdateAvailable' => [ 'shape' => 'Boolean', ], 'Cancellable' => [ 'shape' => 'Boolean', ], 'UpdateStatus' => [ 'shape' => 'DeploymentStatus', ], 'Description' => [ 'shape' => 'String', ], 'AutomatedUpdateDate' => [ 'shape' => 'DeploymentCloseDateTimeStamp', ], 'OptionalDeployment' => [ 'shape' => 'Boolean', ], ], ], 'ServiceUrl' => [ 'type' => 'string', ], 'SkipUnavailableStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'SlotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Long', ], ], 'SlotNotAvailableException' => [ 'type' => 'structure', 'members' => [ 'SlotSuggestions' => [ 'shape' => 'SlotList', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'SnapshotOptions' => [ 'type' => 'structure', 'members' => [ 'AutomatedSnapshotStartHour' => [ 'shape' => 'IntegerClass', ], ], ], 'SnapshotOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'SnapshotOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'SoftwareUpdateOptions' => [ 'type' => 'structure', 'members' => [ 'AutoSoftwareUpdateEnabled' => [ 'shape' => 'Boolean', ], ], ], 'SoftwareUpdateOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'SoftwareUpdateOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'StartAt' => [ 'type' => 'timestamp', ], 'StartDomainMaintenanceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Action', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Action' => [ 'shape' => 'MaintenanceType', ], 'NodeId' => [ 'shape' => 'NodeId', ], ], ], 'StartDomainMaintenanceResponse' => [ 'type' => 'structure', 'members' => [ 'MaintenanceId' => [ 'shape' => 'RequestId', ], ], ], 'StartServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'ScheduleAt' => [ 'shape' => 'ScheduleAt', ], 'DesiredStartTime' => [ 'shape' => 'Long', ], ], ], 'StartServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'StartTimeHours' => [ 'type' => 'long', 'max' => 23, 'min' => 0, ], 'StartTimeMinutes' => [ 'type' => 'long', 'max' => 59, 'min' => 0, ], 'StartTimestamp' => [ 'type' => 'timestamp', ], 'StorageSubTypeName' => [ 'type' => 'string', ], 'StorageType' => [ 'type' => 'structure', 'members' => [ 'StorageTypeName' => [ 'shape' => 'StorageTypeName', ], 'StorageSubTypeName' => [ 'shape' => 'StorageSubTypeName', ], 'StorageTypeLimits' => [ 'shape' => 'StorageTypeLimitList', ], ], ], 'StorageTypeLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'StorageTypeLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageTypeLimit', ], ], 'StorageTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageType', ], ], 'StorageTypeName' => [ 'type' => 'string', ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'TLSSecurityPolicy' => [ 'type' => 'string', 'enum' => [ 'Policy-Min-TLS-1-0-2019-07', 'Policy-Min-TLS-1-2-2019-07', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'TimeUnit' => [ 'type' => 'string', 'enum' => [ 'HOURS', ], ], 'TotalNumberOfStages' => [ 'type' => 'integer', ], 'UIntValue' => [ 'type' => 'integer', 'min' => 0, ], 'UncompressedPluginSizeInBytes' => [ 'type' => 'long', ], 'UpdateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', 'DataSourceType', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'UpdateDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'UpdateDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCOptions', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsInput', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptions', ], 'DryRun' => [ 'shape' => 'DryRun', ], 'DryRunMode' => [ 'shape' => 'DryRunMode', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], ], ], 'UpdateDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'DomainConfig', ], 'DryRunResults' => [ 'shape' => 'DryRunResults', ], 'DryRunProgressStatus' => [ 'shape' => 'DryRunProgressStatus', ], ], ], 'UpdatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'PackageSource', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageSource' => [ 'shape' => 'PackageSource', ], 'PackageDescription' => [ 'shape' => 'PackageDescription', ], 'CommitMessage' => [ 'shape' => 'CommitMessage', ], ], ], 'UpdatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'UpdateScheduledActionRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'ActionID', 'ActionType', 'ScheduleAt', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ActionID' => [ 'shape' => 'String', ], 'ActionType' => [ 'shape' => 'ActionType', ], 'ScheduleAt' => [ 'shape' => 'ScheduleAt', ], 'DesiredStartTime' => [ 'shape' => 'Long', ], ], ], 'UpdateScheduledActionResponse' => [ 'type' => 'structure', 'members' => [ 'ScheduledAction' => [ 'shape' => 'ScheduledAction', ], ], ], 'UpdateTimestamp' => [ 'type' => 'timestamp', ], 'UpdateVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointId', 'VpcOptions', ], 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcOptions' => [ 'shape' => 'VPCOptions', ], ], ], 'UpdateVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoint', ], 'members' => [ 'VpcEndpoint' => [ 'shape' => 'VpcEndpoint', ], ], ], 'UpgradeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'TargetVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'VersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], ], ], 'UpgradeDomainResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeId' => [ 'shape' => 'String', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'VersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], ], ], 'UpgradeHistory' => [ 'type' => 'structure', 'members' => [ 'UpgradeName' => [ 'shape' => 'UpgradeName', ], 'StartTimestamp' => [ 'shape' => 'StartTimestamp', ], 'UpgradeStatus' => [ 'shape' => 'UpgradeStatus', ], 'StepsList' => [ 'shape' => 'UpgradeStepsList', ], ], ], 'UpgradeHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeHistory', ], ], 'UpgradeName' => [ 'type' => 'string', ], 'UpgradeStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'SUCCEEDED', 'SUCCEEDED_WITH_ISSUES', 'FAILED', ], ], 'UpgradeStep' => [ 'type' => 'string', 'enum' => [ 'PRE_UPGRADE_CHECK', 'SNAPSHOT', 'UPGRADE', ], ], 'UpgradeStepItem' => [ 'type' => 'structure', 'members' => [ 'UpgradeStep' => [ 'shape' => 'UpgradeStep', ], 'UpgradeStepStatus' => [ 'shape' => 'UpgradeStatus', ], 'Issues' => [ 'shape' => 'Issues', ], 'ProgressPercent' => [ 'shape' => 'Double', ], ], ], 'UpgradeStepsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeStepItem', ], ], 'UserPoolId' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'Username' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', 'sensitive' => true, ], 'VPCDerivedInfo' => [ 'type' => 'structure', 'members' => [ 'VPCId' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'StringList', ], 'AvailabilityZones' => [ 'shape' => 'StringList', ], 'SecurityGroupIds' => [ 'shape' => 'StringList', ], ], ], 'VPCDerivedInfoStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'VPCDerivedInfo', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'VPCOptions' => [ 'type' => 'structure', 'members' => [ 'SubnetIds' => [ 'shape' => 'StringList', ], 'SecurityGroupIds' => [ 'shape' => 'StringList', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidationFailure' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ValidationFailures' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationFailure', ], ], 'ValueStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString', ], 'min' => 1, ], 'VersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VersionString', ], ], 'VersionStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'VersionString', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'VersionString' => [ 'type' => 'string', 'max' => 18, 'min' => 14, 'pattern' => '^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$', ], 'VolumeSize' => [ 'type' => 'string', ], 'VolumeType' => [ 'type' => 'string', 'enum' => [ 'standard', 'gp2', 'io1', 'gp3', ], ], 'VpcEndpoint' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcEndpointOwner' => [ 'shape' => 'AWSAccount', ], 'DomainArn' => [ 'shape' => 'DomainArn', ], 'VpcOptions' => [ 'shape' => 'VPCDerivedInfo', ], 'Status' => [ 'shape' => 'VpcEndpointStatus', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], ], ], 'VpcEndpointError' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'ErrorCode' => [ 'shape' => 'VpcEndpointErrorCode', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'VpcEndpointErrorCode' => [ 'type' => 'string', 'enum' => [ 'ENDPOINT_NOT_FOUND', 'SERVER_ERROR', ], ], 'VpcEndpointErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointError', ], ], 'VpcEndpointId' => [ 'type' => 'string', 'max' => 256, 'min' => 5, 'pattern' => '^aos-[a-zA-Z0-9]*$', ], 'VpcEndpointIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointId', ], ], 'VpcEndpointStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATE_FAILED', 'ACTIVE', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'VpcEndpointSummary' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcEndpointOwner' => [ 'shape' => 'String', ], 'DomainArn' => [ 'shape' => 'DomainArn', ], 'Status' => [ 'shape' => 'VpcEndpointStatus', ], ], ], 'VpcEndpointSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointSummary', ], ], 'VpcEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpoint', ], ], 'WindowStartTime' => [ 'type' => 'structure', 'required' => [ 'Hours', 'Minutes', ], 'members' => [ 'Hours' => [ 'shape' => 'StartTimeHours', ], 'Minutes' => [ 'shape' => 'StartTimeMinutes', ], ], ], 'ZoneAwarenessConfig' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneCount' => [ 'shape' => 'IntegerClass', ], ], ], 'ZoneStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'StandBy', 'NotAvailable', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2021-01-01', 'endpointPrefix' => 'es', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon OpenSearch Service', 'serviceId' => 'OpenSearch', 'signatureVersion' => 'v4', 'uid' => 'opensearch-2021-01-01', ], 'operations' => [ 'AcceptInboundConnection' => [ 'name' => 'AcceptInboundConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/accept', ], 'input' => [ 'shape' => 'AcceptInboundConnectionRequest', ], 'output' => [ 'shape' => 'AcceptInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'AddDataSource' => [ 'name' => 'AddDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource', ], 'input' => [ 'shape' => 'AddDataSourceRequest', ], 'output' => [ 'shape' => 'AddDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/tags', ], 'input' => [ 'shape' => 'AddTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'AssociatePackage' => [ 'name' => 'AssociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/associate/{PackageID}/{DomainName}', ], 'input' => [ 'shape' => 'AssociatePackageRequest', ], 'output' => [ 'shape' => 'AssociatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'AuthorizeVpcEndpointAccess' => [ 'name' => 'AuthorizeVpcEndpointAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/authorizeVpcEndpointAccess', ], 'input' => [ 'shape' => 'AuthorizeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'AuthorizeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'CancelServiceSoftwareUpdate' => [ 'name' => 'CancelServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/serviceSoftwareUpdate/cancel', ], 'input' => [ 'shape' => 'CancelServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'CancelServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateOutboundConnection' => [ 'name' => 'CreateOutboundConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection', ], 'input' => [ 'shape' => 'CreateOutboundConnectionRequest', ], 'output' => [ 'shape' => 'CreateOutboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'CreatePackage' => [ 'name' => 'CreatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages', ], 'input' => [ 'shape' => 'CreatePackageRequest', ], 'output' => [ 'shape' => 'CreatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'CreateVpcEndpoint' => [ 'name' => 'CreateVpcEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints', ], 'input' => [ 'shape' => 'CreateVpcEndpointRequest', ], 'output' => [ 'shape' => 'CreateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DeleteDataSource' => [ 'name' => 'DeleteDataSource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'DeleteDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'output' => [ 'shape' => 'DeleteDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DeleteInboundConnection' => [ 'name' => 'DeleteInboundConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteInboundConnectionRequest', ], 'output' => [ 'shape' => 'DeleteInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeleteOutboundConnection' => [ 'name' => 'DeleteOutboundConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection/{ConnectionId}', ], 'input' => [ 'shape' => 'DeleteOutboundConnectionRequest', ], 'output' => [ 'shape' => 'DeleteOutboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DeletePackage' => [ 'name' => 'DeletePackage', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/packages/{PackageID}', ], 'input' => [ 'shape' => 'DeletePackageRequest', ], 'output' => [ 'shape' => 'DeletePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteVpcEndpoint' => [ 'name' => 'DeleteVpcEndpoint', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/{VpcEndpointId}', ], 'input' => [ 'shape' => 'DeleteVpcEndpointRequest', ], 'output' => [ 'shape' => 'DeleteVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainAutoTunes' => [ 'name' => 'DescribeDomainAutoTunes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/autoTunes', ], 'input' => [ 'shape' => 'DescribeDomainAutoTunesRequest', ], 'output' => [ 'shape' => 'DescribeDomainAutoTunesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainChangeProgress' => [ 'name' => 'DescribeDomainChangeProgress', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/progress', ], 'input' => [ 'shape' => 'DescribeDomainChangeProgressRequest', ], 'output' => [ 'shape' => 'DescribeDomainChangeProgressResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainConfig' => [ 'name' => 'DescribeDomainConfig', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'DescribeDomainConfigRequest', ], 'output' => [ 'shape' => 'DescribeDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDomainHealth' => [ 'name' => 'DescribeDomainHealth', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/health', ], 'input' => [ 'shape' => 'DescribeDomainHealthRequest', ], 'output' => [ 'shape' => 'DescribeDomainHealthResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeDomainNodes' => [ 'name' => 'DescribeDomainNodes', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/nodes', ], 'input' => [ 'shape' => 'DescribeDomainNodesRequest', ], 'output' => [ 'shape' => 'DescribeDomainNodesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'DescribeDomains' => [ 'name' => 'DescribeDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain-info', ], 'input' => [ 'shape' => 'DescribeDomainsRequest', ], 'output' => [ 'shape' => 'DescribeDomainsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeDryRunProgress' => [ 'name' => 'DescribeDryRunProgress', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dryRun', ], 'input' => [ 'shape' => 'DescribeDryRunProgressRequest', ], 'output' => [ 'shape' => 'DescribeDryRunProgressResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeInboundConnections' => [ 'name' => 'DescribeInboundConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/search', ], 'input' => [ 'shape' => 'DescribeInboundConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeInboundConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeInstanceTypeLimits' => [ 'name' => 'DescribeInstanceTypeLimits', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/instanceTypeLimits/{EngineVersion}/{InstanceType}', ], 'input' => [ 'shape' => 'DescribeInstanceTypeLimitsRequest', ], 'output' => [ 'shape' => 'DescribeInstanceTypeLimitsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeOutboundConnections' => [ 'name' => 'DescribeOutboundConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/cc/outboundConnection/search', ], 'input' => [ 'shape' => 'DescribeOutboundConnectionsRequest', ], 'output' => [ 'shape' => 'DescribeOutboundConnectionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribePackages' => [ 'name' => 'DescribePackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/describe', ], 'input' => [ 'shape' => 'DescribePackagesRequest', ], 'output' => [ 'shape' => 'DescribePackagesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'DescribeReservedInstanceOfferings' => [ 'name' => 'DescribeReservedInstanceOfferings', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/reservedInstanceOfferings', ], 'input' => [ 'shape' => 'DescribeReservedInstanceOfferingsRequest', ], 'output' => [ 'shape' => 'DescribeReservedInstanceOfferingsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], ], ], 'DescribeReservedInstances' => [ 'name' => 'DescribeReservedInstances', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/reservedInstances', ], 'input' => [ 'shape' => 'DescribeReservedInstancesRequest', ], 'output' => [ 'shape' => 'DescribeReservedInstancesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'DescribeVpcEndpoints' => [ 'name' => 'DescribeVpcEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/describe', ], 'input' => [ 'shape' => 'DescribeVpcEndpointsRequest', ], 'output' => [ 'shape' => 'DescribeVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'DissociatePackage' => [ 'name' => 'DissociatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/dissociate/{PackageID}/{DomainName}', ], 'input' => [ 'shape' => 'DissociatePackageRequest', ], 'output' => [ 'shape' => 'DissociatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], ], ], 'GetCompatibleVersions' => [ 'name' => 'GetCompatibleVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/compatibleVersions', ], 'input' => [ 'shape' => 'GetCompatibleVersionsRequest', ], 'output' => [ 'shape' => 'GetCompatibleVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'GetDataSource' => [ 'name' => 'GetDataSource', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'GetDataSourceRequest', ], 'output' => [ 'shape' => 'GetDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'GetDomainMaintenanceStatus' => [ 'name' => 'GetDomainMaintenanceStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance', ], 'input' => [ 'shape' => 'GetDomainMaintenanceStatusRequest', ], 'output' => [ 'shape' => 'GetDomainMaintenanceStatusResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'GetPackageVersionHistory' => [ 'name' => 'GetPackageVersionHistory', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/packages/{PackageID}/history', ], 'input' => [ 'shape' => 'GetPackageVersionHistoryRequest', ], 'output' => [ 'shape' => 'GetPackageVersionHistoryResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'GetUpgradeHistory' => [ 'name' => 'GetUpgradeHistory', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain/{DomainName}/history', ], 'input' => [ 'shape' => 'GetUpgradeHistoryRequest', ], 'output' => [ 'shape' => 'GetUpgradeHistoryResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'GetUpgradeStatus' => [ 'name' => 'GetUpgradeStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain/{DomainName}/status', ], 'input' => [ 'shape' => 'GetUpgradeStatusRequest', ], 'output' => [ 'shape' => 'GetUpgradeStatusResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListDataSources' => [ 'name' => 'ListDataSources', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource', ], 'input' => [ 'shape' => 'ListDataSourcesRequest', ], 'output' => [ 'shape' => 'ListDataSourcesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'ListDomainMaintenances' => [ 'name' => 'ListDomainMaintenances', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenances', ], 'input' => [ 'shape' => 'ListDomainMaintenancesRequest', ], 'output' => [ 'shape' => 'ListDomainMaintenancesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'ListDomainNames' => [ 'name' => 'ListDomainNames', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/domain', ], 'input' => [ 'shape' => 'ListDomainNamesRequest', ], 'output' => [ 'shape' => 'ListDomainNamesResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListDomainsForPackage' => [ 'name' => 'ListDomainsForPackage', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/packages/{PackageID}/domains', ], 'input' => [ 'shape' => 'ListDomainsForPackageRequest', ], 'output' => [ 'shape' => 'ListDomainsForPackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListInstanceTypeDetails' => [ 'name' => 'ListInstanceTypeDetails', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/instanceTypeDetails/{EngineVersion}', ], 'input' => [ 'shape' => 'ListInstanceTypeDetailsRequest', ], 'output' => [ 'shape' => 'ListInstanceTypeDetailsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListPackagesForDomain' => [ 'name' => 'ListPackagesForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/domain/{DomainName}/packages', ], 'input' => [ 'shape' => 'ListPackagesForDomainRequest', ], 'output' => [ 'shape' => 'ListPackagesForDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListScheduledActions' => [ 'name' => 'ListScheduledActions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/scheduledActions', ], 'input' => [ 'shape' => 'ListScheduledActionsRequest', ], 'output' => [ 'shape' => 'ListScheduledActionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidPaginationTokenException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/tags/', ], 'input' => [ 'shape' => 'ListTagsRequest', ], 'output' => [ 'shape' => 'ListTagsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'ListVersions' => [ 'name' => 'ListVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/versions', ], 'input' => [ 'shape' => 'ListVersionsRequest', ], 'output' => [ 'shape' => 'ListVersionsResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListVpcEndpointAccess' => [ 'name' => 'ListVpcEndpointAccess', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/listVpcEndpointAccess', ], 'input' => [ 'shape' => 'ListVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'ListVpcEndpoints' => [ 'name' => 'ListVpcEndpoints', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'BaseException', ], ], ], 'ListVpcEndpointsForDomain' => [ 'name' => 'ListVpcEndpointsForDomain', 'http' => [ 'method' => 'GET', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/vpcEndpoints', ], 'input' => [ 'shape' => 'ListVpcEndpointsForDomainRequest', ], 'output' => [ 'shape' => 'ListVpcEndpointsForDomainResponse', ], 'errors' => [ [ 'shape' => 'InternalException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'BaseException', ], ], ], 'PurchaseReservedInstanceOffering' => [ 'name' => 'PurchaseReservedInstanceOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/purchaseReservedInstanceOffering', ], 'input' => [ 'shape' => 'PurchaseReservedInstanceOfferingRequest', ], 'output' => [ 'shape' => 'PurchaseReservedInstanceOfferingResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RejectInboundConnection' => [ 'name' => 'RejectInboundConnection', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/cc/inboundConnection/{ConnectionId}/reject', ], 'input' => [ 'shape' => 'RejectInboundConnectionRequest', ], 'output' => [ 'shape' => 'RejectInboundConnectionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'RemoveTags' => [ 'name' => 'RemoveTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/tags-removal', ], 'input' => [ 'shape' => 'RemoveTagsRequest', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], 'RevokeVpcEndpointAccess' => [ 'name' => 'RevokeVpcEndpointAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/revokeVpcEndpointAccess', ], 'input' => [ 'shape' => 'RevokeVpcEndpointAccessRequest', ], 'output' => [ 'shape' => 'RevokeVpcEndpointAccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'BaseException', ], ], ], 'StartDomainMaintenance' => [ 'name' => 'StartDomainMaintenance', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance', ], 'input' => [ 'shape' => 'StartDomainMaintenanceRequest', ], 'output' => [ 'shape' => 'StartDomainMaintenanceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], ], ], 'StartServiceSoftwareUpdate' => [ 'name' => 'StartServiceSoftwareUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/serviceSoftwareUpdate/start', ], 'input' => [ 'shape' => 'StartServiceSoftwareUpdateRequest', ], 'output' => [ 'shape' => 'StartServiceSoftwareUpdateResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateDataSource' => [ 'name' => 'UpdateDataSource', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/dataSource/{DataSourceName}', ], 'input' => [ 'shape' => 'UpdateDataSourceRequest', ], 'output' => [ 'shape' => 'UpdateDataSourceResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'DependencyFailureException', ], ], ], 'UpdateDomainConfig' => [ 'name' => 'UpdateDomainConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/config', ], 'input' => [ 'shape' => 'UpdateDomainConfigRequest', ], 'output' => [ 'shape' => 'UpdateDomainConfigResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'InvalidTypeException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdatePackage' => [ 'name' => 'UpdatePackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/packages/update', ], 'input' => [ 'shape' => 'UpdatePackageRequest', ], 'output' => [ 'shape' => 'UpdatePackageResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateScheduledAction' => [ 'name' => 'UpdateScheduledAction', 'http' => [ 'method' => 'PUT', 'requestUri' => '/2021-01-01/opensearch/domain/{DomainName}/scheduledAction/update', ], 'input' => [ 'shape' => 'UpdateScheduledActionRequest', ], 'output' => [ 'shape' => 'UpdateScheduledActionResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'SlotNotAvailableException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ValidationException', ], ], ], 'UpdateVpcEndpoint' => [ 'name' => 'UpdateVpcEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/vpcEndpoints/update', ], 'input' => [ 'shape' => 'UpdateVpcEndpointRequest', ], 'output' => [ 'shape' => 'UpdateVpcEndpointResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'InternalException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'BaseException', ], ], ], 'UpgradeDomain' => [ 'name' => 'UpgradeDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/2021-01-01/opensearch/upgradeDomain', ], 'input' => [ 'shape' => 'UpgradeDomainRequest', ], 'output' => [ 'shape' => 'UpgradeDomainResponse', ], 'errors' => [ [ 'shape' => 'BaseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceAlreadyExistsException', ], [ 'shape' => 'DisabledOperationException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'InternalException', ], ], ], ], 'shapes' => [ 'ARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '.*', ], 'AWSAccount' => [ 'type' => 'string', 'pattern' => '^[0-9]+$', ], 'AWSDomainInformation' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'OwnerId' => [ 'shape' => 'OwnerId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Region' => [ 'shape' => 'Region', ], ], ], 'AcceptInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'AcceptInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccessPoliciesStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'PolicyDocument', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'ActionSeverity' => [ 'type' => 'string', 'enum' => [ 'HIGH', 'MEDIUM', 'LOW', ], ], 'ActionStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_UPDATE', 'IN_PROGRESS', 'FAILED', 'COMPLETED', 'NOT_ELIGIBLE', 'ELIGIBLE', ], ], 'ActionType' => [ 'type' => 'string', 'enum' => [ 'SERVICE_SOFTWARE_UPDATE', 'JVM_HEAP_SIZE_TUNING', 'JVM_YOUNG_GEN_TUNING', ], ], 'AddDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', 'DataSourceType', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'AddDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'AddTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagList', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'AdditionalLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'AdditionalLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalLimit', ], ], 'AdvancedOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'AdvancedOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AdvancedSecurityOptions' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsOutput', ], 'AnonymousAuthDisableDate' => [ 'shape' => 'DisableTimestamp', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'MasterUserOptions' => [ 'shape' => 'MasterUserOptions', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsInput', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'AdvancedSecurityOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'AssociatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'DomainName', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'AssociatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetails' => [ 'shape' => 'DomainPackageDetails', ], ], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Account', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Account' => [ 'shape' => 'AWSAccount', ], ], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'type' => 'structure', 'required' => [ 'AuthorizedPrincipal', ], 'members' => [ 'AuthorizedPrincipal' => [ 'shape' => 'AuthorizedPrincipal', ], ], ], 'AuthorizedPrincipal' => [ 'type' => 'structure', 'members' => [ 'PrincipalType' => [ 'shape' => 'PrincipalType', ], 'Principal' => [ 'shape' => 'String', ], ], ], 'AuthorizedPrincipalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AuthorizedPrincipal', ], ], 'AutoTune' => [ 'type' => 'structure', 'members' => [ 'AutoTuneType' => [ 'shape' => 'AutoTuneType', ], 'AutoTuneDetails' => [ 'shape' => 'AutoTuneDetails', ], ], ], 'AutoTuneDate' => [ 'type' => 'timestamp', ], 'AutoTuneDesiredState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'AutoTuneDetails' => [ 'type' => 'structure', 'members' => [ 'ScheduledAutoTuneDetails' => [ 'shape' => 'ScheduledAutoTuneDetails', ], ], ], 'AutoTuneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTune', ], ], 'AutoTuneMaintenanceSchedule' => [ 'type' => 'structure', 'members' => [ 'StartAt' => [ 'shape' => 'StartAt', ], 'Duration' => [ 'shape' => 'Duration', ], 'CronExpressionForRecurrence' => [ 'shape' => 'String', ], ], ], 'AutoTuneMaintenanceScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoTuneMaintenanceSchedule', ], 'max' => 100, ], 'AutoTuneOptions' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'RollbackOnDisable' => [ 'shape' => 'RollbackOnDisable', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsInput' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'AutoTuneDesiredState', ], 'MaintenanceSchedules' => [ 'shape' => 'AutoTuneMaintenanceScheduleList', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'AutoTuneState', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'UseOffPeakWindow' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'AutoTuneOptions', ], 'Status' => [ 'shape' => 'AutoTuneStatus', ], ], ], 'AutoTuneState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', 'ENABLE_IN_PROGRESS', 'DISABLE_IN_PROGRESS', 'DISABLED_AND_ROLLBACK_SCHEDULED', 'DISABLED_AND_ROLLBACK_IN_PROGRESS', 'DISABLED_AND_ROLLBACK_COMPLETE', 'DISABLED_AND_ROLLBACK_ERROR', 'ERROR', ], ], 'AutoTuneStatus' => [ 'type' => 'structure', 'required' => [ 'CreationDate', 'UpdateDate', 'State', ], 'members' => [ 'CreationDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateDate' => [ 'shape' => 'UpdateTimestamp', ], 'UpdateVersion' => [ 'shape' => 'UIntValue', ], 'State' => [ 'shape' => 'AutoTuneState', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'PendingDeletion' => [ 'shape' => 'Boolean', ], ], ], 'AutoTuneType' => [ 'type' => 'string', 'enum' => [ 'SCHEDULED_ACTION', ], ], 'AvailabilityZone' => [ 'type' => 'string', 'max' => 15, 'min' => 1, ], 'AvailabilityZoneInfo' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneName' => [ 'shape' => 'AvailabilityZone', ], 'ZoneStatus' => [ 'shape' => 'ZoneStatus', ], 'ConfiguredDataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'AvailableDataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'TotalShards' => [ 'shape' => 'NumberOfShards', ], 'TotalUnAssignedShards' => [ 'shape' => 'NumberOfShards', ], ], ], 'AvailabilityZoneInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZoneInfo', ], ], 'AvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityZone', ], ], 'BackendRole' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'BaseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'Boolean' => [ 'type' => 'boolean', ], 'CancelServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], ], ], 'CancelServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'ChangeProgressDetails' => [ 'type' => 'structure', 'members' => [ 'ChangeId' => [ 'shape' => 'GUID', ], 'Message' => [ 'shape' => 'Message', ], ], ], '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', ], ], ], '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', ], ], ], 'ConflictException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConnectionAlias' => [ 'type' => 'string', 'max' => 100, 'min' => 2, 'pattern' => '[a-zA-Z][a-zA-Z0-9\\-\\_]+', ], 'ConnectionId' => [ 'type' => 'string', 'max' => 256, 'min' => 10, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'ConnectionMode' => [ 'type' => 'string', 'enum' => [ 'DIRECT', 'VPC_ENDPOINT', ], ], 'ConnectionProperties' => [ 'type' => 'structure', 'members' => [ 'Endpoint' => [ 'shape' => 'Endpoint', ], 'CrossClusterSearch' => [ 'shape' => 'CrossClusterSearchConnectionProperties', ], ], ], 'ConnectionStatusMessage' => [ 'type' => 'string', ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'EngineVersion' => [ 'shape' => 'VersionString', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCOptions', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsInput', ], 'TagList' => [ 'shape' => 'TagList', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsInput', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], ], ], 'CreateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'CreateOutboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'LocalDomainInfo', 'RemoteDomainInfo', 'ConnectionAlias', ], 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], 'ConnectionProperties' => [ 'shape' => 'ConnectionProperties', ], ], ], 'CreateOutboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionAlias' => [ 'shape' => 'ConnectionAlias', ], 'ConnectionStatus' => [ 'shape' => 'OutboundConnectionStatus', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], 'ConnectionProperties' => [ 'shape' => 'ConnectionProperties', ], ], ], 'CreatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageName', 'PackageType', 'PackageSource', ], 'members' => [ 'PackageName' => [ 'shape' => 'PackageName', ], 'PackageType' => [ 'shape' => 'PackageType', ], 'PackageDescription' => [ 'shape' => 'PackageDescription', ], 'PackageSource' => [ 'shape' => 'PackageSource', ], ], ], 'CreatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'CreateVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'DomainArn', 'VpcOptions', ], 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'VpcOptions' => [ 'shape' => 'VPCOptions', ], 'ClientToken' => [ 'shape' => 'ClientToken', ], ], ], 'CreateVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoint', ], 'members' => [ 'VpcEndpoint' => [ 'shape' => 'VpcEndpoint', ], ], ], 'CreatedAt' => [ 'type' => 'timestamp', ], 'CrossClusterSearchConnectionProperties' => [ 'type' => 'structure', 'members' => [ 'SkipUnavailable' => [ 'shape' => 'SkipUnavailableStatus', ], ], ], 'DataSourceDescription' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$', ], 'DataSourceDetails' => [ 'type' => 'structure', 'members' => [ 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'DataSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceDetails', ], ], 'DataSourceName' => [ 'type' => 'string', 'max' => 80, 'min' => 3, 'pattern' => '[a-z][a-z0-9_]+', ], 'DataSourceType' => [ 'type' => 'structure', 'members' => [ 'S3GlueDataCatalog' => [ 'shape' => 'S3GlueDataCatalog', ], ], 'union' => true, ], 'DeleteDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], ], ], 'DeleteDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DeleteDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'DeleteInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'DeleteOutboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'DeleteOutboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'OutboundConnection', ], ], ], 'DeletePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], ], ], 'DeletePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'DeleteVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointId', ], 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', 'location' => 'uri', 'locationName' => 'VpcEndpointId', ], ], ], 'DeleteVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummary', ], 'members' => [ 'VpcEndpointSummary' => [ 'shape' => 'VpcEndpointSummary', ], ], ], 'DependencyFailureException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 424, ], 'exception' => true, ], 'DeploymentCloseDateTimeStamp' => [ 'type' => 'timestamp', ], 'DeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING_UPDATE', 'IN_PROGRESS', 'COMPLETED', 'NOT_ELIGIBLE', 'ELIGIBLE', ], ], 'DeploymentType' => [ 'type' => 'string', 'max' => 128, 'min' => 2, ], 'DescribeDomainAutoTunesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeDomainAutoTunesResponse' => [ 'type' => 'structure', 'members' => [ 'AutoTunes' => [ 'shape' => 'AutoTuneList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeDomainChangeProgressRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ChangeId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'changeid', ], ], ], 'DescribeDomainChangeProgressResponse' => [ 'type' => 'structure', 'members' => [ 'ChangeProgressStatus' => [ 'shape' => 'ChangeProgressStatusDetails', ], ], ], 'DescribeDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'DomainConfig', ], ], ], 'DescribeDomainHealthRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainHealthResponse' => [ 'type' => 'structure', 'members' => [ 'DomainState' => [ 'shape' => 'DomainState', ], 'AvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'ActiveAvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'StandByAvailabilityZoneCount' => [ 'shape' => 'NumberOfAZs', ], 'DataNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'DedicatedMaster' => [ 'shape' => 'Boolean', ], 'MasterEligibleNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'WarmNodeCount' => [ 'shape' => 'NumberOfNodes', ], 'MasterNode' => [ 'shape' => 'MasterNodeStatus', ], 'ClusterHealth' => [ 'shape' => 'DomainHealth', ], 'TotalShards' => [ 'shape' => 'NumberOfShards', ], 'TotalUnAssignedShards' => [ 'shape' => 'NumberOfShards', ], 'EnvironmentInformation' => [ 'shape' => 'EnvironmentInfoList', ], ], ], 'DescribeDomainNodesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainNodesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainNodesStatusList' => [ 'shape' => 'DomainNodesStatusList', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DescribeDomainResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatus', ], 'members' => [ 'DomainStatus' => [ 'shape' => 'DomainStatus', ], ], ], 'DescribeDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'DomainNames', ], 'members' => [ 'DomainNames' => [ 'shape' => 'DomainNameList', ], ], ], 'DescribeDomainsResponse' => [ 'type' => 'structure', 'required' => [ 'DomainStatusList', ], 'members' => [ 'DomainStatusList' => [ 'shape' => 'DomainStatusList', ], ], ], 'DescribeDryRunProgressRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'DryRunId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'dryRunId', ], 'LoadDryRunConfig' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'loadDryRunConfig', ], ], ], 'DescribeDryRunProgressResponse' => [ 'type' => 'structure', 'members' => [ 'DryRunProgressStatus' => [ 'shape' => 'DryRunProgressStatus', ], 'DryRunConfig' => [ 'shape' => 'DomainStatus', ], 'DryRunResults' => [ 'shape' => 'DryRunResults', ], ], ], 'DescribeInboundConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeInboundConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'Connections' => [ 'shape' => 'InboundConnections', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeInstanceTypeLimitsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'EngineVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', 'location' => 'uri', 'locationName' => 'InstanceType', ], 'EngineVersion' => [ 'shape' => 'VersionString', 'location' => 'uri', 'locationName' => 'EngineVersion', ], ], ], 'DescribeInstanceTypeLimitsResponse' => [ 'type' => 'structure', 'members' => [ 'LimitsByRole' => [ 'shape' => 'LimitsByRole', ], ], ], 'DescribeOutboundConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeOutboundConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'Connections' => [ 'shape' => 'OutboundConnections', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePackagesFilter' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'DescribePackagesFilterName', ], 'Value' => [ 'shape' => 'DescribePackagesFilterValues', ], ], ], 'DescribePackagesFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribePackagesFilter', ], ], 'DescribePackagesFilterName' => [ 'type' => 'string', 'enum' => [ 'PackageID', 'PackageName', 'PackageStatus', 'PackageType', 'EngineVersion', ], ], 'DescribePackagesFilterValue' => [ 'type' => 'string', 'pattern' => '^[0-9a-zA-Z\\*\\.\\_\\\\\\/\\?-]+$', ], 'DescribePackagesFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribePackagesFilterValue', ], 'min' => 1, ], 'DescribePackagesRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'DescribePackagesFilterList', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribePackagesResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetailsList' => [ 'shape' => 'PackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeReservedInstanceOfferingsRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'offeringId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedInstanceOfferingsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ReservedInstanceOfferings' => [ 'shape' => 'ReservedInstanceOfferingList', ], ], ], 'DescribeReservedInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceId' => [ 'shape' => 'GUID', 'location' => 'querystring', 'locationName' => 'reservationId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeReservedInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', ], 'ReservedInstances' => [ 'shape' => 'ReservedInstanceList', ], ], ], 'DescribeVpcEndpointsRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointIds', ], 'members' => [ 'VpcEndpointIds' => [ 'shape' => 'VpcEndpointIdList', ], ], ], 'DescribeVpcEndpointsResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoints', 'VpcEndpointErrors', ], 'members' => [ 'VpcEndpoints' => [ 'shape' => 'VpcEndpoints', ], 'VpcEndpointErrors' => [ 'shape' => 'VpcEndpointErrorList', ], ], ], 'Description' => [ 'type' => 'string', ], 'DisableTimestamp' => [ 'type' => 'timestamp', ], 'DisabledOperationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'DissociatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'DomainName', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'DissociatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetails' => [ 'shape' => 'DomainPackageDetails', ], ], ], 'DomainArn' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:[a-z]+:[a-z0-9\\-]+:[0-9]+:domain\\/[a-z0-9\\-]+', ], 'DomainConfig' => [ 'type' => 'structure', 'members' => [ 'EngineVersion' => [ 'shape' => 'VersionStatus', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfigStatus', ], 'EBSOptions' => [ 'shape' => 'EBSOptionsStatus', ], 'AccessPolicies' => [ 'shape' => 'AccessPoliciesStatus', ], 'IPAddressType' => [ 'shape' => 'IPAddressTypeStatus', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptionsStatus', ], 'VPCOptions' => [ 'shape' => 'VPCDerivedInfoStatus', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptionsStatus', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptionsStatus', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptionsStatus', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptionsStatus', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptionsStatus', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptionsStatus', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsStatus', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsStatus', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptionsStatus', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptionsStatus', ], ], ], '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', ], ], 'DomainState' => [ 'type' => 'string', 'enum' => [ 'Active', 'Processing', 'NotAvailable', ], ], 'DomainStatus' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'DomainName', 'ARN', 'ClusterConfig', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'ARN' => [ 'shape' => 'ARN', ], 'Created' => [ 'shape' => 'Boolean', ], 'Deleted' => [ 'shape' => 'Boolean', ], 'Endpoint' => [ 'shape' => 'ServiceUrl', ], 'EndpointV2' => [ 'shape' => 'ServiceUrl', ], 'Endpoints' => [ 'shape' => 'EndpointsMap', ], 'Processing' => [ 'shape' => 'Boolean', ], 'UpgradeProcessing' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'VersionString', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCDerivedInfo', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptions', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptionsOutput', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], ], ], '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}', ], 'GetCompatibleVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], ], ], 'GetCompatibleVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'CompatibleVersions' => [ 'shape' => 'CompatibleVersionsList', ], ], ], 'GetDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], ], ], 'GetDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Name' => [ 'shape' => 'DataSourceName', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'GetDomainMaintenanceStatusRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'MaintenanceId', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaintenanceId' => [ 'shape' => 'RequestId', 'location' => 'querystring', 'locationName' => 'maintenanceId', ], ], ], 'GetDomainMaintenanceStatusResponse' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'MaintenanceStatus', ], 'StatusMessage' => [ 'shape' => 'MaintenanceStatusMessage', ], 'NodeId' => [ 'shape' => 'NodeId', ], 'Action' => [ 'shape' => 'MaintenanceType', ], 'CreatedAt' => [ 'shape' => 'UpdateTimestamp', ], 'UpdatedAt' => [ 'shape' => 'UpdateTimestamp', ], ], ], 'GetPackageVersionHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetPackageVersionHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageVersionHistoryList' => [ 'shape' => 'PackageVersionHistoryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetUpgradeHistoryRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetUpgradeHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeHistories' => [ 'shape' => 'UpgradeHistoryList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'GetUpgradeStatusRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'GetUpgradeStatusResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeStep' => [ 'shape' => 'UpgradeStep', ], 'StepStatus' => [ 'shape' => 'UpgradeStatus', ], 'UpgradeName' => [ 'shape' => 'UpgradeName', ], ], ], 'IPAddressType' => [ 'type' => 'string', 'enum' => [ 'ipv4', 'dualstack', ], ], 'IPAddressTypeStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'IPAddressType', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'IdentityPoolId' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+:[0-9a-f-]+', ], 'InboundConnection' => [ 'type' => 'structure', 'members' => [ 'LocalDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'RemoteDomainInfo' => [ 'shape' => 'DomainInformationContainer', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionStatus' => [ 'shape' => 'InboundConnectionStatus', ], 'ConnectionMode' => [ 'shape' => 'ConnectionMode', ], ], ], 'InboundConnectionStatus' => [ 'type' => 'structure', 'members' => [ 'StatusCode' => [ 'shape' => 'InboundConnectionStatusCode', ], 'Message' => [ 'shape' => 'ConnectionStatusMessage', ], ], ], 'InboundConnectionStatusCode' => [ 'type' => 'string', 'enum' => [ 'PENDING_ACCEPTANCE', 'APPROVED', 'PROVISIONING', 'ACTIVE', 'REJECTING', 'REJECTED', 'DELETING', 'DELETED', ], ], 'InboundConnections' => [ 'type' => 'list', 'member' => [ 'shape' => 'InboundConnection', ], ], 'InstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'InstanceCountLimits' => [ 'type' => 'structure', 'members' => [ 'MinimumInstanceCount' => [ 'shape' => 'MinimumInstanceCount', ], 'MaximumInstanceCount' => [ 'shape' => 'MaximumInstanceCount', ], ], ], 'InstanceLimits' => [ 'type' => 'structure', 'members' => [ 'InstanceCountLimits' => [ 'shape' => 'InstanceCountLimits', ], ], ], 'InstanceRole' => [ 'type' => 'string', ], 'InstanceRoleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceRole', ], ], 'InstanceTypeDetails' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'EncryptionEnabled' => [ 'shape' => 'Boolean', ], 'CognitoEnabled' => [ 'shape' => 'Boolean', ], 'AppLogsEnabled' => [ 'shape' => 'Boolean', ], 'AdvancedSecurityEnabled' => [ 'shape' => 'Boolean', ], 'WarmEnabled' => [ 'shape' => 'Boolean', ], 'InstanceRole' => [ 'shape' => 'InstanceRoleList', ], 'AvailabilityZones' => [ 'shape' => 'AvailabilityZoneList', ], ], ], 'InstanceTypeDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceTypeDetails', ], ], 'InstanceTypeString' => [ 'type' => 'string', 'max' => 40, 'min' => 10, 'pattern' => '^.*\\..*\\.search$', ], 'Integer' => [ 'type' => 'integer', ], 'IntegerClass' => [ 'type' => 'integer', ], 'InternalException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'InvalidPaginationTokenException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidTypeException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'Issue' => [ 'type' => 'string', ], 'Issues' => [ 'type' => 'list', 'member' => [ 'shape' => 'Issue', ], ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '.*', ], 'LastUpdated' => [ 'type' => 'timestamp', ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'LimitName' => [ 'type' => 'string', ], 'LimitValue' => [ 'type' => 'string', ], 'LimitValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LimitValue', ], ], 'Limits' => [ 'type' => 'structure', 'members' => [ 'StorageTypes' => [ 'shape' => 'StorageTypeList', ], 'InstanceLimits' => [ 'shape' => 'InstanceLimits', ], 'AdditionalLimits' => [ 'shape' => 'AdditionalLimitList', ], ], ], 'LimitsByRole' => [ 'type' => 'map', 'key' => [ 'shape' => 'InstanceRole', ], 'value' => [ 'shape' => 'Limits', ], ], 'ListDataSourcesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], ], ], 'ListDataSourcesResponse' => [ 'type' => 'structure', 'members' => [ 'DataSources' => [ 'shape' => 'DataSourceList', ], ], ], 'ListDomainMaintenancesRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Action' => [ 'shape' => 'MaintenanceType', 'location' => 'querystring', 'locationName' => 'action', ], 'Status' => [ 'shape' => 'MaintenanceStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListDomainMaintenancesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainMaintenances' => [ 'shape' => 'DomainMaintenanceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDomainNamesRequest' => [ 'type' => 'structure', 'members' => [ 'EngineType' => [ 'shape' => 'EngineType', 'location' => 'querystring', 'locationName' => 'engineType', ], ], ], 'ListDomainNamesResponse' => [ 'type' => 'structure', 'members' => [ 'DomainNames' => [ 'shape' => 'DomainInfoList', ], ], ], 'ListDomainsForPackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', 'location' => 'uri', 'locationName' => 'PackageID', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListDomainsForPackageResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetailsList' => [ 'shape' => 'DomainPackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListInstanceTypeDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'EngineVersion', ], 'members' => [ 'EngineVersion' => [ 'shape' => 'VersionString', 'location' => 'uri', 'locationName' => 'EngineVersion', ], 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'querystring', 'locationName' => 'domainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'RetrieveAZs' => [ 'shape' => 'Boolean', 'location' => 'querystring', 'locationName' => 'retrieveAZs', ], 'InstanceType' => [ 'shape' => 'InstanceTypeString', 'location' => 'querystring', 'locationName' => 'instanceType', ], ], ], 'ListInstanceTypeDetailsResponse' => [ 'type' => 'structure', 'members' => [ 'InstanceTypeDetails' => [ 'shape' => 'InstanceTypeDetailsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPackagesForDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListPackagesForDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainPackageDetailsList' => [ 'shape' => 'DomainPackageDetailsList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListScheduledActionsRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListScheduledActionsResponse' => [ 'type' => 'structure', 'members' => [ 'ScheduledActions' => [ 'shape' => 'ScheduledActionsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'arn', ], ], ], 'ListTagsResponse' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'ListVersionsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'Versions' => [ 'shape' => 'VersionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointAccessResponse' => [ 'type' => 'structure', 'required' => [ 'AuthorizedPrincipalList', 'NextToken', ], 'members' => [ 'AuthorizedPrincipalList' => [ 'shape' => 'AuthorizedPrincipalList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointsForDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointsForDomainResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummaryList', 'NextToken', ], 'members' => [ 'VpcEndpointSummaryList' => [ 'shape' => 'VpcEndpointSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListVpcEndpointsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListVpcEndpointsResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointSummaryList', 'NextToken', ], 'members' => [ 'VpcEndpointSummaryList' => [ 'shape' => 'VpcEndpointSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'LogPublishingOption' => [ 'type' => 'structure', 'members' => [ 'CloudWatchLogsLogGroupArn' => [ 'shape' => 'CloudWatchLogsLogGroupArn', ], 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'LogPublishingOptions' => [ 'type' => 'map', 'key' => [ 'shape' => 'LogType', ], 'value' => [ 'shape' => 'LogPublishingOption', ], ], 'LogPublishingOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'LogPublishingOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'LogType' => [ 'type' => 'string', 'enum' => [ 'INDEX_SLOW_LOGS', 'SEARCH_SLOW_LOGS', 'ES_APPLICATION_LOGS', 'AUDIT_LOGS', ], ], 'Long' => [ 'type' => 'long', ], 'MaintenanceStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'TIMED_OUT', ], ], 'MaintenanceStatusMessage' => [ 'type' => 'string', 'max' => 1000, 'min' => 0, 'pattern' => '^([\\s\\S]*)$', ], 'MaintenanceType' => [ 'type' => 'string', 'enum' => [ 'REBOOT_NODE', 'RESTART_SEARCH_PROCESS', 'RESTART_DASHBOARD', ], ], 'MasterNodeStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'UnAvailable', ], ], 'MasterUserOptions' => [ 'type' => 'structure', 'members' => [ 'MasterUserARN' => [ 'shape' => 'ARN', ], 'MasterUserName' => [ 'shape' => 'Username', ], 'MasterUserPassword' => [ 'shape' => 'Password', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, ], 'MaximumInstanceCount' => [ 'type' => 'integer', ], 'Message' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'MinimumInstanceCount' => [ 'type' => 'integer', ], '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', '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', ], ], 'PurchaseReservedInstanceOfferingRequest' => [ 'type' => 'structure', 'required' => [ 'ReservedInstanceOfferingId', 'ReservationName', ], 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', ], 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'InstanceCount' => [ 'shape' => 'InstanceCount', ], ], ], 'PurchaseReservedInstanceOfferingResponse' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceId' => [ 'shape' => 'GUID', ], 'ReservationName' => [ 'shape' => 'ReservationToken', ], ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'RecurringChargeAmount' => [ 'shape' => 'Double', ], 'RecurringChargeFrequency' => [ 'shape' => 'String', ], ], ], 'RecurringChargeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', ], ], 'ReferencePath' => [ 'type' => 'string', ], 'Region' => [ 'type' => 'string', 'max' => 30, 'min' => 5, 'pattern' => '[a-z][a-z0-9\\-]+', ], 'RejectInboundConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectionId', ], 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'ConnectionId', ], ], ], 'RejectInboundConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'InboundConnection', ], ], ], 'RemoveTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ARN', 'TagKeys', ], 'members' => [ 'ARN' => [ 'shape' => 'ARN', ], 'TagKeys' => [ 'shape' => 'StringList', ], ], ], 'RequestId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^([\\s\\S]*)$', ], 'ReservationToken' => [ 'type' => 'string', 'max' => 64, 'min' => 5, 'pattern' => '.*', ], 'ReservedInstance' => [ 'type' => 'structure', 'members' => [ 'ReservationName' => [ 'shape' => 'ReservationToken', ], 'ReservedInstanceId' => [ 'shape' => 'GUID', ], 'BillingSubscriptionId' => [ 'shape' => 'Long', ], 'ReservedInstanceOfferingId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'StartTime' => [ 'shape' => 'UpdateTimestamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'State' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedInstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedInstance', ], ], 'ReservedInstanceOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedInstanceOfferingId' => [ 'shape' => 'GUID', ], 'InstanceType' => [ 'shape' => 'OpenSearchPartitionInstanceType', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CurrencyCode' => [ 'shape' => 'String', ], 'PaymentOption' => [ 'shape' => 'ReservedInstancePaymentOption', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], ], 'ReservedInstanceOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedInstanceOffering', ], ], 'ReservedInstancePaymentOption' => [ 'type' => 'string', 'enum' => [ 'ALL_UPFRONT', 'PARTIAL_UPFRONT', 'NO_UPFRONT', ], ], 'ResourceAlreadyExistsException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'RevokeVpcEndpointAccessRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Account', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Account' => [ 'shape' => 'AWSAccount', ], ], ], 'RevokeVpcEndpointAccessResponse' => [ 'type' => 'structure', 'members' => [], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*', ], 'RollbackOnDisable' => [ 'type' => 'string', 'enum' => [ 'NO_ROLLBACK', 'DEFAULT_ROLLBACK', ], ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, ], 'S3GlueDataCatalog' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'S3Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SAMLEntityId' => [ 'type' => 'string', 'max' => 512, 'min' => 8, ], 'SAMLIdp' => [ 'type' => 'structure', 'required' => [ 'MetadataContent', 'EntityId', ], 'members' => [ 'MetadataContent' => [ 'shape' => 'SAMLMetadata', ], 'EntityId' => [ 'shape' => 'SAMLEntityId', ], ], ], 'SAMLMetadata' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, ], 'SAMLOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'Idp' => [ 'shape' => 'SAMLIdp', ], 'MasterUserName' => [ 'shape' => 'Username', ], 'MasterBackendRole' => [ 'shape' => 'BackendRole', ], 'SubjectKey' => [ 'shape' => 'String', ], 'RolesKey' => [ 'shape' => 'String', ], 'SessionTimeoutMinutes' => [ 'shape' => 'IntegerClass', ], ], ], 'SAMLOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'Idp' => [ 'shape' => 'SAMLIdp', ], 'SubjectKey' => [ 'shape' => 'String', ], 'RolesKey' => [ 'shape' => 'String', ], 'SessionTimeoutMinutes' => [ 'shape' => 'IntegerClass', ], ], ], 'ScheduleAt' => [ 'type' => 'string', 'enum' => [ 'NOW', 'TIMESTAMP', 'OFF_PEAK_WINDOW', ], ], 'ScheduledAction' => [ 'type' => 'structure', 'required' => [ 'Id', 'Type', 'Severity', 'ScheduledTime', ], 'members' => [ 'Id' => [ 'shape' => 'String', ], 'Type' => [ 'shape' => 'ActionType', ], 'Severity' => [ 'shape' => 'ActionSeverity', ], 'ScheduledTime' => [ 'shape' => 'Long', ], 'Description' => [ 'shape' => 'String', ], 'ScheduledBy' => [ 'shape' => 'ScheduledBy', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Mandatory' => [ 'shape' => 'Boolean', ], 'Cancellable' => [ 'shape' => 'Boolean', ], ], ], 'ScheduledActionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScheduledAction', ], ], 'ScheduledAutoTuneActionType' => [ 'type' => 'string', 'enum' => [ 'JVM_HEAP_SIZE_TUNING', 'JVM_YOUNG_GEN_TUNING', ], ], 'ScheduledAutoTuneDescription' => [ 'type' => 'string', ], 'ScheduledAutoTuneDetails' => [ 'type' => 'structure', 'members' => [ 'Date' => [ 'shape' => 'AutoTuneDate', ], 'ActionType' => [ 'shape' => 'ScheduledAutoTuneActionType', ], 'Action' => [ 'shape' => 'ScheduledAutoTuneDescription', ], 'Severity' => [ 'shape' => 'ScheduledAutoTuneSeverityType', ], ], ], 'ScheduledAutoTuneSeverityType' => [ 'type' => 'string', 'enum' => [ 'LOW', 'MEDIUM', 'HIGH', ], ], 'ScheduledBy' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER', 'SYSTEM', ], ], 'ServiceSoftwareOptions' => [ 'type' => 'structure', 'members' => [ 'CurrentVersion' => [ 'shape' => 'String', ], 'NewVersion' => [ 'shape' => 'String', ], 'UpdateAvailable' => [ 'shape' => 'Boolean', ], 'Cancellable' => [ 'shape' => 'Boolean', ], 'UpdateStatus' => [ 'shape' => 'DeploymentStatus', ], 'Description' => [ 'shape' => 'String', ], 'AutomatedUpdateDate' => [ 'shape' => 'DeploymentCloseDateTimeStamp', ], 'OptionalDeployment' => [ 'shape' => 'Boolean', ], ], ], 'ServiceUrl' => [ 'type' => 'string', ], 'SkipUnavailableStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'SlotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Long', ], ], 'SlotNotAvailableException' => [ 'type' => 'structure', 'members' => [ 'SlotSuggestions' => [ 'shape' => 'SlotList', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'SnapshotOptions' => [ 'type' => 'structure', 'members' => [ 'AutomatedSnapshotStartHour' => [ 'shape' => 'IntegerClass', ], ], ], 'SnapshotOptionsStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'SnapshotOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'SoftwareUpdateOptions' => [ 'type' => 'structure', 'members' => [ 'AutoSoftwareUpdateEnabled' => [ 'shape' => 'Boolean', ], ], ], 'SoftwareUpdateOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'SoftwareUpdateOptions', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'StartAt' => [ 'type' => 'timestamp', ], 'StartDomainMaintenanceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Action', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Action' => [ 'shape' => 'MaintenanceType', ], 'NodeId' => [ 'shape' => 'NodeId', ], ], ], 'StartDomainMaintenanceResponse' => [ 'type' => 'structure', 'members' => [ 'MaintenanceId' => [ 'shape' => 'RequestId', ], ], ], 'StartServiceSoftwareUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'ScheduleAt' => [ 'shape' => 'ScheduleAt', ], 'DesiredStartTime' => [ 'shape' => 'Long', ], ], ], 'StartServiceSoftwareUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'ServiceSoftwareOptions' => [ 'shape' => 'ServiceSoftwareOptions', ], ], ], 'StartTimeHours' => [ 'type' => 'long', 'max' => 23, 'min' => 0, ], 'StartTimeMinutes' => [ 'type' => 'long', 'max' => 59, 'min' => 0, ], 'StartTimestamp' => [ 'type' => 'timestamp', ], 'StorageSubTypeName' => [ 'type' => 'string', ], 'StorageType' => [ 'type' => 'structure', 'members' => [ 'StorageTypeName' => [ 'shape' => 'StorageTypeName', ], 'StorageSubTypeName' => [ 'shape' => 'StorageSubTypeName', ], 'StorageTypeLimits' => [ 'shape' => 'StorageTypeLimitList', ], ], ], 'StorageTypeLimit' => [ 'type' => 'structure', 'members' => [ 'LimitName' => [ 'shape' => 'LimitName', ], 'LimitValues' => [ 'shape' => 'LimitValueList', ], ], ], 'StorageTypeLimitList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageTypeLimit', ], ], 'StorageTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StorageType', ], ], 'StorageTypeName' => [ 'type' => 'string', ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'TLSSecurityPolicy' => [ 'type' => 'string', 'enum' => [ 'Policy-Min-TLS-1-0-2019-07', 'Policy-Min-TLS-1-2-2019-07', 'Policy-Min-TLS-1-2-PFS-2023-10', ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'TimeUnit' => [ 'type' => 'string', 'enum' => [ 'HOURS', ], ], 'TotalNumberOfStages' => [ 'type' => 'integer', ], 'UIntValue' => [ 'type' => 'integer', 'min' => 0, ], 'UncompressedPluginSizeInBytes' => [ 'type' => 'long', ], 'UpdateDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'Name', 'DataSourceType', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'Name' => [ 'shape' => 'DataSourceName', 'location' => 'uri', 'locationName' => 'DataSourceName', ], 'DataSourceType' => [ 'shape' => 'DataSourceType', ], 'Description' => [ 'shape' => 'DataSourceDescription', ], ], ], 'UpdateDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'UpdateDomainConfigRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ClusterConfig' => [ 'shape' => 'ClusterConfig', ], 'EBSOptions' => [ 'shape' => 'EBSOptions', ], 'SnapshotOptions' => [ 'shape' => 'SnapshotOptions', ], 'VPCOptions' => [ 'shape' => 'VPCOptions', ], 'CognitoOptions' => [ 'shape' => 'CognitoOptions', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'AccessPolicies' => [ 'shape' => 'PolicyDocument', ], 'IPAddressType' => [ 'shape' => 'IPAddressType', ], 'LogPublishingOptions' => [ 'shape' => 'LogPublishingOptions', ], 'EncryptionAtRestOptions' => [ 'shape' => 'EncryptionAtRestOptions', ], 'DomainEndpointOptions' => [ 'shape' => 'DomainEndpointOptions', ], 'NodeToNodeEncryptionOptions' => [ 'shape' => 'NodeToNodeEncryptionOptions', ], 'AdvancedSecurityOptions' => [ 'shape' => 'AdvancedSecurityOptionsInput', ], 'AutoTuneOptions' => [ 'shape' => 'AutoTuneOptions', ], 'DryRun' => [ 'shape' => 'DryRun', ], 'DryRunMode' => [ 'shape' => 'DryRunMode', ], 'OffPeakWindowOptions' => [ 'shape' => 'OffPeakWindowOptions', ], 'SoftwareUpdateOptions' => [ 'shape' => 'SoftwareUpdateOptions', ], ], ], 'UpdateDomainConfigResponse' => [ 'type' => 'structure', 'required' => [ 'DomainConfig', ], 'members' => [ 'DomainConfig' => [ 'shape' => 'DomainConfig', ], 'DryRunResults' => [ 'shape' => 'DryRunResults', ], 'DryRunProgressStatus' => [ 'shape' => 'DryRunProgressStatus', ], ], ], 'UpdatePackageRequest' => [ 'type' => 'structure', 'required' => [ 'PackageID', 'PackageSource', ], 'members' => [ 'PackageID' => [ 'shape' => 'PackageID', ], 'PackageSource' => [ 'shape' => 'PackageSource', ], 'PackageDescription' => [ 'shape' => 'PackageDescription', ], 'CommitMessage' => [ 'shape' => 'CommitMessage', ], ], ], 'UpdatePackageResponse' => [ 'type' => 'structure', 'members' => [ 'PackageDetails' => [ 'shape' => 'PackageDetails', ], ], ], 'UpdateScheduledActionRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'ActionID', 'ActionType', 'ScheduleAt', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', 'location' => 'uri', 'locationName' => 'DomainName', ], 'ActionID' => [ 'shape' => 'String', ], 'ActionType' => [ 'shape' => 'ActionType', ], 'ScheduleAt' => [ 'shape' => 'ScheduleAt', ], 'DesiredStartTime' => [ 'shape' => 'Long', ], ], ], 'UpdateScheduledActionResponse' => [ 'type' => 'structure', 'members' => [ 'ScheduledAction' => [ 'shape' => 'ScheduledAction', ], ], ], 'UpdateTimestamp' => [ 'type' => 'timestamp', ], 'UpdateVpcEndpointRequest' => [ 'type' => 'structure', 'required' => [ 'VpcEndpointId', 'VpcOptions', ], 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcOptions' => [ 'shape' => 'VPCOptions', ], ], ], 'UpdateVpcEndpointResponse' => [ 'type' => 'structure', 'required' => [ 'VpcEndpoint', ], 'members' => [ 'VpcEndpoint' => [ 'shape' => 'VpcEndpoint', ], ], ], 'UpgradeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'TargetVersion', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'VersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], ], ], 'UpgradeDomainResponse' => [ 'type' => 'structure', 'members' => [ 'UpgradeId' => [ 'shape' => 'String', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'TargetVersion' => [ 'shape' => 'VersionString', ], 'PerformCheckOnly' => [ 'shape' => 'Boolean', ], 'AdvancedOptions' => [ 'shape' => 'AdvancedOptions', ], 'ChangeProgressDetails' => [ 'shape' => 'ChangeProgressDetails', ], ], ], 'UpgradeHistory' => [ 'type' => 'structure', 'members' => [ 'UpgradeName' => [ 'shape' => 'UpgradeName', ], 'StartTimestamp' => [ 'shape' => 'StartTimestamp', ], 'UpgradeStatus' => [ 'shape' => 'UpgradeStatus', ], 'StepsList' => [ 'shape' => 'UpgradeStepsList', ], ], ], 'UpgradeHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeHistory', ], ], 'UpgradeName' => [ 'type' => 'string', ], 'UpgradeStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'SUCCEEDED', 'SUCCEEDED_WITH_ISSUES', 'FAILED', ], ], 'UpgradeStep' => [ 'type' => 'string', 'enum' => [ 'PRE_UPGRADE_CHECK', 'SNAPSHOT', 'UPGRADE', ], ], 'UpgradeStepItem' => [ 'type' => 'structure', 'members' => [ 'UpgradeStep' => [ 'shape' => 'UpgradeStep', ], 'UpgradeStepStatus' => [ 'shape' => 'UpgradeStatus', ], 'Issues' => [ 'shape' => 'Issues', ], 'ProgressPercent' => [ 'shape' => 'Double', ], ], ], 'UpgradeStepsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpgradeStepItem', ], ], 'UserPoolId' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'Username' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', 'sensitive' => true, ], 'VPCDerivedInfo' => [ 'type' => 'structure', 'members' => [ 'VPCId' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'StringList', ], 'AvailabilityZones' => [ 'shape' => 'StringList', ], 'SecurityGroupIds' => [ 'shape' => 'StringList', ], ], ], 'VPCDerivedInfoStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'VPCDerivedInfo', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'VPCOptions' => [ 'type' => 'structure', 'members' => [ 'SubnetIds' => [ 'shape' => 'StringList', ], 'SecurityGroupIds' => [ 'shape' => 'StringList', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidationFailure' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ValidationFailures' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationFailure', ], ], 'ValueStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString', ], 'min' => 1, ], 'VersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VersionString', ], ], 'VersionStatus' => [ 'type' => 'structure', 'required' => [ 'Options', 'Status', ], 'members' => [ 'Options' => [ 'shape' => 'VersionString', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], 'VersionString' => [ 'type' => 'string', 'max' => 18, 'min' => 14, 'pattern' => '^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$', ], 'VolumeSize' => [ 'type' => 'string', ], 'VolumeType' => [ 'type' => 'string', 'enum' => [ 'standard', 'gp2', 'io1', 'gp3', ], ], 'VpcEndpoint' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcEndpointOwner' => [ 'shape' => 'AWSAccount', ], 'DomainArn' => [ 'shape' => 'DomainArn', ], 'VpcOptions' => [ 'shape' => 'VPCDerivedInfo', ], 'Status' => [ 'shape' => 'VpcEndpointStatus', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], ], ], 'VpcEndpointError' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'ErrorCode' => [ 'shape' => 'VpcEndpointErrorCode', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'VpcEndpointErrorCode' => [ 'type' => 'string', 'enum' => [ 'ENDPOINT_NOT_FOUND', 'SERVER_ERROR', ], ], 'VpcEndpointErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointError', ], ], 'VpcEndpointId' => [ 'type' => 'string', 'max' => 256, 'min' => 5, 'pattern' => '^aos-[a-zA-Z0-9]*$', ], 'VpcEndpointIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointId', ], ], 'VpcEndpointStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATE_FAILED', 'ACTIVE', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'VpcEndpointSummary' => [ 'type' => 'structure', 'members' => [ 'VpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], 'VpcEndpointOwner' => [ 'shape' => 'String', ], 'DomainArn' => [ 'shape' => 'DomainArn', ], 'Status' => [ 'shape' => 'VpcEndpointStatus', ], ], ], 'VpcEndpointSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpointSummary', ], ], 'VpcEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcEndpoint', ], ], 'WindowStartTime' => [ 'type' => 'structure', 'required' => [ 'Hours', 'Minutes', ], 'members' => [ 'Hours' => [ 'shape' => 'StartTimeHours', ], 'Minutes' => [ 'shape' => 'StartTimeMinutes', ], ], ], 'ZoneAwarenessConfig' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZoneCount' => [ 'shape' => 'IntegerClass', ], ], ], 'ZoneStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'StandBy', 'NotAvailable', ], ], ],]; diff --git a/src/data/opensearch/2021-01-01/docs-2.json b/src/data/opensearch/2021-01-01/docs-2.json index e85e494239..c3ee721440 100644 --- a/src/data/opensearch/2021-01-01/docs-2.json +++ b/src/data/opensearch/2021-01-01/docs-2.json @@ -67,7 +67,7 @@ }, "shapes": { "ARN": { - "base": "

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

", + "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).

", @@ -1234,7 +1234,7 @@ "EndpointsMap": { "base": null, "refs": { - "DomainStatus$Endpoints": "

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

" + "DomainStatus$Endpoints": "

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

" } }, "EngineType": { @@ -1374,16 +1374,16 @@ "IPAddressType": { "base": null, "refs": { - "CreateDomainRequest$IPAddressType": "

The type of IP addresses supported by the endpoint for the domain.

", + "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": "

The type of IP addresses supported by the endpoint 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": "

The type of IP addresses supported by the endpoint for the domain.

" + "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": { @@ -2386,7 +2386,7 @@ "base": "

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

", "refs": { "DomainStatus$Endpoint": "

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

", - "DomainStatus$EndpointV2": null, + "DomainStatus$EndpointV2": "

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

", "EndpointsMap$value": null } }, @@ -2580,7 +2580,7 @@ "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

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

" } }, "Tag": { 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 e6d53da41c..35bc07fa12 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.

For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide . The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs. 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.

', 'CancelServiceSoftwareUpdate' => '

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain\'s UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

', 'CreateDomain' => '

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'CreateOutboundConnection' => '

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'CreatePackage' => '

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

', 'CreateVpcEndpoint' => '

Creates an Amazon OpenSearch Service-managed VPC endpoint.

', 'DeleteDataSource' => '

Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

', 'DeleteDomain' => '

Deletes an Amazon OpenSearch Service domain and all of its data. You can\'t recover a domain after you delete it.

', 'DeleteInboundConnection' => '

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DeleteOutboundConnection' => '

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DeletePackage' => '

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

', 'DeleteVpcEndpoint' => '

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'DescribeDomain' => '

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

', 'DescribeDomainAutoTunes' => '

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'DescribeDomainChangeProgress' => '

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

', 'DescribeDomainConfig' => '

Returns the configuration of an Amazon OpenSearch Service domain.

', 'DescribeDomainHealth' => '

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

', 'DescribeDomainNodes' => '

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

', 'DescribeDomains' => '

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

', 'DescribeDryRunProgress' => '

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

', 'DescribeInboundConnections' => '

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DescribeInstanceTypeLimits' => '

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

', 'DescribeOutboundConnections' => '

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DescribePackages' => '

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

', 'DescribeReservedInstanceOfferings' => '

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

', 'DescribeReservedInstances' => '

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

', 'DescribeVpcEndpoints' => '

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

', 'DissociatePackage' => '

Removes a package from the specified Amazon OpenSearch Service domain. The package can\'t be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

', 'GetCompatibleVersions' => '

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', 'GetDataSource' => '

Retrieves information about a direct query data source.

', 'GetDomainMaintenanceStatus' => '

The status of the maintenance action.

', 'GetPackageVersionHistory' => '

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.

', 'GetUpgradeHistory' => '

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

', 'GetUpgradeStatus' => '

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

', 'ListDataSources' => '

Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

', 'ListDomainMaintenances' => '

A list of maintenance actions for the domain.

', 'ListDomainNames' => '

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

', 'ListDomainsForPackage' => '

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

', 'ListInstanceTypeDetails' => '

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

', 'ListPackagesForDomain' => '

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

', 'ListScheduledActions' => '

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

', 'ListTags' => '

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

', 'ListVersions' => '

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

', 'ListVpcEndpointAccess' => '

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'ListVpcEndpoints' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

', 'ListVpcEndpointsForDomain' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

', 'PurchaseReservedInstanceOffering' => '

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

', 'RejectInboundConnection' => '

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

', 'RemoveTags' => '

Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

', 'RevokeVpcEndpointAccess' => '

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

', 'StartDomainMaintenance' => '

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

', 'StartServiceSoftwareUpdate' => '

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

', 'UpdateDataSource' => '

Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

', 'UpdateDomainConfig' => '

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

', 'UpdatePackage' => '

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

', 'UpdateScheduledAction' => '

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

', 'UpdateVpcEndpoint' => '

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'UpgradeDomain' => '

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

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

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

', 'refs' => [ 'AddTagsRequest$ARN' => '

Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.

', 'DomainEndpointOptions$CustomEndpointCertificateArn' => '

The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

', 'DomainStatus$ARN' => '

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

', 'ListTagsRequest$ARN' => '

Amazon Resource Name (ARN) for the domain to view tags for.

', 'MasterUserOptions$MasterUserARN' => '

Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.

', 'RemoveTagsRequest$ARN' => '

The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.

', ], ], 'AWSAccount' => [ 'base' => NULL, 'refs' => [ 'AuthorizeVpcEndpointAccessRequest$Account' => '

The Amazon Web Services account ID to grant access to.

', 'RevokeVpcEndpointAccessRequest$Account' => '

The account ID to revoke access from.

', 'VpcEndpoint$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'AWSDomainInformation' => [ 'base' => '

Information about an Amazon OpenSearch Service domain.

', 'refs' => [ 'DomainInformationContainer$AWSDomainInformation' => '

Information about an Amazon OpenSearch Service domain.

', ], ], 'AcceptInboundConnectionRequest' => [ 'base' => '

Container for the parameters to the AcceptInboundConnection operation.

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

Contains details about the accepted inbound connection.

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

An error occurred because you don\'t have permissions to access the resource.

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

The configured access rules for the domain\'s search endpoint, and the current status of those rules.

', 'refs' => [ 'DomainConfig$AccessPolicies' => '

Specifies the access policies for the domain.

', ], ], 'ActionSeverity' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Severity' => '

The severity of the action.

', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Status' => '

The current status of the scheduled action.

', ], ], 'ActionType' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Type' => '

The type of action that will be taken on the domain.

', 'UpdateScheduledActionRequest$ActionType' => '

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

', ], ], 'AddDataSourceRequest' => [ 'base' => '

Container for the parameters to the AddDataSource operation.

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

The result of an AddDataSource operation.

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

Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.

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

List of limits that are specific to a given instance type.

', 'refs' => [ 'AdditionalLimitList$member' => NULL, ], ], 'AdditionalLimitList' => [ 'base' => NULL, 'refs' => [ 'Limits$AdditionalLimits' => '

List of additional limits that are specific to a given instance type for each of its instance roles.

', ], ], 'AdvancedOptions' => [ 'base' => '

Exposes native OpenSearch configuration values from opensearch.yml. The following advanced options are available:

  • 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.

', 'UpgradeDomainResponse$AdvancedOptions' => '

The advanced options configuration for the domain.

', ], ], 'AdvancedOptionsStatus' => [ 'base' => '

Status of the advanced options for the specified domain. The following options are available:

  • "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.

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

Container for the response returned by the AssociatePackage operation.

', 'refs' => [], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizedPrincipal' => [ 'base' => '

Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'refs' => [ 'AuthorizeVpcEndpointAccessResponse$AuthorizedPrincipal' => '

Information about the Amazon Web Services account or service that was provided access to the domain.

', 'AuthorizedPrincipalList$member' => NULL, ], ], 'AuthorizedPrincipalList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointAccessResponse$AuthorizedPrincipalList' => '

A list of IAM principals that can currently access the domain.

', ], ], 'AutoTune' => [ 'base' => '

Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneList$member' => NULL, ], ], 'AutoTuneDate' => [ 'base' => '

The timestamp of the Auto-Tune action scheduled for the domain.

', 'refs' => [ 'ScheduledAutoTuneDetails$Date' => '

The date and time when the Auto-Tune action is scheduled for the domain.

', ], ], 'AutoTuneDesiredState' => [ 'base' => '

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

', 'refs' => [ 'AutoTuneOptions$DesiredState' => '

Whether Auto-Tune is enabled or disabled.

', 'AutoTuneOptionsInput$DesiredState' => '

Whether Auto-Tune is enabled or disabled.

', ], ], 'AutoTuneDetails' => [ 'base' => '

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTune$AutoTuneDetails' => '

Details about an Auto-Tune action.

', ], ], 'AutoTuneList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainAutoTunesResponse$AutoTunes' => '

The list of setting adjustments that Auto-Tune has made to the domain.

', ], ], 'AutoTuneMaintenanceSchedule' => [ 'base' => '

This object is deprecated. Use the domain\'s off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows.

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneMaintenanceScheduleList$member' => NULL, ], ], 'AutoTuneMaintenanceScheduleList' => [ 'base' => NULL, 'refs' => [ 'AutoTuneOptions$MaintenanceSchedules' => '

DEPRECATED. Use off-peak window instead.

A list of maintenance schedules during which Auto-Tune can deploy changes.

', 'AutoTuneOptionsInput$MaintenanceSchedules' => '

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.

', ], ], 'AutoTuneOptions' => [ 'base' => '

Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsStatus$Options' => '

Auto-Tune settings for updating a domain.

', 'UpdateDomainConfigRequest$AutoTuneOptions' => '

Options for Auto-Tune.

', ], ], 'AutoTuneOptionsInput' => [ 'base' => '

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service

', 'refs' => [ 'CreateDomainRequest$AutoTuneOptions' => '

Options for Auto-Tune.

', ], ], 'AutoTuneOptionsOutput' => [ 'base' => '

The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.

', 'refs' => [ 'DomainStatus$AutoTuneOptions' => '

Auto-Tune settings for the domain.

', ], ], 'AutoTuneOptionsStatus' => [ 'base' => '

The Auto-Tune status for the domain.

', 'refs' => [ 'DomainConfig$AutoTuneOptions' => '

Container for Auto-Tune settings for the domain.

', ], ], 'AutoTuneState' => [ 'base' => '

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsOutput$State' => '

The current state of Auto-Tune on the domain.

', 'AutoTuneStatus$State' => '

The current state of Auto-Tune on the domain.

', ], ], 'AutoTuneStatus' => [ 'base' => '

The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsStatus$Status' => '

The current status of Auto-Tune for a domain.

', ], ], 'AutoTuneType' => [ 'base' => '

Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

', 'refs' => [ 'AutoTune$AutoTuneType' => '

The type of Auto-Tune action.

', ], ], 'AvailabilityZone' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$AvailabilityZoneName' => '

The name of the Availability Zone.

', 'AvailabilityZoneList$member' => NULL, 'DomainNodesStatus$AvailabilityZone' => '

The Availability Zone of the node.

', ], ], 'AvailabilityZoneInfo' => [ 'base' => '

Information about an Availability Zone on a domain.

', 'refs' => [ 'AvailabilityZoneInfoList$member' => NULL, ], ], 'AvailabilityZoneInfoList' => [ 'base' => NULL, 'refs' => [ 'EnvironmentInfo$AvailabilityZoneInformation' => '

A list of AvailabilityZoneInfo for the domain.

', ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'InstanceTypeDetails$AvailabilityZones' => '

The supported Availability Zones for the instance type.

', ], ], 'BackendRole' => [ 'base' => NULL, 'refs' => [ 'SAMLOptionsInput$MasterBackendRole' => '

The backend role that the SAML master user is mapped to.

', ], ], 'BaseException' => [ 'base' => '

An error occurred while processing the request.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$Enabled' => '

True if fine-grained access control is enabled.

', 'AdvancedSecurityOptions$InternalUserDatabaseEnabled' => '

True if the internal user database is enabled.

', 'AdvancedSecurityOptions$AnonymousAuthEnabled' => '

True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

', 'AdvancedSecurityOptionsInput$Enabled' => '

True to enable fine-grained access control.

', 'AdvancedSecurityOptionsInput$InternalUserDatabaseEnabled' => '

True to enable the internal user database.

', 'AdvancedSecurityOptionsInput$AnonymousAuthEnabled' => '

True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

', 'AutoTuneOptions$UseOffPeakWindow' => '

Whether to use the domain\'s off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

', 'AutoTuneOptionsInput$UseOffPeakWindow' => '

Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain\'s configured daily off-peak window.

', 'AutoTuneOptionsOutput$UseOffPeakWindow' => '

Whether the domain\'s off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

', 'AutoTuneStatus$PendingDeletion' => '

Indicates whether the domain is being deleted.

', 'ClusterConfig$DedicatedMasterEnabled' => '

Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

', 'ClusterConfig$ZoneAwarenessEnabled' => '

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

', 'ClusterConfig$WarmEnabled' => '

Whether to enable warm storage for the cluster.

', 'ClusterConfig$MultiAZWithStandbyEnabled' => '

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

', 'CognitoOptions$Enabled' => '

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

', 'ColdStorageOptions$Enabled' => '

Whether to enable or disable cold storage on the domain.

', 'DescribeDomainHealthResponse$DedicatedMaster' => '

A boolean that indicates if dedicated master nodes are activated for the domain.

', 'DescribeDryRunProgressRequest$LoadDryRunConfig' => '

Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you\'re planning to make on the domain.

', 'DomainEndpointOptions$EnforceHTTPS' => '

True to require that all traffic to the domain arrive over HTTPS.

', 'DomainEndpointOptions$CustomEndpointEnabled' => '

Whether to enable a custom endpoint for the domain.

', 'DomainStatus$Created' => '

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

', 'DomainStatus$Deleted' => '

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

', 'DomainStatus$Processing' => '

The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

', 'DomainStatus$UpgradeProcessing' => '

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

', 'EBSOptions$EBSEnabled' => '

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

', 'EncryptionAtRestOptions$Enabled' => '

True to enable encryption at rest.

', 'InstanceTypeDetails$EncryptionEnabled' => '

Whether encryption at rest and node-to-node encryption are supported for the instance type.

', 'InstanceTypeDetails$CognitoEnabled' => '

Whether Amazon Cognito access is supported for the instance type.

', 'InstanceTypeDetails$AppLogsEnabled' => '

Whether logging is supported for the instance type.

', 'InstanceTypeDetails$AdvancedSecurityEnabled' => '

Whether fine-grained access control is supported for the instance type.

', 'InstanceTypeDetails$WarmEnabled' => '

Whether UltraWarm is supported for the instance type.

', 'ListInstanceTypeDetailsRequest$RetrieveAZs' => '

An optional parameter that specifies the Availability Zones for the domain.

', 'LogPublishingOption$Enabled' => '

Whether the log should be published.

', 'NodeToNodeEncryptionOptions$Enabled' => '

True to enable node-to-node encryption.

', 'OffPeakWindowOptions$Enabled' => '

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can\'t disable the off-peak window after it\'s enabled for a domain.

', 'OptionStatus$PendingDeletion' => '

Indicates whether the entity is being deleted.

', 'SAMLOptionsInput$Enabled' => '

True to enable SAML authentication for a domain.

', 'SAMLOptionsOutput$Enabled' => '

True if SAML is enabled.

', 'ScheduledAction$Mandatory' => '

Whether the action is required or optional.

', 'ScheduledAction$Cancellable' => '

Whether or not the scheduled action is cancellable.

', 'ServiceSoftwareOptions$UpdateAvailable' => '

True if you\'re able to update your service software version. False if you can\'t update your service software version.

', 'ServiceSoftwareOptions$Cancellable' => '

True if you\'re able to cancel your service software version update. False if you can\'t cancel your service software update.

', 'ServiceSoftwareOptions$OptionalDeployment' => '

True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

', 'SoftwareUpdateOptions$AutoSoftwareUpdateEnabled' => '

Whether automatic service software updates are enabled for the domain.

', 'UpgradeDomainRequest$PerformCheckOnly' => '

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

', 'UpgradeDomainResponse$PerformCheckOnly' => '

When true, indicates that an upgrade eligibility check was performed.

', ], ], 'CancelServiceSoftwareUpdateRequest' => [ 'base' => '

Container for the request parameters to cancel a service software update.

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

Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.

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

Container for information about a configuration change happening on a domain.

', 'refs' => [ 'DomainConfig$ChangeProgressDetails' => '

Container for information about the progress of an existing configuration change.

', 'DomainStatus$ChangeProgressDetails' => '

Information about a configuration change happening on the domain.

', 'UpgradeDomainResponse$ChangeProgressDetails' => '

Container for information about a configuration change happening on a domain.

', ], ], 'ChangeProgressStage' => [ 'base' => '

Progress details for each stage of a domain update.

', 'refs' => [ 'ChangeProgressStageList$member' => NULL, ], ], 'ChangeProgressStageList' => [ 'base' => '

The list of progress stages of a specific domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$ChangeProgressStages' => '

The specific stages that the domain is going through to perform the configuration change.

', ], ], 'ChangeProgressStageName' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Name' => '

The name of the stage.

', ], ], 'ChangeProgressStageStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => '

The status of the stage.

', ], ], 'ChangeProgressStatusDetails' => [ 'base' => '

The progress details of a specific domain configuration change.

', 'refs' => [ 'DescribeDomainChangeProgressResponse$ChangeProgressStatus' => '

Container for information about the stages of a configuration change happening on a domain.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$ClientToken' => '

Unique, case-sensitive identifier to ensure idempotency of the request.

', ], ], 'CloudWatchLogsLogGroupArn' => [ 'base' => '

ARN of the Cloudwatch log group to publish logs to.

', 'refs' => [ 'LogPublishingOption$CloudWatchLogsLogGroupArn' => '

The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

', ], ], 'ClusterConfig' => [ 'base' => '

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'refs' => [ 'ClusterConfigStatus$Options' => '

Cluster configuration options for the specified domain.

', 'CreateDomainRequest$ClusterConfig' => '

Container for the cluster configuration of a domain.

', 'DomainStatus$ClusterConfig' => '

Container for the cluster configuration of the domain.

', 'UpdateDomainConfigRequest$ClusterConfig' => '

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

', ], ], 'ClusterConfigStatus' => [ 'base' => '

The cluster configuration status for a domain.

', 'refs' => [ 'DomainConfig$ClusterConfig' => '

Container for the cluster configuration of a the domain.

', ], ], 'CognitoOptions' => [ 'base' => '

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

', 'refs' => [ 'CognitoOptionsStatus$Options' => '

Cognito options for the specified domain.

', 'CreateDomainRequest$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

', 'DomainStatus$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

', 'UpdateDomainConfigRequest$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

', ], ], 'CognitoOptionsStatus' => [ 'base' => '

The status of the Cognito options for the specified domain.

', 'refs' => [ 'DomainConfig$CognitoOptions' => '

Container for Amazon Cognito options for the domain.

', ], ], 'ColdStorageOptions' => [ 'base' => '

Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.

', 'refs' => [ 'ClusterConfig$ColdStorageOptions' => '

Container for cold storage configuration options.

', ], ], 'CommitMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionHistory$CommitMessage' => '

A message associated with the package version when it was uploaded.

', 'UpdatePackageRequest$CommitMessage' => '

Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

', ], ], 'CompatibleVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetCompatibleVersionsResponse$CompatibleVersions' => '

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', ], ], 'CompatibleVersionsMap' => [ 'base' => '

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', 'refs' => [ 'CompatibleVersionsList$member' => NULL, ], ], '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.

', 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionMode' => '

The connection mode.

', 'CreateOutboundConnectionResponse$ConnectionMode' => '

The connection mode.

', 'InboundConnection$ConnectionMode' => '

The connection mode.

', 'OutboundConnection$ConnectionMode' => '

The connection mode.

', ], ], 'ConnectionProperties' => [ 'base' => '

The connection properties of an outbound connection.

', 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionProperties' => '

The ConnectionProperties for the outbound connection.

', 'CreateOutboundConnectionResponse$ConnectionProperties' => '

The ConnectionProperties for the newly created connection.

', 'OutboundConnection$ConnectionProperties' => '

Properties for the outbound connection.

', ], ], 'ConnectionStatusMessage' => [ 'base' => NULL, 'refs' => [ 'InboundConnectionStatus$Message' => '

Information about the connection.

', 'OutboundConnectionStatus$Message' => '

Verbose information for the outbound connection.

', ], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => '

The result of a CreateDomain operation. Contains the status of the newly created domain.

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

Container for the parameters to the CreateOutboundConnection operation.

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

The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.

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

Container for request parameters to the CreatePackage operation.

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

Container for the response returned by the CreatePackage operation.

', 'refs' => [], ], 'CreateVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatedAt' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$CreatedAt' => '

The timestamp when the package was created.

', 'PackageVersionHistory$CreatedAt' => '

The date and time when the package was created.

', ], ], 'CrossClusterSearchConnectionProperties' => [ 'base' => '

Cross-cluster search specific connection properties.

', 'refs' => [ 'ConnectionProperties$CrossClusterSearch' => '

The connection properties for cross cluster search.

', ], ], 'DataSourceDescription' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceRequest$Description' => '

A description of the data source.

', 'DataSourceDetails$Description' => '

A description of the data source.

', 'GetDataSourceResponse$Description' => '

A description of the data source.

', 'UpdateDataSourceRequest$Description' => '

A new description of the data source.

', ], ], 'DataSourceDetails' => [ 'base' => '

Details about a direct-query data source.

', 'refs' => [ 'DataSourceList$member' => NULL, ], ], 'DataSourceList' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$DataSources' => '

A list of data sources associated with specified domain.

', ], ], 'DataSourceName' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceRequest$Name' => '

A name for the data source.

', 'DataSourceDetails$Name' => '

The name of the data source.

', 'DeleteDataSourceRequest$Name' => '

The name of the data source to delete.

', 'GetDataSourceRequest$Name' => '

The name of the data source to get information about.

', 'GetDataSourceResponse$Name' => '

The name of the data source.

', 'UpdateDataSourceRequest$Name' => '

The name of the data source to modify.

', ], ], 'DataSourceType' => [ 'base' => '

The type of data source.

', 'refs' => [ 'AddDataSourceRequest$DataSourceType' => '

The type of data source.

', 'DataSourceDetails$DataSourceType' => '

The type of data source.

', 'GetDataSourceResponse$DataSourceType' => '

The type of data source.

', 'UpdateDataSourceRequest$DataSourceType' => '

The type of data source.

', ], ], 'DeleteDataSourceRequest' => [ 'base' => '

Container for the parameters to the DeleteDataSource operation.

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

The result of a GetDataSource operation.

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

Container for the parameters to the DeleteDomain operation.

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

The results of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.

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

Container for the parameters to the DeleteInboundConnection operation.

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

The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.

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

Container for the parameters to the DeleteOutboundConnection operation.

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

Details about the deleted outbound connection.

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

Deletes a package from OpenSearch Service. The package can\'t be associated with any OpenSearch Service domain.

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

Container for the response parameters to the DeletePackage operation.

', 'refs' => [], ], 'DeleteVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DependencyFailureException' => [ 'base' => '

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

', 'refs' => [], ], 'DeploymentCloseDateTimeStamp' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$AutomatedUpdateDate' => '

The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

', ], ], 'DeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$UpdateStatus' => '

The status of your service software update.

', ], ], 'DeploymentType' => [ 'base' => NULL, 'refs' => [ 'DryRunResults$DeploymentType' => '

Specifies the way in which OpenSearch Service will apply an update. Possible values are:

  • 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.

', ], ], 'DescribeDomainAutoTunesRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainAutoTunes operation.

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

The result of a DescribeDomainAutoTunes request.

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

Container for the parameters to the DescribeDomainChangeProgress operation.

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

The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.

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

Container for the parameters to the DescribeDomainConfig operation.

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

Contains the configuration information of the requested domain.

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

Container for the parameters to the DescribeDomainHealth operation.

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

The result of a DescribeDomainHealth request. Contains health information for the requested domain.

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

Container for the parameters to the DescribeDomainNodes operation.

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

The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.

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

Container for the parameters to the DescribeDomain operation.

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

Contains the status of the domain specified in the request.

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

Container for the parameters to the DescribeDomains operation.

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

Contains the status of the specified domains or all domains owned by the account.

', 'refs' => [], ], 'DescribeDryRunProgressRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDryRunProgressResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInboundConnectionsRequest' => [ 'base' => '

Container for the parameters to the DescribeInboundConnections operation.

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

Contains a list of connections matching the filter criteria.

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

Container for the parameters to the DescribeInstanceTypeLimits operation.

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

Container for the parameters received from the DescribeInstanceTypeLimits operation.

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

Container for the parameters to the DescribeOutboundConnections operation.

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

Contains a list of connections matching the filter criteria.

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

A filter to apply to the DescribePackage response.

', 'refs' => [ 'DescribePackagesFilterList$member' => NULL, ], ], 'DescribePackagesFilterList' => [ 'base' => '

A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.

', 'refs' => [ 'DescribePackagesRequest$Filters' => '

Only returns packages that match the DescribePackagesFilterList values.

', ], ], 'DescribePackagesFilterName' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Name' => '

Any field from PackageDetails.

', ], ], 'DescribePackagesFilterValue' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilterValues$member' => NULL, ], ], 'DescribePackagesFilterValues' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Value' => '

A non-empty list of values for the specified filter field.

', ], ], 'DescribePackagesRequest' => [ 'base' => '

Container for the request parameters to the DescribePackage operation.

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

Container for the response returned by the DescribePackages operation.

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

Container for the request parameters to a DescribeReservedInstanceOfferings operation.

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

Container for results of a DescribeReservedInstanceOfferings request.

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

Container for the request parameters to the DescribeReservedInstances operation.

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

Container for results from DescribeReservedInstances

', 'refs' => [], ], 'DescribeVpcEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVpcEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Description' => '

The description of the stage.

', ], ], 'DisableTimestamp' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$AnonymousAuthDisableDate' => '

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

', ], ], 'DisabledOperationException' => [ 'base' => '

An error occured because the client wanted to access an unsupported operation.

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

Container for the request parameters to the DissociatePackage operation.

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

Container for the response returned by an DissociatePackage operation.

', 'refs' => [], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$DomainArn' => '

The Amazon Resource Name (ARN) of the domain to create the endpoint for.

', 'VpcEndpoint$DomainArn' => '

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

', 'VpcEndpointSummary$DomainArn' => '

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

', ], ], 'DomainConfig' => [ 'base' => '

Container for the configuration of an OpenSearch Service domain.

', 'refs' => [ 'DescribeDomainConfigResponse$DomainConfig' => '

Container for the configuration of the OpenSearch Service domain.

', 'UpdateDomainConfigResponse$DomainConfig' => '

The status of the updated domain.

', ], ], 'DomainEndpointOptions' => [ 'base' => '

Options to configure a custom endpoint for an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainRequest$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', 'DomainEndpointOptionsStatus$Options' => '

Options to configure the endpoint for a domain.

', 'DomainStatus$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', 'UpdateDomainConfigRequest$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', ], ], 'DomainEndpointOptionsStatus' => [ 'base' => '

The configured endpoint options for a domain and their current status.

', 'refs' => [ 'DomainConfig$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', ], ], 'DomainHealth' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$ClusterHealth' => '

The current health status of your cluster.

  • 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.

', ], ], 'DomainId' => [ 'base' => '

Unique identifier for an OpenSearch Service domain.

', 'refs' => [ 'DomainStatus$DomainId' => '

Unique identifier for the domain.

', ], ], 'DomainInfo' => [ 'base' => '

Information about an OpenSearch Service domain.

', 'refs' => [ 'DomainInfoList$member' => NULL, ], ], 'DomainInfoList' => [ 'base' => '

Contains a list of information about a domain.

', 'refs' => [ 'ListDomainNamesResponse$DomainNames' => '

The names of all OpenSearch Service domains owned by the current user and their respective engine types.

', ], ], 'DomainInformationContainer' => [ 'base' => '

Container for information about an OpenSearch Service domain.

', 'refs' => [ 'CreateOutboundConnectionRequest$LocalDomainInfo' => '

Name and Region of the source (local) domain.

', 'CreateOutboundConnectionRequest$RemoteDomainInfo' => '

Name and Region of the destination (remote) domain.

', 'CreateOutboundConnectionResponse$LocalDomainInfo' => '

Information about the source (local) domain.

', 'CreateOutboundConnectionResponse$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', 'InboundConnection$LocalDomainInfo' => '

Information about the source (local) domain.

', 'InboundConnection$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', 'OutboundConnection$LocalDomainInfo' => '

Information about the source (local) domain.

', 'OutboundConnection$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', ], ], 'DomainMaintenanceDetails' => [ 'base' => '

Container for the domain maintenance details.

', 'refs' => [ 'DomainMaintenanceList$member' => NULL, ], ], 'DomainMaintenanceList' => [ 'base' => NULL, 'refs' => [ 'ListDomainMaintenancesResponse$DomainMaintenances' => '

A list of the submitted maintenance actions.

', ], ], 'DomainName' => [ 'base' => '

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

', 'refs' => [ 'AWSDomainInformation$DomainName' => '

Name of the domain.

', 'AddDataSourceRequest$DomainName' => '

The name of the domain to add the data source to.

', 'AssociatePackageRequest$DomainName' => '

Name of the domain to associate the package with.

', 'AuthorizeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to provide access to.

', 'CancelServiceSoftwareUpdateRequest$DomainName' => '

Name of the OpenSearch Service domain that you want to cancel the service software update on.

', 'CreateDomainRequest$DomainName' => '

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

', 'DeleteDataSourceRequest$DomainName' => '

The name of the domain.

', 'DeleteDomainRequest$DomainName' => '

The name of the domain you want to permanently delete.

', 'DescribeDomainAutoTunesRequest$DomainName' => '

Name of the domain that you want Auto-Tune details about.

', 'DescribeDomainChangeProgressRequest$DomainName' => '

The name of the domain to get progress information for.

', 'DescribeDomainConfigRequest$DomainName' => '

Name of the OpenSearch Service domain configuration that you want to describe.

', 'DescribeDomainHealthRequest$DomainName' => '

The name of the domain.

', 'DescribeDomainNodesRequest$DomainName' => '

The name of the domain.

', 'DescribeDomainRequest$DomainName' => '

The name of the domain that you want information about.

', 'DescribeDryRunProgressRequest$DomainName' => '

The name of the domain.

', 'DescribeInstanceTypeLimitsRequest$DomainName' => '

The name of the domain. Only specify if you need the limits for an existing domain.

', 'DissociatePackageRequest$DomainName' => '

Name of the domain to dissociate the package from.

', 'DomainInfo$DomainName' => '

Name of the domain.

', 'DomainMaintenanceDetails$DomainName' => '

The name of the domain.

', 'DomainNameList$member' => NULL, 'DomainPackageDetails$DomainName' => '

Name of the domain that the package is associated with.

', 'DomainStatus$DomainName' => '

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

', 'GetCompatibleVersionsRequest$DomainName' => '

The name of an existing domain. Provide this parameter to limit the results to a single domain.

', 'GetDataSourceRequest$DomainName' => '

The name of the domain.

', 'GetDomainMaintenanceStatusRequest$DomainName' => '

The name of the domain.

', 'GetUpgradeHistoryRequest$DomainName' => '

The name of an existing domain.

', 'GetUpgradeStatusRequest$DomainName' => '

The domain of the domain to get upgrade status information for.

', 'ListDataSourcesRequest$DomainName' => '

The name of the domain.

', 'ListDomainMaintenancesRequest$DomainName' => '

The name of the domain.

', 'ListInstanceTypeDetailsRequest$DomainName' => '

The name of the domain.

', 'ListPackagesForDomainRequest$DomainName' => '

The name of the domain for which you want to list associated packages.

', 'ListScheduledActionsRequest$DomainName' => '

The name of the domain.

', 'ListVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to retrieve access information for.

', 'ListVpcEndpointsForDomainRequest$DomainName' => '

The name of the domain to list associated VPC endpoints for.

', 'RevokeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain.

', 'StartDomainMaintenanceRequest$DomainName' => '

The name of the domain.

', 'StartServiceSoftwareUpdateRequest$DomainName' => '

The name of the domain that you want to update to the latest service software.

', 'UpdateDataSourceRequest$DomainName' => '

The name of the domain.

', 'UpdateDomainConfigRequest$DomainName' => '

The name of the domain that you\'re updating.

', 'UpdateScheduledActionRequest$DomainName' => '

The name of the domain to reschedule an action for.

', 'UpgradeDomainRequest$DomainName' => '

Name of the OpenSearch Service domain that you want to upgrade.

', 'UpgradeDomainResponse$DomainName' => '

The name of the domain that was upgraded.

', ], ], 'DomainNameFqdn' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$CustomEndpoint' => '

The fully qualified URL for the custom endpoint.

', ], ], 'DomainNameList' => [ 'base' => '

A list of OpenSearch Service domain names.

', 'refs' => [ 'DescribeDomainsRequest$DomainNames' => '

Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.

', ], ], 'DomainNodesStatus' => [ 'base' => '

Container for information about nodes on the domain.

', 'refs' => [ 'DomainNodesStatusList$member' => NULL, ], ], 'DomainNodesStatusList' => [ 'base' => '

List of DomainNodesStatus with details about nodes on the requested domain.

', 'refs' => [ 'DescribeDomainNodesResponse$DomainNodesStatusList' => '

Contains nodes information list DomainNodesStatusList with details about the all nodes on the requested domain.

', ], ], 'DomainPackageDetails' => [ 'base' => '

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

', 'refs' => [ 'AssociatePackageResponse$DomainPackageDetails' => '

Information about a package that is associated with a domain.

', 'DissociatePackageResponse$DomainPackageDetails' => '

Information about a package that has been dissociated from the domain.

', 'DomainPackageDetailsList$member' => NULL, ], ], 'DomainPackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsForPackageResponse$DomainPackageDetailsList' => '

Information about all domains associated with a package.

', 'ListPackagesForDomainResponse$DomainPackageDetailsList' => '

List of all packages associated with a domain.

', ], ], 'DomainPackageStatus' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$DomainPackageStatus' => '

State of the association.

', ], ], '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.

', ], ], 'DomainStatus' => [ 'base' => '

The current status of an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainResponse$DomainStatus' => '

The status of the newly created domain.

', 'DeleteDomainResponse$DomainStatus' => '

The status of the domain being deleted.

', 'DescribeDomainResponse$DomainStatus' => '

List that contains the status of each specified OpenSearch Service domain.

', 'DescribeDryRunProgressResponse$DryRunConfig' => '

Details about the changes you\'re planning to make on the domain.

', 'DomainStatusList$member' => NULL, ], ], 'DomainStatusList' => [ 'base' => '

List that contains the status of each specified OpenSearch Service domain.

', 'refs' => [ 'DescribeDomainsResponse$DomainStatusList' => '

The status of the requested domains.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$RecurringChargeAmount' => '

The monetary amount of the recurring charge.

', 'ReservedInstance$FixedPrice' => '

The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.

', 'ReservedInstance$UsagePrice' => '

The hourly rate at which you\'re charged for the domain using this Reserved Instance.

', 'ReservedInstanceOffering$FixedPrice' => '

The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.

', 'ReservedInstanceOffering$UsagePrice' => '

The hourly rate at which you\'re charged for the domain using this Reserved Instance.

', 'UpgradeStepItem$ProgressPercent' => '

The floating point value representing the progress percentage of a particular step.

', ], ], 'DryRun' => [ 'base' => NULL, 'refs' => [ 'UpdateDomainConfigRequest$DryRun' => '

This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.

', ], ], 'DryRunMode' => [ 'base' => NULL, 'refs' => [ 'UpdateDomainConfigRequest$DryRunMode' => '

The type of dry run to perform.

  • 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.

', ], ], 'DryRunProgressStatus' => [ 'base' => '

Information about the progress of a pre-upgrade dry run analysis.

', 'refs' => [ 'DescribeDryRunProgressResponse$DryRunProgressStatus' => '

The current status of the dry run, including any validation errors.

', 'UpdateDomainConfigResponse$DryRunProgressStatus' => '

The status of the dry run being performed on the domain, if any.

', ], ], 'DryRunResults' => [ 'base' => '

Results of a dry run performed in an update domain request.

', 'refs' => [ 'DescribeDryRunProgressResponse$DryRunResults' => '

The results of the dry run.

', 'UpdateDomainConfigResponse$DryRunResults' => '

Results of the dry run performed in the update domain request.

', ], ], 'Duration' => [ 'base' => '

The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneMaintenanceSchedule$Duration' => '

The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.

', ], ], 'DurationValue' => [ 'base' => '

Integer that specifies the value of a maintenance schedule duration.

', 'refs' => [ 'Duration$Value' => '

Integer to specify the value of a maintenance schedule duration.

', ], ], 'EBSOptions' => [ 'base' => '

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainRequest$EBSOptions' => '

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

', 'DomainStatus$EBSOptions' => '

Container for EBS-based storage settings for the domain.

', 'EBSOptionsStatus$Options' => '

The configured EBS options for the specified domain.

', 'UpdateDomainConfigRequest$EBSOptions' => '

The type and size of the EBS volume to attach to instances in the domain.

', ], ], 'EBSOptionsStatus' => [ 'base' => '

The status of the EBS options for the specified OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EBSOptions' => '

Container for EBS options configured for the domain.

', ], ], 'EncryptionAtRestOptions' => [ 'base' => '

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can be used only to create a new domain, not update an existing one.

', 'refs' => [ 'CreateDomainRequest$EncryptionAtRestOptions' => '

Key-value pairs to enable encryption at rest.

', 'DomainStatus$EncryptionAtRestOptions' => '

Encryption at rest settings for the domain.

', 'EncryptionAtRestOptionsStatus$Options' => '

Encryption at rest options for the specified domain.

', 'UpdateDomainConfigRequest$EncryptionAtRestOptions' => '

Encryption at rest options for the domain.

', ], ], 'EncryptionAtRestOptionsStatus' => [ 'base' => '

Status of the encryption at rest options for the specified OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EncryptionAtRestOptions' => '

Key-value pairs to enable encryption at rest.

', ], ], 'Endpoint' => [ 'base' => NULL, 'refs' => [ 'ConnectionProperties$Endpoint' => '

The Endpoint attribute cannot be modified.

The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

', 'VpcEndpoint$Endpoint' => '

The connection endpoint ID for connecting to the domain.

', ], ], 'EndpointsMap' => [ 'base' => NULL, 'refs' => [ 'DomainStatus$Endpoints' => '

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: \'vpc\',\'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com\'.

', ], ], 'EngineType' => [ 'base' => NULL, 'refs' => [ 'DomainInfo$EngineType' => '

The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

', 'ListDomainNamesRequest$EngineType' => '

Filters the output by domain engine type.

', ], ], 'EngineVersion' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$EngineVersion' => '

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', ], ], 'EnvironmentInfo' => [ 'base' => '

Information about the active domain environment.

', 'refs' => [ 'EnvironmentInfoList$member' => NULL, ], ], 'EnvironmentInfoList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$EnvironmentInformation' => '

A list of EnvironmentInfo for the domain.

', ], ], 'ErrorDetails' => [ 'base' => '

Additional information if the package is in an error state. Null otherwise.

', 'refs' => [ 'DomainPackageDetails$ErrorDetails' => '

Additional information if the package is in an error state. Null otherwise.

', 'PackageDetails$ErrorDetails' => '

Additional information if the package is in an error state. Null otherwise.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'BaseException$message' => '

A description of the error.

', 'ErrorDetails$ErrorMessage' => '

A message describing the error.

', ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorType' => '

The type of error that occurred.

', ], ], 'Filter' => [ 'base' => '

A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundConnectionsRequest$Filters' => '

A list of filters used to match properties for inbound cross-cluster connections.

', 'DescribeOutboundConnectionsRequest$Filters' => '

List of filter names and values that you can use for requests.

', ], ], 'GUID' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$ChangeId' => '

The ID of the configuration change.

', 'ChangeProgressStatusDetails$ChangeId' => '

The unique change identifier associated with a specific domain configuration change.

', 'DescribeDomainChangeProgressRequest$ChangeId' => '

The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

', 'DescribeDryRunProgressRequest$DryRunId' => '

The unique identifier of the dry run.

', 'DescribeReservedInstanceOfferingsRequest$ReservedInstanceOfferingId' => '

The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

', 'DescribeReservedInstancesRequest$ReservedInstanceId' => '

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

', 'DryRunProgressStatus$DryRunId' => '

The unique identifier of the dry run.

', '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.

', ], ], 'GetCompatibleVersionsRequest' => [ 'base' => '

Container for the request parameters to GetCompatibleVersions operation.

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

Container for the response returned by the GetCompatibleVersions operation.

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

Container for the parameters to the GetDataSource operation.

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

The result of a GetDataSource operation.

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

Container for the parameters to the GetDomainMaintenanceStatus operation.

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

The result of a GetDomainMaintenanceStatus request that information about the requested action.

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

Container for the request parameters to the GetPackageVersionHistory operation.

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

Container for response returned by GetPackageVersionHistory operation.

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

Container for the request parameters to the GetUpgradeHistory operation.

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

Container for the response returned by the GetUpgradeHistory operation.

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

Container for the request parameters to the GetUpgradeStatus operation.

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

Container for the response returned by the GetUpgradeStatus operation.

', 'refs' => [], ], 'IPAddressType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$IPAddressType' => '

The type of IP addresses supported by the endpoint for the domain.

', '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' => '

The type of IP addresses supported by the endpoint for the domain.

', ], ], 'IPAddressTypeStatus' => [ 'base' => '

The IP address type status for the domain.

', 'refs' => [ 'DomainConfig$IPAddressType' => '

The type of IP addresses supported by the endpoint for the domain.

', ], ], '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.

', ], ], 'InboundConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundConnectionsResponse$Connections' => '

List of inbound connections.

', ], ], 'InstanceCount' => [ 'base' => '

Number of instances in an OpenSearch Service cluster.

', 'refs' => [ 'PurchaseReservedInstanceOfferingRequest$InstanceCount' => '

The number of OpenSearch instances to reserve.

', ], ], 'InstanceCountLimits' => [ 'base' => '

Limits on the number of instances that can be created in OpenSearch Service for a given instance type.

', 'refs' => [ 'InstanceLimits$InstanceCountLimits' => '

Limits on the number of instances that can be created for a given instance type.

', ], ], 'InstanceLimits' => [ 'base' => '

Instance-related attributes that are available for a given instance type.

', 'refs' => [ 'Limits$InstanceLimits' => '

The limits for a given instance type.

', ], ], 'InstanceRole' => [ 'base' => NULL, 'refs' => [ 'InstanceRoleList$member' => NULL, 'LimitsByRole$key' => NULL, ], ], 'InstanceRoleList' => [ 'base' => NULL, 'refs' => [ 'InstanceTypeDetails$InstanceRole' => '

Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.

', ], ], 'InstanceTypeDetails' => [ 'base' => '

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

', 'refs' => [ 'InstanceTypeDetailsList$member' => NULL, ], ], 'InstanceTypeDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceTypeDetailsResponse$InstanceTypeDetails' => '

Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

', ], ], 'InstanceTypeString' => [ 'base' => NULL, 'refs' => [ 'ListInstanceTypeDetailsRequest$InstanceType' => '

An optional parameter that lists information for a given instance type.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$Duration' => '

The duration, in seconds, for which the OpenSearch instance is reserved.

', 'ReservedInstance$InstanceCount' => '

The number of OpenSearch instances that have been reserved.

', 'ReservedInstanceOffering$Duration' => '

The duration, in seconds, for which the offering will reserve the OpenSearch instance.

', ], ], 'IntegerClass' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$InstanceCount' => '

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

', 'ClusterConfig$DedicatedMasterCount' => '

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

', 'ClusterConfig$WarmCount' => '

The number of warm nodes in the cluster.

', 'EBSOptions$VolumeSize' => '

Specifies the size (in GiB) of EBS volumes attached to data nodes.

', 'EBSOptions$Iops' => '

Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

', 'EBSOptions$Throughput' => '

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

', 'SAMLOptionsInput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

', 'SAMLOptionsOutput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive.

', 'SnapshotOptions$AutomatedSnapshotStartHour' => '

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

', 'ZoneAwarenessConfig$AvailabilityZoneCount' => '

If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

', ], ], 'InternalException' => [ 'base' => '

Request processing failed because of an unknown error, exception, or internal failure.

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

Request processing failed because you provided an invalid pagination token.

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

An exception for trying to create or access a sub-resource that\'s either invalid or not supported.

', 'refs' => [], ], 'Issue' => [ 'base' => NULL, 'refs' => [ 'Issues$member' => NULL, ], ], 'Issues' => [ 'base' => NULL, 'refs' => [ 'UpgradeStepItem$Issues' => '

A list of strings containing detailed information about the errors encountered in a particular step.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyId' => '

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

', ], ], 'LastUpdated' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$LastUpdated' => '

The most recent updated timestamp of the stage.

', 'DomainPackageDetails$LastUpdated' => '

Timestamp of the most recent update to the package association status.

', 'PackageDetails$LastUpdatedAt' => '

Date and time when the package was last updated.

', ], ], 'LimitExceededException' => [ 'base' => '

An exception for trying to create more than the allowed number of resources or sub-resources.

', 'refs' => [], ], 'LimitName' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitName' => '

  • 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.

', 'StorageTypeLimit$LimitName' => '

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.

', ], ], 'LimitValue' => [ 'base' => NULL, 'refs' => [ 'LimitValueList$member' => NULL, ], ], 'LimitValueList' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitValues' => '

The values of the additional instance type limits.

', 'StorageTypeLimit$LimitValues' => '

The limit values.

', ], ], 'Limits' => [ 'base' => '

Limits for a given instance type and for each of its roles.

', 'refs' => [ 'LimitsByRole$value' => NULL, ], ], 'LimitsByRole' => [ 'base' => '

The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

  • data - A data node.

  • master - A dedicated master node.

  • ultra_warm - An UltraWarm node.

', 'refs' => [ 'DescribeInstanceTypeLimitsResponse$LimitsByRole' => '

Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

', ], ], 'ListDataSourcesRequest' => [ 'base' => '

Container for the parameters to the ListDataSources operation.

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

The result of a ListDataSources operation.

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

Container for the parameters to the ListDomainMaintenances operation.

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

The result of a ListDomainMaintenances request that contains information about the requested actions.

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

Container for the parameters to the ListDomainNames operation.

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

The results of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

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

Container for the request parameters to the ListDomainsForPackage operation.

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

Container for the response parameters to the ListDomainsForPackage operation.

', 'refs' => [], ], 'ListInstanceTypeDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceTypeDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesForDomainRequest' => [ 'base' => '

Container for the request parameters to the ListPackagesForDomain operation.

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

Container for the response parameters to the ListPackagesForDomain operation.

', 'refs' => [], ], 'ListScheduledActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListScheduledActionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsRequest' => [ 'base' => '

Container for the parameters to the ListTags operation.

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

The results of a ListTags operation.

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

Container for the request parameters to the ListVersions operation.

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

Container for the parameters for response received from the ListVersions operation.

', 'refs' => [], ], 'ListVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsForDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsForDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogPublishingOption' => [ 'base' => '

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.

After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

', 'refs' => [ 'LogPublishingOptions$value' => NULL, ], ], 'LogPublishingOptions' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$LogPublishingOptions' => '

Key-value pairs to configure log publishing.

', 'DomainStatus$LogPublishingOptions' => '

Log publishing options for the domain.

', 'LogPublishingOptionsStatus$Options' => '

The log publishing options configured for the domain.

', 'UpdateDomainConfigRequest$LogPublishingOptions' => '

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

', ], ], 'LogPublishingOptionsStatus' => [ 'base' => '

The configured log publishing options for the domain and their current status.

', 'refs' => [ 'DomainConfig$LogPublishingOptions' => '

Key-value pairs to configure log publishing.

', ], ], 'LogType' => [ 'base' => '

The type of log file. Can be one of the following:

  • 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.

', 'refs' => [ 'LogPublishingOptions$key' => NULL, ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$BillingSubscriptionId' => '

The unique identifier of the billing subscription.

', 'ScheduledAction$ScheduledTime' => '

The time when the change is scheduled to happen.

', 'SlotList$member' => NULL, 'StartServiceSoftwareUpdateRequest$DesiredStartTime' => '

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

', 'UpdateScheduledActionRequest$DesiredStartTime' => '

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

', ], ], 'MaintenanceStatus' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$Status' => '

The status of the action.

', 'GetDomainMaintenanceStatusResponse$Status' => '

The status of the maintenance action.

', 'ListDomainMaintenancesRequest$Status' => '

The status of the action.

', ], ], 'MaintenanceStatusMessage' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$StatusMessage' => '

The status message for the action.

', 'GetDomainMaintenanceStatusResponse$StatusMessage' => '

The status message of the maintenance action.

', ], ], 'MaintenanceType' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$Action' => '

The name of the action.

', 'GetDomainMaintenanceStatusResponse$Action' => '

The action name.

', 'ListDomainMaintenancesRequest$Action' => '

The name of the action.

', 'StartDomainMaintenanceRequest$Action' => '

The name of the action.

', ], ], 'MasterNodeStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$MasterNode' => '

Indicates whether the domain has an elected master node.

  • 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.

', ], ], 'MasterUserOptions' => [ 'base' => '

Credentials for the master user for a domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$MasterUserOptions' => '

Container for information about the master user.

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

An optional parameter that specifies the maximum number of results to return for a given request.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeInboundConnectionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeOutboundConnectionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribePackagesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeReservedInstanceOfferingsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeReservedInstancesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'GetPackageVersionHistoryRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'GetUpgradeHistoryRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListDomainMaintenancesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListDomainsForPackageRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListInstanceTypeDetailsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListPackagesForDomainRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListScheduledActionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListVersionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', ], ], 'MaximumInstanceCount' => [ 'base' => '

Maximum number of instances that can be instantiated for a given instance type.

', 'refs' => [ 'InstanceCountLimits$MaximumInstanceCount' => '

The minimum allowed number of instances.

', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$Message' => '

A message corresponding to the status of the configuration change.

', 'DryRunResults$Message' => '

A message corresponding to the deployment type.

', ], ], 'MinimumInstanceCount' => [ 'base' => '

Minimum number of instances that can be instantiated for a given instance type.

', 'refs' => [ 'InstanceCountLimits$MinimumInstanceCount' => '

The maximum allowed number of instances.

', ], ], 'NextToken' => [ 'base' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$NextToken' => '

If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.

', 'DescribeDomainAutoTunesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'DescribeInboundConnectionsRequest$NextToken' => '

If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.

', 'DescribeInboundConnectionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'DescribeOutboundConnectionsRequest$NextToken' => '

If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.

', 'DescribeOutboundConnectionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'DescribePackagesRequest$NextToken' => '

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

', 'DescribeReservedInstanceOfferingsRequest$NextToken' => '

If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.

', 'DescribeReservedInstanceOfferingsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'DescribeReservedInstancesRequest$NextToken' => '

If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.

', 'GetPackageVersionHistoryRequest$NextToken' => '

If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.

', 'GetUpgradeHistoryRequest$NextToken' => '

If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.

', 'ListDomainMaintenancesRequest$NextToken' => '

If your initial ListDomainMaintenances operation returns a nextToken, include the returned nextToken in subsequent ListDomainMaintenances operations, which returns results in the next page.

', 'ListDomainMaintenancesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListDomainsForPackageRequest$NextToken' => '

If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.

', 'ListInstanceTypeDetailsRequest$NextToken' => '

If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

', 'ListInstanceTypeDetailsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListPackagesForDomainRequest$NextToken' => '

If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.

', 'ListScheduledActionsRequest$NextToken' => '

If your initial ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.

', 'ListScheduledActionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListVersionsRequest$NextToken' => '

If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.

', 'ListVersionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListVpcEndpointAccessRequest$NextToken' => '

If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.

', 'ListVpcEndpointAccessResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListVpcEndpointsForDomainRequest$NextToken' => '

If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.

', 'ListVpcEndpointsForDomainResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListVpcEndpointsRequest$NextToken' => '

If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

', 'ListVpcEndpointsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', ], ], 'NodeId' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$NodeId' => '

The ID of the data node.

', 'DomainNodesStatus$NodeId' => '

The ID of the node.

', 'GetDomainMaintenanceStatusResponse$NodeId' => '

The node ID of the maintenance action.

', 'StartDomainMaintenanceRequest$NodeId' => '

The ID of the data node.

', ], ], 'NodeStatus' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$NodeStatus' => '

Indicates if the node is active or in standby.

', ], ], 'NodeToNodeEncryptionOptions' => [ 'base' => '

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.

', 'refs' => [ 'CreateDomainRequest$NodeToNodeEncryptionOptions' => '

Enables node-to-node encryption.

', 'DomainStatus$NodeToNodeEncryptionOptions' => '

Whether node-to-node encryption is enabled or disabled.

', 'NodeToNodeEncryptionOptionsStatus$Options' => '

The node-to-node encryption options for the specified domain.

', 'UpdateDomainConfigRequest$NodeToNodeEncryptionOptions' => '

Node-to-node encryption options for the domain.

', ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'base' => '

Status of the node-to-node encryption options for the specified domain.

', 'refs' => [ 'DomainConfig$NodeToNodeEncryptionOptions' => '

Whether node-to-node encryption is enabled or disabled.

', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$NodeType' => '

Indicates whether the nodes is a data, master, or ultrawarm node.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

The name of the filter.

', 'ValueStringList$member' => NULL, ], ], 'NumberOfAZs' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$AvailabilityZoneCount' => '

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$ActiveAvailabilityZoneCount' => '

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$StandByAvailabilityZoneCount' => '

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', ], ], 'NumberOfNodes' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$ConfiguredDataNodeCount' => '

The total number of data nodes configured in the Availability Zone.

', 'AvailabilityZoneInfo$AvailableDataNodeCount' => '

The number of data nodes active in the Availability Zone.

', 'DescribeDomainHealthResponse$DataNodeCount' => '

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$MasterEligibleNodeCount' => '

The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$WarmNodeCount' => '

The number of warm nodes configured for the domain.

', ], ], 'NumberOfShards' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$TotalShards' => '

The total number of primary and replica shards in the Availability Zone.

', 'AvailabilityZoneInfo$TotalUnAssignedShards' => '

The total number of primary and replica shards that aren\'t allocated to any of the nodes in the Availability Zone.

', 'DescribeDomainHealthResponse$TotalShards' => '

The total number of primary and replica shards for the domain.

', 'DescribeDomainHealthResponse$TotalUnAssignedShards' => '

The total number of primary and replica shards not allocated to any of the nodes for the cluster.

', ], ], 'OffPeakWindow' => [ 'base' => '

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify.

If you don\'t specify a window start time, it defaults to 10:00 P.M. local time.

For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service.

', 'refs' => [ 'OffPeakWindowOptions$OffPeakWindow' => '

Off-peak window settings for the domain.

', ], ], 'OffPeakWindowOptions' => [ 'base' => '

Options for a domain\'s off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

', 'refs' => [ 'CreateDomainRequest$OffPeakWindowOptions' => '

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

', 'DomainStatus$OffPeakWindowOptions' => '

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

', 'OffPeakWindowOptionsStatus$Options' => '

The domain\'s off-peak window configuration.

', 'UpdateDomainConfigRequest$OffPeakWindowOptions' => '

Off-peak window options for the domain.

', ], ], 'OffPeakWindowOptionsStatus' => [ 'base' => '

The status of off-peak window options for a domain.

', 'refs' => [ 'DomainConfig$OffPeakWindowOptions' => '

Container for off-peak window options for the domain.

', ], ], 'OpenSearchPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$InstanceType' => '

Instance type of data nodes in the cluster.

', 'ClusterConfig$DedicatedMasterType' => '

OpenSearch Service instance type of the dedicated master nodes in the cluster.

', 'DescribeInstanceTypeLimitsRequest$InstanceType' => '

The OpenSearch Service instance type for which you need limit information.

', 'DomainNodesStatus$InstanceType' => '

The instance type information of the node.

', 'InstanceTypeDetails$InstanceType' => '

The instance type.

', 'ReservedInstance$InstanceType' => '

The OpenSearch instance type offered by theReserved Instance offering.

', 'ReservedInstanceOffering$InstanceType' => '

The OpenSearch instance type offered by the Reserved Instance offering.

', ], ], 'OpenSearchWarmPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$WarmType' => '

The instance type for the cluster\'s warm nodes.

', ], ], 'OptionState' => [ 'base' => '

The state of a requested domain configuration change. Can be one of the following:

  • Processing - The requested change is still in progress.

  • Active - The requested change is processed and deployed to the domain.

', 'refs' => [ 'OptionStatus$State' => '

The state of the entity.

', ], ], 'OptionStatus' => [ 'base' => '

Provides the current status of an entity.

', 'refs' => [ 'AccessPoliciesStatus$Status' => '

The status of the access policy for the domain.

', 'AdvancedOptionsStatus$Status' => '

The status of advanced options for the specified domain.

', 'AdvancedSecurityOptionsStatus$Status' => '

Status of the fine-grained access control settings for a domain.

', 'ClusterConfigStatus$Status' => '

The status of cluster configuration options for the specified domain.

', 'CognitoOptionsStatus$Status' => '

The status of the Cognito options for the specified domain.

', 'DomainEndpointOptionsStatus$Status' => '

The status of the endpoint options for a domain.

', 'EBSOptionsStatus$Status' => '

The status of the EBS options for the specified domain.

', 'EncryptionAtRestOptionsStatus$Status' => '

The status of the encryption at rest options for the specified domain.

', 'IPAddressTypeStatus$Status' => NULL, 'LogPublishingOptionsStatus$Status' => '

The status of the log publishing options for the domain.

', 'NodeToNodeEncryptionOptionsStatus$Status' => '

The status of the node-to-node encryption options for the specified domain.

', 'OffPeakWindowOptionsStatus$Status' => '

The current status of off-peak window options.

', 'SnapshotOptionsStatus$Status' => '

The status of a daily automated snapshot.

', 'SoftwareUpdateOptionsStatus$Status' => '

The status of service software update options, including creation date and last updated date.

', 'VPCDerivedInfoStatus$Status' => '

The status of the VPC options for the specified domain.

', 'VersionStatus$Status' => '

The status of the version options for the specified domain.

', ], ], 'OutboundConnection' => [ 'base' => '

Specifies details about an outbound cross-cluster connection.

', 'refs' => [ 'DeleteOutboundConnectionResponse$Connection' => '

The deleted inbound connection.

', 'OutboundConnections$member' => NULL, ], ], 'OutboundConnectionStatus' => [ 'base' => '

The status of an outbound cross-cluster connection.

', 'refs' => [ 'CreateOutboundConnectionResponse$ConnectionStatus' => '

The status of the connection.

', 'OutboundConnection$ConnectionStatus' => '

Status of the connection.

', ], ], 'OutboundConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'OutboundConnectionStatus$StatusCode' => '

The status code for the outbound connection. Can be one of the following:

  • 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.

', ], ], 'OutboundConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeOutboundConnectionsResponse$Connections' => '

List of outbound connections that match the filter criteria.

', ], ], 'OverallChangeStatus' => [ 'base' => '

The overall status value of the domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$Status' => '

The overall status of the domain configuration change.

', ], ], 'OwnerId' => [ 'base' => NULL, 'refs' => [ 'AWSDomainInformation$OwnerId' => '

The Amazon Web Services account ID of the domain owner.

', ], ], 'PackageDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageDescription' => '

Description of the package.

', 'PackageDetails$PackageDescription' => '

User-specified description of the package.

', 'UpdatePackageRequest$PackageDescription' => '

A new description of the package.

', ], ], 'PackageDetails' => [ 'base' => '

Basic information about a package.

', 'refs' => [ 'CreatePackageResponse$PackageDetails' => '

Basic information about an OpenSearch Service package.

', 'DeletePackageResponse$PackageDetails' => '

Information about the deleted package.

', 'PackageDetailsList$member' => NULL, 'UpdatePackageResponse$PackageDetails' => '

Information about a package.

', ], ], 'PackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesResponse$PackageDetailsList' => '

Basic information about a package.

', ], ], 'PackageID' => [ 'base' => NULL, 'refs' => [ 'AssociatePackageRequest$PackageID' => '

Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

', 'DeletePackageRequest$PackageID' => '

The internal ID of the package you want to delete. Use DescribePackages to find this value.

', 'DissociatePackageRequest$PackageID' => '

Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.

', 'DomainPackageDetails$PackageID' => '

Internal ID of the package.

', 'GetPackageVersionHistoryRequest$PackageID' => '

The unique identifier of the package.

', 'GetPackageVersionHistoryResponse$PackageID' => '

The unique identifier of the package.

', 'ListDomainsForPackageRequest$PackageID' => '

The unique identifier of the package for which to list associated domains.

', 'PackageDetails$PackageID' => '

The unique identifier of the package.

', 'UpdatePackageRequest$PackageID' => '

The unique identifier for the package.

', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageName' => '

Unique name for the package.

', 'DomainPackageDetails$PackageName' => '

User-specified name of the package.

', 'PackageDetails$PackageName' => '

The user-specified name of the package.

', ], ], 'PackageSource' => [ 'base' => '

The Amazon S3 location to import the package from.

', 'refs' => [ 'CreatePackageRequest$PackageSource' => '

The Amazon S3 location from which to import the package.

', 'UpdatePackageRequest$PackageSource' => '

Amazon S3 bucket and key for the package.

', ], ], 'PackageStatus' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$PackageStatus' => '

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

', ], ], 'PackageType' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageType' => '

The type of package.

', 'DomainPackageDetails$PackageType' => '

The type of package.

', 'PackageDetails$PackageType' => '

The type of package.

', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$PackageVersion' => '

The current version of the package.

', 'PackageDetails$AvailablePackageVersion' => '

The package version.

', 'PackageVersionHistory$PackageVersion' => '

The package version.

', ], ], 'PackageVersionHistory' => [ 'base' => '

Details about a package version.

', 'refs' => [ 'PackageVersionHistoryList$member' => NULL, ], ], 'PackageVersionHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionHistoryResponse$PackageVersionHistoryList' => '

A list of package versions, along with their creation time and commit message.

', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserPassword' => '

Password for the master user. Only specify if InternalUserDatabaseEnabled is true.

', ], ], 'PluginClassName' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$ClassName' => '

The name of the class to load.

', ], ], 'PluginDescription' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Description' => '

The description of the plugin.

', ], ], 'PluginName' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Name' => '

The name of the plugin.

', ], ], 'PluginProperties' => [ 'base' => '

Basic information about the plugin.

', 'refs' => [ 'PackageDetails$AvailablePluginProperties' => '

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

', 'PackageVersionHistory$PluginProperties' => '

Additional information about plugin properties if the package is a ZIP-PLUGIN package.

', ], ], 'PluginVersion' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Version' => '

The version of the plugin.

', ], ], 'PolicyDocument' => [ 'base' => '

Access policy rules for an Amazon OpenSearch Service domain endpoint. For more information, see Configuring access policies. The maximum size of a policy document is 100 KB.

', 'refs' => [ 'AccessPoliciesStatus$Options' => '

The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.

', 'CreateDomainRequest$AccessPolicies' => '

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

', 'DomainStatus$AccessPolicies' => '

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

', 'UpdateDomainConfigRequest$AccessPolicies' => '

Identity and Access Management (IAM) access policy as a JSON-formatted string.

', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'AuthorizedPrincipal$PrincipalType' => '

The type of principal.

', ], ], 'PurchaseReservedInstanceOfferingRequest' => [ 'base' => '

Container for request parameters to the PurchaseReservedInstanceOffering operation.

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

Represents the output of a PurchaseReservedInstanceOffering operation.

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

Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.

', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$RecurringCharges' => '

The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.

', 'ReservedInstanceOffering$RecurringCharges' => '

The recurring charge to your account, regardless of whether you creates any domains using the offering.

', ], ], 'ReferencePath' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$ReferencePath' => '

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'AWSDomainInformation$Region' => '

The Amazon Web Services Region in which the domain is located.

', ], ], 'RejectInboundConnectionRequest' => [ 'base' => '

Container for the request parameters to the RejectInboundConnection operation.

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

Represents the output of a RejectInboundConnection operation.

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

Container for the request parameters to the RemoveTags operation.

', 'refs' => [], ], 'RequestId' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$MaintenanceId' => '

The ID of the requested action.

', 'GetDomainMaintenanceStatusRequest$MaintenanceId' => '

The request ID of the maintenance action.

', 'StartDomainMaintenanceResponse$MaintenanceId' => '

The request ID of requested action.

', ], ], 'ReservationToken' => [ 'base' => NULL, 'refs' => [ 'PurchaseReservedInstanceOfferingRequest$ReservationName' => '

A customer-specified identifier to track this reservation.

', 'PurchaseReservedInstanceOfferingResponse$ReservationName' => '

The customer-specified identifier used to track this reservation.

', 'ReservedInstance$ReservationName' => '

The customer-specified identifier to track this reservation.

', ], ], 'ReservedInstance' => [ 'base' => '

Details of an OpenSearch Reserved Instance.

', 'refs' => [ 'ReservedInstanceList$member' => NULL, ], ], 'ReservedInstanceList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedInstancesResponse$ReservedInstances' => '

List of Reserved Instances in the current Region.

', ], ], 'ReservedInstanceOffering' => [ 'base' => '

Details of an OpenSearch Reserved Instance offering.

', 'refs' => [ 'ReservedInstanceOfferingList$member' => NULL, ], ], 'ReservedInstanceOfferingList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedInstanceOfferingsResponse$ReservedInstanceOfferings' => '

List of Reserved Instance offerings.

', ], ], 'ReservedInstancePaymentOption' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$PaymentOption' => '

The payment option as defined in the Reserved Instance offering.

', 'ReservedInstanceOffering$PaymentOption' => '

Payment option for the Reserved Instance offering

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

An exception for creating a resource that already exists.

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

An exception for accessing or deleting a resource that doesn\'t exist.

', 'refs' => [], ], 'RevokeVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$RoleArn' => '

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

', 'S3GlueDataCatalog$RoleArn' => '

>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.

', ], ], 'RollbackOnDisable' => [ 'base' => '

The rollback state while disabling Auto-Tune for the domain.

', 'refs' => [ 'AutoTuneOptions$RollbackOnDisable' => '

When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3BucketName' => '

The name of the Amazon S3 bucket containing the package.

', ], ], 'S3GlueDataCatalog' => [ 'base' => '

Information about the Amazon S3 Glue Data Catalog.

', 'refs' => [ 'DataSourceType$S3GlueDataCatalog' => '

An Amazon S3 data source.

', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3Key' => '

Key (file name) of the package.

', ], ], 'SAMLEntityId' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$EntityId' => '

The unique entity ID of the application in the SAML identity provider.

', ], ], 'SAMLIdp' => [ 'base' => '

The SAML identity povider information.

', 'refs' => [ 'SAMLOptionsInput$Idp' => '

The SAML Identity Provider\'s information.

', 'SAMLOptionsOutput$Idp' => '

Describes the SAML identity provider\'s information.

', ], ], 'SAMLMetadata' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$MetadataContent' => '

The metadata of the SAML application, in XML format.

', ], ], 'SAMLOptionsInput' => [ 'base' => '

The SAML authentication configuration for an Amazon OpenSearch Service domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$SAMLOptions' => '

Container for information about the SAML configuration for OpenSearch Dashboards.

', ], ], 'SAMLOptionsOutput' => [ 'base' => '

Describes the SAML application configured for the domain.

', 'refs' => [ 'AdvancedSecurityOptions$SAMLOptions' => '

Container for information about the SAML configuration for OpenSearch Dashboards.

', ], ], 'ScheduleAt' => [ 'base' => NULL, 'refs' => [ 'StartServiceSoftwareUpdateRequest$ScheduleAt' => '

When to start the service software update.

  • 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.

', 'UpdateScheduledActionRequest$ScheduleAt' => '

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.

', ], ], 'ScheduledAction' => [ 'base' => '

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

', 'refs' => [ 'ScheduledActionsList$member' => NULL, 'UpdateScheduledActionResponse$ScheduledAction' => '

Information about the rescheduled action.

', ], ], 'ScheduledActionsList' => [ 'base' => NULL, 'refs' => [ 'ListScheduledActionsResponse$ScheduledActions' => '

A list of actions that are scheduled for the domain.

', ], ], 'ScheduledAutoTuneActionType' => [ 'base' => '

The Auto-Tune action type.

', 'refs' => [ 'ScheduledAutoTuneDetails$ActionType' => '

The type of Auto-Tune action.

', ], ], 'ScheduledAutoTuneDescription' => [ 'base' => '

The description of an Auto-Tune maintenance action that occurs on a domain.

', 'refs' => [ 'ScheduledAutoTuneDetails$Action' => '

A description of the Auto-Tune action.

', ], ], 'ScheduledAutoTuneDetails' => [ 'base' => '

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneDetails$ScheduledAutoTuneDetails' => '

Container for details about a scheduled Auto-Tune action.

', ], ], 'ScheduledAutoTuneSeverityType' => [ 'base' => '

The Auto-Tune action severity.

', 'refs' => [ 'ScheduledAutoTuneDetails$Severity' => '

The severity of the Auto-Tune action. Valid values are LOW, MEDIUM, and HIGH.

', ], ], 'ScheduledBy' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$ScheduledBy' => '

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

', ], ], 'ServiceSoftwareOptions' => [ 'base' => '

The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

', 'refs' => [ 'CancelServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

Container for the state of your domain relative to the latest service software.

', 'DomainStatus$ServiceSoftwareOptions' => '

The current status of the domain\'s service software.

', 'StartServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

The current status of the OpenSearch Service software update.

', ], ], 'ServiceUrl' => [ 'base' => '

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

', 'refs' => [ 'DomainStatus$Endpoint' => '

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

', 'DomainStatus$EndpointV2' => NULL, 'EndpointsMap$value' => NULL, ], ], 'SkipUnavailableStatus' => [ 'base' => '

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.

', 'refs' => [ 'CrossClusterSearchConnectionProperties$SkipUnavailable' => '

The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.

', ], ], 'SlotList' => [ 'base' => NULL, 'refs' => [ 'SlotNotAvailableException$SlotSuggestions' => '

Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.

', ], ], 'SlotNotAvailableException' => [ 'base' => '

An exception for attempting to schedule a domain action during an unavailable time slot.

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

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

', 'refs' => [ 'CreateDomainRequest$SnapshotOptions' => '

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

', 'DomainStatus$SnapshotOptions' => '

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

', 'SnapshotOptionsStatus$Options' => '

The daily snapshot options specified for the domain.

', 'UpdateDomainConfigRequest$SnapshotOptions' => '

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

', ], ], 'SnapshotOptionsStatus' => [ 'base' => '

Container for information about a daily automated snapshot for an OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$SnapshotOptions' => '

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

', ], ], 'SoftwareUpdateOptions' => [ 'base' => '

Options for configuring service software updates for a domain.

', 'refs' => [ 'CreateDomainRequest$SoftwareUpdateOptions' => '

Software update options for the domain.

', 'DomainStatus$SoftwareUpdateOptions' => '

Service software update options for the domain.

', 'SoftwareUpdateOptionsStatus$Options' => '

The service software update options for a domain.

', 'UpdateDomainConfigRequest$SoftwareUpdateOptions' => '

Service software update options for the domain.

', ], ], 'SoftwareUpdateOptionsStatus' => [ 'base' => '

The status of the service software options for a domain.

', 'refs' => [ 'DomainConfig$SoftwareUpdateOptions' => '

Software update options for the domain.

', ], ], 'StartAt' => [ 'base' => NULL, 'refs' => [ 'AutoTuneMaintenanceSchedule$StartAt' => '

The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

', ], ], 'StartDomainMaintenanceRequest' => [ 'base' => '

Container for the parameters to the StartDomainMaintenance operation.

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

The result of a StartDomainMaintenance request that information about the requested action.

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

Container for the request parameters to the StartServiceSoftwareUpdate operation.

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

Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.

', 'refs' => [], ], 'StartTimeHours' => [ 'base' => NULL, 'refs' => [ 'WindowStartTime$Hours' => '

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

', ], ], 'StartTimeMinutes' => [ 'base' => NULL, 'refs' => [ 'WindowStartTime$Minutes' => '

The start minute of the window, in UTC.

', ], ], 'StartTimestamp' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StartTimestamp' => '

UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.

', ], ], 'StorageSubTypeName' => [ 'base' => '

Sub-type of the given EBS storage type. List of available sub-storage options. The instance storage type has no storage sub-type. The ebs storage type has the following valid sub-types:

  • standard

  • gp2

  • gp3

  • io1

', 'refs' => [ 'StorageType$StorageSubTypeName' => '

The storage sub-type, such as gp3 or io1.

', ], ], 'StorageType' => [ 'base' => '

A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.

', 'refs' => [ 'StorageTypeList$member' => NULL, ], ], 'StorageTypeLimit' => [ 'base' => '

Limits that are applicable for the given Amazon OpenSearch Service storage type.

', 'refs' => [ 'StorageTypeLimitList$member' => NULL, ], ], 'StorageTypeLimitList' => [ 'base' => NULL, 'refs' => [ 'StorageType$StorageTypeLimits' => '

Limits that are applicable for the given storage type.

', ], ], 'StorageTypeList' => [ 'base' => NULL, 'refs' => [ 'Limits$StorageTypes' => '

Storage-related attributes that are available for a given instance type.

', ], ], 'StorageTypeName' => [ 'base' => '

The type of storage that the domain uses. Can be one of the following:

instance

Built-in storage available for the instance.

ebs

Elastic Block Storage (EBS) attached to the instance.

', 'refs' => [ 'DomainNodesStatus$StorageType' => '

Indicates if the node has EBS or instance storage.

', 'StorageType$StorageTypeName' => '

The name of the storage type.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceResponse$Message' => '

A message associated with creation of the data source.

', 'AdvancedOptions$key' => NULL, 'AdvancedOptions$value' => NULL, 'AuthorizedPrincipal$Principal' => '

The IAM principal that is allowed access to the domain.

', 'AutoTuneMaintenanceSchedule$CronExpressionForRecurrence' => '

A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

', 'AutoTuneOptionsOutput$ErrorMessage' => '

Any errors that occurred while enabling or disabling Auto-Tune.

', 'AutoTuneStatus$ErrorMessage' => '

Any errors that occurred while enabling or disabling Auto-Tune.

', '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. Make the call again using the returned token to retrieve the next page.

', 'DescribeReservedInstancesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'DryRunProgressStatus$DryRunStatus' => '

The current status of the dry run.

', 'DryRunProgressStatus$CreationDate' => '

The timestamp when the dry run was initiated.

', 'DryRunProgressStatus$UpdateDate' => '

The timestamp when the dry run was last updated.

', 'EndpointsMap$key' => NULL, 'GetPackageVersionHistoryResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'GetUpgradeHistoryResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListDomainsForPackageResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListPackagesForDomainResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'RecurringCharge$RecurringChargeFrequency' => '

The frequency of the recurring charge.

', 'ReservedInstance$ReservedInstanceOfferingId' => '

The unique identifier of the Reserved Instance offering.

', 'ReservedInstance$CurrencyCode' => '

The currency code for the offering.

', 'ReservedInstance$State' => '

The state of the Reserved Instance.

', 'ReservedInstanceOffering$CurrencyCode' => '

The currency code for the Reserved Instance offering.

', 'SAMLOptionsInput$SubjectKey' => '

Element of the SAML assertion to use for the user name. Default is NameID.

', 'SAMLOptionsInput$RolesKey' => '

Element of the SAML assertion to use for backend roles. Default is roles.

', 'SAMLOptionsOutput$SubjectKey' => '

The key used for matching the SAML subject attribute.

', 'SAMLOptionsOutput$RolesKey' => '

The key used for matching the SAML roles attribute.

', 'ScheduledAction$Id' => '

The unique identifier of the scheduled action.

', 'ScheduledAction$Description' => '

A description of the action to be taken.

', 'ServiceSoftwareOptions$CurrentVersion' => '

The current service software version present on the domain.

', 'ServiceSoftwareOptions$NewVersion' => '

The new service software version, if one is available.

', 'ServiceSoftwareOptions$Description' => '

A description of the service software update status.

', 'StringList$member' => NULL, 'UpdateDataSourceResponse$Message' => '

A message associated with the updated data source.

', 'UpdateScheduledActionRequest$ActionID' => '

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

', 'UpgradeDomainResponse$UpgradeId' => '

The unique identifier of the domain upgrade.

', 'VPCDerivedInfo$VPCId' => '

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

', 'ValidationFailure$Code' => '

The error code of the failure.

', 'ValidationFailure$Message' => '

A message corresponding to the failure.

', 'VpcEndpointError$ErrorMessage' => '

A message describing the error.

', 'VpcEndpointSummary$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$PendingProperties' => '

The list of properties in the domain configuration change that are still pending.

', 'ChangeProgressStatusDetails$CompletedProperties' => '

The list of properties in the domain configuration change that have completed.

', 'RemoveTagsRequest$TagKeys' => '

The list of tag keys to remove from the domain.

', 'VPCDerivedInfo$SubnetIds' => '

A list of subnet IDs associated with the VPC endpoints for the domain.

', 'VPCDerivedInfo$AvailabilityZones' => '

The list of Availability Zones associated with the VPC subnets.

', 'VPCDerivedInfo$SecurityGroupIds' => '

The list of security group IDs associated with the VPC endpoints for the domain.

', 'VPCOptions$SubnetIds' => '

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

', 'VPCOptions$SecurityGroupIds' => '

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

', ], ], 'TLSSecurityPolicy' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$TLSSecurityPolicy' => '

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:

  • 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

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

A tag (key-value pair) for an Amazon OpenSearch Service resource.

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

A string between 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they\'re attached.

', 'refs' => [ 'Tag$Key' => '

The tag key. Tag keys must be unique for the domain to which they are attached.

', ], ], 'TagList' => [ 'base' => '

A list of tags attached to a domain.

', 'refs' => [ 'AddTagsRequest$TagList' => '

List of resource tags.

', 'CreateDomainRequest$TagList' => '

List of tags to add to the domain upon creation.

', 'ListTagsResponse$TagList' => '

List of resource tags associated with the specified domain.

', ], ], 'TagValue' => [ 'base' => '

A string between 0 to 256 characters that specifies the value for a tag. Tag values can be null and don\'t have to be unique in a tag set.

', 'refs' => [ 'Tag$Value' => '

The value assigned to the corresponding tag key. Tag values can be null and don\'t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

', ], ], 'TimeUnit' => [ 'base' => '

The unit of a maintenance schedule duration. Valid value is HOUR.

', 'refs' => [ 'Duration$Unit' => '

The unit of measurement for the duration of a maintenance schedule.

', ], ], 'TotalNumberOfStages' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$TotalNumberOfStages' => '

The total number of stages required for the configuration change.

', ], ], 'UIntValue' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$UpdateVersion' => '

The latest version of the Auto-Tune options.

', 'OptionStatus$UpdateVersion' => '

The latest version of the entity.

', ], ], 'UncompressedPluginSizeInBytes' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$UncompressedSizeInBytes' => '

The uncompressed size of the plugin.

', ], ], 'UpdateDataSourceRequest' => [ 'base' => '

Container for the parameters to the UpdateDataSource operation.

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

The result of an UpdateDataSource operation.

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

Container for the request parameters to the UpdateDomain operation.

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

The results of an UpdateDomain request. Contains the status of the domain being updated.

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

Container for request parameters to the UpdatePackage operation.

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

Container for the response returned by the UpdatePackage operation.

', 'refs' => [], ], 'UpdateScheduledActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateScheduledActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTimestamp' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$CreationDate' => '

Date and time when Auto-Tune was enabled for the domain.

', 'AutoTuneStatus$UpdateDate' => '

Date and time when the Auto-Tune options were last updated for the domain.

', 'ChangeProgressStatusDetails$StartTime' => '

The time at which the configuration change is made on the domain.

', 'DomainMaintenanceDetails$CreatedAt' => '

The time at which the action was created.

', 'DomainMaintenanceDetails$UpdatedAt' => '

The time at which the action was updated.

', 'GetDomainMaintenanceStatusResponse$CreatedAt' => '

The time at which the action was created.

', 'GetDomainMaintenanceStatusResponse$UpdatedAt' => '

The time at which the action was updated.

', 'OptionStatus$CreationDate' => '

The timestamp when the entity was created.

', 'OptionStatus$UpdateDate' => '

The timestamp of the last time the entity was updated.

', 'ReservedInstance$StartTime' => '

The date and time when the reservation was purchased.

', ], ], 'UpdateVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpgradeDomainRequest' => [ 'base' => '

Container for the request parameters to the UpgradeDomain operation.

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

Container for the response returned by UpgradeDomain operation.

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

History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.

', 'refs' => [ 'UpgradeHistoryList$member' => NULL, ], ], 'UpgradeHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeHistoryResponse$UpgradeHistories' => '

A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

', ], ], 'UpgradeName' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeName' => '

A string that describes the update.

', 'UpgradeHistory$UpgradeName' => '

A string that describes the upgrade.

', ], ], 'UpgradeStatus' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$StepStatus' => '

The status of the current step that an upgrade is on.

', 'UpgradeHistory$UpgradeStatus' => '

The current status of the upgrade. The status can take one of the following values:

  • In Progress

  • Succeeded

  • Succeeded with Issues

  • Failed

', 'UpgradeStepItem$UpgradeStepStatus' => '

The current status of the upgrade. The status can take one of the following values:

  • In Progress

  • Succeeded

  • Succeeded with Issues

  • Failed

', ], ], 'UpgradeStep' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeStep' => '

One of three steps that an upgrade or upgrade eligibility check goes through.

', 'UpgradeStepItem$UpgradeStep' => '

One of three steps that an upgrade or upgrade eligibility check goes through:

  • PreUpgradeCheck

  • Snapshot

  • Upgrade

', ], ], 'UpgradeStepItem' => [ 'base' => '

Represents a single step of an upgrade or upgrade eligibility check workflow.

', 'refs' => [ 'UpgradeStepsList$member' => NULL, ], ], 'UpgradeStepsList' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StepsList' => '

A list of each step performed as part of a specific upgrade or upgrade eligibility check.

', ], ], 'UserPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$UserPoolId' => '

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

', ], ], 'Username' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserName' => '

User name for the master user. Only specify if InternalUserDatabaseEnabled is true.

', 'SAMLOptionsInput$MasterUserName' => '

The SAML master user name, which is stored in the domain\'s internal user database.

', ], ], 'VPCDerivedInfo' => [ 'base' => '

Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC). For more information, see Launching your Amazon OpenSearch Service domains using a VPC. This information only exists if the domain was created with VPCOptions.

', 'refs' => [ 'DomainStatus$VPCOptions' => '

The VPC configuration for the domain.

', 'VPCDerivedInfoStatus$Options' => '

The VPC options for the specified domain.

', 'VpcEndpoint$VpcOptions' => '

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

', ], ], 'VPCDerivedInfoStatus' => [ 'base' => '

Status of the VPC options for a specified domain.

', 'refs' => [ 'DomainConfig$VPCOptions' => '

The current VPC options for the domain and the status of any updates to their configuration.

', ], ], 'VPCOptions' => [ 'base' => '

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'refs' => [ 'CreateDomainRequest$VPCOptions' => '

Container for the values required to configure VPC access domains. If you don\'t specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'CreateVpcEndpointRequest$VpcOptions' => '

Options to specify the subnets and security groups for the endpoint.

', 'UpdateDomainConfigRequest$VPCOptions' => '

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'UpdateVpcEndpointRequest$VpcOptions' => '

The security groups and/or subnets to add, remove, or modify.

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

An exception for accessing or deleting a resource that doesn\'t exist.

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

A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.

', 'refs' => [ 'ValidationFailures$member' => NULL, ], ], 'ValidationFailures' => [ 'base' => NULL, 'refs' => [ 'DryRunProgressStatus$ValidationFailures' => '

Any validation failures that occurred as a result of the dry run.

', ], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

One or more values for the filter.

', ], ], 'VersionList' => [ 'base' => '

List of supported OpenSearch versions.

', 'refs' => [ 'CompatibleVersionsMap$TargetVersions' => '

The possible versions that you can upgrade the domain to.

', 'ListVersionsResponse$Versions' => '

A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

', ], ], 'VersionStatus' => [ 'base' => '

The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EngineVersion' => '

The OpenSearch or Elasticsearch version that the domain is running.

', ], ], 'VersionString' => [ 'base' => NULL, 'refs' => [ 'CompatibleVersionsMap$SourceVersion' => '

The current version that the OpenSearch Service domain is running.

', 'CreateDomainRequest$EngineVersion' => '

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'DescribeInstanceTypeLimitsRequest$EngineVersion' => '

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', 'DomainStatus$EngineVersion' => '

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

', 'ListInstanceTypeDetailsRequest$EngineVersion' => '

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', 'UpgradeDomainRequest$TargetVersion' => '

OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

', 'UpgradeDomainResponse$TargetVersion' => '

OpenSearch or Elasticsearch version that the domain was upgraded to.

', 'VersionList$member' => NULL, 'VersionStatus$Options' => '

The OpenSearch or Elasticsearch version for the specified domain.

', ], ], 'VolumeSize' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$StorageSize' => '

The storage size of the node, in GiB.

', ], ], 'VolumeType' => [ 'base' => '

The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage.

', 'refs' => [ 'DomainNodesStatus$StorageVolumeType' => '

If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable for data nodes.

', 'EBSOptions$VolumeType' => '

Specifies the type of EBS volumes attached to data nodes.

', ], ], 'VpcEndpoint' => [ 'base' => '

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

', 'refs' => [ 'CreateVpcEndpointResponse$VpcEndpoint' => '

Information about the newly created VPC endpoint.

', 'UpdateVpcEndpointResponse$VpcEndpoint' => '

The endpoint to be updated.

', 'VpcEndpoints$member' => NULL, ], ], 'VpcEndpointError' => [ 'base' => '

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'VpcEndpointErrorList$member' => NULL, ], ], 'VpcEndpointErrorCode' => [ 'base' => NULL, 'refs' => [ 'VpcEndpointError$ErrorCode' => '

The code associated with the error.

', ], ], 'VpcEndpointErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpointErrors' => '

Any errors associated with the request.

', ], ], 'VpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'DeleteVpcEndpointRequest$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'UpdateVpcEndpointRequest$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpoint$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpointError$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpointIdList$member' => NULL, 'VpcEndpointSummary$VpcEndpointId' => '

The unique identifier of the endpoint.

', ], ], 'VpcEndpointIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsRequest$VpcEndpointIds' => '

The unique identifiers of the endpoints to get information about.

', ], ], 'VpcEndpointStatus' => [ 'base' => NULL, 'refs' => [ 'VpcEndpoint$Status' => '

The current status of the endpoint.

', 'VpcEndpointSummary$Status' => '

The current status of the endpoint.

', ], ], 'VpcEndpointSummary' => [ 'base' => '

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'DeleteVpcEndpointResponse$VpcEndpointSummary' => '

Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).

', 'VpcEndpointSummaryList$member' => NULL, ], ], 'VpcEndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointsForDomainResponse$VpcEndpointSummaryList' => '

Information about each endpoint associated with the domain.

', 'ListVpcEndpointsResponse$VpcEndpointSummaryList' => '

Information about each endpoint.

', ], ], 'VpcEndpoints' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpoints' => '

Information about each requested VPC endpoint.

', ], ], 'WindowStartTime' => [ 'base' => '

The desired start time for an off-peak maintenance window.

', 'refs' => [ 'OffPeakWindow$WindowStartTime' => '

A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can\'t specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

', ], ], 'ZoneAwarenessConfig' => [ 'base' => '

The zone awareness configuration for an Amazon OpenSearch Service domain.

', 'refs' => [ 'ClusterConfig$ZoneAwarenessConfig' => '

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

', ], ], 'ZoneStatus' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$ZoneStatus' => '

The current state of the Availability Zone. Current options are Active and StandBy.

  • 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.

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

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains.

For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide . The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs. 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.

', 'CancelServiceSoftwareUpdate' => '

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain\'s UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

', 'CreateDomain' => '

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'CreateOutboundConnection' => '

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'CreatePackage' => '

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

', 'CreateVpcEndpoint' => '

Creates an Amazon OpenSearch Service-managed VPC endpoint.

', 'DeleteDataSource' => '

Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

', 'DeleteDomain' => '

Deletes an Amazon OpenSearch Service domain and all of its data. You can\'t recover a domain after you delete it.

', 'DeleteInboundConnection' => '

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DeleteOutboundConnection' => '

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DeletePackage' => '

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

', 'DeleteVpcEndpoint' => '

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'DescribeDomain' => '

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

', 'DescribeDomainAutoTunes' => '

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'DescribeDomainChangeProgress' => '

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

', 'DescribeDomainConfig' => '

Returns the configuration of an Amazon OpenSearch Service domain.

', 'DescribeDomainHealth' => '

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

', 'DescribeDomainNodes' => '

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

', 'DescribeDomains' => '

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

', 'DescribeDryRunProgress' => '

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

', 'DescribeInboundConnections' => '

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DescribeInstanceTypeLimits' => '

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

', 'DescribeOutboundConnections' => '

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'DescribePackages' => '

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

', 'DescribeReservedInstanceOfferings' => '

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

', 'DescribeReservedInstances' => '

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

', 'DescribeVpcEndpoints' => '

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

', 'DissociatePackage' => '

Removes a package from the specified Amazon OpenSearch Service domain. The package can\'t be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

', 'GetCompatibleVersions' => '

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', 'GetDataSource' => '

Retrieves information about a direct query data source.

', 'GetDomainMaintenanceStatus' => '

The status of the maintenance action.

', 'GetPackageVersionHistory' => '

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.

', 'GetUpgradeHistory' => '

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

', 'GetUpgradeStatus' => '

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

', 'ListDataSources' => '

Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

', 'ListDomainMaintenances' => '

A list of maintenance actions for the domain.

', 'ListDomainNames' => '

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

', 'ListDomainsForPackage' => '

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

', 'ListInstanceTypeDetails' => '

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

', 'ListPackagesForDomain' => '

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

', 'ListScheduledActions' => '

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

', 'ListTags' => '

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

', 'ListVersions' => '

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

', 'ListVpcEndpointAccess' => '

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'ListVpcEndpoints' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

', 'ListVpcEndpointsForDomain' => '

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

', 'PurchaseReservedInstanceOffering' => '

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

', 'RejectInboundConnection' => '

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

', 'RemoveTags' => '

Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

', 'RevokeVpcEndpointAccess' => '

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

', 'StartDomainMaintenance' => '

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

', 'StartServiceSoftwareUpdate' => '

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

', 'UpdateDataSource' => '

Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

', 'UpdateDomainConfig' => '

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

', 'UpdatePackage' => '

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

', 'UpdateScheduledAction' => '

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

', 'UpdateVpcEndpoint' => '

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

', 'UpgradeDomain' => '

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

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

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.

', 'refs' => [ 'AddTagsRequest$ARN' => '

Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.

', 'DomainEndpointOptions$CustomEndpointCertificateArn' => '

The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

', 'DomainStatus$ARN' => '

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

', 'ListTagsRequest$ARN' => '

Amazon Resource Name (ARN) for the domain to view tags for.

', 'MasterUserOptions$MasterUserARN' => '

Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.

', 'RemoveTagsRequest$ARN' => '

The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.

', ], ], 'AWSAccount' => [ 'base' => NULL, 'refs' => [ 'AuthorizeVpcEndpointAccessRequest$Account' => '

The Amazon Web Services account ID to grant access to.

', 'RevokeVpcEndpointAccessRequest$Account' => '

The account ID to revoke access from.

', 'VpcEndpoint$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'AWSDomainInformation' => [ 'base' => '

Information about an Amazon OpenSearch Service domain.

', 'refs' => [ 'DomainInformationContainer$AWSDomainInformation' => '

Information about an Amazon OpenSearch Service domain.

', ], ], 'AcceptInboundConnectionRequest' => [ 'base' => '

Container for the parameters to the AcceptInboundConnection operation.

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

Contains details about the accepted inbound connection.

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

An error occurred because you don\'t have permissions to access the resource.

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

The configured access rules for the domain\'s search endpoint, and the current status of those rules.

', 'refs' => [ 'DomainConfig$AccessPolicies' => '

Specifies the access policies for the domain.

', ], ], 'ActionSeverity' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Severity' => '

The severity of the action.

', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Status' => '

The current status of the scheduled action.

', ], ], 'ActionType' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Type' => '

The type of action that will be taken on the domain.

', 'UpdateScheduledActionRequest$ActionType' => '

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

', ], ], 'AddDataSourceRequest' => [ 'base' => '

Container for the parameters to the AddDataSource operation.

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

The result of an AddDataSource operation.

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

Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.

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

List of limits that are specific to a given instance type.

', 'refs' => [ 'AdditionalLimitList$member' => NULL, ], ], 'AdditionalLimitList' => [ 'base' => NULL, 'refs' => [ 'Limits$AdditionalLimits' => '

List of additional limits that are specific to a given instance type for each of its instance roles.

', ], ], 'AdvancedOptions' => [ 'base' => '

Exposes native OpenSearch configuration values from opensearch.yml. The following advanced options are available:

  • 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.

', 'UpgradeDomainResponse$AdvancedOptions' => '

The advanced options configuration for the domain.

', ], ], 'AdvancedOptionsStatus' => [ 'base' => '

Status of the advanced options for the specified domain. The following options are available:

  • "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.

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

Container for the response returned by the AssociatePackage operation.

', 'refs' => [], ], 'AuthorizeVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizeVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizedPrincipal' => [ 'base' => '

Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

', 'refs' => [ 'AuthorizeVpcEndpointAccessResponse$AuthorizedPrincipal' => '

Information about the Amazon Web Services account or service that was provided access to the domain.

', 'AuthorizedPrincipalList$member' => NULL, ], ], 'AuthorizedPrincipalList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointAccessResponse$AuthorizedPrincipalList' => '

A list of IAM principals that can currently access the domain.

', ], ], 'AutoTune' => [ 'base' => '

Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneList$member' => NULL, ], ], 'AutoTuneDate' => [ 'base' => '

The timestamp of the Auto-Tune action scheduled for the domain.

', 'refs' => [ 'ScheduledAutoTuneDetails$Date' => '

The date and time when the Auto-Tune action is scheduled for the domain.

', ], ], 'AutoTuneDesiredState' => [ 'base' => '

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

', 'refs' => [ 'AutoTuneOptions$DesiredState' => '

Whether Auto-Tune is enabled or disabled.

', 'AutoTuneOptionsInput$DesiredState' => '

Whether Auto-Tune is enabled or disabled.

', ], ], 'AutoTuneDetails' => [ 'base' => '

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTune$AutoTuneDetails' => '

Details about an Auto-Tune action.

', ], ], 'AutoTuneList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainAutoTunesResponse$AutoTunes' => '

The list of setting adjustments that Auto-Tune has made to the domain.

', ], ], 'AutoTuneMaintenanceSchedule' => [ 'base' => '

This object is deprecated. Use the domain\'s off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows.

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneMaintenanceScheduleList$member' => NULL, ], ], 'AutoTuneMaintenanceScheduleList' => [ 'base' => NULL, 'refs' => [ 'AutoTuneOptions$MaintenanceSchedules' => '

DEPRECATED. Use off-peak window instead.

A list of maintenance schedules during which Auto-Tune can deploy changes.

', 'AutoTuneOptionsInput$MaintenanceSchedules' => '

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.

', ], ], 'AutoTuneOptions' => [ 'base' => '

Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsStatus$Options' => '

Auto-Tune settings for updating a domain.

', 'UpdateDomainConfigRequest$AutoTuneOptions' => '

Options for Auto-Tune.

', ], ], 'AutoTuneOptionsInput' => [ 'base' => '

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service

', 'refs' => [ 'CreateDomainRequest$AutoTuneOptions' => '

Options for Auto-Tune.

', ], ], 'AutoTuneOptionsOutput' => [ 'base' => '

The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.

', 'refs' => [ 'DomainStatus$AutoTuneOptions' => '

Auto-Tune settings for the domain.

', ], ], 'AutoTuneOptionsStatus' => [ 'base' => '

The Auto-Tune status for the domain.

', 'refs' => [ 'DomainConfig$AutoTuneOptions' => '

Container for Auto-Tune settings for the domain.

', ], ], 'AutoTuneState' => [ 'base' => '

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsOutput$State' => '

The current state of Auto-Tune on the domain.

', 'AutoTuneStatus$State' => '

The current state of Auto-Tune on the domain.

', ], ], 'AutoTuneStatus' => [ 'base' => '

The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneOptionsStatus$Status' => '

The current status of Auto-Tune for a domain.

', ], ], 'AutoTuneType' => [ 'base' => '

Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

', 'refs' => [ 'AutoTune$AutoTuneType' => '

The type of Auto-Tune action.

', ], ], 'AvailabilityZone' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$AvailabilityZoneName' => '

The name of the Availability Zone.

', 'AvailabilityZoneList$member' => NULL, 'DomainNodesStatus$AvailabilityZone' => '

The Availability Zone of the node.

', ], ], 'AvailabilityZoneInfo' => [ 'base' => '

Information about an Availability Zone on a domain.

', 'refs' => [ 'AvailabilityZoneInfoList$member' => NULL, ], ], 'AvailabilityZoneInfoList' => [ 'base' => NULL, 'refs' => [ 'EnvironmentInfo$AvailabilityZoneInformation' => '

A list of AvailabilityZoneInfo for the domain.

', ], ], 'AvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'InstanceTypeDetails$AvailabilityZones' => '

The supported Availability Zones for the instance type.

', ], ], 'BackendRole' => [ 'base' => NULL, 'refs' => [ 'SAMLOptionsInput$MasterBackendRole' => '

The backend role that the SAML master user is mapped to.

', ], ], 'BaseException' => [ 'base' => '

An error occurred while processing the request.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$Enabled' => '

True if fine-grained access control is enabled.

', 'AdvancedSecurityOptions$InternalUserDatabaseEnabled' => '

True if the internal user database is enabled.

', 'AdvancedSecurityOptions$AnonymousAuthEnabled' => '

True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

', 'AdvancedSecurityOptionsInput$Enabled' => '

True to enable fine-grained access control.

', 'AdvancedSecurityOptionsInput$InternalUserDatabaseEnabled' => '

True to enable the internal user database.

', 'AdvancedSecurityOptionsInput$AnonymousAuthEnabled' => '

True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

', 'AutoTuneOptions$UseOffPeakWindow' => '

Whether to use the domain\'s off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

', 'AutoTuneOptionsInput$UseOffPeakWindow' => '

Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain\'s configured daily off-peak window.

', 'AutoTuneOptionsOutput$UseOffPeakWindow' => '

Whether the domain\'s off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

', 'AutoTuneStatus$PendingDeletion' => '

Indicates whether the domain is being deleted.

', 'ClusterConfig$DedicatedMasterEnabled' => '

Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

', 'ClusterConfig$ZoneAwarenessEnabled' => '

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

', 'ClusterConfig$WarmEnabled' => '

Whether to enable warm storage for the cluster.

', 'ClusterConfig$MultiAZWithStandbyEnabled' => '

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

', 'CognitoOptions$Enabled' => '

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

', 'ColdStorageOptions$Enabled' => '

Whether to enable or disable cold storage on the domain.

', 'DescribeDomainHealthResponse$DedicatedMaster' => '

A boolean that indicates if dedicated master nodes are activated for the domain.

', 'DescribeDryRunProgressRequest$LoadDryRunConfig' => '

Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you\'re planning to make on the domain.

', 'DomainEndpointOptions$EnforceHTTPS' => '

True to require that all traffic to the domain arrive over HTTPS.

', 'DomainEndpointOptions$CustomEndpointEnabled' => '

Whether to enable a custom endpoint for the domain.

', 'DomainStatus$Created' => '

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

', 'DomainStatus$Deleted' => '

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

', 'DomainStatus$Processing' => '

The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

', 'DomainStatus$UpgradeProcessing' => '

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

', 'EBSOptions$EBSEnabled' => '

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

', 'EncryptionAtRestOptions$Enabled' => '

True to enable encryption at rest.

', 'InstanceTypeDetails$EncryptionEnabled' => '

Whether encryption at rest and node-to-node encryption are supported for the instance type.

', 'InstanceTypeDetails$CognitoEnabled' => '

Whether Amazon Cognito access is supported for the instance type.

', 'InstanceTypeDetails$AppLogsEnabled' => '

Whether logging is supported for the instance type.

', 'InstanceTypeDetails$AdvancedSecurityEnabled' => '

Whether fine-grained access control is supported for the instance type.

', 'InstanceTypeDetails$WarmEnabled' => '

Whether UltraWarm is supported for the instance type.

', 'ListInstanceTypeDetailsRequest$RetrieveAZs' => '

An optional parameter that specifies the Availability Zones for the domain.

', 'LogPublishingOption$Enabled' => '

Whether the log should be published.

', 'NodeToNodeEncryptionOptions$Enabled' => '

True to enable node-to-node encryption.

', 'OffPeakWindowOptions$Enabled' => '

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can\'t disable the off-peak window after it\'s enabled for a domain.

', 'OptionStatus$PendingDeletion' => '

Indicates whether the entity is being deleted.

', 'SAMLOptionsInput$Enabled' => '

True to enable SAML authentication for a domain.

', 'SAMLOptionsOutput$Enabled' => '

True if SAML is enabled.

', 'ScheduledAction$Mandatory' => '

Whether the action is required or optional.

', 'ScheduledAction$Cancellable' => '

Whether or not the scheduled action is cancellable.

', 'ServiceSoftwareOptions$UpdateAvailable' => '

True if you\'re able to update your service software version. False if you can\'t update your service software version.

', 'ServiceSoftwareOptions$Cancellable' => '

True if you\'re able to cancel your service software version update. False if you can\'t cancel your service software update.

', 'ServiceSoftwareOptions$OptionalDeployment' => '

True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

', 'SoftwareUpdateOptions$AutoSoftwareUpdateEnabled' => '

Whether automatic service software updates are enabled for the domain.

', 'UpgradeDomainRequest$PerformCheckOnly' => '

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

', 'UpgradeDomainResponse$PerformCheckOnly' => '

When true, indicates that an upgrade eligibility check was performed.

', ], ], 'CancelServiceSoftwareUpdateRequest' => [ 'base' => '

Container for the request parameters to cancel a service software update.

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

Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.

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

Container for information about a configuration change happening on a domain.

', 'refs' => [ 'DomainConfig$ChangeProgressDetails' => '

Container for information about the progress of an existing configuration change.

', 'DomainStatus$ChangeProgressDetails' => '

Information about a configuration change happening on the domain.

', 'UpgradeDomainResponse$ChangeProgressDetails' => '

Container for information about a configuration change happening on a domain.

', ], ], 'ChangeProgressStage' => [ 'base' => '

Progress details for each stage of a domain update.

', 'refs' => [ 'ChangeProgressStageList$member' => NULL, ], ], 'ChangeProgressStageList' => [ 'base' => '

The list of progress stages of a specific domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$ChangeProgressStages' => '

The specific stages that the domain is going through to perform the configuration change.

', ], ], 'ChangeProgressStageName' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Name' => '

The name of the stage.

', ], ], 'ChangeProgressStageStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => '

The status of the stage.

', ], ], 'ChangeProgressStatusDetails' => [ 'base' => '

The progress details of a specific domain configuration change.

', 'refs' => [ 'DescribeDomainChangeProgressResponse$ChangeProgressStatus' => '

Container for information about the stages of a configuration change happening on a domain.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$ClientToken' => '

Unique, case-sensitive identifier to ensure idempotency of the request.

', ], ], 'CloudWatchLogsLogGroupArn' => [ 'base' => '

ARN of the Cloudwatch log group to publish logs to.

', 'refs' => [ 'LogPublishingOption$CloudWatchLogsLogGroupArn' => '

The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

', ], ], 'ClusterConfig' => [ 'base' => '

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'refs' => [ 'ClusterConfigStatus$Options' => '

Cluster configuration options for the specified domain.

', 'CreateDomainRequest$ClusterConfig' => '

Container for the cluster configuration of a domain.

', 'DomainStatus$ClusterConfig' => '

Container for the cluster configuration of the domain.

', 'UpdateDomainConfigRequest$ClusterConfig' => '

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

', ], ], 'ClusterConfigStatus' => [ 'base' => '

The cluster configuration status for a domain.

', 'refs' => [ 'DomainConfig$ClusterConfig' => '

Container for the cluster configuration of a the domain.

', ], ], 'CognitoOptions' => [ 'base' => '

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

', 'refs' => [ 'CognitoOptionsStatus$Options' => '

Cognito options for the specified domain.

', 'CreateDomainRequest$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

', 'DomainStatus$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

', 'UpdateDomainConfigRequest$CognitoOptions' => '

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

', ], ], 'CognitoOptionsStatus' => [ 'base' => '

The status of the Cognito options for the specified domain.

', 'refs' => [ 'DomainConfig$CognitoOptions' => '

Container for Amazon Cognito options for the domain.

', ], ], 'ColdStorageOptions' => [ 'base' => '

Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.

', 'refs' => [ 'ClusterConfig$ColdStorageOptions' => '

Container for cold storage configuration options.

', ], ], 'CommitMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionHistory$CommitMessage' => '

A message associated with the package version when it was uploaded.

', 'UpdatePackageRequest$CommitMessage' => '

Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

', ], ], 'CompatibleVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetCompatibleVersionsResponse$CompatibleVersions' => '

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', ], ], 'CompatibleVersionsMap' => [ 'base' => '

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

', 'refs' => [ 'CompatibleVersionsList$member' => NULL, ], ], '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.

', 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionMode' => '

The connection mode.

', 'CreateOutboundConnectionResponse$ConnectionMode' => '

The connection mode.

', 'InboundConnection$ConnectionMode' => '

The connection mode.

', 'OutboundConnection$ConnectionMode' => '

The connection mode.

', ], ], 'ConnectionProperties' => [ 'base' => '

The connection properties of an outbound connection.

', 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionProperties' => '

The ConnectionProperties for the outbound connection.

', 'CreateOutboundConnectionResponse$ConnectionProperties' => '

The ConnectionProperties for the newly created connection.

', 'OutboundConnection$ConnectionProperties' => '

Properties for the outbound connection.

', ], ], 'ConnectionStatusMessage' => [ 'base' => NULL, 'refs' => [ 'InboundConnectionStatus$Message' => '

Information about the connection.

', 'OutboundConnectionStatus$Message' => '

Verbose information for the outbound connection.

', ], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => '

The result of a CreateDomain operation. Contains the status of the newly created domain.

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

Container for the parameters to the CreateOutboundConnection operation.

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

The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.

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

Container for request parameters to the CreatePackage operation.

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

Container for the response returned by the CreatePackage operation.

', 'refs' => [], ], 'CreateVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatedAt' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$CreatedAt' => '

The timestamp when the package was created.

', 'PackageVersionHistory$CreatedAt' => '

The date and time when the package was created.

', ], ], 'CrossClusterSearchConnectionProperties' => [ 'base' => '

Cross-cluster search specific connection properties.

', 'refs' => [ 'ConnectionProperties$CrossClusterSearch' => '

The connection properties for cross cluster search.

', ], ], 'DataSourceDescription' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceRequest$Description' => '

A description of the data source.

', 'DataSourceDetails$Description' => '

A description of the data source.

', 'GetDataSourceResponse$Description' => '

A description of the data source.

', 'UpdateDataSourceRequest$Description' => '

A new description of the data source.

', ], ], 'DataSourceDetails' => [ 'base' => '

Details about a direct-query data source.

', 'refs' => [ 'DataSourceList$member' => NULL, ], ], 'DataSourceList' => [ 'base' => NULL, 'refs' => [ 'ListDataSourcesResponse$DataSources' => '

A list of data sources associated with specified domain.

', ], ], 'DataSourceName' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceRequest$Name' => '

A name for the data source.

', 'DataSourceDetails$Name' => '

The name of the data source.

', 'DeleteDataSourceRequest$Name' => '

The name of the data source to delete.

', 'GetDataSourceRequest$Name' => '

The name of the data source to get information about.

', 'GetDataSourceResponse$Name' => '

The name of the data source.

', 'UpdateDataSourceRequest$Name' => '

The name of the data source to modify.

', ], ], 'DataSourceType' => [ 'base' => '

The type of data source.

', 'refs' => [ 'AddDataSourceRequest$DataSourceType' => '

The type of data source.

', 'DataSourceDetails$DataSourceType' => '

The type of data source.

', 'GetDataSourceResponse$DataSourceType' => '

The type of data source.

', 'UpdateDataSourceRequest$DataSourceType' => '

The type of data source.

', ], ], 'DeleteDataSourceRequest' => [ 'base' => '

Container for the parameters to the DeleteDataSource operation.

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

The result of a GetDataSource operation.

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

Container for the parameters to the DeleteDomain operation.

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

The results of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.

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

Container for the parameters to the DeleteInboundConnection operation.

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

The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.

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

Container for the parameters to the DeleteOutboundConnection operation.

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

Details about the deleted outbound connection.

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

Deletes a package from OpenSearch Service. The package can\'t be associated with any OpenSearch Service domain.

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

Container for the response parameters to the DeletePackage operation.

', 'refs' => [], ], 'DeleteVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DependencyFailureException' => [ 'base' => '

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

', 'refs' => [], ], 'DeploymentCloseDateTimeStamp' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$AutomatedUpdateDate' => '

The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

', ], ], 'DeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$UpdateStatus' => '

The status of your service software update.

', ], ], 'DeploymentType' => [ 'base' => NULL, 'refs' => [ 'DryRunResults$DeploymentType' => '

Specifies the way in which OpenSearch Service will apply an update. Possible values are:

  • 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.

', ], ], 'DescribeDomainAutoTunesRequest' => [ 'base' => '

Container for the parameters to the DescribeDomainAutoTunes operation.

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

The result of a DescribeDomainAutoTunes request.

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

Container for the parameters to the DescribeDomainChangeProgress operation.

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

The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.

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

Container for the parameters to the DescribeDomainConfig operation.

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

Contains the configuration information of the requested domain.

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

Container for the parameters to the DescribeDomainHealth operation.

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

The result of a DescribeDomainHealth request. Contains health information for the requested domain.

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

Container for the parameters to the DescribeDomainNodes operation.

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

The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.

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

Container for the parameters to the DescribeDomain operation.

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

Contains the status of the domain specified in the request.

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

Container for the parameters to the DescribeDomains operation.

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

Contains the status of the specified domains or all domains owned by the account.

', 'refs' => [], ], 'DescribeDryRunProgressRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDryRunProgressResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInboundConnectionsRequest' => [ 'base' => '

Container for the parameters to the DescribeInboundConnections operation.

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

Contains a list of connections matching the filter criteria.

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

Container for the parameters to the DescribeInstanceTypeLimits operation.

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

Container for the parameters received from the DescribeInstanceTypeLimits operation.

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

Container for the parameters to the DescribeOutboundConnections operation.

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

Contains a list of connections matching the filter criteria.

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

A filter to apply to the DescribePackage response.

', 'refs' => [ 'DescribePackagesFilterList$member' => NULL, ], ], 'DescribePackagesFilterList' => [ 'base' => '

A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.

', 'refs' => [ 'DescribePackagesRequest$Filters' => '

Only returns packages that match the DescribePackagesFilterList values.

', ], ], 'DescribePackagesFilterName' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Name' => '

Any field from PackageDetails.

', ], ], 'DescribePackagesFilterValue' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilterValues$member' => NULL, ], ], 'DescribePackagesFilterValues' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesFilter$Value' => '

A non-empty list of values for the specified filter field.

', ], ], 'DescribePackagesRequest' => [ 'base' => '

Container for the request parameters to the DescribePackage operation.

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

Container for the response returned by the DescribePackages operation.

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

Container for the request parameters to a DescribeReservedInstanceOfferings operation.

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

Container for results of a DescribeReservedInstanceOfferings request.

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

Container for the request parameters to the DescribeReservedInstances operation.

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

Container for results from DescribeReservedInstances

', 'refs' => [], ], 'DescribeVpcEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVpcEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Description' => '

The description of the stage.

', ], ], 'DisableTimestamp' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$AnonymousAuthDisableDate' => '

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

', ], ], 'DisabledOperationException' => [ 'base' => '

An error occured because the client wanted to access an unsupported operation.

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

Container for the request parameters to the DissociatePackage operation.

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

Container for the response returned by an DissociatePackage operation.

', 'refs' => [], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$DomainArn' => '

The Amazon Resource Name (ARN) of the domain to create the endpoint for.

', 'VpcEndpoint$DomainArn' => '

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

', 'VpcEndpointSummary$DomainArn' => '

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

', ], ], 'DomainConfig' => [ 'base' => '

Container for the configuration of an OpenSearch Service domain.

', 'refs' => [ 'DescribeDomainConfigResponse$DomainConfig' => '

Container for the configuration of the OpenSearch Service domain.

', 'UpdateDomainConfigResponse$DomainConfig' => '

The status of the updated domain.

', ], ], 'DomainEndpointOptions' => [ 'base' => '

Options to configure a custom endpoint for an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainRequest$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', 'DomainEndpointOptionsStatus$Options' => '

Options to configure the endpoint for a domain.

', 'DomainStatus$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', 'UpdateDomainConfigRequest$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', ], ], 'DomainEndpointOptionsStatus' => [ 'base' => '

The configured endpoint options for a domain and their current status.

', 'refs' => [ 'DomainConfig$DomainEndpointOptions' => '

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

', ], ], 'DomainHealth' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$ClusterHealth' => '

The current health status of your cluster.

  • 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.

', ], ], 'DomainId' => [ 'base' => '

Unique identifier for an OpenSearch Service domain.

', 'refs' => [ 'DomainStatus$DomainId' => '

Unique identifier for the domain.

', ], ], 'DomainInfo' => [ 'base' => '

Information about an OpenSearch Service domain.

', 'refs' => [ 'DomainInfoList$member' => NULL, ], ], 'DomainInfoList' => [ 'base' => '

Contains a list of information about a domain.

', 'refs' => [ 'ListDomainNamesResponse$DomainNames' => '

The names of all OpenSearch Service domains owned by the current user and their respective engine types.

', ], ], 'DomainInformationContainer' => [ 'base' => '

Container for information about an OpenSearch Service domain.

', 'refs' => [ 'CreateOutboundConnectionRequest$LocalDomainInfo' => '

Name and Region of the source (local) domain.

', 'CreateOutboundConnectionRequest$RemoteDomainInfo' => '

Name and Region of the destination (remote) domain.

', 'CreateOutboundConnectionResponse$LocalDomainInfo' => '

Information about the source (local) domain.

', 'CreateOutboundConnectionResponse$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', 'InboundConnection$LocalDomainInfo' => '

Information about the source (local) domain.

', 'InboundConnection$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', 'OutboundConnection$LocalDomainInfo' => '

Information about the source (local) domain.

', 'OutboundConnection$RemoteDomainInfo' => '

Information about the destination (remote) domain.

', ], ], 'DomainMaintenanceDetails' => [ 'base' => '

Container for the domain maintenance details.

', 'refs' => [ 'DomainMaintenanceList$member' => NULL, ], ], 'DomainMaintenanceList' => [ 'base' => NULL, 'refs' => [ 'ListDomainMaintenancesResponse$DomainMaintenances' => '

A list of the submitted maintenance actions.

', ], ], 'DomainName' => [ 'base' => '

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

', 'refs' => [ 'AWSDomainInformation$DomainName' => '

Name of the domain.

', 'AddDataSourceRequest$DomainName' => '

The name of the domain to add the data source to.

', 'AssociatePackageRequest$DomainName' => '

Name of the domain to associate the package with.

', 'AuthorizeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to provide access to.

', 'CancelServiceSoftwareUpdateRequest$DomainName' => '

Name of the OpenSearch Service domain that you want to cancel the service software update on.

', 'CreateDomainRequest$DomainName' => '

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

', 'DeleteDataSourceRequest$DomainName' => '

The name of the domain.

', 'DeleteDomainRequest$DomainName' => '

The name of the domain you want to permanently delete.

', 'DescribeDomainAutoTunesRequest$DomainName' => '

Name of the domain that you want Auto-Tune details about.

', 'DescribeDomainChangeProgressRequest$DomainName' => '

The name of the domain to get progress information for.

', 'DescribeDomainConfigRequest$DomainName' => '

Name of the OpenSearch Service domain configuration that you want to describe.

', 'DescribeDomainHealthRequest$DomainName' => '

The name of the domain.

', 'DescribeDomainNodesRequest$DomainName' => '

The name of the domain.

', 'DescribeDomainRequest$DomainName' => '

The name of the domain that you want information about.

', 'DescribeDryRunProgressRequest$DomainName' => '

The name of the domain.

', 'DescribeInstanceTypeLimitsRequest$DomainName' => '

The name of the domain. Only specify if you need the limits for an existing domain.

', 'DissociatePackageRequest$DomainName' => '

Name of the domain to dissociate the package from.

', 'DomainInfo$DomainName' => '

Name of the domain.

', 'DomainMaintenanceDetails$DomainName' => '

The name of the domain.

', 'DomainNameList$member' => NULL, 'DomainPackageDetails$DomainName' => '

Name of the domain that the package is associated with.

', 'DomainStatus$DomainName' => '

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

', 'GetCompatibleVersionsRequest$DomainName' => '

The name of an existing domain. Provide this parameter to limit the results to a single domain.

', 'GetDataSourceRequest$DomainName' => '

The name of the domain.

', 'GetDomainMaintenanceStatusRequest$DomainName' => '

The name of the domain.

', 'GetUpgradeHistoryRequest$DomainName' => '

The name of an existing domain.

', 'GetUpgradeStatusRequest$DomainName' => '

The domain of the domain to get upgrade status information for.

', 'ListDataSourcesRequest$DomainName' => '

The name of the domain.

', 'ListDomainMaintenancesRequest$DomainName' => '

The name of the domain.

', 'ListInstanceTypeDetailsRequest$DomainName' => '

The name of the domain.

', 'ListPackagesForDomainRequest$DomainName' => '

The name of the domain for which you want to list associated packages.

', 'ListScheduledActionsRequest$DomainName' => '

The name of the domain.

', 'ListVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain to retrieve access information for.

', 'ListVpcEndpointsForDomainRequest$DomainName' => '

The name of the domain to list associated VPC endpoints for.

', 'RevokeVpcEndpointAccessRequest$DomainName' => '

The name of the OpenSearch Service domain.

', 'StartDomainMaintenanceRequest$DomainName' => '

The name of the domain.

', 'StartServiceSoftwareUpdateRequest$DomainName' => '

The name of the domain that you want to update to the latest service software.

', 'UpdateDataSourceRequest$DomainName' => '

The name of the domain.

', 'UpdateDomainConfigRequest$DomainName' => '

The name of the domain that you\'re updating.

', 'UpdateScheduledActionRequest$DomainName' => '

The name of the domain to reschedule an action for.

', 'UpgradeDomainRequest$DomainName' => '

Name of the OpenSearch Service domain that you want to upgrade.

', 'UpgradeDomainResponse$DomainName' => '

The name of the domain that was upgraded.

', ], ], 'DomainNameFqdn' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$CustomEndpoint' => '

The fully qualified URL for the custom endpoint.

', ], ], 'DomainNameList' => [ 'base' => '

A list of OpenSearch Service domain names.

', 'refs' => [ 'DescribeDomainsRequest$DomainNames' => '

Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.

', ], ], 'DomainNodesStatus' => [ 'base' => '

Container for information about nodes on the domain.

', 'refs' => [ 'DomainNodesStatusList$member' => NULL, ], ], 'DomainNodesStatusList' => [ 'base' => '

List of DomainNodesStatus with details about nodes on the requested domain.

', 'refs' => [ 'DescribeDomainNodesResponse$DomainNodesStatusList' => '

Contains nodes information list DomainNodesStatusList with details about the all nodes on the requested domain.

', ], ], 'DomainPackageDetails' => [ 'base' => '

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

', 'refs' => [ 'AssociatePackageResponse$DomainPackageDetails' => '

Information about a package that is associated with a domain.

', 'DissociatePackageResponse$DomainPackageDetails' => '

Information about a package that has been dissociated from the domain.

', 'DomainPackageDetailsList$member' => NULL, ], ], 'DomainPackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsForPackageResponse$DomainPackageDetailsList' => '

Information about all domains associated with a package.

', 'ListPackagesForDomainResponse$DomainPackageDetailsList' => '

List of all packages associated with a domain.

', ], ], 'DomainPackageStatus' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$DomainPackageStatus' => '

State of the association.

', ], ], '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.

', ], ], 'DomainStatus' => [ 'base' => '

The current status of an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainResponse$DomainStatus' => '

The status of the newly created domain.

', 'DeleteDomainResponse$DomainStatus' => '

The status of the domain being deleted.

', 'DescribeDomainResponse$DomainStatus' => '

List that contains the status of each specified OpenSearch Service domain.

', 'DescribeDryRunProgressResponse$DryRunConfig' => '

Details about the changes you\'re planning to make on the domain.

', 'DomainStatusList$member' => NULL, ], ], 'DomainStatusList' => [ 'base' => '

List that contains the status of each specified OpenSearch Service domain.

', 'refs' => [ 'DescribeDomainsResponse$DomainStatusList' => '

The status of the requested domains.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$RecurringChargeAmount' => '

The monetary amount of the recurring charge.

', 'ReservedInstance$FixedPrice' => '

The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.

', 'ReservedInstance$UsagePrice' => '

The hourly rate at which you\'re charged for the domain using this Reserved Instance.

', 'ReservedInstanceOffering$FixedPrice' => '

The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.

', 'ReservedInstanceOffering$UsagePrice' => '

The hourly rate at which you\'re charged for the domain using this Reserved Instance.

', 'UpgradeStepItem$ProgressPercent' => '

The floating point value representing the progress percentage of a particular step.

', ], ], 'DryRun' => [ 'base' => NULL, 'refs' => [ 'UpdateDomainConfigRequest$DryRun' => '

This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.

', ], ], 'DryRunMode' => [ 'base' => NULL, 'refs' => [ 'UpdateDomainConfigRequest$DryRunMode' => '

The type of dry run to perform.

  • 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.

', ], ], 'DryRunProgressStatus' => [ 'base' => '

Information about the progress of a pre-upgrade dry run analysis.

', 'refs' => [ 'DescribeDryRunProgressResponse$DryRunProgressStatus' => '

The current status of the dry run, including any validation errors.

', 'UpdateDomainConfigResponse$DryRunProgressStatus' => '

The status of the dry run being performed on the domain, if any.

', ], ], 'DryRunResults' => [ 'base' => '

Results of a dry run performed in an update domain request.

', 'refs' => [ 'DescribeDryRunProgressResponse$DryRunResults' => '

The results of the dry run.

', 'UpdateDomainConfigResponse$DryRunResults' => '

Results of the dry run performed in the update domain request.

', ], ], 'Duration' => [ 'base' => '

The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneMaintenanceSchedule$Duration' => '

The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.

', ], ], 'DurationValue' => [ 'base' => '

Integer that specifies the value of a maintenance schedule duration.

', 'refs' => [ 'Duration$Value' => '

Integer to specify the value of a maintenance schedule duration.

', ], ], 'EBSOptions' => [ 'base' => '

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

', 'refs' => [ 'CreateDomainRequest$EBSOptions' => '

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

', 'DomainStatus$EBSOptions' => '

Container for EBS-based storage settings for the domain.

', 'EBSOptionsStatus$Options' => '

The configured EBS options for the specified domain.

', 'UpdateDomainConfigRequest$EBSOptions' => '

The type and size of the EBS volume to attach to instances in the domain.

', ], ], 'EBSOptionsStatus' => [ 'base' => '

The status of the EBS options for the specified OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EBSOptions' => '

Container for EBS options configured for the domain.

', ], ], 'EncryptionAtRestOptions' => [ 'base' => '

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can be used only to create a new domain, not update an existing one.

', 'refs' => [ 'CreateDomainRequest$EncryptionAtRestOptions' => '

Key-value pairs to enable encryption at rest.

', 'DomainStatus$EncryptionAtRestOptions' => '

Encryption at rest settings for the domain.

', 'EncryptionAtRestOptionsStatus$Options' => '

Encryption at rest options for the specified domain.

', 'UpdateDomainConfigRequest$EncryptionAtRestOptions' => '

Encryption at rest options for the domain.

', ], ], 'EncryptionAtRestOptionsStatus' => [ 'base' => '

Status of the encryption at rest options for the specified OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EncryptionAtRestOptions' => '

Key-value pairs to enable encryption at rest.

', ], ], 'Endpoint' => [ 'base' => NULL, 'refs' => [ 'ConnectionProperties$Endpoint' => '

The Endpoint attribute cannot be modified.

The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

', 'VpcEndpoint$Endpoint' => '

The connection endpoint ID for connecting to the domain.

', ], ], 'EndpointsMap' => [ 'base' => NULL, 'refs' => [ 'DomainStatus$Endpoints' => '

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example key, value: \'vpc\',\'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com\'.

', ], ], 'EngineType' => [ 'base' => NULL, 'refs' => [ 'DomainInfo$EngineType' => '

The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

', 'ListDomainNamesRequest$EngineType' => '

Filters the output by domain engine type.

', ], ], 'EngineVersion' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$EngineVersion' => '

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', ], ], 'EnvironmentInfo' => [ 'base' => '

Information about the active domain environment.

', 'refs' => [ 'EnvironmentInfoList$member' => NULL, ], ], 'EnvironmentInfoList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$EnvironmentInformation' => '

A list of EnvironmentInfo for the domain.

', ], ], 'ErrorDetails' => [ 'base' => '

Additional information if the package is in an error state. Null otherwise.

', 'refs' => [ 'DomainPackageDetails$ErrorDetails' => '

Additional information if the package is in an error state. Null otherwise.

', 'PackageDetails$ErrorDetails' => '

Additional information if the package is in an error state. Null otherwise.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'BaseException$message' => '

A description of the error.

', 'ErrorDetails$ErrorMessage' => '

A message describing the error.

', ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorType' => '

The type of error that occurred.

', ], ], 'Filter' => [ 'base' => '

A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundConnectionsRequest$Filters' => '

A list of filters used to match properties for inbound cross-cluster connections.

', 'DescribeOutboundConnectionsRequest$Filters' => '

List of filter names and values that you can use for requests.

', ], ], 'GUID' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$ChangeId' => '

The ID of the configuration change.

', 'ChangeProgressStatusDetails$ChangeId' => '

The unique change identifier associated with a specific domain configuration change.

', 'DescribeDomainChangeProgressRequest$ChangeId' => '

The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

', 'DescribeDryRunProgressRequest$DryRunId' => '

The unique identifier of the dry run.

', 'DescribeReservedInstanceOfferingsRequest$ReservedInstanceOfferingId' => '

The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

', 'DescribeReservedInstancesRequest$ReservedInstanceId' => '

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

', 'DryRunProgressStatus$DryRunId' => '

The unique identifier of the dry run.

', '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.

', ], ], 'GetCompatibleVersionsRequest' => [ 'base' => '

Container for the request parameters to GetCompatibleVersions operation.

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

Container for the response returned by the GetCompatibleVersions operation.

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

Container for the parameters to the GetDataSource operation.

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

The result of a GetDataSource operation.

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

Container for the parameters to the GetDomainMaintenanceStatus operation.

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

The result of a GetDomainMaintenanceStatus request that information about the requested action.

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

Container for the request parameters to the GetPackageVersionHistory operation.

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

Container for response returned by GetPackageVersionHistory operation.

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

Container for the request parameters to the GetUpgradeHistory operation.

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

Container for the response returned by the GetUpgradeHistory operation.

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

Container for the request parameters to the GetUpgradeStatus operation.

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

Container for the response returned by the GetUpgradeStatus operation.

', 'refs' => [], ], 'IPAddressType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$IPAddressType' => '

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can\'t change your address type later.

', 'DomainStatus$IPAddressType' => '

The type of IP addresses supported by the endpoint for the domain.

', 'IPAddressTypeStatus$Options' => '

The IP address options for the domain.

', 'UpdateDomainConfigRequest$IPAddressType' => '

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can\'t change it.

', ], ], 'IPAddressTypeStatus' => [ 'base' => '

The IP address type status for the domain.

', 'refs' => [ 'DomainConfig$IPAddressType' => '

Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can\'t change your address type later.

', ], ], 'IdentityPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$IdentityPoolId' => '

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

', ], ], 'InboundConnection' => [ 'base' => '

Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.

', 'refs' => [ 'AcceptInboundConnectionResponse$Connection' => '

Information about the accepted inbound connection.

', 'DeleteInboundConnectionResponse$Connection' => '

The deleted inbound connection.

', 'InboundConnections$member' => NULL, 'RejectInboundConnectionResponse$Connection' => '

Contains details about the rejected inbound connection.

', ], ], 'InboundConnectionStatus' => [ 'base' => '

The status of an inbound cross-cluster connection for OpenSearch Service.

', 'refs' => [ 'InboundConnection$ConnectionStatus' => '

The current status of the connection.

', ], ], 'InboundConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'InboundConnectionStatus$StatusCode' => '

The status code for the connection. Can be one of the following:

  • 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.

', ], ], 'InboundConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundConnectionsResponse$Connections' => '

List of inbound connections.

', ], ], 'InstanceCount' => [ 'base' => '

Number of instances in an OpenSearch Service cluster.

', 'refs' => [ 'PurchaseReservedInstanceOfferingRequest$InstanceCount' => '

The number of OpenSearch instances to reserve.

', ], ], 'InstanceCountLimits' => [ 'base' => '

Limits on the number of instances that can be created in OpenSearch Service for a given instance type.

', 'refs' => [ 'InstanceLimits$InstanceCountLimits' => '

Limits on the number of instances that can be created for a given instance type.

', ], ], 'InstanceLimits' => [ 'base' => '

Instance-related attributes that are available for a given instance type.

', 'refs' => [ 'Limits$InstanceLimits' => '

The limits for a given instance type.

', ], ], 'InstanceRole' => [ 'base' => NULL, 'refs' => [ 'InstanceRoleList$member' => NULL, 'LimitsByRole$key' => NULL, ], ], 'InstanceRoleList' => [ 'base' => NULL, 'refs' => [ 'InstanceTypeDetails$InstanceRole' => '

Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.

', ], ], 'InstanceTypeDetails' => [ 'base' => '

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

', 'refs' => [ 'InstanceTypeDetailsList$member' => NULL, ], ], 'InstanceTypeDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceTypeDetailsResponse$InstanceTypeDetails' => '

Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

', ], ], 'InstanceTypeString' => [ 'base' => NULL, 'refs' => [ 'ListInstanceTypeDetailsRequest$InstanceType' => '

An optional parameter that lists information for a given instance type.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$Duration' => '

The duration, in seconds, for which the OpenSearch instance is reserved.

', 'ReservedInstance$InstanceCount' => '

The number of OpenSearch instances that have been reserved.

', 'ReservedInstanceOffering$Duration' => '

The duration, in seconds, for which the offering will reserve the OpenSearch instance.

', ], ], 'IntegerClass' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$InstanceCount' => '

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

', 'ClusterConfig$DedicatedMasterCount' => '

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

', 'ClusterConfig$WarmCount' => '

The number of warm nodes in the cluster.

', 'EBSOptions$VolumeSize' => '

Specifies the size (in GiB) of EBS volumes attached to data nodes.

', 'EBSOptions$Iops' => '

Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

', 'EBSOptions$Throughput' => '

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

', 'SAMLOptionsInput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

', 'SAMLOptionsOutput$SessionTimeoutMinutes' => '

The duration, in minutes, after which a user session becomes inactive.

', 'SnapshotOptions$AutomatedSnapshotStartHour' => '

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

', 'ZoneAwarenessConfig$AvailabilityZoneCount' => '

If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

', ], ], 'InternalException' => [ 'base' => '

Request processing failed because of an unknown error, exception, or internal failure.

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

Request processing failed because you provided an invalid pagination token.

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

An exception for trying to create or access a sub-resource that\'s either invalid or not supported.

', 'refs' => [], ], 'Issue' => [ 'base' => NULL, 'refs' => [ 'Issues$member' => NULL, ], ], 'Issues' => [ 'base' => NULL, 'refs' => [ 'UpgradeStepItem$Issues' => '

A list of strings containing detailed information about the errors encountered in a particular step.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyId' => '

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

', ], ], 'LastUpdated' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$LastUpdated' => '

The most recent updated timestamp of the stage.

', 'DomainPackageDetails$LastUpdated' => '

Timestamp of the most recent update to the package association status.

', 'PackageDetails$LastUpdatedAt' => '

Date and time when the package was last updated.

', ], ], 'LimitExceededException' => [ 'base' => '

An exception for trying to create more than the allowed number of resources or sub-resources.

', 'refs' => [], ], 'LimitName' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitName' => '

  • 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.

', 'StorageTypeLimit$LimitName' => '

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.

', ], ], 'LimitValue' => [ 'base' => NULL, 'refs' => [ 'LimitValueList$member' => NULL, ], ], 'LimitValueList' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitValues' => '

The values of the additional instance type limits.

', 'StorageTypeLimit$LimitValues' => '

The limit values.

', ], ], 'Limits' => [ 'base' => '

Limits for a given instance type and for each of its roles.

', 'refs' => [ 'LimitsByRole$value' => NULL, ], ], 'LimitsByRole' => [ 'base' => '

The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

  • data - A data node.

  • master - A dedicated master node.

  • ultra_warm - An UltraWarm node.

', 'refs' => [ 'DescribeInstanceTypeLimitsResponse$LimitsByRole' => '

Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

', ], ], 'ListDataSourcesRequest' => [ 'base' => '

Container for the parameters to the ListDataSources operation.

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

The result of a ListDataSources operation.

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

Container for the parameters to the ListDomainMaintenances operation.

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

The result of a ListDomainMaintenances request that contains information about the requested actions.

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

Container for the parameters to the ListDomainNames operation.

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

The results of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

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

Container for the request parameters to the ListDomainsForPackage operation.

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

Container for the response parameters to the ListDomainsForPackage operation.

', 'refs' => [], ], 'ListInstanceTypeDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceTypeDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPackagesForDomainRequest' => [ 'base' => '

Container for the request parameters to the ListPackagesForDomain operation.

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

Container for the response parameters to the ListPackagesForDomain operation.

', 'refs' => [], ], 'ListScheduledActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListScheduledActionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsRequest' => [ 'base' => '

Container for the parameters to the ListTags operation.

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

The results of a ListTags operation.

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

Container for the request parameters to the ListVersions operation.

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

Container for the parameters for response received from the ListVersions operation.

', 'refs' => [], ], 'ListVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsForDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsForDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVpcEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogPublishingOption' => [ 'base' => '

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.

After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

', 'refs' => [ 'LogPublishingOptions$value' => NULL, ], ], 'LogPublishingOptions' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$LogPublishingOptions' => '

Key-value pairs to configure log publishing.

', 'DomainStatus$LogPublishingOptions' => '

Log publishing options for the domain.

', 'LogPublishingOptionsStatus$Options' => '

The log publishing options configured for the domain.

', 'UpdateDomainConfigRequest$LogPublishingOptions' => '

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

', ], ], 'LogPublishingOptionsStatus' => [ 'base' => '

The configured log publishing options for the domain and their current status.

', 'refs' => [ 'DomainConfig$LogPublishingOptions' => '

Key-value pairs to configure log publishing.

', ], ], 'LogType' => [ 'base' => '

The type of log file. Can be one of the following:

  • 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.

', 'refs' => [ 'LogPublishingOptions$key' => NULL, ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$BillingSubscriptionId' => '

The unique identifier of the billing subscription.

', 'ScheduledAction$ScheduledTime' => '

The time when the change is scheduled to happen.

', 'SlotList$member' => NULL, 'StartServiceSoftwareUpdateRequest$DesiredStartTime' => '

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

', 'UpdateScheduledActionRequest$DesiredStartTime' => '

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

', ], ], 'MaintenanceStatus' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$Status' => '

The status of the action.

', 'GetDomainMaintenanceStatusResponse$Status' => '

The status of the maintenance action.

', 'ListDomainMaintenancesRequest$Status' => '

The status of the action.

', ], ], 'MaintenanceStatusMessage' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$StatusMessage' => '

The status message for the action.

', 'GetDomainMaintenanceStatusResponse$StatusMessage' => '

The status message of the maintenance action.

', ], ], 'MaintenanceType' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$Action' => '

The name of the action.

', 'GetDomainMaintenanceStatusResponse$Action' => '

The action name.

', 'ListDomainMaintenancesRequest$Action' => '

The name of the action.

', 'StartDomainMaintenanceRequest$Action' => '

The name of the action.

', ], ], 'MasterNodeStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$MasterNode' => '

Indicates whether the domain has an elected master node.

  • 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.

', ], ], 'MasterUserOptions' => [ 'base' => '

Credentials for the master user for a domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$MasterUserOptions' => '

Container for information about the master user.

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

An optional parameter that specifies the maximum number of results to return for a given request.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeInboundConnectionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeOutboundConnectionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribePackagesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeReservedInstanceOfferingsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'DescribeReservedInstancesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'GetPackageVersionHistoryRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'GetUpgradeHistoryRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListDomainMaintenancesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListDomainsForPackageRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListInstanceTypeDetailsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListPackagesForDomainRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListScheduledActionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', 'ListVersionsRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', ], ], 'MaximumInstanceCount' => [ 'base' => '

Maximum number of instances that can be instantiated for a given instance type.

', 'refs' => [ 'InstanceCountLimits$MaximumInstanceCount' => '

The minimum allowed number of instances.

', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$Message' => '

A message corresponding to the status of the configuration change.

', 'DryRunResults$Message' => '

A message corresponding to the deployment type.

', ], ], 'MinimumInstanceCount' => [ 'base' => '

Minimum number of instances that can be instantiated for a given instance type.

', 'refs' => [ 'InstanceCountLimits$MinimumInstanceCount' => '

The maximum allowed number of instances.

', ], ], 'NextToken' => [ 'base' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'refs' => [ 'DescribeDomainAutoTunesRequest$NextToken' => '

If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.

', 'DescribeDomainAutoTunesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'DescribeInboundConnectionsRequest$NextToken' => '

If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.

', 'DescribeInboundConnectionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'DescribeOutboundConnectionsRequest$NextToken' => '

If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.

', 'DescribeOutboundConnectionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'DescribePackagesRequest$NextToken' => '

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

', 'DescribeReservedInstanceOfferingsRequest$NextToken' => '

If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.

', 'DescribeReservedInstanceOfferingsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'DescribeReservedInstancesRequest$NextToken' => '

If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.

', 'GetPackageVersionHistoryRequest$NextToken' => '

If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.

', 'GetUpgradeHistoryRequest$NextToken' => '

If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.

', 'ListDomainMaintenancesRequest$NextToken' => '

If your initial ListDomainMaintenances operation returns a nextToken, include the returned nextToken in subsequent ListDomainMaintenances operations, which returns results in the next page.

', 'ListDomainMaintenancesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListDomainsForPackageRequest$NextToken' => '

If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.

', 'ListInstanceTypeDetailsRequest$NextToken' => '

If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

', 'ListInstanceTypeDetailsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListPackagesForDomainRequest$NextToken' => '

If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.

', 'ListScheduledActionsRequest$NextToken' => '

If your initial ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.

', 'ListScheduledActionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListVersionsRequest$NextToken' => '

If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.

', 'ListVersionsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListVpcEndpointAccessRequest$NextToken' => '

If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.

', 'ListVpcEndpointAccessResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListVpcEndpointsForDomainRequest$NextToken' => '

If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.

', 'ListVpcEndpointsForDomainResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListVpcEndpointsRequest$NextToken' => '

If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

', 'ListVpcEndpointsResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', ], ], 'NodeId' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$NodeId' => '

The ID of the data node.

', 'DomainNodesStatus$NodeId' => '

The ID of the node.

', 'GetDomainMaintenanceStatusResponse$NodeId' => '

The node ID of the maintenance action.

', 'StartDomainMaintenanceRequest$NodeId' => '

The ID of the data node.

', ], ], 'NodeStatus' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$NodeStatus' => '

Indicates if the node is active or in standby.

', ], ], 'NodeToNodeEncryptionOptions' => [ 'base' => '

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.

', 'refs' => [ 'CreateDomainRequest$NodeToNodeEncryptionOptions' => '

Enables node-to-node encryption.

', 'DomainStatus$NodeToNodeEncryptionOptions' => '

Whether node-to-node encryption is enabled or disabled.

', 'NodeToNodeEncryptionOptionsStatus$Options' => '

The node-to-node encryption options for the specified domain.

', 'UpdateDomainConfigRequest$NodeToNodeEncryptionOptions' => '

Node-to-node encryption options for the domain.

', ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'base' => '

Status of the node-to-node encryption options for the specified domain.

', 'refs' => [ 'DomainConfig$NodeToNodeEncryptionOptions' => '

Whether node-to-node encryption is enabled or disabled.

', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$NodeType' => '

Indicates whether the nodes is a data, master, or ultrawarm node.

', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

The name of the filter.

', 'ValueStringList$member' => NULL, ], ], 'NumberOfAZs' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$AvailabilityZoneCount' => '

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$ActiveAvailabilityZoneCount' => '

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$StandByAvailabilityZoneCount' => '

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', ], ], 'NumberOfNodes' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$ConfiguredDataNodeCount' => '

The total number of data nodes configured in the Availability Zone.

', 'AvailabilityZoneInfo$AvailableDataNodeCount' => '

The number of data nodes active in the Availability Zone.

', 'DescribeDomainHealthResponse$DataNodeCount' => '

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$MasterEligibleNodeCount' => '

The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

', 'DescribeDomainHealthResponse$WarmNodeCount' => '

The number of warm nodes configured for the domain.

', ], ], 'NumberOfShards' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$TotalShards' => '

The total number of primary and replica shards in the Availability Zone.

', 'AvailabilityZoneInfo$TotalUnAssignedShards' => '

The total number of primary and replica shards that aren\'t allocated to any of the nodes in the Availability Zone.

', 'DescribeDomainHealthResponse$TotalShards' => '

The total number of primary and replica shards for the domain.

', 'DescribeDomainHealthResponse$TotalUnAssignedShards' => '

The total number of primary and replica shards not allocated to any of the nodes for the cluster.

', ], ], 'OffPeakWindow' => [ 'base' => '

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify.

If you don\'t specify a window start time, it defaults to 10:00 P.M. local time.

For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service.

', 'refs' => [ 'OffPeakWindowOptions$OffPeakWindow' => '

Off-peak window settings for the domain.

', ], ], 'OffPeakWindowOptions' => [ 'base' => '

Options for a domain\'s off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

', 'refs' => [ 'CreateDomainRequest$OffPeakWindowOptions' => '

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

', 'DomainStatus$OffPeakWindowOptions' => '

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

', 'OffPeakWindowOptionsStatus$Options' => '

The domain\'s off-peak window configuration.

', 'UpdateDomainConfigRequest$OffPeakWindowOptions' => '

Off-peak window options for the domain.

', ], ], 'OffPeakWindowOptionsStatus' => [ 'base' => '

The status of off-peak window options for a domain.

', 'refs' => [ 'DomainConfig$OffPeakWindowOptions' => '

Container for off-peak window options for the domain.

', ], ], 'OpenSearchPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$InstanceType' => '

Instance type of data nodes in the cluster.

', 'ClusterConfig$DedicatedMasterType' => '

OpenSearch Service instance type of the dedicated master nodes in the cluster.

', 'DescribeInstanceTypeLimitsRequest$InstanceType' => '

The OpenSearch Service instance type for which you need limit information.

', 'DomainNodesStatus$InstanceType' => '

The instance type information of the node.

', 'InstanceTypeDetails$InstanceType' => '

The instance type.

', 'ReservedInstance$InstanceType' => '

The OpenSearch instance type offered by theReserved Instance offering.

', 'ReservedInstanceOffering$InstanceType' => '

The OpenSearch instance type offered by the Reserved Instance offering.

', ], ], 'OpenSearchWarmPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$WarmType' => '

The instance type for the cluster\'s warm nodes.

', ], ], 'OptionState' => [ 'base' => '

The state of a requested domain configuration change. Can be one of the following:

  • Processing - The requested change is still in progress.

  • Active - The requested change is processed and deployed to the domain.

', 'refs' => [ 'OptionStatus$State' => '

The state of the entity.

', ], ], 'OptionStatus' => [ 'base' => '

Provides the current status of an entity.

', 'refs' => [ 'AccessPoliciesStatus$Status' => '

The status of the access policy for the domain.

', 'AdvancedOptionsStatus$Status' => '

The status of advanced options for the specified domain.

', 'AdvancedSecurityOptionsStatus$Status' => '

Status of the fine-grained access control settings for a domain.

', 'ClusterConfigStatus$Status' => '

The status of cluster configuration options for the specified domain.

', 'CognitoOptionsStatus$Status' => '

The status of the Cognito options for the specified domain.

', 'DomainEndpointOptionsStatus$Status' => '

The status of the endpoint options for a domain.

', 'EBSOptionsStatus$Status' => '

The status of the EBS options for the specified domain.

', 'EncryptionAtRestOptionsStatus$Status' => '

The status of the encryption at rest options for the specified domain.

', 'IPAddressTypeStatus$Status' => NULL, 'LogPublishingOptionsStatus$Status' => '

The status of the log publishing options for the domain.

', 'NodeToNodeEncryptionOptionsStatus$Status' => '

The status of the node-to-node encryption options for the specified domain.

', 'OffPeakWindowOptionsStatus$Status' => '

The current status of off-peak window options.

', 'SnapshotOptionsStatus$Status' => '

The status of a daily automated snapshot.

', 'SoftwareUpdateOptionsStatus$Status' => '

The status of service software update options, including creation date and last updated date.

', 'VPCDerivedInfoStatus$Status' => '

The status of the VPC options for the specified domain.

', 'VersionStatus$Status' => '

The status of the version options for the specified domain.

', ], ], 'OutboundConnection' => [ 'base' => '

Specifies details about an outbound cross-cluster connection.

', 'refs' => [ 'DeleteOutboundConnectionResponse$Connection' => '

The deleted inbound connection.

', 'OutboundConnections$member' => NULL, ], ], 'OutboundConnectionStatus' => [ 'base' => '

The status of an outbound cross-cluster connection.

', 'refs' => [ 'CreateOutboundConnectionResponse$ConnectionStatus' => '

The status of the connection.

', 'OutboundConnection$ConnectionStatus' => '

Status of the connection.

', ], ], 'OutboundConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'OutboundConnectionStatus$StatusCode' => '

The status code for the outbound connection. Can be one of the following:

  • 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.

', ], ], 'OutboundConnections' => [ 'base' => NULL, 'refs' => [ 'DescribeOutboundConnectionsResponse$Connections' => '

List of outbound connections that match the filter criteria.

', ], ], 'OverallChangeStatus' => [ 'base' => '

The overall status value of the domain configuration change.

', 'refs' => [ 'ChangeProgressStatusDetails$Status' => '

The overall status of the domain configuration change.

', ], ], 'OwnerId' => [ 'base' => NULL, 'refs' => [ 'AWSDomainInformation$OwnerId' => '

The Amazon Web Services account ID of the domain owner.

', ], ], 'PackageDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageDescription' => '

Description of the package.

', 'PackageDetails$PackageDescription' => '

User-specified description of the package.

', 'UpdatePackageRequest$PackageDescription' => '

A new description of the package.

', ], ], 'PackageDetails' => [ 'base' => '

Basic information about a package.

', 'refs' => [ 'CreatePackageResponse$PackageDetails' => '

Basic information about an OpenSearch Service package.

', 'DeletePackageResponse$PackageDetails' => '

Information about the deleted package.

', 'PackageDetailsList$member' => NULL, 'UpdatePackageResponse$PackageDetails' => '

Information about a package.

', ], ], 'PackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesResponse$PackageDetailsList' => '

Basic information about a package.

', ], ], 'PackageID' => [ 'base' => NULL, 'refs' => [ 'AssociatePackageRequest$PackageID' => '

Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

', 'DeletePackageRequest$PackageID' => '

The internal ID of the package you want to delete. Use DescribePackages to find this value.

', 'DissociatePackageRequest$PackageID' => '

Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.

', 'DomainPackageDetails$PackageID' => '

Internal ID of the package.

', 'GetPackageVersionHistoryRequest$PackageID' => '

The unique identifier of the package.

', 'GetPackageVersionHistoryResponse$PackageID' => '

The unique identifier of the package.

', 'ListDomainsForPackageRequest$PackageID' => '

The unique identifier of the package for which to list associated domains.

', 'PackageDetails$PackageID' => '

The unique identifier of the package.

', 'UpdatePackageRequest$PackageID' => '

The unique identifier for the package.

', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageName' => '

Unique name for the package.

', 'DomainPackageDetails$PackageName' => '

User-specified name of the package.

', 'PackageDetails$PackageName' => '

The user-specified name of the package.

', ], ], 'PackageSource' => [ 'base' => '

The Amazon S3 location to import the package from.

', 'refs' => [ 'CreatePackageRequest$PackageSource' => '

The Amazon S3 location from which to import the package.

', 'UpdatePackageRequest$PackageSource' => '

Amazon S3 bucket and key for the package.

', ], ], 'PackageStatus' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$PackageStatus' => '

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

', ], ], 'PackageType' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageType' => '

The type of package.

', 'DomainPackageDetails$PackageType' => '

The type of package.

', 'PackageDetails$PackageType' => '

The type of package.

', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$PackageVersion' => '

The current version of the package.

', 'PackageDetails$AvailablePackageVersion' => '

The package version.

', 'PackageVersionHistory$PackageVersion' => '

The package version.

', ], ], 'PackageVersionHistory' => [ 'base' => '

Details about a package version.

', 'refs' => [ 'PackageVersionHistoryList$member' => NULL, ], ], 'PackageVersionHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionHistoryResponse$PackageVersionHistoryList' => '

A list of package versions, along with their creation time and commit message.

', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserPassword' => '

Password for the master user. Only specify if InternalUserDatabaseEnabled is true.

', ], ], 'PluginClassName' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$ClassName' => '

The name of the class to load.

', ], ], 'PluginDescription' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Description' => '

The description of the plugin.

', ], ], 'PluginName' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Name' => '

The name of the plugin.

', ], ], 'PluginProperties' => [ 'base' => '

Basic information about the plugin.

', 'refs' => [ 'PackageDetails$AvailablePluginProperties' => '

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

', 'PackageVersionHistory$PluginProperties' => '

Additional information about plugin properties if the package is a ZIP-PLUGIN package.

', ], ], 'PluginVersion' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$Version' => '

The version of the plugin.

', ], ], 'PolicyDocument' => [ 'base' => '

Access policy rules for an Amazon OpenSearch Service domain endpoint. For more information, see Configuring access policies. The maximum size of a policy document is 100 KB.

', 'refs' => [ 'AccessPoliciesStatus$Options' => '

The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.

', 'CreateDomainRequest$AccessPolicies' => '

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

', 'DomainStatus$AccessPolicies' => '

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

', 'UpdateDomainConfigRequest$AccessPolicies' => '

Identity and Access Management (IAM) access policy as a JSON-formatted string.

', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'AuthorizedPrincipal$PrincipalType' => '

The type of principal.

', ], ], 'PurchaseReservedInstanceOfferingRequest' => [ 'base' => '

Container for request parameters to the PurchaseReservedInstanceOffering operation.

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

Represents the output of a PurchaseReservedInstanceOffering operation.

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

Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.

', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$RecurringCharges' => '

The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.

', 'ReservedInstanceOffering$RecurringCharges' => '

The recurring charge to your account, regardless of whether you creates any domains using the offering.

', ], ], 'ReferencePath' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$ReferencePath' => '

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'AWSDomainInformation$Region' => '

The Amazon Web Services Region in which the domain is located.

', ], ], 'RejectInboundConnectionRequest' => [ 'base' => '

Container for the request parameters to the RejectInboundConnection operation.

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

Represents the output of a RejectInboundConnection operation.

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

Container for the request parameters to the RemoveTags operation.

', 'refs' => [], ], 'RequestId' => [ 'base' => NULL, 'refs' => [ 'DomainMaintenanceDetails$MaintenanceId' => '

The ID of the requested action.

', 'GetDomainMaintenanceStatusRequest$MaintenanceId' => '

The request ID of the maintenance action.

', 'StartDomainMaintenanceResponse$MaintenanceId' => '

The request ID of requested action.

', ], ], 'ReservationToken' => [ 'base' => NULL, 'refs' => [ 'PurchaseReservedInstanceOfferingRequest$ReservationName' => '

A customer-specified identifier to track this reservation.

', 'PurchaseReservedInstanceOfferingResponse$ReservationName' => '

The customer-specified identifier used to track this reservation.

', 'ReservedInstance$ReservationName' => '

The customer-specified identifier to track this reservation.

', ], ], 'ReservedInstance' => [ 'base' => '

Details of an OpenSearch Reserved Instance.

', 'refs' => [ 'ReservedInstanceList$member' => NULL, ], ], 'ReservedInstanceList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedInstancesResponse$ReservedInstances' => '

List of Reserved Instances in the current Region.

', ], ], 'ReservedInstanceOffering' => [ 'base' => '

Details of an OpenSearch Reserved Instance offering.

', 'refs' => [ 'ReservedInstanceOfferingList$member' => NULL, ], ], 'ReservedInstanceOfferingList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedInstanceOfferingsResponse$ReservedInstanceOfferings' => '

List of Reserved Instance offerings.

', ], ], 'ReservedInstancePaymentOption' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$PaymentOption' => '

The payment option as defined in the Reserved Instance offering.

', 'ReservedInstanceOffering$PaymentOption' => '

Payment option for the Reserved Instance offering

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

An exception for creating a resource that already exists.

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

An exception for accessing or deleting a resource that doesn\'t exist.

', 'refs' => [], ], 'RevokeVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$RoleArn' => '

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

', 'S3GlueDataCatalog$RoleArn' => '

>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.

', ], ], 'RollbackOnDisable' => [ 'base' => '

The rollback state while disabling Auto-Tune for the domain.

', 'refs' => [ 'AutoTuneOptions$RollbackOnDisable' => '

When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3BucketName' => '

The name of the Amazon S3 bucket containing the package.

', ], ], 'S3GlueDataCatalog' => [ 'base' => '

Information about the Amazon S3 Glue Data Catalog.

', 'refs' => [ 'DataSourceType$S3GlueDataCatalog' => '

An Amazon S3 data source.

', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3Key' => '

Key (file name) of the package.

', ], ], 'SAMLEntityId' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$EntityId' => '

The unique entity ID of the application in the SAML identity provider.

', ], ], 'SAMLIdp' => [ 'base' => '

The SAML identity povider information.

', 'refs' => [ 'SAMLOptionsInput$Idp' => '

The SAML Identity Provider\'s information.

', 'SAMLOptionsOutput$Idp' => '

Describes the SAML identity provider\'s information.

', ], ], 'SAMLMetadata' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$MetadataContent' => '

The metadata of the SAML application, in XML format.

', ], ], 'SAMLOptionsInput' => [ 'base' => '

The SAML authentication configuration for an Amazon OpenSearch Service domain.

', 'refs' => [ 'AdvancedSecurityOptionsInput$SAMLOptions' => '

Container for information about the SAML configuration for OpenSearch Dashboards.

', ], ], 'SAMLOptionsOutput' => [ 'base' => '

Describes the SAML application configured for the domain.

', 'refs' => [ 'AdvancedSecurityOptions$SAMLOptions' => '

Container for information about the SAML configuration for OpenSearch Dashboards.

', ], ], 'ScheduleAt' => [ 'base' => NULL, 'refs' => [ 'StartServiceSoftwareUpdateRequest$ScheduleAt' => '

When to start the service software update.

  • 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.

', 'UpdateScheduledActionRequest$ScheduleAt' => '

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.

', ], ], 'ScheduledAction' => [ 'base' => '

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

', 'refs' => [ 'ScheduledActionsList$member' => NULL, 'UpdateScheduledActionResponse$ScheduledAction' => '

Information about the rescheduled action.

', ], ], 'ScheduledActionsList' => [ 'base' => NULL, 'refs' => [ 'ListScheduledActionsResponse$ScheduledActions' => '

A list of actions that are scheduled for the domain.

', ], ], 'ScheduledAutoTuneActionType' => [ 'base' => '

The Auto-Tune action type.

', 'refs' => [ 'ScheduledAutoTuneDetails$ActionType' => '

The type of Auto-Tune action.

', ], ], 'ScheduledAutoTuneDescription' => [ 'base' => '

The description of an Auto-Tune maintenance action that occurs on a domain.

', 'refs' => [ 'ScheduledAutoTuneDetails$Action' => '

A description of the Auto-Tune action.

', ], ], 'ScheduledAutoTuneDetails' => [ 'base' => '

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

', 'refs' => [ 'AutoTuneDetails$ScheduledAutoTuneDetails' => '

Container for details about a scheduled Auto-Tune action.

', ], ], 'ScheduledAutoTuneSeverityType' => [ 'base' => '

The Auto-Tune action severity.

', 'refs' => [ 'ScheduledAutoTuneDetails$Severity' => '

The severity of the Auto-Tune action. Valid values are LOW, MEDIUM, and HIGH.

', ], ], 'ScheduledBy' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$ScheduledBy' => '

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

', ], ], 'ServiceSoftwareOptions' => [ 'base' => '

The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

', 'refs' => [ 'CancelServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

Container for the state of your domain relative to the latest service software.

', 'DomainStatus$ServiceSoftwareOptions' => '

The current status of the domain\'s service software.

', 'StartServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => '

The current status of the OpenSearch Service software update.

', ], ], 'ServiceUrl' => [ 'base' => '

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

', 'refs' => [ 'DomainStatus$Endpoint' => '

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

', 'DomainStatus$EndpointV2' => '

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

', 'EndpointsMap$value' => NULL, ], ], 'SkipUnavailableStatus' => [ 'base' => '

The status of SkipUnavailable setting for the outbound connection.

  • ENABLED - The SkipUnavailable setting is enabled for the connection.

  • DISABLED - The SkipUnavailable setting is disabled for the connection.

', 'refs' => [ 'CrossClusterSearchConnectionProperties$SkipUnavailable' => '

The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.

', ], ], 'SlotList' => [ 'base' => NULL, 'refs' => [ 'SlotNotAvailableException$SlotSuggestions' => '

Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.

', ], ], 'SlotNotAvailableException' => [ 'base' => '

An exception for attempting to schedule a domain action during an unavailable time slot.

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

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

', 'refs' => [ 'CreateDomainRequest$SnapshotOptions' => '

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

', 'DomainStatus$SnapshotOptions' => '

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

', 'SnapshotOptionsStatus$Options' => '

The daily snapshot options specified for the domain.

', 'UpdateDomainConfigRequest$SnapshotOptions' => '

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

', ], ], 'SnapshotOptionsStatus' => [ 'base' => '

Container for information about a daily automated snapshot for an OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$SnapshotOptions' => '

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

', ], ], 'SoftwareUpdateOptions' => [ 'base' => '

Options for configuring service software updates for a domain.

', 'refs' => [ 'CreateDomainRequest$SoftwareUpdateOptions' => '

Software update options for the domain.

', 'DomainStatus$SoftwareUpdateOptions' => '

Service software update options for the domain.

', 'SoftwareUpdateOptionsStatus$Options' => '

The service software update options for a domain.

', 'UpdateDomainConfigRequest$SoftwareUpdateOptions' => '

Service software update options for the domain.

', ], ], 'SoftwareUpdateOptionsStatus' => [ 'base' => '

The status of the service software options for a domain.

', 'refs' => [ 'DomainConfig$SoftwareUpdateOptions' => '

Software update options for the domain.

', ], ], 'StartAt' => [ 'base' => NULL, 'refs' => [ 'AutoTuneMaintenanceSchedule$StartAt' => '

The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

', ], ], 'StartDomainMaintenanceRequest' => [ 'base' => '

Container for the parameters to the StartDomainMaintenance operation.

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

The result of a StartDomainMaintenance request that information about the requested action.

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

Container for the request parameters to the StartServiceSoftwareUpdate operation.

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

Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.

', 'refs' => [], ], 'StartTimeHours' => [ 'base' => NULL, 'refs' => [ 'WindowStartTime$Hours' => '

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

', ], ], 'StartTimeMinutes' => [ 'base' => NULL, 'refs' => [ 'WindowStartTime$Minutes' => '

The start minute of the window, in UTC.

', ], ], 'StartTimestamp' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StartTimestamp' => '

UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.

', ], ], 'StorageSubTypeName' => [ 'base' => '

Sub-type of the given EBS storage type. List of available sub-storage options. The instance storage type has no storage sub-type. The ebs storage type has the following valid sub-types:

  • standard

  • gp2

  • gp3

  • io1

', 'refs' => [ 'StorageType$StorageSubTypeName' => '

The storage sub-type, such as gp3 or io1.

', ], ], 'StorageType' => [ 'base' => '

A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.

', 'refs' => [ 'StorageTypeList$member' => NULL, ], ], 'StorageTypeLimit' => [ 'base' => '

Limits that are applicable for the given Amazon OpenSearch Service storage type.

', 'refs' => [ 'StorageTypeLimitList$member' => NULL, ], ], 'StorageTypeLimitList' => [ 'base' => NULL, 'refs' => [ 'StorageType$StorageTypeLimits' => '

Limits that are applicable for the given storage type.

', ], ], 'StorageTypeList' => [ 'base' => NULL, 'refs' => [ 'Limits$StorageTypes' => '

Storage-related attributes that are available for a given instance type.

', ], ], 'StorageTypeName' => [ 'base' => '

The type of storage that the domain uses. Can be one of the following:

instance

Built-in storage available for the instance.

ebs

Elastic Block Storage (EBS) attached to the instance.

', 'refs' => [ 'DomainNodesStatus$StorageType' => '

Indicates if the node has EBS or instance storage.

', 'StorageType$StorageTypeName' => '

The name of the storage type.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddDataSourceResponse$Message' => '

A message associated with creation of the data source.

', 'AdvancedOptions$key' => NULL, 'AdvancedOptions$value' => NULL, 'AuthorizedPrincipal$Principal' => '

The IAM principal that is allowed access to the domain.

', 'AutoTuneMaintenanceSchedule$CronExpressionForRecurrence' => '

A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

', 'AutoTuneOptionsOutput$ErrorMessage' => '

Any errors that occurred while enabling or disabling Auto-Tune.

', 'AutoTuneStatus$ErrorMessage' => '

Any errors that occurred while enabling or disabling Auto-Tune.

', '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. Make the call again using the returned token to retrieve the next page.

', 'DescribeReservedInstancesResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'DryRunProgressStatus$DryRunStatus' => '

The current status of the dry run.

', 'DryRunProgressStatus$CreationDate' => '

The timestamp when the dry run was initiated.

', 'DryRunProgressStatus$UpdateDate' => '

The timestamp when the dry run was last updated.

', 'EndpointsMap$key' => NULL, 'GetPackageVersionHistoryResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'GetUpgradeHistoryResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListDomainsForPackageResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'ListPackagesForDomainResponse$NextToken' => '

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

', 'RecurringCharge$RecurringChargeFrequency' => '

The frequency of the recurring charge.

', 'ReservedInstance$ReservedInstanceOfferingId' => '

The unique identifier of the Reserved Instance offering.

', 'ReservedInstance$CurrencyCode' => '

The currency code for the offering.

', 'ReservedInstance$State' => '

The state of the Reserved Instance.

', 'ReservedInstanceOffering$CurrencyCode' => '

The currency code for the Reserved Instance offering.

', 'SAMLOptionsInput$SubjectKey' => '

Element of the SAML assertion to use for the user name. Default is NameID.

', 'SAMLOptionsInput$RolesKey' => '

Element of the SAML assertion to use for backend roles. Default is roles.

', 'SAMLOptionsOutput$SubjectKey' => '

The key used for matching the SAML subject attribute.

', 'SAMLOptionsOutput$RolesKey' => '

The key used for matching the SAML roles attribute.

', 'ScheduledAction$Id' => '

The unique identifier of the scheduled action.

', 'ScheduledAction$Description' => '

A description of the action to be taken.

', 'ServiceSoftwareOptions$CurrentVersion' => '

The current service software version present on the domain.

', 'ServiceSoftwareOptions$NewVersion' => '

The new service software version, if one is available.

', 'ServiceSoftwareOptions$Description' => '

A description of the service software update status.

', 'StringList$member' => NULL, 'UpdateDataSourceResponse$Message' => '

A message associated with the updated data source.

', 'UpdateScheduledActionRequest$ActionID' => '

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

', 'UpgradeDomainResponse$UpgradeId' => '

The unique identifier of the domain upgrade.

', 'VPCDerivedInfo$VPCId' => '

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

', 'ValidationFailure$Code' => '

The error code of the failure.

', 'ValidationFailure$Message' => '

A message corresponding to the failure.

', 'VpcEndpointError$ErrorMessage' => '

A message describing the error.

', 'VpcEndpointSummary$VpcEndpointOwner' => '

The creator of the endpoint.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$PendingProperties' => '

The list of properties in the domain configuration change that are still pending.

', 'ChangeProgressStatusDetails$CompletedProperties' => '

The list of properties in the domain configuration change that have completed.

', 'RemoveTagsRequest$TagKeys' => '

The list of tag keys to remove from the domain.

', 'VPCDerivedInfo$SubnetIds' => '

A list of subnet IDs associated with the VPC endpoints for the domain.

', 'VPCDerivedInfo$AvailabilityZones' => '

The list of Availability Zones associated with the VPC subnets.

', 'VPCDerivedInfo$SecurityGroupIds' => '

The list of security group IDs associated with the VPC endpoints for the domain.

', 'VPCOptions$SubnetIds' => '

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

', 'VPCOptions$SecurityGroupIds' => '

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

', ], ], 'TLSSecurityPolicy' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$TLSSecurityPolicy' => '

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:

  • 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

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

A tag (key-value pair) for an Amazon OpenSearch Service resource.

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

A string between 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they\'re attached.

', 'refs' => [ 'Tag$Key' => '

The tag key. Tag keys must be unique for the domain to which they are attached.

', ], ], 'TagList' => [ 'base' => '

A list of tags attached to a domain.

', 'refs' => [ 'AddTagsRequest$TagList' => '

List of resource tags.

', 'CreateDomainRequest$TagList' => '

List of tags to add to the domain upon creation.

', 'ListTagsResponse$TagList' => '

List of resource tags associated with the specified domain.

', ], ], 'TagValue' => [ 'base' => '

A string between 0 to 256 characters that specifies the value for a tag. Tag values can be null and don\'t have to be unique in a tag set.

', 'refs' => [ 'Tag$Value' => '

The value assigned to the corresponding tag key. Tag values can be null and don\'t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

', ], ], 'TimeUnit' => [ 'base' => '

The unit of a maintenance schedule duration. Valid value is HOUR.

', 'refs' => [ 'Duration$Unit' => '

The unit of measurement for the duration of a maintenance schedule.

', ], ], 'TotalNumberOfStages' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$TotalNumberOfStages' => '

The total number of stages required for the configuration change.

', ], ], 'UIntValue' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$UpdateVersion' => '

The latest version of the Auto-Tune options.

', 'OptionStatus$UpdateVersion' => '

The latest version of the entity.

', ], ], 'UncompressedPluginSizeInBytes' => [ 'base' => NULL, 'refs' => [ 'PluginProperties$UncompressedSizeInBytes' => '

The uncompressed size of the plugin.

', ], ], 'UpdateDataSourceRequest' => [ 'base' => '

Container for the parameters to the UpdateDataSource operation.

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

The result of an UpdateDataSource operation.

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

Container for the request parameters to the UpdateDomain operation.

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

The results of an UpdateDomain request. Contains the status of the domain being updated.

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

Container for request parameters to the UpdatePackage operation.

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

Container for the response returned by the UpdatePackage operation.

', 'refs' => [], ], 'UpdateScheduledActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateScheduledActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTimestamp' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$CreationDate' => '

Date and time when Auto-Tune was enabled for the domain.

', 'AutoTuneStatus$UpdateDate' => '

Date and time when the Auto-Tune options were last updated for the domain.

', 'ChangeProgressStatusDetails$StartTime' => '

The time at which the configuration change is made on the domain.

', 'DomainMaintenanceDetails$CreatedAt' => '

The time at which the action was created.

', 'DomainMaintenanceDetails$UpdatedAt' => '

The time at which the action was updated.

', 'GetDomainMaintenanceStatusResponse$CreatedAt' => '

The time at which the action was created.

', 'GetDomainMaintenanceStatusResponse$UpdatedAt' => '

The time at which the action was updated.

', 'OptionStatus$CreationDate' => '

The timestamp when the entity was created.

', 'OptionStatus$UpdateDate' => '

The timestamp of the last time the entity was updated.

', 'ReservedInstance$StartTime' => '

The date and time when the reservation was purchased.

', ], ], 'UpdateVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpgradeDomainRequest' => [ 'base' => '

Container for the request parameters to the UpgradeDomain operation.

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

Container for the response returned by UpgradeDomain operation.

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

History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.

', 'refs' => [ 'UpgradeHistoryList$member' => NULL, ], ], 'UpgradeHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeHistoryResponse$UpgradeHistories' => '

A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

', ], ], 'UpgradeName' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeName' => '

A string that describes the update.

', 'UpgradeHistory$UpgradeName' => '

A string that describes the upgrade.

', ], ], 'UpgradeStatus' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$StepStatus' => '

The status of the current step that an upgrade is on.

', 'UpgradeHistory$UpgradeStatus' => '

The current status of the upgrade. The status can take one of the following values:

  • In Progress

  • Succeeded

  • Succeeded with Issues

  • Failed

', 'UpgradeStepItem$UpgradeStepStatus' => '

The current status of the upgrade. The status can take one of the following values:

  • In Progress

  • Succeeded

  • Succeeded with Issues

  • Failed

', ], ], 'UpgradeStep' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeStep' => '

One of three steps that an upgrade or upgrade eligibility check goes through.

', 'UpgradeStepItem$UpgradeStep' => '

One of three steps that an upgrade or upgrade eligibility check goes through:

  • PreUpgradeCheck

  • Snapshot

  • Upgrade

', ], ], 'UpgradeStepItem' => [ 'base' => '

Represents a single step of an upgrade or upgrade eligibility check workflow.

', 'refs' => [ 'UpgradeStepsList$member' => NULL, ], ], 'UpgradeStepsList' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StepsList' => '

A list of each step performed as part of a specific upgrade or upgrade eligibility check.

', ], ], 'UserPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$UserPoolId' => '

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

', ], ], 'Username' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserName' => '

User name for the master user. Only specify if InternalUserDatabaseEnabled is true.

', 'SAMLOptionsInput$MasterUserName' => '

The SAML master user name, which is stored in the domain\'s internal user database.

', ], ], 'VPCDerivedInfo' => [ 'base' => '

Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC). For more information, see Launching your Amazon OpenSearch Service domains using a VPC. This information only exists if the domain was created with VPCOptions.

', 'refs' => [ 'DomainStatus$VPCOptions' => '

The VPC configuration for the domain.

', 'VPCDerivedInfoStatus$Options' => '

The VPC options for the specified domain.

', 'VpcEndpoint$VpcOptions' => '

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

', ], ], 'VPCDerivedInfoStatus' => [ 'base' => '

Status of the VPC options for a specified domain.

', 'refs' => [ 'DomainConfig$VPCOptions' => '

The current VPC options for the domain and the status of any updates to their configuration.

', ], ], 'VPCOptions' => [ 'base' => '

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'refs' => [ 'CreateDomainRequest$VPCOptions' => '

Container for the values required to configure VPC access domains. If you don\'t specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'CreateVpcEndpointRequest$VpcOptions' => '

Options to specify the subnets and security groups for the endpoint.

', 'UpdateDomainConfigRequest$VPCOptions' => '

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

', 'UpdateVpcEndpointRequest$VpcOptions' => '

The security groups and/or subnets to add, remove, or modify.

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

An exception for accessing or deleting a resource that doesn\'t exist.

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

A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.

', 'refs' => [ 'ValidationFailures$member' => NULL, ], ], 'ValidationFailures' => [ 'base' => NULL, 'refs' => [ 'DryRunProgressStatus$ValidationFailures' => '

Any validation failures that occurred as a result of the dry run.

', ], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => '

One or more values for the filter.

', ], ], 'VersionList' => [ 'base' => '

List of supported OpenSearch versions.

', 'refs' => [ 'CompatibleVersionsMap$TargetVersions' => '

The possible versions that you can upgrade the domain to.

', 'ListVersionsResponse$Versions' => '

A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

', ], ], 'VersionStatus' => [ 'base' => '

The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.

', 'refs' => [ 'DomainConfig$EngineVersion' => '

The OpenSearch or Elasticsearch version that the domain is running.

', ], ], 'VersionString' => [ 'base' => NULL, 'refs' => [ 'CompatibleVersionsMap$SourceVersion' => '

The current version that the OpenSearch Service domain is running.

', 'CreateDomainRequest$EngineVersion' => '

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

', 'DescribeInstanceTypeLimitsRequest$EngineVersion' => '

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', 'DomainStatus$EngineVersion' => '

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

', 'ListInstanceTypeDetailsRequest$EngineVersion' => '

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

', 'UpgradeDomainRequest$TargetVersion' => '

OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

', 'UpgradeDomainResponse$TargetVersion' => '

OpenSearch or Elasticsearch version that the domain was upgraded to.

', 'VersionList$member' => NULL, 'VersionStatus$Options' => '

The OpenSearch or Elasticsearch version for the specified domain.

', ], ], 'VolumeSize' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$StorageSize' => '

The storage size of the node, in GiB.

', ], ], 'VolumeType' => [ 'base' => '

The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage.

', 'refs' => [ 'DomainNodesStatus$StorageVolumeType' => '

If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable for data nodes.

', 'EBSOptions$VolumeType' => '

Specifies the type of EBS volumes attached to data nodes.

', ], ], 'VpcEndpoint' => [ 'base' => '

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

', 'refs' => [ 'CreateVpcEndpointResponse$VpcEndpoint' => '

Information about the newly created VPC endpoint.

', 'UpdateVpcEndpointResponse$VpcEndpoint' => '

The endpoint to be updated.

', 'VpcEndpoints$member' => NULL, ], ], 'VpcEndpointError' => [ 'base' => '

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'VpcEndpointErrorList$member' => NULL, ], ], 'VpcEndpointErrorCode' => [ 'base' => NULL, 'refs' => [ 'VpcEndpointError$ErrorCode' => '

The code associated with the error.

', ], ], 'VpcEndpointErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpointErrors' => '

Any errors associated with the request.

', ], ], 'VpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'DeleteVpcEndpointRequest$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'UpdateVpcEndpointRequest$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpoint$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpointError$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpointIdList$member' => NULL, 'VpcEndpointSummary$VpcEndpointId' => '

The unique identifier of the endpoint.

', ], ], 'VpcEndpointIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsRequest$VpcEndpointIds' => '

The unique identifiers of the endpoints to get information about.

', ], ], 'VpcEndpointStatus' => [ 'base' => NULL, 'refs' => [ 'VpcEndpoint$Status' => '

The current status of the endpoint.

', 'VpcEndpointSummary$Status' => '

The current status of the endpoint.

', ], ], 'VpcEndpointSummary' => [ 'base' => '

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

', 'refs' => [ 'DeleteVpcEndpointResponse$VpcEndpointSummary' => '

Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).

', 'VpcEndpointSummaryList$member' => NULL, ], ], 'VpcEndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointsForDomainResponse$VpcEndpointSummaryList' => '

Information about each endpoint associated with the domain.

', 'ListVpcEndpointsResponse$VpcEndpointSummaryList' => '

Information about each endpoint.

', ], ], 'VpcEndpoints' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpoints' => '

Information about each requested VPC endpoint.

', ], ], 'WindowStartTime' => [ 'base' => '

The desired start time for an off-peak maintenance window.

', 'refs' => [ 'OffPeakWindow$WindowStartTime' => '

A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can\'t specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

', ], ], 'ZoneAwarenessConfig' => [ 'base' => '

The zone awareness configuration for an Amazon OpenSearch Service domain.

', 'refs' => [ 'ClusterConfig$ZoneAwarenessConfig' => '

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

', ], ], 'ZoneStatus' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$ZoneStatus' => '

The current state of the Availability Zone. Current options are Active and StandBy.

  • 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.

', ], ], ],]; diff --git a/src/data/sagemaker/2017-07-24/api-2.json b/src/data/sagemaker/2017-07-24/api-2.json index 83159bf171..5c765f7348 100644 --- a/src/data/sagemaker/2017-07-24/api-2.json +++ b/src/data/sagemaker/2017-07-24/api-2.json @@ -5111,6 +5111,11 @@ "type":"integer", "min":1 }, + "CapacityUnit":{ + "type":"integer", + "max":10000000, + "min":0 + }, "CaptureContentTypeHeader":{ "type":"structure", "members":{ @@ -6648,6 +6653,7 @@ "FeatureDefinitions":{"shape":"FeatureDefinitions"}, "OnlineStoreConfig":{"shape":"OnlineStoreConfig"}, "OfflineStoreConfig":{"shape":"OfflineStoreConfig"}, + "ThroughputConfig":{"shape":"ThroughputConfig"}, "RoleArn":{"shape":"RoleArn"}, "Description":{"shape":"Description"}, "Tags":{"shape":"TagList"} @@ -9086,6 +9092,7 @@ "LastModifiedTime":{"shape":"LastModifiedTime"}, "OnlineStoreConfig":{"shape":"OnlineStoreConfig"}, "OfflineStoreConfig":{"shape":"OfflineStoreConfig"}, + "ThroughputConfig":{"shape":"ThroughputConfigDescription"}, "RoleArn":{"shape":"RoleArn"}, "FeatureGroupStatus":{"shape":"FeatureGroupStatus"}, "OfflineStoreStatus":{"shape":"OfflineStoreStatus"}, @@ -21070,6 +21077,39 @@ "max":128, "pattern":"[a-zA-Z0-9:_-]+" }, + "ThroughputConfig":{ + "type":"structure", + "required":["ThroughputMode"], + "members":{ + "ThroughputMode":{"shape":"ThroughputMode"}, + "ProvisionedReadCapacityUnits":{"shape":"CapacityUnit"}, + "ProvisionedWriteCapacityUnits":{"shape":"CapacityUnit"} + } + }, + "ThroughputConfigDescription":{ + "type":"structure", + "required":["ThroughputMode"], + "members":{ + "ThroughputMode":{"shape":"ThroughputMode"}, + "ProvisionedReadCapacityUnits":{"shape":"CapacityUnit"}, + "ProvisionedWriteCapacityUnits":{"shape":"CapacityUnit"} + } + }, + "ThroughputConfigUpdate":{ + "type":"structure", + "members":{ + "ThroughputMode":{"shape":"ThroughputMode"}, + "ProvisionedReadCapacityUnits":{"shape":"CapacityUnit"}, + "ProvisionedWriteCapacityUnits":{"shape":"CapacityUnit"} + } + }, + "ThroughputMode":{ + "type":"string", + "enum":[ + "OnDemand", + "Provisioned" + ] + }, "TimeSeriesConfig":{ "type":"structure", "required":[ @@ -22190,7 +22230,8 @@ "members":{ "FeatureGroupName":{"shape":"FeatureGroupNameOrArn"}, "FeatureAdditions":{"shape":"FeatureAdditions"}, - "OnlineStoreConfig":{"shape":"OnlineStoreConfigUpdate"} + "OnlineStoreConfig":{"shape":"OnlineStoreConfigUpdate"}, + "ThroughputConfig":{"shape":"ThroughputConfigUpdate"} } }, "UpdateFeatureGroupResponse":{ diff --git a/src/data/sagemaker/2017-07-24/api-2.json.php b/src/data/sagemaker/2017-07-24/api-2.json.php index 2609306ea2..b472b4c18c 100644 --- a/src/data/sagemaker/2017-07-24/api-2.json.php +++ b/src/data/sagemaker/2017-07-24/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2017-07-24', 'endpointPrefix' => 'api.sagemaker', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'SageMaker', 'serviceFullName' => 'Amazon SageMaker Service', 'serviceId' => 'SageMaker', 'signatureVersion' => 'v4', 'signingName' => 'sagemaker', 'targetPrefix' => 'SageMaker', 'uid' => 'sagemaker-2017-07-24', ], 'operations' => [ 'AddAssociation' => [ 'name' => 'AddAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddAssociationRequest', ], 'output' => [ 'shape' => 'AddAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsInput', ], 'output' => [ 'shape' => 'AddTagsOutput', ], ], 'AssociateTrialComponent' => [ 'name' => 'AssociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateTrialComponentRequest', ], 'output' => [ 'shape' => 'AssociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'BatchDescribeModelPackage' => [ 'name' => 'BatchDescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDescribeModelPackageInput', ], 'output' => [ 'shape' => 'BatchDescribeModelPackageOutput', ], ], 'CreateAction' => [ 'name' => 'CreateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateActionRequest', ], 'output' => [ 'shape' => 'CreateActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAlgorithm' => [ 'name' => 'CreateAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAlgorithmInput', ], 'output' => [ 'shape' => 'CreateAlgorithmOutput', ], ], 'CreateApp' => [ 'name' => 'CreateApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppRequest', ], 'output' => [ 'shape' => 'CreateAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateAppImageConfig' => [ 'name' => 'CreateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppImageConfigRequest', ], 'output' => [ 'shape' => 'CreateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateArtifact' => [ 'name' => 'CreateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateArtifactRequest', ], 'output' => [ 'shape' => 'CreateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJob' => [ 'name' => 'CreateAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobRequest', ], 'output' => [ 'shape' => 'CreateAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJobV2' => [ 'name' => 'CreateAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobV2Request', ], 'output' => [ 'shape' => 'CreateAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateCodeRepository' => [ 'name' => 'CreateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCodeRepositoryInput', ], 'output' => [ 'shape' => 'CreateCodeRepositoryOutput', ], ], 'CreateCompilationJob' => [ 'name' => 'CreateCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCompilationJobRequest', ], 'output' => [ 'shape' => 'CreateCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateContext' => [ 'name' => 'CreateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContextRequest', ], 'output' => [ 'shape' => 'CreateContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDataQualityJobDefinition' => [ 'name' => 'CreateDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateDeviceFleet' => [ 'name' => 'CreateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateEdgeDeploymentPlan' => [ 'name' => 'CreateEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'CreateEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgeDeploymentStage' => [ 'name' => 'CreateEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgePackagingJob' => [ 'name' => 'CreateEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgePackagingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpoint' => [ 'name' => 'CreateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointInput', ], 'output' => [ 'shape' => 'CreateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpointConfig' => [ 'name' => 'CreateEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointConfigInput', ], 'output' => [ 'shape' => 'CreateEndpointConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateExperiment' => [ 'name' => 'CreateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateExperimentRequest', ], 'output' => [ 'shape' => 'CreateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFeatureGroup' => [ 'name' => 'CreateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFeatureGroupRequest', ], 'output' => [ 'shape' => 'CreateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFlowDefinition' => [ 'name' => 'CreateFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFlowDefinitionRequest', ], 'output' => [ 'shape' => 'CreateFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHub' => [ 'name' => 'CreateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHubRequest', ], 'output' => [ 'shape' => 'CreateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateHumanTaskUi' => [ 'name' => 'CreateHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHumanTaskUiRequest', ], 'output' => [ 'shape' => 'CreateHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHyperParameterTuningJob' => [ 'name' => 'CreateHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'CreateHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImage' => [ 'name' => 'CreateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageRequest', ], 'output' => [ 'shape' => 'CreateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImageVersion' => [ 'name' => 'CreateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageVersionRequest', ], 'output' => [ 'shape' => 'CreateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateInferenceComponent' => [ 'name' => 'CreateInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceComponentInput', ], 'output' => [ 'shape' => 'CreateInferenceComponentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateInferenceExperiment' => [ 'name' => 'CreateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'CreateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateInferenceRecommendationsJob' => [ 'name' => 'CreateInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'CreateInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateLabelingJob' => [ 'name' => 'CreateLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLabelingJobRequest', ], 'output' => [ 'shape' => 'CreateLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModel' => [ 'name' => 'CreateModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelInput', ], 'output' => [ 'shape' => 'CreateModelOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelBiasJobDefinition' => [ 'name' => 'CreateModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelCard' => [ 'name' => 'CreateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardRequest', ], 'output' => [ 'shape' => 'CreateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelCardExportJob' => [ 'name' => 'CreateModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardExportJobRequest', ], 'output' => [ 'shape' => 'CreateModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelExplainabilityJobDefinition' => [ 'name' => 'CreateModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelPackage' => [ 'name' => 'CreateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageInput', ], 'output' => [ 'shape' => 'CreateModelPackageOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelPackageGroup' => [ 'name' => 'CreateModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageGroupInput', ], 'output' => [ 'shape' => 'CreateModelPackageGroupOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelQualityJobDefinition' => [ 'name' => 'CreateModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateMonitoringSchedule' => [ 'name' => 'CreateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'CreateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateNotebookInstance' => [ 'name' => 'CreateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateNotebookInstanceLifecycleConfig' => [ 'name' => 'CreateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreatePipeline' => [ 'name' => 'CreatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePipelineRequest', ], 'output' => [ 'shape' => 'CreatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreatePresignedDomainUrl' => [ 'name' => 'CreatePresignedDomainUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedDomainUrlRequest', ], 'output' => [ 'shape' => 'CreatePresignedDomainUrlResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'CreatePresignedNotebookInstanceUrl' => [ 'name' => 'CreatePresignedNotebookInstanceUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlInput', ], 'output' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlOutput', ], ], 'CreateProcessingJob' => [ 'name' => 'CreateProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProcessingJobRequest', ], 'output' => [ 'shape' => 'CreateProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateProject' => [ 'name' => 'CreateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProjectInput', ], 'output' => [ 'shape' => 'CreateProjectOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateSpace' => [ 'name' => 'CreateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSpaceRequest', ], 'output' => [ 'shape' => 'CreateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateStudioLifecycleConfig' => [ 'name' => 'CreateStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'CreateStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateTrainingJob' => [ 'name' => 'CreateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrainingJobRequest', ], 'output' => [ 'shape' => 'CreateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTransformJob' => [ 'name' => 'CreateTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTransformJobRequest', ], 'output' => [ 'shape' => 'CreateTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTrial' => [ 'name' => 'CreateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialRequest', ], 'output' => [ 'shape' => 'CreateTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateTrialComponent' => [ 'name' => 'CreateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialComponentRequest', ], 'output' => [ 'shape' => 'CreateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateUserProfile' => [ 'name' => 'CreateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserProfileRequest', ], 'output' => [ 'shape' => 'CreateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateWorkforce' => [ 'name' => 'CreateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkforceRequest', ], 'output' => [ 'shape' => 'CreateWorkforceResponse', ], ], 'CreateWorkteam' => [ 'name' => 'CreateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkteamRequest', ], 'output' => [ 'shape' => 'CreateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeleteAction' => [ 'name' => 'DeleteAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteActionRequest', ], 'output' => [ 'shape' => 'DeleteActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAlgorithm' => [ 'name' => 'DeleteAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAlgorithmInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteApp' => [ 'name' => 'DeleteApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAppImageConfig' => [ 'name' => 'DeleteAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppImageConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteArtifact' => [ 'name' => 'DeleteArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteArtifactRequest', ], 'output' => [ 'shape' => 'DeleteArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAssociation' => [ 'name' => 'DeleteAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAssociationRequest', ], 'output' => [ 'shape' => 'DeleteAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteCodeRepository' => [ 'name' => 'DeleteCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCodeRepositoryInput', ], ], 'DeleteCompilationJob' => [ 'name' => 'DeleteCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCompilationJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteContext' => [ 'name' => 'DeleteContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContextRequest', ], 'output' => [ 'shape' => 'DeleteContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDataQualityJobDefinition' => [ 'name' => 'DeleteDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDataQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDeviceFleet' => [ 'name' => 'DeleteDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteEdgeDeploymentPlan' => [ 'name' => 'DeleteEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentPlanRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEdgeDeploymentStage' => [ 'name' => 'DeleteEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEndpoint' => [ 'name' => 'DeleteEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointInput', ], ], 'DeleteEndpointConfig' => [ 'name' => 'DeleteEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointConfigInput', ], ], 'DeleteExperiment' => [ 'name' => 'DeleteExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteExperimentRequest', ], 'output' => [ 'shape' => 'DeleteExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFeatureGroup' => [ 'name' => 'DeleteFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFeatureGroupRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFlowDefinition' => [ 'name' => 'DeleteFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHub' => [ 'name' => 'DeleteHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHubContent' => [ 'name' => 'DeleteHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubContentRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHumanTaskUi' => [ 'name' => 'DeleteHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DeleteHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteImage' => [ 'name' => 'DeleteImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageRequest', ], 'output' => [ 'shape' => 'DeleteImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteImageVersion' => [ 'name' => 'DeleteImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageVersionRequest', ], 'output' => [ 'shape' => 'DeleteImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteInferenceComponent' => [ 'name' => 'DeleteInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInferenceComponentInput', ], ], 'DeleteInferenceExperiment' => [ 'name' => 'DeleteInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DeleteInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModel' => [ 'name' => 'DeleteModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelInput', ], ], 'DeleteModelBiasJobDefinition' => [ 'name' => 'DeleteModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelBiasJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelCard' => [ 'name' => 'DeleteModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelCardRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelExplainabilityJobDefinition' => [ 'name' => 'DeleteModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelExplainabilityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelPackage' => [ 'name' => 'DeleteModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroup' => [ 'name' => 'DeleteModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroupPolicy' => [ 'name' => 'DeleteModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupPolicyInput', ], ], 'DeleteModelQualityJobDefinition' => [ 'name' => 'DeleteModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteMonitoringSchedule' => [ 'name' => 'DeleteMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteNotebookInstance' => [ 'name' => 'DeleteNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceInput', ], ], 'DeleteNotebookInstanceLifecycleConfig' => [ 'name' => 'DeleteNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceLifecycleConfigInput', ], ], 'DeletePipeline' => [ 'name' => 'DeletePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePipelineRequest', ], 'output' => [ 'shape' => 'DeletePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteProject' => [ 'name' => 'DeleteProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProjectInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteSpace' => [ 'name' => 'DeleteSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSpaceRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteStudioLifecycleConfig' => [ 'name' => 'DeleteStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStudioLifecycleConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteTags' => [ 'name' => 'DeleteTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTagsInput', ], 'output' => [ 'shape' => 'DeleteTagsOutput', ], ], 'DeleteTrial' => [ 'name' => 'DeleteTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialRequest', ], 'output' => [ 'shape' => 'DeleteTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteTrialComponent' => [ 'name' => 'DeleteTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialComponentRequest', ], 'output' => [ 'shape' => 'DeleteTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteUserProfile' => [ 'name' => 'DeleteUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserProfileRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteWorkforce' => [ 'name' => 'DeleteWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkforceRequest', ], 'output' => [ 'shape' => 'DeleteWorkforceResponse', ], ], 'DeleteWorkteam' => [ 'name' => 'DeleteWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkteamRequest', ], 'output' => [ 'shape' => 'DeleteWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeregisterDevices' => [ 'name' => 'DeregisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterDevicesRequest', ], ], 'DescribeAction' => [ 'name' => 'DescribeAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeActionRequest', ], 'output' => [ 'shape' => 'DescribeActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAlgorithm' => [ 'name' => 'DescribeAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAlgorithmInput', ], 'output' => [ 'shape' => 'DescribeAlgorithmOutput', ], ], 'DescribeApp' => [ 'name' => 'DescribeApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppRequest', ], 'output' => [ 'shape' => 'DescribeAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAppImageConfig' => [ 'name' => 'DescribeAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppImageConfigRequest', ], 'output' => [ 'shape' => 'DescribeAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeArtifact' => [ 'name' => 'DescribeArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeArtifactRequest', ], 'output' => [ 'shape' => 'DescribeArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJob' => [ 'name' => 'DescribeAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobRequest', ], 'output' => [ 'shape' => 'DescribeAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJobV2' => [ 'name' => 'DescribeAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobV2Request', ], 'output' => [ 'shape' => 'DescribeAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeCluster' => [ 'name' => 'DescribeCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClusterRequest', ], 'output' => [ 'shape' => 'DescribeClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeClusterNode' => [ 'name' => 'DescribeClusterNode', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClusterNodeRequest', ], 'output' => [ 'shape' => 'DescribeClusterNodeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeCodeRepository' => [ 'name' => 'DescribeCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCodeRepositoryInput', ], 'output' => [ 'shape' => 'DescribeCodeRepositoryOutput', ], ], 'DescribeCompilationJob' => [ 'name' => 'DescribeCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCompilationJobRequest', ], 'output' => [ 'shape' => 'DescribeCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeContext' => [ 'name' => 'DescribeContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContextRequest', ], 'output' => [ 'shape' => 'DescribeContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDataQualityJobDefinition' => [ 'name' => 'DescribeDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDevice' => [ 'name' => 'DescribeDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceRequest', ], 'output' => [ 'shape' => 'DescribeDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDeviceFleet' => [ 'name' => 'DescribeDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceFleetRequest', ], 'output' => [ 'shape' => 'DescribeDeviceFleetResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgeDeploymentPlan' => [ 'name' => 'DescribeEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'DescribeEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgePackagingJob' => [ 'name' => 'DescribeEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgePackagingJobRequest', ], 'output' => [ 'shape' => 'DescribeEdgePackagingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEndpoint' => [ 'name' => 'DescribeEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointInput', ], 'output' => [ 'shape' => 'DescribeEndpointOutput', ], ], 'DescribeEndpointConfig' => [ 'name' => 'DescribeEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointConfigInput', ], 'output' => [ 'shape' => 'DescribeEndpointConfigOutput', ], ], 'DescribeExperiment' => [ 'name' => 'DescribeExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExperimentRequest', ], 'output' => [ 'shape' => 'DescribeExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureGroup' => [ 'name' => 'DescribeFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureGroupRequest', ], 'output' => [ 'shape' => 'DescribeFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureMetadata' => [ 'name' => 'DescribeFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureMetadataRequest', ], 'output' => [ 'shape' => 'DescribeFeatureMetadataResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFlowDefinition' => [ 'name' => 'DescribeFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHub' => [ 'name' => 'DescribeHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubRequest', ], 'output' => [ 'shape' => 'DescribeHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHubContent' => [ 'name' => 'DescribeHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubContentRequest', ], 'output' => [ 'shape' => 'DescribeHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHumanTaskUi' => [ 'name' => 'DescribeHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DescribeHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHyperParameterTuningJob' => [ 'name' => 'DescribeHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'DescribeHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImage' => [ 'name' => 'DescribeImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageRequest', ], 'output' => [ 'shape' => 'DescribeImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImageVersion' => [ 'name' => 'DescribeImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageVersionRequest', ], 'output' => [ 'shape' => 'DescribeImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceComponent' => [ 'name' => 'DescribeInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceComponentInput', ], 'output' => [ 'shape' => 'DescribeInferenceComponentOutput', ], ], 'DescribeInferenceExperiment' => [ 'name' => 'DescribeInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DescribeInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceRecommendationsJob' => [ 'name' => 'DescribeInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'DescribeInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLabelingJob' => [ 'name' => 'DescribeLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLabelingJobRequest', ], 'output' => [ 'shape' => 'DescribeLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLineageGroup' => [ 'name' => 'DescribeLineageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLineageGroupRequest', ], 'output' => [ 'shape' => 'DescribeLineageGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModel' => [ 'name' => 'DescribeModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelInput', ], 'output' => [ 'shape' => 'DescribeModelOutput', ], ], 'DescribeModelBiasJobDefinition' => [ 'name' => 'DescribeModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCard' => [ 'name' => 'DescribeModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardRequest', ], 'output' => [ 'shape' => 'DescribeModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCardExportJob' => [ 'name' => 'DescribeModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardExportJobRequest', ], 'output' => [ 'shape' => 'DescribeModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelExplainabilityJobDefinition' => [ 'name' => 'DescribeModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelPackage' => [ 'name' => 'DescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageInput', ], 'output' => [ 'shape' => 'DescribeModelPackageOutput', ], ], 'DescribeModelPackageGroup' => [ 'name' => 'DescribeModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageGroupInput', ], 'output' => [ 'shape' => 'DescribeModelPackageGroupOutput', ], ], 'DescribeModelQualityJobDefinition' => [ 'name' => 'DescribeModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeMonitoringSchedule' => [ 'name' => 'DescribeMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'DescribeMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeNotebookInstance' => [ 'name' => 'DescribeNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceOutput', ], ], 'DescribeNotebookInstanceLifecycleConfig' => [ 'name' => 'DescribeNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigOutput', ], ], 'DescribePipeline' => [ 'name' => 'DescribePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineRequest', ], 'output' => [ 'shape' => 'DescribePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineDefinitionForExecution' => [ 'name' => 'DescribePipelineDefinitionForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineDefinitionForExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineDefinitionForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineExecution' => [ 'name' => 'DescribePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProcessingJob' => [ 'name' => 'DescribeProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProcessingJobRequest', ], 'output' => [ 'shape' => 'DescribeProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProject' => [ 'name' => 'DescribeProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProjectInput', ], 'output' => [ 'shape' => 'DescribeProjectOutput', ], ], 'DescribeSpace' => [ 'name' => 'DescribeSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSpaceRequest', ], 'output' => [ 'shape' => 'DescribeSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeStudioLifecycleConfig' => [ 'name' => 'DescribeStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'DescribeStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeSubscribedWorkteam' => [ 'name' => 'DescribeSubscribedWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSubscribedWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeSubscribedWorkteamResponse', ], ], 'DescribeTrainingJob' => [ 'name' => 'DescribeTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrainingJobRequest', ], 'output' => [ 'shape' => 'DescribeTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTransformJob' => [ 'name' => 'DescribeTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTransformJobRequest', ], 'output' => [ 'shape' => 'DescribeTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrial' => [ 'name' => 'DescribeTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialRequest', ], 'output' => [ 'shape' => 'DescribeTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrialComponent' => [ 'name' => 'DescribeTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialComponentRequest', ], 'output' => [ 'shape' => 'DescribeTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeUserProfile' => [ 'name' => 'DescribeUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserProfileRequest', ], 'output' => [ 'shape' => 'DescribeUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DescribeWorkforce' => [ 'name' => 'DescribeWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkforceRequest', ], 'output' => [ 'shape' => 'DescribeWorkforceResponse', ], ], 'DescribeWorkteam' => [ 'name' => 'DescribeWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeWorkteamResponse', ], ], 'DisableSagemakerServicecatalogPortfolio' => [ 'name' => 'DisableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioOutput', ], ], 'DisassociateTrialComponent' => [ 'name' => 'DisassociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateTrialComponentRequest', ], 'output' => [ 'shape' => 'DisassociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'EnableSagemakerServicecatalogPortfolio' => [ 'name' => 'EnableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioOutput', ], ], 'GetDeviceFleetReport' => [ 'name' => 'GetDeviceFleetReport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceFleetReportRequest', ], 'output' => [ 'shape' => 'GetDeviceFleetReportResponse', ], ], 'GetLineageGroupPolicy' => [ 'name' => 'GetLineageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLineageGroupPolicyRequest', ], 'output' => [ 'shape' => 'GetLineageGroupPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetModelPackageGroupPolicy' => [ 'name' => 'GetModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'GetModelPackageGroupPolicyOutput', ], ], 'GetSagemakerServicecatalogPortfolioStatus' => [ 'name' => 'GetSagemakerServicecatalogPortfolioStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusInput', ], 'output' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusOutput', ], ], 'GetScalingConfigurationRecommendation' => [ 'name' => 'GetScalingConfigurationRecommendation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetScalingConfigurationRecommendationRequest', ], 'output' => [ 'shape' => 'GetScalingConfigurationRecommendationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetSearchSuggestions' => [ 'name' => 'GetSearchSuggestions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSearchSuggestionsRequest', ], 'output' => [ 'shape' => 'GetSearchSuggestionsResponse', ], ], 'ImportHubContent' => [ 'name' => 'ImportHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportHubContentRequest', ], 'output' => [ 'shape' => 'ImportHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'ListActions' => [ 'name' => 'ListActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListActionsRequest', ], 'output' => [ 'shape' => 'ListActionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAlgorithms' => [ 'name' => 'ListAlgorithms', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAlgorithmsInput', ], 'output' => [ 'shape' => 'ListAlgorithmsOutput', ], ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAliasesRequest', ], 'output' => [ 'shape' => 'ListAliasesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAppImageConfigs' => [ 'name' => 'ListAppImageConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppImageConfigsRequest', ], 'output' => [ 'shape' => 'ListAppImageConfigsResponse', ], ], 'ListApps' => [ 'name' => 'ListApps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppsRequest', ], 'output' => [ 'shape' => 'ListAppsResponse', ], ], 'ListArtifacts' => [ 'name' => 'ListArtifacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListArtifactsRequest', ], 'output' => [ 'shape' => 'ListArtifactsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAssociations' => [ 'name' => 'ListAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAssociationsRequest', ], 'output' => [ 'shape' => 'ListAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAutoMLJobs' => [ 'name' => 'ListAutoMLJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAutoMLJobsRequest', ], 'output' => [ 'shape' => 'ListAutoMLJobsResponse', ], ], 'ListCandidatesForAutoMLJob' => [ 'name' => 'ListCandidatesForAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCandidatesForAutoMLJobRequest', ], 'output' => [ 'shape' => 'ListCandidatesForAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListClusterNodes' => [ 'name' => 'ListClusterNodes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClusterNodesRequest', ], 'output' => [ 'shape' => 'ListClusterNodesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersRequest', ], 'output' => [ 'shape' => 'ListClustersResponse', ], ], 'ListCodeRepositories' => [ 'name' => 'ListCodeRepositories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCodeRepositoriesInput', ], 'output' => [ 'shape' => 'ListCodeRepositoriesOutput', ], ], 'ListCompilationJobs' => [ 'name' => 'ListCompilationJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCompilationJobsRequest', ], 'output' => [ 'shape' => 'ListCompilationJobsResponse', ], ], 'ListContexts' => [ 'name' => 'ListContexts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContextsRequest', ], 'output' => [ 'shape' => 'ListContextsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListDataQualityJobDefinitions' => [ 'name' => 'ListDataQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDataQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListDataQualityJobDefinitionsResponse', ], ], 'ListDeviceFleets' => [ 'name' => 'ListDeviceFleets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDeviceFleetsRequest', ], 'output' => [ 'shape' => 'ListDeviceFleetsResponse', ], ], 'ListDevices' => [ 'name' => 'ListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicesRequest', ], 'output' => [ 'shape' => 'ListDevicesResponse', ], ], 'ListDomains' => [ 'name' => 'ListDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDomainsRequest', ], 'output' => [ 'shape' => 'ListDomainsResponse', ], ], 'ListEdgeDeploymentPlans' => [ 'name' => 'ListEdgeDeploymentPlans', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgeDeploymentPlansRequest', ], 'output' => [ 'shape' => 'ListEdgeDeploymentPlansResponse', ], ], 'ListEdgePackagingJobs' => [ 'name' => 'ListEdgePackagingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgePackagingJobsRequest', ], 'output' => [ 'shape' => 'ListEdgePackagingJobsResponse', ], ], 'ListEndpointConfigs' => [ 'name' => 'ListEndpointConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointConfigsInput', ], 'output' => [ 'shape' => 'ListEndpointConfigsOutput', ], ], 'ListEndpoints' => [ 'name' => 'ListEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointsInput', ], 'output' => [ 'shape' => 'ListEndpointsOutput', ], ], 'ListExperiments' => [ 'name' => 'ListExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListExperimentsRequest', ], 'output' => [ 'shape' => 'ListExperimentsResponse', ], ], 'ListFeatureGroups' => [ 'name' => 'ListFeatureGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFeatureGroupsRequest', ], 'output' => [ 'shape' => 'ListFeatureGroupsResponse', ], ], 'ListFlowDefinitions' => [ 'name' => 'ListFlowDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFlowDefinitionsRequest', ], 'output' => [ 'shape' => 'ListFlowDefinitionsResponse', ], ], 'ListHubContentVersions' => [ 'name' => 'ListHubContentVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentVersionsRequest', ], 'output' => [ 'shape' => 'ListHubContentVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubContents' => [ 'name' => 'ListHubContents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentsRequest', ], 'output' => [ 'shape' => 'ListHubContentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubs' => [ 'name' => 'ListHubs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubsRequest', ], 'output' => [ 'shape' => 'ListHubsResponse', ], ], 'ListHumanTaskUis' => [ 'name' => 'ListHumanTaskUis', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHumanTaskUisRequest', ], 'output' => [ 'shape' => 'ListHumanTaskUisResponse', ], ], 'ListHyperParameterTuningJobs' => [ 'name' => 'ListHyperParameterTuningJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHyperParameterTuningJobsRequest', ], 'output' => [ 'shape' => 'ListHyperParameterTuningJobsResponse', ], ], 'ListImageVersions' => [ 'name' => 'ListImageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImageVersionsRequest', ], 'output' => [ 'shape' => 'ListImageVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListImages' => [ 'name' => 'ListImages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImagesRequest', ], 'output' => [ 'shape' => 'ListImagesResponse', ], ], 'ListInferenceComponents' => [ 'name' => 'ListInferenceComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceComponentsInput', ], 'output' => [ 'shape' => 'ListInferenceComponentsOutput', ], ], 'ListInferenceExperiments' => [ 'name' => 'ListInferenceExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceExperimentsRequest', ], 'output' => [ 'shape' => 'ListInferenceExperimentsResponse', ], ], 'ListInferenceRecommendationsJobSteps' => [ 'name' => 'ListInferenceRecommendationsJobSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobStepsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListInferenceRecommendationsJobs' => [ 'name' => 'ListInferenceRecommendationsJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobsResponse', ], ], 'ListLabelingJobs' => [ 'name' => 'ListLabelingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsResponse', ], ], 'ListLabelingJobsForWorkteam' => [ 'name' => 'ListLabelingJobsForWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsForWorkteamRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsForWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListLineageGroups' => [ 'name' => 'ListLineageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLineageGroupsRequest', ], 'output' => [ 'shape' => 'ListLineageGroupsResponse', ], ], 'ListModelBiasJobDefinitions' => [ 'name' => 'ListModelBiasJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelBiasJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelBiasJobDefinitionsResponse', ], ], 'ListModelCardExportJobs' => [ 'name' => 'ListModelCardExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardExportJobsRequest', ], 'output' => [ 'shape' => 'ListModelCardExportJobsResponse', ], ], 'ListModelCardVersions' => [ 'name' => 'ListModelCardVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardVersionsRequest', ], 'output' => [ 'shape' => 'ListModelCardVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListModelCards' => [ 'name' => 'ListModelCards', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardsRequest', ], 'output' => [ 'shape' => 'ListModelCardsResponse', ], ], 'ListModelExplainabilityJobDefinitions' => [ 'name' => 'ListModelExplainabilityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsResponse', ], ], 'ListModelMetadata' => [ 'name' => 'ListModelMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelMetadataRequest', ], 'output' => [ 'shape' => 'ListModelMetadataResponse', ], ], 'ListModelPackageGroups' => [ 'name' => 'ListModelPackageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackageGroupsInput', ], 'output' => [ 'shape' => 'ListModelPackageGroupsOutput', ], ], 'ListModelPackages' => [ 'name' => 'ListModelPackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackagesInput', ], 'output' => [ 'shape' => 'ListModelPackagesOutput', ], ], 'ListModelQualityJobDefinitions' => [ 'name' => 'ListModelQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelQualityJobDefinitionsResponse', ], ], 'ListModels' => [ 'name' => 'ListModels', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelsInput', ], 'output' => [ 'shape' => 'ListModelsOutput', ], ], 'ListMonitoringAlertHistory' => [ 'name' => 'ListMonitoringAlertHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertHistoryRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertHistoryResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringAlerts' => [ 'name' => 'ListMonitoringAlerts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertsRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringExecutions' => [ 'name' => 'ListMonitoringExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringExecutionsRequest', ], 'output' => [ 'shape' => 'ListMonitoringExecutionsResponse', ], ], 'ListMonitoringSchedules' => [ 'name' => 'ListMonitoringSchedules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringSchedulesRequest', ], 'output' => [ 'shape' => 'ListMonitoringSchedulesResponse', ], ], 'ListNotebookInstanceLifecycleConfigs' => [ 'name' => 'ListNotebookInstanceLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsInput', ], 'output' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsOutput', ], ], 'ListNotebookInstances' => [ 'name' => 'ListNotebookInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstancesInput', ], 'output' => [ 'shape' => 'ListNotebookInstancesOutput', ], ], 'ListPipelineExecutionSteps' => [ 'name' => 'ListPipelineExecutionSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionStepsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineExecutions' => [ 'name' => 'ListPipelineExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineParametersForExecution' => [ 'name' => 'ListPipelineParametersForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineParametersForExecutionRequest', ], 'output' => [ 'shape' => 'ListPipelineParametersForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelines' => [ 'name' => 'ListPipelines', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelinesRequest', ], 'output' => [ 'shape' => 'ListPipelinesResponse', ], ], 'ListProcessingJobs' => [ 'name' => 'ListProcessingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProcessingJobsRequest', ], 'output' => [ 'shape' => 'ListProcessingJobsResponse', ], ], 'ListProjects' => [ 'name' => 'ListProjects', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProjectsInput', ], 'output' => [ 'shape' => 'ListProjectsOutput', ], ], 'ListResourceCatalogs' => [ 'name' => 'ListResourceCatalogs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceCatalogsRequest', ], 'output' => [ 'shape' => 'ListResourceCatalogsResponse', ], ], 'ListSpaces' => [ 'name' => 'ListSpaces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSpacesRequest', ], 'output' => [ 'shape' => 'ListSpacesResponse', ], ], 'ListStageDevices' => [ 'name' => 'ListStageDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStageDevicesRequest', ], 'output' => [ 'shape' => 'ListStageDevicesResponse', ], ], 'ListStudioLifecycleConfigs' => [ 'name' => 'ListStudioLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStudioLifecycleConfigsRequest', ], 'output' => [ 'shape' => 'ListStudioLifecycleConfigsResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'ListSubscribedWorkteams' => [ 'name' => 'ListSubscribedWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSubscribedWorkteamsRequest', ], 'output' => [ 'shape' => 'ListSubscribedWorkteamsResponse', ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsInput', ], 'output' => [ 'shape' => 'ListTagsOutput', ], ], 'ListTrainingJobs' => [ 'name' => 'ListTrainingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsResponse', ], ], 'ListTrainingJobsForHyperParameterTuningJob' => [ 'name' => 'ListTrainingJobsForHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTransformJobs' => [ 'name' => 'ListTransformJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTransformJobsRequest', ], 'output' => [ 'shape' => 'ListTransformJobsResponse', ], ], 'ListTrialComponents' => [ 'name' => 'ListTrialComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialComponentsRequest', ], 'output' => [ 'shape' => 'ListTrialComponentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTrials' => [ 'name' => 'ListTrials', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialsRequest', ], 'output' => [ 'shape' => 'ListTrialsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListUserProfiles' => [ 'name' => 'ListUserProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserProfilesRequest', ], 'output' => [ 'shape' => 'ListUserProfilesResponse', ], ], 'ListWorkforces' => [ 'name' => 'ListWorkforces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkforcesRequest', ], 'output' => [ 'shape' => 'ListWorkforcesResponse', ], ], 'ListWorkteams' => [ 'name' => 'ListWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkteamsRequest', ], 'output' => [ 'shape' => 'ListWorkteamsResponse', ], ], 'PutModelPackageGroupPolicy' => [ 'name' => 'PutModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'PutModelPackageGroupPolicyOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'QueryLineage' => [ 'name' => 'QueryLineage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'QueryLineageRequest', ], 'output' => [ 'shape' => 'QueryLineageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RegisterDevices' => [ 'name' => 'RegisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterDevicesRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'RenderUiTemplate' => [ 'name' => 'RenderUiTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RenderUiTemplateRequest', ], 'output' => [ 'shape' => 'RenderUiTemplateResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RetryPipelineExecution' => [ 'name' => 'RetryPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RetryPipelineExecutionRequest', ], 'output' => [ 'shape' => 'RetryPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'Search' => [ 'name' => 'Search', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchRequest', ], 'output' => [ 'shape' => 'SearchResponse', ], ], 'SendPipelineExecutionStepFailure' => [ 'name' => 'SendPipelineExecutionStepFailure', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepFailureRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepFailureResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'SendPipelineExecutionStepSuccess' => [ 'name' => 'SendPipelineExecutionStepSuccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepSuccessRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepSuccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'StartEdgeDeploymentStage' => [ 'name' => 'StartEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartEdgeDeploymentStageRequest', ], ], 'StartInferenceExperiment' => [ 'name' => 'StartInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StartInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StartMonitoringSchedule' => [ 'name' => 'StartMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StartNotebookInstance' => [ 'name' => 'StartNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartNotebookInstanceInput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'StartPipelineExecution' => [ 'name' => 'StartPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StartPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'StopAutoMLJob' => [ 'name' => 'StopAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopAutoMLJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopCompilationJob' => [ 'name' => 'StopCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopCompilationJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopEdgeDeploymentStage' => [ 'name' => 'StopEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgeDeploymentStageRequest', ], ], 'StopEdgePackagingJob' => [ 'name' => 'StopEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgePackagingJobRequest', ], ], 'StopHyperParameterTuningJob' => [ 'name' => 'StopHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopHyperParameterTuningJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceExperiment' => [ 'name' => 'StopInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StopInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceRecommendationsJob' => [ 'name' => 'StopInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceRecommendationsJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopLabelingJob' => [ 'name' => 'StopLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopLabelingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopMonitoringSchedule' => [ 'name' => 'StopMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopNotebookInstance' => [ 'name' => 'StopNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopNotebookInstanceInput', ], ], 'StopPipelineExecution' => [ 'name' => 'StopPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StopPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'StopProcessingJob' => [ 'name' => 'StopProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopProcessingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTrainingJob' => [ 'name' => 'StopTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTrainingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTransformJob' => [ 'name' => 'StopTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTransformJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAction' => [ 'name' => 'UpdateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateActionRequest', ], 'output' => [ 'shape' => 'UpdateActionResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAppImageConfig' => [ 'name' => 'UpdateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAppImageConfigRequest', ], 'output' => [ 'shape' => 'UpdateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateArtifact' => [ 'name' => 'UpdateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateArtifactRequest', ], 'output' => [ 'shape' => 'UpdateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateCluster' => [ 'name' => 'UpdateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateClusterRequest', ], 'output' => [ 'shape' => 'UpdateClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateCodeRepository' => [ 'name' => 'UpdateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCodeRepositoryInput', ], 'output' => [ 'shape' => 'UpdateCodeRepositoryOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateContext' => [ 'name' => 'UpdateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContextRequest', ], 'output' => [ 'shape' => 'UpdateContextResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateDeviceFleet' => [ 'name' => 'UpdateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'UpdateDevices' => [ 'name' => 'UpdateDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDevicesRequest', ], ], 'UpdateDomain' => [ 'name' => 'UpdateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDomainRequest', ], 'output' => [ 'shape' => 'UpdateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateEndpoint' => [ 'name' => 'UpdateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointInput', ], 'output' => [ 'shape' => 'UpdateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateEndpointWeightsAndCapacities' => [ 'name' => 'UpdateEndpointWeightsAndCapacities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesInput', ], 'output' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateExperiment' => [ 'name' => 'UpdateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateExperimentRequest', ], 'output' => [ 'shape' => 'UpdateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateFeatureGroup' => [ 'name' => 'UpdateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureGroupRequest', ], 'output' => [ 'shape' => 'UpdateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateFeatureMetadata' => [ 'name' => 'UpdateFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureMetadataRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateHub' => [ 'name' => 'UpdateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateHubRequest', ], 'output' => [ 'shape' => 'UpdateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImage' => [ 'name' => 'UpdateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageRequest', ], 'output' => [ 'shape' => 'UpdateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImageVersion' => [ 'name' => 'UpdateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageVersionRequest', ], 'output' => [ 'shape' => 'UpdateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateInferenceComponent' => [ 'name' => 'UpdateInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceComponentInput', ], 'output' => [ 'shape' => 'UpdateInferenceComponentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateInferenceComponentRuntimeConfig' => [ 'name' => 'UpdateInferenceComponentRuntimeConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceComponentRuntimeConfigInput', ], 'output' => [ 'shape' => 'UpdateInferenceComponentRuntimeConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateInferenceExperiment' => [ 'name' => 'UpdateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'UpdateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateModelCard' => [ 'name' => 'UpdateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelCardRequest', ], 'output' => [ 'shape' => 'UpdateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateModelPackage' => [ 'name' => 'UpdateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelPackageInput', ], 'output' => [ 'shape' => 'UpdateModelPackageOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateMonitoringAlert' => [ 'name' => 'UpdateMonitoringAlert', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringAlertRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringAlertResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateMonitoringSchedule' => [ 'name' => 'UpdateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateNotebookInstance' => [ 'name' => 'UpdateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateNotebookInstanceLifecycleConfig' => [ 'name' => 'UpdateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdatePipeline' => [ 'name' => 'UpdatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineRequest', ], 'output' => [ 'shape' => 'UpdatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdatePipelineExecution' => [ 'name' => 'UpdatePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineExecutionRequest', ], 'output' => [ 'shape' => 'UpdatePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateProject' => [ 'name' => 'UpdateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProjectInput', ], 'output' => [ 'shape' => 'UpdateProjectOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateSpace' => [ 'name' => 'UpdateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateSpaceRequest', ], 'output' => [ 'shape' => 'UpdateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrainingJob' => [ 'name' => 'UpdateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrainingJobRequest', ], 'output' => [ 'shape' => 'UpdateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateTrial' => [ 'name' => 'UpdateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialRequest', ], 'output' => [ 'shape' => 'UpdateTrialResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrialComponent' => [ 'name' => 'UpdateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialComponentRequest', ], 'output' => [ 'shape' => 'UpdateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateUserProfile' => [ 'name' => 'UpdateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserProfileRequest', ], 'output' => [ 'shape' => 'UpdateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateWorkforce' => [ 'name' => 'UpdateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkforceRequest', ], 'output' => [ 'shape' => 'UpdateWorkforceResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateWorkteam' => [ 'name' => 'UpdateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkteamRequest', ], 'output' => [ 'shape' => 'UpdateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], ], 'shapes' => [ 'Accept' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'AcceptEula' => [ 'type' => 'boolean', ], 'AccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^\\d+$', ], 'ActionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/.*', ], 'ActionSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ActionStatus' => [ 'type' => 'string', 'enum' => [ 'Unknown', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ActionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionSummary', ], ], 'ActionSummary' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String64', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AddAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'AddAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'AddTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AddTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'max' => 3, ], 'AdditionalInferenceSpecificationDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Containers', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'AdditionalInferenceSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalInferenceSpecificationDefinition', ], 'max' => 15, 'min' => 1, ], 'AdditionalS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'AdditionalS3DataSourceDataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], ], ], 'AdditionalS3DataSourceDataType' => [ 'type' => 'string', 'enum' => [ 'S3Object', ], ], 'AgentVersion' => [ 'type' => 'structure', 'required' => [ 'Version', 'AgentCount', ], 'members' => [ 'Version' => [ 'shape' => 'EdgeVersion', ], 'AgentCount' => [ 'shape' => 'Long', ], ], ], 'AgentVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentVersion', ], ], 'AggregationTransformationValue' => [ 'type' => 'string', 'enum' => [ 'sum', 'avg', 'first', 'min', 'max', ], ], 'AggregationTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'AggregationTransformationValue', ], 'max' => 50, 'min' => 1, ], 'Alarm' => [ 'type' => 'structure', 'members' => [ 'AlarmName' => [ 'shape' => 'AlarmName', ], ], ], 'AlarmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Alarm', ], 'max' => 10, 'min' => 1, ], 'AlarmName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^(?!\\s*$).+', ], 'AlgorithmArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}$', ], 'AlgorithmImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'AlgorithmSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'AlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'EnableSageMakerMetricsTimeSeries' => [ 'shape' => 'Boolean', ], 'ContainerEntrypoint' => [ 'shape' => 'TrainingContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'TrainingContainerArguments', ], 'TrainingImageConfig' => [ 'shape' => 'TrainingImageConfig', ], ], ], 'AlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'AlgorithmStatusDetails' => [ 'type' => 'structure', 'members' => [ 'ValidationStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], ], ], 'AlgorithmStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedAlgorithmStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'AlgorithmStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmStatusItem', ], ], 'AlgorithmSummary' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'AlgorithmStatus', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], ], ], 'AlgorithmSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmSummary', ], ], 'AlgorithmValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TrainingJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TrainingJobDefinition' => [ 'shape' => 'TrainingJobDefinition', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'AlgorithmValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmValidationProfile', ], 'max' => 1, 'min' => 1, ], 'AlgorithmValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'AlgorithmValidationProfiles', ], ], ], 'AnnotationConsolidationConfig' => [ 'type' => 'structure', 'required' => [ 'AnnotationConsolidationLambdaArn', ], 'members' => [ 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], ], ], 'AppArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*', ], 'AppDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'AppImageConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*', ], 'AppImageConfigDetails' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], ], ], 'AppImageConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppImageConfigDetails', ], ], 'AppImageConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppImageConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'AppInstanceType' => [ 'type' => 'string', 'enum' => [ 'system', 'ml.t3.micro', 'ml.t3.small', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.8xlarge', 'ml.m5.12xlarge', 'ml.m5.16xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.12xlarge', 'ml.c5.18xlarge', 'ml.c5.24xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.geospatial.interactive', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', ], ], 'AppList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppDetails', ], ], 'AppManaged' => [ 'type' => 'boolean', ], 'AppName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppNetworkAccessType' => [ 'type' => 'string', 'enum' => [ 'PublicInternetOnly', 'VpcOnly', ], ], 'AppSecurityGroupManagement' => [ 'type' => 'string', 'enum' => [ 'Service', 'Customer', ], ], 'AppSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'AppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'ContainerArguments', ], ], ], 'AppStatus' => [ 'type' => 'string', 'enum' => [ 'Deleted', 'Deleting', 'Failed', 'InService', 'Pending', ], ], 'AppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', 'DetailedProfiler', 'TensorBoard', 'VSCode', 'Savitur', 'CodeEditor', 'JupyterLab', 'RStudioServerPro', 'RSession', 'RSessionGateway', 'Canvas', 'DatasetManager', 'SageMakerLite', 'Local', ], ], 'ApprovalDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'ArnOrName' => [ 'type' => 'string', 'max' => 170, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:artifact/.*', ], 'ArtifactDigest' => [ 'type' => 'string', 'pattern' => '^[\\w:]+$', ], 'ArtifactProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringParameterValue', ], 'value' => [ 'shape' => 'ArtifactPropertyValue', ], 'max' => 30, ], 'ArtifactPropertyValue' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'ArtifactSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceTypes' => [ 'shape' => 'ArtifactSourceTypes', ], ], ], 'ArtifactSourceIdType' => [ 'type' => 'string', 'enum' => [ 'MD5Hash', 'S3ETag', 'S3Version', 'Custom', ], ], 'ArtifactSourceType' => [ 'type' => 'structure', 'required' => [ 'SourceIdType', 'Value', ], 'members' => [ 'SourceIdType' => [ 'shape' => 'ArtifactSourceIdType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ArtifactSourceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSourceType', ], ], 'ArtifactSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSummary', ], ], 'ArtifactSummary' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AssemblyType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', ], ], 'AssociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'AssociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'AssociationEdgeType' => [ 'type' => 'string', 'enum' => [ 'ContributedTo', 'AssociatedWith', 'DerivedFrom', 'Produced', 'SameAs', ], ], 'AssociationEntityArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*', ], 'AssociationSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationSummary', ], ], 'AssociationSummary' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'SourceName' => [ 'shape' => 'ExperimentEntityName', ], 'DestinationName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'AsyncInferenceClientConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrentInvocationsPerInstance' => [ 'shape' => 'MaxConcurrentInvocationsPerInstance', ], ], ], 'AsyncInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'OutputConfig', ], 'members' => [ 'ClientConfig' => [ 'shape' => 'AsyncInferenceClientConfig', ], 'OutputConfig' => [ 'shape' => 'AsyncInferenceOutputConfig', ], ], ], 'AsyncInferenceNotificationConfig' => [ 'type' => 'structure', 'members' => [ 'SuccessTopic' => [ 'shape' => 'SnsTopicArn', ], 'ErrorTopic' => [ 'shape' => 'SnsTopicArn', ], 'IncludeInferenceResponseIn' => [ 'shape' => 'AsyncNotificationTopicTypeList', ], ], ], 'AsyncInferenceOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'DestinationS3Uri', ], 'NotificationConfig' => [ 'shape' => 'AsyncInferenceNotificationConfig', ], 'S3FailurePath' => [ 'shape' => 'DestinationS3Uri', ], ], ], 'AsyncNotificationTopicTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AsyncNotificationTopicTypes', ], 'max' => 2, 'min' => 0, ], 'AsyncNotificationTopicTypes' => [ 'type' => 'string', 'enum' => [ 'SUCCESS_NOTIFICATION_TOPIC', 'ERROR_NOTIFICATION_TOPIC', ], ], 'AthenaCatalog' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'AthenaDatabase' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'AthenaDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'Catalog', 'Database', 'QueryString', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'Catalog' => [ 'shape' => 'AthenaCatalog', ], 'Database' => [ 'shape' => 'AthenaDatabase', ], 'QueryString' => [ 'shape' => 'AthenaQueryString', ], 'WorkGroup' => [ 'shape' => 'AthenaWorkGroup', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'AthenaResultFormat', ], 'OutputCompression' => [ 'shape' => 'AthenaResultCompressionType', ], ], ], 'AthenaQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'AthenaResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'SNAPPY', 'ZLIB', ], ], 'AthenaResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'ORC', 'AVRO', 'JSON', 'TEXTFILE', ], ], 'AthenaWorkGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9._-]+', ], 'AttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.+', ], 'AttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeName', ], 'max' => 16, ], 'AuthMode' => [ 'type' => 'string', 'enum' => [ 'SSO', 'IAM', ], ], 'AutoGenerateEndpointName' => [ 'type' => 'boolean', ], 'AutoMLAlgorithm' => [ 'type' => 'string', 'enum' => [ 'xgboost', 'linear-learner', 'mlp', 'lightgbm', 'catboost', 'randomforest', 'extra-trees', 'nn-torch', 'fastai', ], ], 'AutoMLAlgorithmConfig' => [ 'type' => 'structure', 'required' => [ 'AutoMLAlgorithms', ], 'members' => [ 'AutoMLAlgorithms' => [ 'shape' => 'AutoMLAlgorithms', ], ], ], 'AutoMLAlgorithms' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithm', ], 'max' => 11, ], 'AutoMLAlgorithmsConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithmConfig', ], 'max' => 1, ], 'AutoMLCandidate' => [ 'type' => 'structure', 'required' => [ 'CandidateName', 'ObjectiveStatus', 'CandidateSteps', 'CandidateStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CandidateName' => [ 'shape' => 'CandidateName', ], 'FinalAutoMLJobObjectiveMetric' => [ 'shape' => 'FinalAutoMLJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], 'CandidateSteps' => [ 'shape' => 'CandidateSteps', ], 'CandidateStatus' => [ 'shape' => 'CandidateStatus', ], 'InferenceContainers' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'CandidateProperties' => [ 'shape' => 'CandidateProperties', ], 'InferenceContainerDefinitions' => [ 'shape' => 'AutoMLInferenceContainerDefinitions', ], ], ], 'AutoMLCandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'AutoMLCandidateStep' => [ 'type' => 'structure', 'required' => [ 'CandidateStepType', 'CandidateStepArn', 'CandidateStepName', ], 'members' => [ 'CandidateStepType' => [ 'shape' => 'CandidateStepType', ], 'CandidateStepArn' => [ 'shape' => 'CandidateStepArn', ], 'CandidateStepName' => [ 'shape' => 'CandidateStepName', ], ], ], 'AutoMLCandidates' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidate', ], ], 'AutoMLChannel' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', ], 'members' => [ 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'AutoMLChannelType' => [ 'type' => 'string', 'enum' => [ 'training', 'validation', ], ], 'AutoMLContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', 'ModelDataUrl', ], 'members' => [ 'Image' => [ 'shape' => 'ContainerImage', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'AutoMLContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLContainerDefinition', ], 'max' => 5, ], 'AutoMLDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'AutoMLS3DataSource', ], ], ], 'AutoMLDataSplitConfig' => [ 'type' => 'structure', 'members' => [ 'ValidationFraction' => [ 'shape' => 'ValidationFraction', ], ], ], 'AutoMLFailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'AutoMLInferenceContainerDefinitions' => [ 'type' => 'map', 'key' => [ 'shape' => 'AutoMLProcessingUnit', ], 'value' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'max' => 2, ], 'AutoMLInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:automl-job/.*', ], 'AutoMLJobArtifacts' => [ 'type' => 'structure', 'members' => [ 'CandidateDefinitionNotebookLocation' => [ 'shape' => 'CandidateDefinitionNotebookLocation', ], 'DataExplorationNotebookLocation' => [ 'shape' => 'DataExplorationNotebookLocation', ], ], ], 'AutoMLJobChannel' => [ 'type' => 'structure', 'members' => [ 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], ], ], 'AutoMLJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'MaxCandidates' => [ 'shape' => 'MaxCandidates', ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'shape' => 'MaxRuntimePerTrainingJobInSeconds', ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'shape' => 'MaxAutoMLJobRuntimeInSeconds', ], ], ], 'AutoMLJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'CandidateGenerationConfig' => [ 'shape' => 'AutoMLCandidateGenerationConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], ], ], 'AutoMLJobInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'AutoMLJobObjective' => [ 'type' => 'structure', 'required' => [ 'MetricName', ], 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'AutoMLJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'AutoMLJobSecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'MaxCandidatesReached', 'Failed', 'Stopped', 'MaxAutoMLJobRuntimeReached', 'Stopping', 'CandidateDefinitionsGenerated', 'Completed', 'ExplainabilityError', 'DeployingModel', 'ModelDeploymentError', 'GeneratingModelInsightsReport', 'ModelInsightsError', 'AnalyzingData', 'FeatureEngineering', 'ModelTuning', 'GeneratingExplainabilityReport', 'TrainingModels', 'PreTraining', ], ], 'AutoMLJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'AutoMLJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'AutoMLJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobSummary', ], ], 'AutoMLJobSummary' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], ], ], 'AutoMLMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'AutoMLMaxResultsForTrials' => [ 'type' => 'integer', 'max' => 300, 'min' => 1, ], 'AutoMLMetricEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'BalancedAccuracy', 'R2', 'Recall', 'RecallMacro', 'Precision', 'PrecisionMacro', 'MAE', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', ], ], 'AutoMLMetricExtendedEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'MAE', 'R2', 'BalancedAccuracy', 'Precision', 'PrecisionMacro', 'Recall', 'RecallMacro', 'LogLoss', 'InferenceLatency', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', 'Rouge1', 'Rouge2', 'RougeL', 'RougeLSum', 'Perplexity', 'ValidationLoss', 'TrainingLoss', ], ], 'AutoMLMode' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'ENSEMBLING', 'HYPERPARAMETER_TUNING', ], ], 'AutoMLNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'AutoMLOutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLPartialFailureReason' => [ 'type' => 'structure', 'members' => [ 'PartialFailureMessage' => [ 'shape' => 'AutoMLFailureReason', ], ], ], 'AutoMLPartialFailureReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLPartialFailureReason', ], 'max' => 5, 'min' => 1, ], 'AutoMLProblemTypeConfig' => [ 'type' => 'structure', 'members' => [ 'ImageClassificationJobConfig' => [ 'shape' => 'ImageClassificationJobConfig', ], 'TextClassificationJobConfig' => [ 'shape' => 'TextClassificationJobConfig', ], 'TimeSeriesForecastingJobConfig' => [ 'shape' => 'TimeSeriesForecastingJobConfig', ], 'TabularJobConfig' => [ 'shape' => 'TabularJobConfig', ], 'TextGenerationJobConfig' => [ 'shape' => 'TextGenerationJobConfig', ], ], 'union' => true, ], 'AutoMLProblemTypeConfigName' => [ 'type' => 'string', 'enum' => [ 'ImageClassification', 'TextClassification', 'TimeSeriesForecasting', 'Tabular', 'TextGeneration', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'TabularResolvedAttributes' => [ 'shape' => 'TabularResolvedAttributes', ], 'TextGenerationResolvedAttributes' => [ 'shape' => 'TextGenerationResolvedAttributes', ], ], 'union' => true, ], 'AutoMLProcessingUnit' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'AutoMLResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'AutoMLProblemTypeResolvedAttributes' => [ 'shape' => 'AutoMLProblemTypeResolvedAttributes', ], ], ], 'AutoMLS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'AutoMLS3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'AutoMLSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'AutoMLSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'AutoMLSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'AutoParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'ValueHint', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'ValueHint' => [ 'shape' => 'ParameterValue', ], ], ], 'AutoParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoParameter', ], 'max' => 100, 'min' => 0, ], 'AutoRollbackConfig' => [ 'type' => 'structure', 'members' => [ 'Alarms' => [ 'shape' => 'AlarmList', ], ], ], 'Autotune' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'AutotuneMode', ], ], ], 'AutotuneMode' => [ 'type' => 'string', 'enum' => [ 'Enabled', ], ], 'AwsManagedHumanLoopRequestSource' => [ 'type' => 'string', 'enum' => [ 'AWS/Rekognition/DetectModerationLabels/Image/V3', 'AWS/Textract/AnalyzeDocument/Forms/V1', 'AWS/Textract/AnalyzeExpense', 'AWS/Handshake/VerifyIdentity', 'AWS/Bedrock/ModelEvaluation', ], ], 'BacktestResultsLocation' => [ 'type' => 'string', 'min' => 1, ], 'BaseModelName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'BatchDataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'GenerateInferenceId' => [ 'shape' => 'Boolean', ], ], ], 'BatchDescribeModelPackageError' => [ 'type' => 'structure', 'required' => [ 'ErrorCode', 'ErrorResponse', ], 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorResponse' => [ 'shape' => 'String', ], ], ], 'BatchDescribeModelPackageErrorMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageError', ], ], 'BatchDescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArnList', ], 'members' => [ 'ModelPackageArnList' => [ 'shape' => 'ModelPackageArnList', ], ], ], 'BatchDescribeModelPackageOutput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageSummaries' => [ 'shape' => 'ModelPackageSummaries', ], 'BatchDescribeModelPackageErrorMap' => [ 'shape' => 'BatchDescribeModelPackageErrorMap', ], ], ], 'BatchDescribeModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageArn', 'CreationTime', 'InferenceSpecification', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'BatchStrategy' => [ 'type' => 'string', 'enum' => [ 'MultiRecord', 'SingleRecord', ], ], 'BatchTransformInput' => [ 'type' => 'structure', 'required' => [ 'DataCapturedDestinationS3Uri', 'DatasetFormat', 'LocalPath', ], 'members' => [ 'DataCapturedDestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'DatasetFormat' => [ 'shape' => 'MonitoringDatasetFormat', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'ExcludeFeaturesAttribute' => [ 'shape' => 'ExcludeFeaturesAttribute', ], ], ], 'BestObjectiveNotImproving' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTrainingJobsNotImproving' => [ 'shape' => 'MaxNumberOfTrainingJobsNotImproving', ], ], ], 'Bias' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], 'PreTrainingReport' => [ 'shape' => 'MetricsSource', ], 'PostTrainingReport' => [ 'shape' => 'MetricsSource', ], ], ], 'BillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'BlockedReason' => [ 'type' => 'string', 'max' => 1024, ], 'BlueGreenUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'TrafficRoutingConfiguration', ], 'members' => [ 'TrafficRoutingConfiguration' => [ 'shape' => 'TrafficRoutingConfig', ], 'TerminationWaitInSeconds' => [ 'shape' => 'TerminationWaitInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOperator' => [ 'type' => 'string', 'enum' => [ 'And', 'Or', ], ], 'Branch' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[^ ~^:?*\\[]+', ], 'BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, 'pattern' => '[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]', ], 'CacheHitResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'CallbackStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'SqsQueueUrl' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'CallbackToken' => [ 'type' => 'string', 'max' => 10, 'min' => 10, 'pattern' => '^[a-zA-Z0-9]+$', ], 'CandidateArtifactLocations' => [ 'type' => 'structure', 'required' => [ 'Explainability', ], 'members' => [ 'Explainability' => [ 'shape' => 'ExplainabilityLocation', ], 'ModelInsights' => [ 'shape' => 'ModelInsightsLocation', ], 'BacktestResults' => [ 'shape' => 'BacktestResultsLocation', ], ], ], 'CandidateDefinitionNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'CandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'CandidateName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateProperties' => [ 'type' => 'structure', 'members' => [ 'CandidateArtifactLocations' => [ 'shape' => 'CandidateArtifactLocations', ], 'CandidateMetrics' => [ 'shape' => 'MetricDataList', ], ], ], 'CandidateSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'CandidateStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'CandidateStepArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/.*', ], 'CandidateStepName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateStepType' => [ 'type' => 'string', 'enum' => [ 'AWS::SageMaker::TrainingJob', 'AWS::SageMaker::TransformJob', 'AWS::SageMaker::ProcessingJob', ], ], 'CandidateSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidateStep', ], ], 'CanvasAppSettings' => [ 'type' => 'structure', 'members' => [ 'TimeSeriesForecastingSettings' => [ 'shape' => 'TimeSeriesForecastingSettings', ], 'ModelRegisterSettings' => [ 'shape' => 'ModelRegisterSettings', ], 'WorkspaceSettings' => [ 'shape' => 'WorkspaceSettings', ], 'IdentityProviderOAuthSettings' => [ 'shape' => 'IdentityProviderOAuthSettings', ], 'DirectDeploySettings' => [ 'shape' => 'DirectDeploySettings', ], 'KendraSettings' => [ 'shape' => 'KendraSettings', ], ], ], 'CapacitySize' => [ 'type' => 'structure', 'required' => [ 'Type', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'CapacitySizeType', ], 'Value' => [ 'shape' => 'CapacitySizeValue', ], ], ], 'CapacitySizeType' => [ 'type' => 'string', 'enum' => [ 'INSTANCE_COUNT', 'CAPACITY_PERCENT', ], ], 'CapacitySizeValue' => [ 'type' => 'integer', 'min' => 1, ], 'CaptureContentTypeHeader' => [ 'type' => 'structure', 'members' => [ 'CsvContentTypes' => [ 'shape' => 'CsvContentTypes', ], 'JsonContentTypes' => [ 'shape' => 'JsonContentTypes', ], ], ], 'CaptureMode' => [ 'type' => 'string', 'enum' => [ 'Input', 'Output', 'InputAndOutput', ], ], 'CaptureOption' => [ 'type' => 'structure', 'required' => [ 'CaptureMode', ], 'members' => [ 'CaptureMode' => [ 'shape' => 'CaptureMode', ], ], ], 'CaptureOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptureOption', ], 'max' => 32, 'min' => 1, ], 'CaptureStatus' => [ 'type' => 'string', 'enum' => [ 'Started', 'Stopped', ], ], 'Catalog' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'CategoricalParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String64', ], 'Value' => [ 'shape' => 'CategoricalParameterRangeValues', ], ], ], 'CategoricalParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'Values', ], 'members' => [ 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'String128', ], 'max' => 3, 'min' => 1, ], 'CategoricalParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameterRange', ], 'max' => 30, 'min' => 0, ], 'CategoricalParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameter', ], 'max' => 5, 'min' => 1, ], 'Cents' => [ 'type' => 'integer', 'max' => 99, 'min' => 0, ], 'CertifyForMarketplace' => [ 'type' => 'boolean', ], 'Channel' => [ 'type' => 'structure', 'required' => [ 'ChannelName', 'DataSource', ], 'members' => [ 'ChannelName' => [ 'shape' => 'ChannelName', ], 'DataSource' => [ 'shape' => 'DataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'RecordWrapperType' => [ 'shape' => 'RecordWrapper', ], 'InputMode' => [ 'shape' => 'TrainingInputMode', ], 'ShuffleConfig' => [ 'shape' => 'ShuffleConfig', ], ], ], 'ChannelName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9\\.\\-_]+', ], 'ChannelSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'SupportedContentTypes', 'SupportedInputModes', ], 'members' => [ 'Name' => [ 'shape' => 'ChannelName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedCompressionTypes' => [ 'shape' => 'CompressionTypes', ], 'SupportedInputModes' => [ 'shape' => 'InputModes', ], ], ], 'ChannelSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelSpecification', ], 'max' => 8, 'min' => 1, ], 'CheckpointConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'Cidr' => [ 'type' => 'string', 'max' => 64, 'min' => 4, 'pattern' => '(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)', ], 'Cidrs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cidr', ], ], 'ClarifyCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'ClarifyContentTemplate' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyEnableExplanations' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyExplainerConfig' => [ 'type' => 'structure', 'required' => [ 'ShapConfig', ], 'members' => [ 'EnableExplanations' => [ 'shape' => 'ClarifyEnableExplanations', ], 'InferenceConfig' => [ 'shape' => 'ClarifyInferenceConfig', ], 'ShapConfig' => [ 'shape' => 'ClarifyShapConfig', ], ], ], 'ClarifyFeatureHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeatureType' => [ 'type' => 'string', 'enum' => [ 'numerical', 'categorical', 'text', ], ], 'ClarifyFeatureTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyFeatureType', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeaturesAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyHeader' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyInferenceConfig' => [ 'type' => 'structure', 'members' => [ 'FeaturesAttribute' => [ 'shape' => 'ClarifyFeaturesAttribute', ], 'ContentTemplate' => [ 'shape' => 'ClarifyContentTemplate', ], 'MaxRecordCount' => [ 'shape' => 'ClarifyMaxRecordCount', ], 'MaxPayloadInMB' => [ 'shape' => 'ClarifyMaxPayloadInMB', ], 'ProbabilityIndex' => [ 'shape' => 'ClarifyProbabilityIndex', ], 'LabelIndex' => [ 'shape' => 'ClarifyLabelIndex', ], 'ProbabilityAttribute' => [ 'shape' => 'ClarifyProbabilityAttribute', ], 'LabelAttribute' => [ 'shape' => 'ClarifyLabelAttribute', ], 'LabelHeaders' => [ 'shape' => 'ClarifyLabelHeaders', ], 'FeatureHeaders' => [ 'shape' => 'ClarifyFeatureHeaders', ], 'FeatureTypes' => [ 'shape' => 'ClarifyFeatureTypes', ], ], ], 'ClarifyLabelAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyLabelHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 16, 'min' => 1, ], 'ClarifyLabelIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyMaxPayloadInMB' => [ 'type' => 'integer', 'max' => 25, 'min' => 1, ], 'ClarifyMaxRecordCount' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyMimeType' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*', ], 'ClarifyProbabilityAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyProbabilityIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyShapBaseline' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'ClarifyShapBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'MimeType' => [ 'shape' => 'ClarifyMimeType', ], 'ShapBaseline' => [ 'shape' => 'ClarifyShapBaseline', ], 'ShapBaselineUri' => [ 'shape' => 'Url', ], ], ], 'ClarifyShapConfig' => [ 'type' => 'structure', 'required' => [ 'ShapBaselineConfig', ], 'members' => [ 'ShapBaselineConfig' => [ 'shape' => 'ClarifyShapBaselineConfig', ], 'NumberOfSamples' => [ 'shape' => 'ClarifyShapNumberOfSamples', ], 'UseLogit' => [ 'shape' => 'ClarifyShapUseLogit', ], 'Seed' => [ 'shape' => 'ClarifyShapSeed', ], 'TextConfig' => [ 'shape' => 'ClarifyTextConfig', ], ], ], 'ClarifyShapNumberOfSamples' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyShapSeed' => [ 'type' => 'integer', ], 'ClarifyShapUseLogit' => [ 'type' => 'boolean', ], 'ClarifyTextConfig' => [ 'type' => 'structure', 'required' => [ 'Language', 'Granularity', ], 'members' => [ 'Language' => [ 'shape' => 'ClarifyTextLanguage', ], 'Granularity' => [ 'shape' => 'ClarifyTextGranularity', ], ], ], 'ClarifyTextGranularity' => [ 'type' => 'string', 'enum' => [ 'token', 'sentence', 'paragraph', ], ], 'ClarifyTextLanguage' => [ 'type' => 'string', 'enum' => [ 'af', 'sq', 'ar', 'hy', 'eu', 'bn', 'bg', 'ca', 'zh', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fi', 'fr', 'de', 'el', 'gu', 'he', 'hi', 'hu', 'is', 'id', 'ga', 'it', 'kn', 'ky', 'lv', 'lt', 'lb', 'mk', 'ml', 'mr', 'ne', 'nb', 'fa', 'pl', 'pt', 'ro', 'ru', 'sa', 'sr', 'tn', 'si', 'sk', 'sl', 'es', 'sv', 'tl', 'ta', 'tt', 'te', 'tr', 'uk', 'ur', 'yo', 'lij', 'xx', ], ], 'ClientId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', ], 'ClientSecret' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', 'sensitive' => true, ], 'ClientToken' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'ClusterArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$', ], 'ClusterInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ClusterInstanceGroupDetails' => [ 'type' => 'structure', 'members' => [ 'CurrentCount' => [ 'shape' => 'ClusterNonNegativeInstanceCount', ], 'TargetCount' => [ 'shape' => 'ClusterInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterInstanceGroupDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterInstanceGroupDetails', ], ], 'ClusterInstanceGroupName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ClusterInstanceGroupSpecification' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceGroupName', 'InstanceType', 'LifeCycleConfig', 'ExecutionRole', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ClusterInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterInstanceGroupSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterInstanceGroupSpecification', ], 'max' => 5, 'min' => 1, ], 'ClusterInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'Running', 'Failure', 'Pending', 'ShuttingDown', 'SystemUpdating', ], ], 'ClusterInstanceStatusDetails' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'ClusterInstanceStatus', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ClusterInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.p5.48xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.12xlarge', 'ml.g5.16xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.12xlarge', 'ml.c5.18xlarge', 'ml.c5.24xlarge', 'ml.c5n.large', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.8xlarge', 'ml.m5.12xlarge', 'ml.m5.16xlarge', 'ml.m5.24xlarge', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', ], ], 'ClusterLifeCycleConfig' => [ 'type' => 'structure', 'required' => [ 'SourceS3Uri', 'OnCreate', ], 'members' => [ 'SourceS3Uri' => [ 'shape' => 'S3Uri', ], 'OnCreate' => [ 'shape' => 'ClusterLifeCycleConfigFileName', ], ], ], 'ClusterLifeCycleConfigFileName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\S\\s]+$', ], 'ClusterName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ClusterNameOrArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$', ], 'ClusterNodeDetails' => [ 'type' => 'structure', 'members' => [ 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceId' => [ 'shape' => 'String', ], 'InstanceStatus' => [ 'shape' => 'ClusterInstanceStatusDetails', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LaunchTime' => [ 'shape' => 'Timestamp', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterNodeId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z][-a-zA-Z0-9]*$', ], 'ClusterNodeSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterNodeSummary', ], ], 'ClusterNodeSummary' => [ 'type' => 'structure', 'required' => [ 'InstanceGroupName', 'InstanceId', 'InstanceType', 'LaunchTime', 'InstanceStatus', ], 'members' => [ 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LaunchTime' => [ 'shape' => 'Timestamp', ], 'InstanceStatus' => [ 'shape' => 'ClusterInstanceStatusDetails', ], ], ], 'ClusterNonNegativeInstanceCount' => [ 'type' => 'integer', 'min' => 0, ], 'ClusterSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'NAME', ], ], 'ClusterStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Deleting', 'Failed', 'InService', 'RollingBack', 'SystemUpdating', 'Updating', ], ], 'ClusterSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterSummary', ], ], 'ClusterSummary' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', 'ClusterName', 'CreationTime', 'ClusterStatus', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], 'ClusterName' => [ 'shape' => 'ClusterName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ClusterStatus' => [ 'shape' => 'ClusterStatus', ], ], ], 'ClusterThreadsPerCore' => [ 'type' => 'integer', 'max' => 2, 'min' => 1, ], 'CodeEditorAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], ], ], 'CodeRepositories' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepository', ], 'max' => 10, ], 'CodeRepository' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'RepositoryUrl', ], ], ], 'CodeRepositoryArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:code-repository/[\\S]{1,2048}$', ], 'CodeRepositoryContains' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameOrUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'CodeRepositorySortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'CodeRepositorySortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'CodeRepositorySummary' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'CodeRepositorySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositorySummary', ], ], 'CognitoConfig' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoMemberDefinition' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'UserGroup', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'UserGroup' => [ 'shape' => 'CognitoUserGroup', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoUserGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'CognitoUserPool' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'CollectionConfig' => [ 'type' => 'structure', 'members' => [ 'VectorConfig' => [ 'shape' => 'VectorConfig', ], ], 'union' => true, ], 'CollectionConfiguration' => [ 'type' => 'structure', 'members' => [ 'CollectionName' => [ 'shape' => 'CollectionName', ], 'CollectionParameters' => [ 'shape' => 'CollectionParameters', ], ], ], 'CollectionConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'CollectionConfiguration', ], 'max' => 20, 'min' => 0, ], 'CollectionName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'CollectionParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'CollectionType' => [ 'type' => 'string', 'enum' => [ 'List', 'Set', 'Vector', ], ], 'CompilationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/.*', ], 'CompilationJobStatus' => [ 'type' => 'string', 'enum' => [ 'INPROGRESS', 'COMPLETED', 'FAILED', 'STARTING', 'STOPPING', 'STOPPED', ], ], 'CompilationJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompilationJobSummary', ], ], 'CompilationJobSummary' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CreationTime', 'CompilationJobStatus', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'CompilationTargetDevice' => [ 'shape' => 'TargetDevice', ], 'CompilationTargetPlatformOs' => [ 'shape' => 'TargetPlatformOs', ], 'CompilationTargetPlatformArch' => [ 'shape' => 'TargetPlatformArch', ], 'CompilationTargetPlatformAccelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], ], ], 'CompilerOptions' => [ 'type' => 'string', 'max' => 1024, 'min' => 3, 'pattern' => '.*', ], 'CompleteOnConvergence' => [ 'type' => 'string', 'enum' => [ 'Disabled', 'Enabled', ], ], 'CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'CompressionTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompressionType', ], ], 'ConditionOutcome' => [ 'type' => 'string', 'enum' => [ 'True', 'False', ], ], 'ConditionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Outcome' => [ 'shape' => 'ConditionOutcome', ], ], ], 'ConfigKey' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'ConfigValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 100, 'min' => 1, ], 'ContainerConfig' => [ 'type' => 'structure', 'members' => [ 'ContainerArguments' => [ 'shape' => 'CustomImageContainerArguments', ], 'ContainerEntrypoint' => [ 'shape' => 'CustomImageContainerEntrypoint', ], 'ContainerEnvironmentVariables' => [ 'shape' => 'CustomImageContainerEnvironmentVariables', ], ], ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageConfig' => [ 'shape' => 'ImageConfig', ], 'Mode' => [ 'shape' => 'ContainerMode', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ModelDataSource' => [ 'shape' => 'ModelDataSource', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'MultiModelConfig' => [ 'shape' => 'MultiModelConfig', ], ], ], 'ContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], 'max' => 15, ], 'ContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerEntrypointString', ], 'max' => 100, 'min' => 1, ], 'ContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerHostname' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ContainerImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '[\\S]+', ], 'ContainerMode' => [ 'type' => 'string', 'enum' => [ 'SingleModel', 'MultiModel', ], ], 'ContentClassifier' => [ 'type' => 'string', 'enum' => [ 'FreeOfPersonallyIdentifiableInformation', 'FreeOfAdultContent', ], ], 'ContentClassifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentClassifier', ], 'max' => 256, ], 'ContentColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ContentDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ContentType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentType', ], ], 'ContextArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/.*', ], 'ContextName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}', ], 'ContextNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context\\/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119})', ], 'ContextSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ContextSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContextSummary', ], ], 'ContextSummary' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], 'ContextName' => [ 'shape' => 'ContextName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ContinuousParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'ContinuousParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'ContinuousParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContinuousParameterRange', ], 'max' => 30, 'min' => 0, ], 'ConvergenceDetected' => [ 'type' => 'structure', 'members' => [ 'CompleteOnConvergence' => [ 'shape' => 'CompleteOnConvergence', ], ], ], 'CountryCode' => [ 'type' => 'string', 'max' => 2, 'min' => 2, 'pattern' => '[A-Z]{2}', ], 'CreateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', 'Source', 'ActionType', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'CreateAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'TrainingSpecification', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmArn', ], 'members' => [ 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], ], ], 'CreateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'Tags' => [ 'shape' => 'TagList', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], ], ], 'CreateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'CreateAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'CreateAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], ], ], 'CreateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'Source', 'ArtifactType', ], 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'ArtifactProperties', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'CreateAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], ], ], 'CreateAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'AutoMLProblemTypeConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], ], ], 'CreateAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'InstanceGroups', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterName', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupSpecifications', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'CreateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'GitConfig', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'CreateCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'RoleArn', 'OutputConfig', 'StoppingCondition', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobArn', ], 'members' => [ 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], ], ], 'CreateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', 'Source', 'ContextType', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'CreateDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'AuthMode', 'DefaultUserSettings', 'SubnetIds', 'VpcId', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'Tags' => [ 'shape' => 'TagList', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'CreateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'CreateEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], ], ], 'CreateEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], ], ], 'CreateEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', 'CompilationJobName', 'ModelName', 'ModelVersion', 'RoleArn', 'OutputConfig', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'ProductionVariants', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'CreateEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigArn', ], 'members' => [ 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], ], ], 'CreateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'CreateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'CreateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'CreateFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], ], ], 'CreateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubDescription', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'CreateHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'UiTemplate', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'CreateHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobConfig', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'Autotune' => [ 'shape' => 'Autotune', ], ], ], 'CreateHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobArn', ], 'members' => [ 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'CreateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'RoleArn', ], 'members' => [ 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'CreateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'BaseImage', 'ClientToken', 'ImageName', ], 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ImageName' => [ 'shape' => 'ImageName', ], 'Aliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'CreateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'CreateInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'EndpointName', 'VariantName', 'Specification', 'RuntimeConfig', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecification', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'CreateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'RoleArn', 'EndpointName', 'ModelVariants', 'ShadowModeConfig', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'CreateInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'RoleArn', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'OutputConfig' => [ 'shape' => 'RecommendationJobOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobArn', ], 'members' => [ 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], ], ], 'CreateLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelAttributeName', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobArn', ], 'members' => [ 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], ], ], 'CreateModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardExportJobName', 'OutputConfig', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], ], ], 'CreateModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'CreateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'Content', 'ModelCardStatus', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'CreateModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelArn', ], 'members' => [ 'ModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'CreateModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'CreateModelPackageInput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], ], ], 'CreateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'CreateModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'CreateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'InstanceType', 'RoleArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], ], ], 'CreateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], ], ], 'CreatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', 'RoleArn', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'CreatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'CreatePresignedDomainUrlRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], 'ExpiresInSeconds' => [ 'shape' => 'ExpiresInSeconds', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'LandingUri' => [ 'shape' => 'LandingUri', ], ], ], 'CreatePresignedDomainUrlResponse' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'PresignedDomainUrl', ], ], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], ], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'NotebookInstanceUrl', ], ], ], 'CreateProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'RoleArn', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobArn', ], 'members' => [ 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'CreateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ServiceCatalogProvisioningDetails', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectId', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], ], ], 'CreateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'OwnershipSettings' => [ 'shape' => 'OwnershipSettings', ], 'SpaceSharingSettings' => [ 'shape' => 'SpaceSharingSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'CreateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'CreateStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', 'StudioLifecycleConfigContent', 'StudioLifecycleConfigAppType', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'CreateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfig', ], 'InfraCheckConfig' => [ 'shape' => 'InfraCheckConfig', ], ], ], 'CreateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'CreateTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'ModelName', 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobArn', ], 'members' => [ 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], ], ], 'CreateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'CreateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', 'ExperimentName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'CreateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'Tags' => [ 'shape' => 'TagList', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'CreateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'CreateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'CreateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'WorkforceArn', ], 'members' => [ 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], ], ], 'CreateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateWorkteamResponse' => [ 'type' => 'structure', 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'CreationTime' => [ 'type' => 'timestamp', ], 'CrossAccountFilterOption' => [ 'type' => 'string', 'enum' => [ 'SameAccount', 'CrossAccount', ], ], 'CsvContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'CsvContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CsvContentType', ], 'max' => 10, 'min' => 1, ], 'CustomFileSystem' => [ 'type' => 'structure', 'members' => [ 'EFSFileSystem' => [ 'shape' => 'EFSFileSystem', ], ], 'union' => true, ], 'CustomFileSystemConfig' => [ 'type' => 'structure', 'members' => [ 'EFSFileSystemConfig' => [ 'shape' => 'EFSFileSystemConfig', ], ], 'union' => true, ], 'CustomFileSystemConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomFileSystemConfig', ], 'max' => 2, ], 'CustomFileSystems' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomFileSystem', ], 'max' => 1, ], 'CustomImage' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'AppImageConfigName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageVersionNumber' => [ 'shape' => 'ImageVersionNumber', 'box' => true, ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'CustomImageContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString64', ], 'max' => 50, ], 'CustomImageContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString256', ], 'max' => 1, ], 'CustomImageContainerEnvironmentVariables' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonEmptyString256', ], 'value' => [ 'shape' => 'String256', ], 'max' => 25, ], 'CustomImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomImage', ], 'max' => 200, ], 'CustomPosixUserConfig' => [ 'type' => 'structure', 'required' => [ 'Uid', 'Gid', ], 'members' => [ 'Uid' => [ 'shape' => 'Uid', ], 'Gid' => [ 'shape' => 'Gid', ], ], ], 'CustomerMetadataKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}', ], 'CustomerMetadataKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerMetadataKey', ], ], 'CustomerMetadataMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'CustomerMetadataKey', ], 'value' => [ 'shape' => 'CustomerMetadataValue', ], 'max' => 50, 'min' => 1, ], 'CustomerMetadataValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}', ], 'CustomizedMetricSpecification' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'String', ], 'Namespace' => [ 'shape' => 'String', ], 'Statistic' => [ 'shape' => 'Statistic', ], ], ], 'DataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'InitialSamplingPercentage', 'DestinationS3Uri', 'CaptureOptions', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'InitialSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CaptureOptions' => [ 'shape' => 'CaptureOptionList', ], 'CaptureContentTypeHeader' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'DataCaptureConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EnableCapture', 'CaptureStatus', 'CurrentSamplingPercentage', 'DestinationS3Uri', 'KmsKeyId', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'CaptureStatus' => [ 'shape' => 'CaptureStatus', ], 'CurrentSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'DataCatalogConfig' => [ 'type' => 'structure', 'required' => [ 'TableName', 'Catalog', 'Database', ], 'members' => [ 'TableName' => [ 'shape' => 'TableName', ], 'Catalog' => [ 'shape' => 'Catalog', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'DataExplorationNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'DataInputConfig' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'DataProcessing' => [ 'type' => 'structure', 'members' => [ 'InputFilter' => [ 'shape' => 'JsonPath', ], 'OutputFilter' => [ 'shape' => 'JsonPath', ], 'JoinSource' => [ 'shape' => 'JoinSource', ], ], ], 'DataQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'DataQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'DataQualityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'S3DataSource', ], 'FileSystemDataSource' => [ 'shape' => 'FileSystemDataSource', ], ], ], 'DataSourceName' => [ 'type' => 'string', 'enum' => [ 'SalesforceGenie', 'Snowflake', ], ], 'Database' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'DatasetDefinition' => [ 'type' => 'structure', 'members' => [ 'AthenaDatasetDefinition' => [ 'shape' => 'AthenaDatasetDefinition', ], 'RedshiftDatasetDefinition' => [ 'shape' => 'RedshiftDatasetDefinition', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'DataDistributionType' => [ 'shape' => 'DataDistributionType', ], 'InputMode' => [ 'shape' => 'InputMode', ], ], ], 'DebugHookConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'HookParameters' => [ 'shape' => 'HookParameters', ], 'CollectionConfigurations' => [ 'shape' => 'CollectionConfigurations', ], ], ], 'DebugRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'DebugRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'DebugRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DebugRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'DefaultEbsStorageSettings' => [ 'type' => 'structure', 'required' => [ 'DefaultEbsVolumeSizeInGb', 'MaximumEbsVolumeSizeInGb', ], 'members' => [ 'DefaultEbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], 'MaximumEbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], ], ], 'DefaultGid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DefaultSpaceSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], ], ], 'DefaultSpaceStorageSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultEbsStorageSettings' => [ 'shape' => 'DefaultEbsStorageSettings', ], ], ], 'DefaultUid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DeleteActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'DeleteAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DeleteAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], ], ], 'DeleteArtifactRequest' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], ], ], 'DeleteArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DeleteAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], ], ], 'DeleteClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'DeleteCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], ], ], 'DeleteContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'DeleteDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'RetentionPolicy' => [ 'shape' => 'RetentionPolicy', ], ], ], 'DeleteEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DeleteEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DeleteExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'DeleteFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'DeleteFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DeleteFlowDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', 'HubContentVersion', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DeleteHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DeleteHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DeleteHumanTaskUiResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DeleteImageResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DeleteImageVersionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], ], ], 'DeleteInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DeleteInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'DeleteModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DeleteModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DeleteModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DeleteModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DeleteNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DeleteNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DeletePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'DeletePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'DeleteProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DeleteSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DeleteStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DeleteTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'DeleteTagsOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'DeleteTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DeleteUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DeleteWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DeleteWorkforceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DeleteWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Success', ], 'members' => [ 'Success' => [ 'shape' => 'Success', ], ], ], 'DependencyCopyPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DependencyOriginPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DeployedImage' => [ 'type' => 'structure', 'members' => [ 'SpecifiedImage' => [ 'shape' => 'ContainerImage', ], 'ResolvedImage' => [ 'shape' => 'ContainerImage', ], 'ResolutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeployedImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeployedImage', ], ], 'DeploymentConfig' => [ 'type' => 'structure', 'members' => [ 'BlueGreenUpdatePolicy' => [ 'shape' => 'BlueGreenUpdatePolicy', ], 'RollingUpdatePolicy' => [ 'shape' => 'RollingUpdatePolicy', ], 'AutoRollbackConfiguration' => [ 'shape' => 'AutoRollbackConfig', ], ], ], 'DeploymentRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationStatus', ], 'members' => [ 'RecommendationStatus' => [ 'shape' => 'RecommendationStatus', ], 'RealTimeInferenceRecommendations' => [ 'shape' => 'RealTimeInferenceRecommendations', ], ], ], 'DeploymentStage' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], ], ], 'DeploymentStageMaxResults' => [ 'type' => 'integer', 'max' => 10, ], 'DeploymentStageStatusSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStageStatusSummary', ], ], 'DeploymentStageStatusSummary' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', 'DeploymentConfig', 'DeploymentStatus', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], 'DeploymentStatus' => [ 'shape' => 'EdgeDeploymentStatus', ], ], ], 'DeploymentStages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStage', ], ], 'DeregisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceNames', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], ], ], 'DerivedInformation' => [ 'type' => 'structure', 'members' => [ 'DerivedDataInputConfig' => [ 'shape' => 'DataInputConfig', ], ], ], 'DescribeActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ActionArn' => [ 'shape' => 'ActionArn', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'TrainingSpecification', 'AlgorithmStatus', 'AlgorithmStatusDetails', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], 'AlgorithmStatusDetails' => [ 'shape' => 'AlgorithmStatusDetails', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], ], ], 'DescribeAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DescribeAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], ], ], 'DescribeAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], ], ], 'DescribeAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'LastHealthCheckTimestamp' => [ 'shape' => 'Timestamp', ], 'LastUserActivityTimestamp' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'DescribeArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DescribeArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'ResolvedAttributes', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], ], ], 'DescribeAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'AutoMLProblemTypeConfigName' => [ 'shape' => 'AutoMLProblemTypeConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'AutoMLResolvedAttributes', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], ], ], 'DescribeClusterNodeRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'NodeId', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'NodeId' => [ 'shape' => 'ClusterNodeId', ], ], ], 'DescribeClusterNodeResponse' => [ 'type' => 'structure', 'required' => [ 'NodeDetails', ], 'members' => [ 'NodeDetails' => [ 'shape' => 'ClusterNodeDetails', ], ], ], 'DescribeClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], ], ], 'DescribeClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', 'ClusterStatus', 'InstanceGroups', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], 'ClusterName' => [ 'shape' => 'ClusterName', ], 'ClusterStatus' => [ 'shape' => 'ClusterStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureMessage' => [ 'shape' => 'String', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupDetailsList', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'DescribeCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'DescribeCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CompilationJobStatus', 'StoppingCondition', 'CreationTime', 'LastModifiedTime', 'FailureReason', 'ModelArtifacts', 'RoleArn', 'InputConfig', 'OutputConfig', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'InferenceImage' => [ 'shape' => 'InferenceImage', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'ModelDigests' => [ 'shape' => 'ModelDigests', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], 'DerivedInformation' => [ 'shape' => 'DerivedInformation', ], ], ], 'DescribeContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextNameOrArn', ], ], ], 'DescribeContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'ContextArn' => [ 'shape' => 'ContextArn', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceFleetResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceFleetArn', 'OutputConfig', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'IotRoleAlias' => [ 'shape' => 'IotRoleAlias', ], ], ], 'DescribeDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', 'RegistrationTime', ], 'members' => [ 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModels', ], 'MaxModels' => [ 'shape' => 'Integer', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], ], ], 'DescribeDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'HomeEfsFileSystemId' => [ 'shape' => 'ResourceId', ], 'SingleSignOnManagedApplicationInstanceId' => [ 'shape' => 'String256', ], 'SingleSignOnApplicationArn' => [ 'shape' => 'SingleSignOnApplicationArn', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SecurityGroupIdForDomainBoundary' => [ 'shape' => 'SecurityGroupId', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'Url' => [ 'shape' => 'String1024', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'DeploymentStageMaxResults', ], ], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'Stages' => [ 'shape' => 'DeploymentStageStatusSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeEdgePackagingJobResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'EdgePackagingJobStatusMessage' => [ 'shape' => 'String', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ModelArtifact' => [ 'shape' => 'S3Uri', ], 'ModelSignature' => [ 'shape' => 'String', ], 'PresetDeploymentOutput' => [ 'shape' => 'EdgePresetDeploymentOutput', ], ], ], 'DescribeEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DescribeEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'ProductionVariants', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'DescribeEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DescribeEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastDeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'PendingDeploymentSummary' => [ 'shape' => 'PendingDeploymentSummary', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'DescribeExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', 'CreationTime', 'NextToken', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'OnlineStoreTotalSizeBytes' => [ 'shape' => 'OnlineStoreTotalSizeBytes', ], ], ], 'DescribeFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], ], ], 'DescribeFeatureMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'FeatureName', 'FeatureType', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'DescribeFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DescribeFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', 'FlowDefinitionName', 'FlowDefinitionStatus', 'CreationTime', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DescribeHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DescribeHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubArn', 'HubContentDocument', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentDependencies' => [ 'shape' => 'HubContentDependencyList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DescribeHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DescribeHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', 'HumanTaskUiName', 'CreationTime', 'UiTemplate', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiStatus' => [ 'shape' => 'HumanTaskUiStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'UiTemplate' => [ 'shape' => 'UiTemplateInfo', ], ], ], 'DescribeHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'DescribeHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobConfig', 'HyperParameterTuningJobStatus', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'Autotune' => [ 'shape' => 'Autotune', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], ], ], 'DescribeImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DescribeImageResponse' => [ 'type' => 'structure', 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'DescribeImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DescribeImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ContainerImage' => [ 'shape' => 'ImageContainerImage', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'DescribeInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], ], ], 'DescribeInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'InferenceComponentArn', 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecificationSummary', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfigSummary', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'InferenceComponentStatus' => [ 'shape' => 'InferenceComponentStatus', ], ], ], 'DescribeInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DescribeInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Name', 'Type', 'Status', 'EndpointMetadata', 'ModelVariants', ], 'members' => [ 'Arn' => [ 'shape' => 'InferenceExperimentArn', ], 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointMetadata' => [ 'shape' => 'EndpointMetadata', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigSummaryList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], ], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'JobArn', 'RoleArn', 'Status', 'CreationTime', 'LastModifiedTime', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'InferenceRecommendations' => [ 'shape' => 'InferenceRecommendations', ], 'EndpointPerformances' => [ 'shape' => 'EndpointPerformances', ], ], ], 'DescribeLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'DescribeLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobStatus', 'LabelCounters', 'CreationTime', 'LastModifiedTime', 'JobReferenceCode', 'LabelingJobName', 'LabelingJobArn', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], ], ], 'DescribeLineageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeLineageGroupResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'DescribeModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'OutputConfig', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExportArtifacts' => [ 'shape' => 'ModelCardExportArtifacts', ], ], ], 'DescribeModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], ], ], 'DescribeModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', 'ModelCardName', 'ModelCardVersion', 'Content', 'ModelCardStatus', 'CreationTime', 'CreatedBy', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ModelCardProcessingStatus' => [ 'shape' => 'ModelCardProcessingStatus', ], ], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DescribeModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'CreationTime', 'ModelArn', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'DescribeModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'CreatedBy', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'DescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DescribeModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', 'ModelPackageStatusDetails', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], ], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DescribeMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', 'MonitoringScheduleName', 'MonitoringScheduleStatus', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], ], ], 'DescribeNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], ], ], 'DescribeNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'NetworkInterfaceId' => [ 'shape' => 'NetworkInterfaceId', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'DescribePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], ], ], 'DescribePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'DescribeProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'DescribeProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'ProcessingJobArn', 'ProcessingJobStatus', 'CreationTime', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'DescribeProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DescribeProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectName', 'ProjectId', 'ServiceCatalogProvisioningDetails', 'ProjectStatus', 'CreationTime', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DescribeSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceArn' => [ 'shape' => 'SpaceArn', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'OwnershipSettings' => [ 'shape' => 'OwnershipSettings', ], 'SpaceSharingSettings' => [ 'shape' => 'SpaceSharingSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'DescribeStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DescribeStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'DescribeSubscribedWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'DescribeSubscribedWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteam', ], 'members' => [ 'SubscribedWorkteam' => [ 'shape' => 'SubscribedWorkteam', ], ], ], 'DescribeTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'DescribeTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'ModelArtifacts', 'TrainingJobStatus', 'SecondaryStatus', 'AlgorithmSpecification', 'ResourceConfig', 'StoppingCondition', 'CreationTime', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ProfilerRuleEvaluationStatuses' => [ 'shape' => 'ProfilerRuleEvaluationStatuses', ], 'ProfilingStatus' => [ 'shape' => 'ProfilingStatus', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfig', ], 'InfraCheckConfig' => [ 'shape' => 'InfraCheckConfig', ], ], ], 'DescribeTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'DescribeTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'TransformJobStatus', 'ModelName', 'TransformInput', 'TransformResources', 'CreationTime', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'DescribeTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Sources' => [ 'shape' => 'TrialComponentSources', ], ], ], 'DescribeTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], ], ], 'DescribeUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DescribeUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'DescribeWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DescribeWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'DescribeWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DescribeWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 128, ], 'DesiredWeightAndCapacity' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'ServerlessUpdateConfig' => [ 'shape' => 'ProductionVariantServerlessUpdateConfig', ], ], ], 'DesiredWeightAndCapacityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DesiredWeightAndCapacity', ], 'min' => 1, ], 'DestinationS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/])/?(.*)$', ], 'DetailedAlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'DetailedModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'Device' => [ 'type' => 'structure', 'required' => [ 'DeviceName', ], 'members' => [ 'DeviceName' => [ 'shape' => 'DeviceName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'IotThingName' => [ 'shape' => 'ThingName', ], ], ], 'DeviceArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'READYTODEPLOY', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'DeviceDeploymentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceDeploymentSummary', ], ], 'DeviceDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'StageName', 'DeviceName', 'DeviceArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], 'DeployedStageName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceName' => [ 'shape' => 'DeviceName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceDeploymentStatus' => [ 'shape' => 'DeviceDeploymentStatus', ], 'DeviceDeploymentStatusMessage' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeploymentStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceDescription' => [ 'type' => 'string', 'max' => 40, 'min' => 1, 'pattern' => '^[-a-zA-Z0-9_.,;:! ]*$', ], 'DeviceFleetArn' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceFleetDescription' => [ 'type' => 'string', 'max' => 800, 'min' => 1, 'pattern' => '^[-a-zA-Z0-9_.,;:! ]*$', ], 'DeviceFleetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceFleetSummary', ], ], 'DeviceFleetSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'DeviceNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceName', ], ], 'DeviceSelectionConfig' => [ 'type' => 'structure', 'required' => [ 'DeviceSubsetType', ], 'members' => [ 'DeviceSubsetType' => [ 'shape' => 'DeviceSubsetType', ], 'Percentage' => [ 'shape' => 'Percentage', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], 'DeviceNameContains' => [ 'shape' => 'DeviceName', ], ], ], 'DeviceStats' => [ 'type' => 'structure', 'required' => [ 'ConnectedDeviceCount', 'RegisteredDeviceCount', ], 'members' => [ 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'RegisteredDeviceCount' => [ 'shape' => 'Long', ], ], ], 'DeviceSubsetType' => [ 'type' => 'string', 'enum' => [ 'PERCENTAGE', 'SELECTION', 'NAMECONTAINS', ], ], 'DeviceSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceSummary', ], ], 'DeviceSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceArn', ], 'members' => [ 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModelSummaries', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'Devices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'Dimension' => [ 'type' => 'integer', 'max' => 8192, 'min' => 1, ], 'DirectDeploySettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], ], ], 'DirectInternetAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Direction' => [ 'type' => 'string', 'enum' => [ 'Both', 'Ascendants', 'Descendants', ], ], 'DirectoryPath' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'DisableProfiler' => [ 'type' => 'boolean', ], 'DisableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'DisableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateAdditionalCodeRepositories' => [ 'type' => 'boolean', ], 'DisassociateDefaultCodeRepository' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'type' => 'boolean', ], 'DisassociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DisassociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DockerSettings' => [ 'type' => 'structure', 'members' => [ 'EnableDockerAccess' => [ 'shape' => 'FeatureStatus', ], 'VpcOnlyTrustedAccounts' => [ 'shape' => 'VpcOnlyTrustedAccounts', ], ], ], 'DocumentSchemaVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'Dollars' => [ 'type' => 'integer', 'max' => 2, 'min' => 0, ], 'DomainArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*', ], 'DomainDetails' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'DomainId' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^d-(-*[a-z0-9]){1,61}', ], 'DomainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainDetails', ], ], 'DomainName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'DomainSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 3, ], 'DomainSettings' => [ 'type' => 'structure', 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], 'RStudioServerProDomainSettings' => [ 'shape' => 'RStudioServerProDomainSettings', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], 'DockerSettings' => [ 'shape' => 'DockerSettings', ], ], ], 'DomainSettingsForUpdate' => [ 'type' => 'structure', 'members' => [ 'RStudioServerProDomainSettingsForUpdate' => [ 'shape' => 'RStudioServerProDomainSettingsForUpdate', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], 'DockerSettings' => [ 'shape' => 'DockerSettings', ], ], ], 'DomainStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'Double' => [ 'type' => 'double', ], 'DoubleParameterValue' => [ 'type' => 'double', ], 'DriftCheckBaselines' => [ 'type' => 'structure', 'members' => [ 'Bias' => [ 'shape' => 'DriftCheckBias', ], 'Explainability' => [ 'shape' => 'DriftCheckExplainability', ], 'ModelQuality' => [ 'shape' => 'DriftCheckModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'DriftCheckModelDataQuality', ], ], ], 'DriftCheckBias' => [ 'type' => 'structure', 'members' => [ 'ConfigFile' => [ 'shape' => 'FileSource', ], 'PreTrainingConstraints' => [ 'shape' => 'MetricsSource', ], 'PostTrainingConstraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckExplainability' => [ 'type' => 'structure', 'members' => [ 'Constraints' => [ 'shape' => 'MetricsSource', ], 'ConfigFile' => [ 'shape' => 'FileSource', ], ], ], 'DriftCheckModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DynamicScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'Integer', ], 'MaxCapacity' => [ 'shape' => 'Integer', ], 'ScaleInCooldown' => [ 'shape' => 'Integer', ], 'ScaleOutCooldown' => [ 'shape' => 'Integer', ], 'ScalingPolicies' => [ 'shape' => 'ScalingPolicies', ], ], ], 'EFSFileSystem' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], ], ], 'EFSFileSystemConfig' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], 'FileSystemPath' => [ 'shape' => 'FileSystemPath', ], ], ], 'EMRStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'String256', ], 'StepId' => [ 'shape' => 'String256', ], 'StepName' => [ 'shape' => 'String256', ], 'LogFilePath' => [ 'shape' => 'String1024', ], ], ], 'EbsStorageSettings' => [ 'type' => 'structure', 'required' => [ 'EbsVolumeSizeInGb', ], 'members' => [ 'EbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], ], ], 'Edge' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'EdgeDeploymentConfig' => [ 'type' => 'structure', 'required' => [ 'FailureHandlingPolicy', ], 'members' => [ 'FailureHandlingPolicy' => [ 'shape' => 'FailureHandlingPolicy', ], ], ], 'EdgeDeploymentModelConfig' => [ 'type' => 'structure', 'required' => [ 'ModelHandle', 'EdgePackagingJobName', ], 'members' => [ 'ModelHandle' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'EdgeDeploymentModelConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentModelConfig', ], ], 'EdgeDeploymentPlanArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgeDeploymentPlanSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentPlanSummary', ], ], 'EdgeDeploymentPlanSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'DeviceFleetName', 'EdgeDeploymentSuccess', 'EdgeDeploymentPending', 'EdgeDeploymentFailed', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeDeploymentStatus' => [ 'type' => 'structure', 'required' => [ 'StageStatus', 'EdgeDeploymentSuccessInStage', 'EdgeDeploymentPendingInStage', 'EdgeDeploymentFailedInStage', ], 'members' => [ 'StageStatus' => [ 'shape' => 'StageStatus', ], 'EdgeDeploymentSuccessInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPendingInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailedInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentStatusMessage' => [ 'shape' => 'String', ], 'EdgeDeploymentStageStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModel' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'LatestSampleTime' => [ 'shape' => 'Timestamp', ], 'LatestInference' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModelStat' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', 'OfflineDeviceCount', 'ConnectedDeviceCount', 'ActiveDeviceCount', 'SamplingDeviceCount', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'OfflineDeviceCount' => [ 'shape' => 'Long', ], 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'ActiveDeviceCount' => [ 'shape' => 'Long', ], 'SamplingDeviceCount' => [ 'shape' => 'Long', ], ], ], 'EdgeModelStats' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelStat', ], ], 'EdgeModelSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelSummary', ], ], 'EdgeModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'EdgeModels' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModel', ], ], 'EdgeOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'PresetDeploymentType' => [ 'shape' => 'EdgePresetDeploymentType', ], 'PresetDeploymentConfig' => [ 'shape' => 'String', ], ], ], 'EdgePackagingJobArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgePackagingJobStatus' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'INPROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'EdgePackagingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgePackagingJobSummary', ], ], 'EdgePackagingJobSummary' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgePresetDeploymentArtifact' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'EdgePresetDeploymentOutput' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'EdgePresetDeploymentType', ], 'Artifact' => [ 'shape' => 'EdgePresetDeploymentArtifact', ], 'Status' => [ 'shape' => 'EdgePresetDeploymentStatus', ], 'StatusMessage' => [ 'shape' => 'String', ], ], ], 'EdgePresetDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETED', 'FAILED', ], ], 'EdgePresetDeploymentType' => [ 'type' => 'string', 'enum' => [ 'GreengrassV2Component', ], ], 'EdgeVersion' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[a-zA-Z0-9\\ \\_\\.]+', ], 'Edges' => [ 'type' => 'list', 'member' => [ 'shape' => 'Edge', ], ], 'EfsUid' => [ 'type' => 'string', 'max' => 10, 'pattern' => '\\d+', ], 'EnableCapture' => [ 'type' => 'boolean', ], 'EnableInfraCheck' => [ 'type' => 'boolean', ], 'EnableIotRoleAlias' => [ 'type' => 'boolean', ], 'EnableRemoteDebug' => [ 'type' => 'boolean', ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'Endpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointConfigName', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringSchedules' => [ 'shape' => 'MonitoringScheduleList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'EndpointArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/.*', ], 'EndpointConfigArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/.*', ], 'EndpointConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'EndpointConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'EndpointConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointConfigSummary', ], ], 'EndpointInfo' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'EndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'LocalPath', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'ExcludeFeaturesAttribute' => [ 'shape' => 'ExcludeFeaturesAttribute', ], ], ], 'EndpointInputConfiguration' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameterRanges' => [ 'shape' => 'EnvironmentParameterRanges', ], ], ], 'EndpointInputConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInputConfiguration', ], 'max' => 10, 'min' => 1, ], 'EndpointMetadata' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'EndpointName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointOutputConfiguration' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'VariantName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'String', ], 'VariantName' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialInstanceCount' => [ 'shape' => 'InitialInstanceCount', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'EndpointPerformance' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointInfo', ], 'members' => [ 'Metrics' => [ 'shape' => 'InferenceMetrics', ], 'EndpointInfo' => [ 'shape' => 'EndpointInfo', ], ], ], 'EndpointPerformances' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointPerformance', ], 'max' => 1, ], 'EndpointSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'EndpointStatus' => [ 'type' => 'string', 'enum' => [ 'OutOfService', 'Creating', 'Updating', 'SystemUpdating', 'RollingBack', 'InService', 'Deleting', 'Failed', 'UpdateRollbackFailed', ], ], 'EndpointSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'EndpointSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointSummary', ], ], 'Endpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInfo', ], 'max' => 1, ], 'EntityDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'EntityName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'EnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'EnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'EnvironmentKey', ], 'value' => [ 'shape' => 'EnvironmentValue', ], 'max' => 16, ], 'EnvironmentParameter' => [ 'type' => 'structure', 'required' => [ 'Key', 'ValueType', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'String', ], 'ValueType' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'EnvironmentParameterRanges' => [ 'type' => 'structure', 'members' => [ 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameters', ], ], ], 'EnvironmentParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnvironmentParameter', ], 'max' => 10, 'min' => 1, ], 'EnvironmentValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'ExcludeFeaturesAttribute' => [ 'type' => 'string', 'max' => 100, ], 'ExecutionRoleIdentityConfig' => [ 'type' => 'string', 'enum' => [ 'USER_PROFILE_NAME', 'DISABLED', ], ], 'ExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Completed', 'CompletedWithViolations', 'InProgress', 'Failed', 'Stopping', 'Stopped', ], ], 'ExitMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'Experiment' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/.*', ], 'ExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentDisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ExperimentDescription' => [ 'type' => 'string', 'max' => 3072, 'pattern' => '.*', ], 'ExperimentEntityName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'ExperimentEntityNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'ExperimentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'ExperimentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'ExperimentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'ExperimentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExperimentSummary', ], ], 'ExperimentSummary' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentSource' => [ 'shape' => 'ExperimentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ExpiresInSeconds' => [ 'type' => 'integer', 'max' => 300, 'min' => 5, ], 'Explainability' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], ], ], 'ExplainabilityLocation' => [ 'type' => 'string', 'min' => 1, ], 'ExplainerConfig' => [ 'type' => 'structure', 'members' => [ 'ClarifyExplainerConfig' => [ 'shape' => 'ClarifyExplainerConfig', ], ], ], 'FailStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ErrorMessage' => [ 'shape' => 'String3072', ], ], ], 'FailureHandlingPolicy' => [ 'type' => 'string', 'enum' => [ 'ROLLBACK_ON_FAILURE', 'DO_NOTHING', ], ], 'FailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'FeatureAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 100, 'min' => 1, ], 'FeatureDefinition' => [ 'type' => 'structure', 'required' => [ 'FeatureName', 'FeatureType', ], 'members' => [ 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CollectionType' => [ 'shape' => 'CollectionType', ], 'CollectionConfig' => [ 'shape' => 'CollectionConfig', ], ], ], 'FeatureDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 2500, 'min' => 1, ], 'FeatureDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 0, 'pattern' => '.*', ], 'FeatureGroup' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'FeatureGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/.*', ], 'FeatureGroupMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'FeatureGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}', ], 'FeatureGroupNameContains' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'FeatureGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group\\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})', ], 'FeatureGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'FeatureGroupStatus', 'OfflineStoreStatus', 'CreationTime', ], ], 'FeatureGroupSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'FeatureGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'CreateFailed', 'Deleting', 'DeleteFailed', ], ], 'FeatureGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureGroupSummary', ], ], 'FeatureGroupSummary' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureGroupArn', 'CreationTime', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], ], ], 'FeatureMetadata' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'FeatureName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}', ], 'FeatureParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'FeatureParameterKey', ], 'Value' => [ 'shape' => 'FeatureParameterValue', ], ], ], 'FeatureParameterAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, ], 'FeatureParameterKey' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameterRemovals' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameterKey', ], 'max' => 25, ], 'FeatureParameterValue' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, 'min' => 0, ], 'FeatureStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'FeatureType' => [ 'type' => 'string', 'enum' => [ 'Integral', 'Fractional', 'String', ], ], 'FileSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'FileSystemAccessMode' => [ 'type' => 'string', 'enum' => [ 'rw', 'ro', ], ], 'FileSystemConfig' => [ 'type' => 'structure', 'members' => [ 'MountPath' => [ 'shape' => 'MountPath', ], 'DefaultUid' => [ 'shape' => 'DefaultUid', 'box' => true, ], 'DefaultGid' => [ 'shape' => 'DefaultGid', 'box' => true, ], ], ], 'FileSystemDataSource' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', 'FileSystemAccessMode', 'FileSystemType', 'DirectoryPath', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], 'FileSystemAccessMode' => [ 'shape' => 'FileSystemAccessMode', ], 'FileSystemType' => [ 'shape' => 'FileSystemType', ], 'DirectoryPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'FileSystemId' => [ 'type' => 'string', 'max' => 21, 'min' => 11, 'pattern' => '^(fs-[0-9a-f]{8,})$', ], 'FileSystemPath' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^\\/\\S*$', ], 'FileSystemType' => [ 'type' => 'string', 'enum' => [ 'EFS', 'FSxLustre', ], ], 'FillingTransformationMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'FillingType', ], 'value' => [ 'shape' => 'FillingTransformationValue', ], 'max' => 6, 'min' => 1, ], 'FillingTransformationValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\_\\-]+$', ], 'FillingTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'FillingTransformationMap', ], 'max' => 50, 'min' => 1, ], 'FillingType' => [ 'type' => 'string', 'enum' => [ 'frontfill', 'middlefill', 'backfill', 'futurefill', 'frontfill_value', 'middlefill_value', 'backfill_value', 'futurefill_value', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'ResourcePropertyName', ], 'Operator' => [ 'shape' => 'Operator', ], 'Value' => [ 'shape' => 'FilterValue', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], 'max' => 20, 'min' => 1, ], 'FilterValue' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'FinalAutoMLJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'AutoMLJobObjectiveType', ], 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'MetricValue', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'MetricValue', ], ], ], 'FinalMetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricData', ], 'max' => 40, 'min' => 0, ], 'FlatInvocations' => [ 'type' => 'string', 'enum' => [ 'Continue', 'Stop', ], ], 'Float' => [ 'type' => 'float', ], 'FlowDefinitionArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:flow-definition/.*', ], 'FlowDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9]){0,62}', ], 'FlowDefinitionOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'FlowDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Active', 'Failed', 'Deleting', ], ], 'FlowDefinitionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionSummary', ], ], 'FlowDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'FlowDefinitionArn', 'FlowDefinitionStatus', 'CreationTime', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'FlowDefinitionTaskCount' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'FlowDefinitionTaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'FlowDefinitionTaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'FlowDefinitionTaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionTaskKeyword', ], 'max' => 5, 'min' => 1, ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'type' => 'integer', 'min' => 30, ], 'FlowDefinitionTaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'ForecastFrequency' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min$', ], 'ForecastHorizon' => [ 'type' => 'integer', 'min' => 1, ], 'ForecastQuantile' => [ 'type' => 'string', 'max' => 4, 'min' => 2, 'pattern' => '(^p[1-9]\\d?$)', ], 'ForecastQuantiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ForecastQuantile', ], 'max' => 5, 'min' => 1, ], 'Framework' => [ 'type' => 'string', 'enum' => [ 'TENSORFLOW', 'KERAS', 'MXNET', 'ONNX', 'PYTORCH', 'XGBOOST', 'TFLITE', 'DARKNET', 'SKLEARN', ], ], 'FrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.]+', ], 'GenerateCandidateDefinitionsOnly' => [ 'type' => 'boolean', ], 'GetDeviceFleetReportRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'GetDeviceFleetReportResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'ReportGenerated' => [ 'shape' => 'Timestamp', ], 'DeviceStats' => [ 'shape' => 'DeviceStats', ], 'AgentVersions' => [ 'shape' => 'AgentVersions', ], 'ModelStats' => [ 'shape' => 'EdgeModelStats', ], ], ], 'GetLineageGroupPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'LineageGroupNameOrArn', ], ], ], 'GetLineageGroupPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'ResourcePolicy' => [ 'shape' => 'ResourcePolicyString', ], ], ], 'GetModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'GetModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ResourcePolicy', ], 'members' => [ 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'type' => 'structure', 'members' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'SagemakerServicecatalogStatus', ], ], ], 'GetScalingConfigurationRecommendationRequest' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobName', ], 'members' => [ 'InferenceRecommendationsJobName' => [ 'shape' => 'RecommendationJobName', ], 'RecommendationId' => [ 'shape' => 'String', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'TargetCpuUtilizationPerCore' => [ 'shape' => 'UtilizationPercentagePerCore', ], 'ScalingPolicyObjective' => [ 'shape' => 'ScalingPolicyObjective', ], ], ], 'GetScalingConfigurationRecommendationResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceRecommendationsJobName' => [ 'shape' => 'RecommendationJobName', ], 'RecommendationId' => [ 'shape' => 'String', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'TargetCpuUtilizationPerCore' => [ 'shape' => 'UtilizationPercentagePerCore', ], 'ScalingPolicyObjective' => [ 'shape' => 'ScalingPolicyObjective', ], 'Metric' => [ 'shape' => 'ScalingPolicyMetric', ], 'DynamicScalingConfiguration' => [ 'shape' => 'DynamicScalingConfiguration', ], ], ], 'GetSearchSuggestionsRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SuggestionQuery' => [ 'shape' => 'SuggestionQuery', ], ], ], 'GetSearchSuggestionsResponse' => [ 'type' => 'structure', 'members' => [ 'PropertyNameSuggestions' => [ 'shape' => 'PropertyNameSuggestionList', ], ], ], 'Gid' => [ 'type' => 'long', 'max' => 4000000, 'min' => 1001, ], 'GitConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'GitConfigUrl', ], 'Branch' => [ 'shape' => 'Branch', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 11, 'pattern' => '^https://([^/]+)/?.{3,1016}$', ], 'Group' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'GroupingAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'GroupingAttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupingAttributeName', ], 'max' => 5, 'min' => 1, ], 'Groups' => [ 'type' => 'list', 'member' => [ 'shape' => 'Group', ], 'max' => 10, 'min' => 1, ], 'HolidayConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'HolidayConfigAttributes', ], 'max' => 1, 'min' => 1, ], 'HolidayConfigAttributes' => [ 'type' => 'structure', 'members' => [ 'CountryCode' => [ 'shape' => 'CountryCode', ], ], ], 'HookParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'Horovod' => [ 'type' => 'boolean', ], 'HubArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDependency' => [ 'type' => 'structure', 'members' => [ 'DependencyOriginPath' => [ 'shape' => 'DependencyOriginPath', ], 'DependencyCopyPath' => [ 'shape' => 'DependencyCopyPath', ], ], ], 'HubContentDependencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentDependency', ], 'max' => 50, ], 'HubContentDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubContentDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDocument' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentInfo' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubContentInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentInfo', ], ], 'HubContentMarkdown' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubContentSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubContentSortBy' => [ 'type' => 'string', 'enum' => [ 'HubContentName', 'CreationTime', 'HubContentStatus', ], ], 'HubContentStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Importing', 'Deleting', 'ImportFailed', 'DeleteFailed', ], ], 'HubContentType' => [ 'type' => 'string', 'enum' => [ 'Model', 'Notebook', ], ], 'HubContentVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'HubDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubInfo' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubInfo', ], ], 'HubName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubS3StorageConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3OutputPath', ], ], ], 'HubSearchKeyword' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[^A-Z]*$', ], 'HubSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubSortBy' => [ 'type' => 'string', 'enum' => [ 'HubName', 'CreationTime', 'HubStatus', 'AccountIdOwner', ], ], 'HubStatus' => [ 'type' => 'string', 'enum' => [ 'InService', 'Creating', 'Updating', 'Deleting', 'CreateFailed', 'UpdateFailed', 'DeleteFailed', ], ], 'HumanLoopActivationConditions' => [ 'type' => 'string', 'max' => 10240, ], 'HumanLoopActivationConditionsConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditions', ], 'members' => [ 'HumanLoopActivationConditions' => [ 'shape' => 'HumanLoopActivationConditions', 'jsonvalue' => true, ], ], ], 'HumanLoopActivationConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditionsConfig', ], 'members' => [ 'HumanLoopActivationConditionsConfig' => [ 'shape' => 'HumanLoopActivationConditionsConfig', ], ], ], 'HumanLoopConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'HumanTaskUiArn', 'TaskTitle', 'TaskDescription', 'TaskCount', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'TaskTitle' => [ 'shape' => 'FlowDefinitionTaskTitle', ], 'TaskDescription' => [ 'shape' => 'FlowDefinitionTaskDescription', ], 'TaskCount' => [ 'shape' => 'FlowDefinitionTaskCount', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'FlowDefinitionTaskAvailabilityLifetimeInSeconds', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'FlowDefinitionTaskTimeLimitInSeconds', ], 'TaskKeywords' => [ 'shape' => 'FlowDefinitionTaskKeywords', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanLoopRequestSource' => [ 'type' => 'structure', 'required' => [ 'AwsManagedHumanLoopRequestSource', ], 'members' => [ 'AwsManagedHumanLoopRequestSource' => [ 'shape' => 'AwsManagedHumanLoopRequestSource', ], ], ], 'HumanTaskConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'UiConfig', 'PreHumanTaskLambdaArn', 'TaskTitle', 'TaskDescription', 'NumberOfHumanWorkersPerDataObject', 'TaskTimeLimitInSeconds', 'AnnotationConsolidationConfig', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'UiConfig' => [ 'shape' => 'UiConfig', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'TaskKeywords' => [ 'shape' => 'TaskKeywords', ], 'TaskTitle' => [ 'shape' => 'TaskTitle', ], 'TaskDescription' => [ 'shape' => 'TaskDescription', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'TaskTimeLimitInSeconds', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'TaskAvailabilityLifetimeInSeconds', ], 'MaxConcurrentTaskCount' => [ 'shape' => 'MaxConcurrentTaskCount', ], 'AnnotationConsolidationConfig' => [ 'shape' => 'AnnotationConsolidationConfig', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanTaskUiArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:human-task-ui/.*', ], 'HumanTaskUiName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9])*', ], 'HumanTaskUiStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'HumanTaskUiSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HumanTaskUiSummary', ], ], 'HumanTaskUiSummary' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'HumanTaskUiArn', 'CreationTime', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], ], ], 'HyperParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'HyperParameterScalingType' => [ 'type' => 'string', 'enum' => [ 'Auto', 'Linear', 'Logarithmic', 'ReverseLogarithmic', ], ], 'HyperParameterSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Type' => [ 'shape' => 'ParameterType', ], 'Range' => [ 'shape' => 'ParameterRange', ], 'IsTunable' => [ 'shape' => 'Boolean', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'DefaultValue' => [ 'shape' => 'HyperParameterValue', ], ], ], 'HyperParameterSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterSpecification', ], 'max' => 100, 'min' => 0, ], 'HyperParameterTrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'StoppingCondition', ], 'members' => [ 'DefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TuningObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'HyperParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'StaticHyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'HyperParameterAlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'HyperParameterTuningResourceConfig' => [ 'shape' => 'HyperParameterTuningResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Environment' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentMap', ], ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'HyperParameterTrainingJobDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'max' => 10, 'min' => 1, ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentKey', ], 'value' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentValue', ], 'max' => 48, ], 'HyperParameterTrainingJobEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'HyperParameterTrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], ], 'HyperParameterTrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', 'TunedHyperParameters', ], 'members' => [ 'TrainingJobDefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'TunedHyperParameters' => [ 'shape' => 'HyperParameters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'shape' => 'FinalHyperParameterTuningJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], ], ], 'HyperParameterTuningAllocationStrategy' => [ 'type' => 'string', 'enum' => [ 'Prioritized', ], ], 'HyperParameterTuningInstanceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], ], ], 'HyperParameterTuningInstanceConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningInstanceConfig', ], 'max' => 6, 'min' => 1, ], 'HyperParameterTuningJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*', ], 'HyperParameterTuningJobCompletionDetails' => [ 'type' => 'structure', 'members' => [ 'NumberOfTrainingJobsObjectiveNotImproving' => [ 'shape' => 'Integer', ], 'ConvergenceDetectedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterTuningJobConfig' => [ 'type' => 'structure', 'required' => [ 'Strategy', 'ResourceLimits', ], 'members' => [ 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'StrategyConfig' => [ 'shape' => 'HyperParameterTuningJobStrategyConfig', ], 'HyperParameterTuningJobObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], 'ParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'TrainingJobEarlyStoppingType' => [ 'shape' => 'TrainingJobEarlyStoppingType', ], 'TuningJobCompletionCriteria' => [ 'shape' => 'TuningJobCompletionCriteria', ], 'RandomSeed' => [ 'shape' => 'RandomSeed', ], ], ], 'HyperParameterTuningJobConsumedResources' => [ 'type' => 'structure', 'members' => [ 'RuntimeInSeconds' => [ 'shape' => 'Integer', ], ], ], 'HyperParameterTuningJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'HyperParameterTuningJobObjective' => [ 'type' => 'structure', 'required' => [ 'Type', 'MetricName', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], ], ], 'HyperParameterTuningJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'HyperParameterTuningJobObjectives' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobObjective', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'HyperParameterTuningJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'Status', 'CreationTime', ], ], 'HyperParameterTuningJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', 'Deleting', 'DeleteFailed', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'HyperbandStrategyConfig' => [ 'shape' => 'HyperbandStrategyConfig', ], ], ], 'HyperParameterTuningJobStrategyType' => [ 'type' => 'string', 'enum' => [ 'Bayesian', 'Random', 'Hyperband', 'Grid', ], ], 'HyperParameterTuningJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobSummary', ], ], 'HyperParameterTuningJobSummary' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobStatus', 'Strategy', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'type' => 'structure', 'required' => [ 'ParentHyperParameterTuningJobs', 'WarmStartType', ], 'members' => [ 'ParentHyperParameterTuningJobs' => [ 'shape' => 'ParentHyperParameterTuningJobs', ], 'WarmStartType' => [ 'shape' => 'HyperParameterTuningJobWarmStartType', ], ], ], 'HyperParameterTuningJobWarmStartType' => [ 'type' => 'string', 'enum' => [ 'IdenticalDataAndAlgorithm', 'TransferLearning', ], ], 'HyperParameterTuningMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 15768000, 'min' => 120, ], 'HyperParameterTuningResourceConfig' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AllocationStrategy' => [ 'shape' => 'HyperParameterTuningAllocationStrategy', ], 'InstanceConfigs' => [ 'shape' => 'HyperParameterTuningInstanceConfigs', ], ], ], 'HyperParameterValue' => [ 'type' => 'string', 'max' => 2500, 'pattern' => '.*', ], 'HyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterKey', ], 'value' => [ 'shape' => 'HyperParameterValue', ], 'max' => 100, 'min' => 0, ], 'HyperbandStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'MinResource' => [ 'shape' => 'HyperbandStrategyMinResource', ], 'MaxResource' => [ 'shape' => 'HyperbandStrategyMaxResource', ], ], ], 'HyperbandStrategyMaxResource' => [ 'type' => 'integer', 'min' => 1, ], 'HyperbandStrategyMinResource' => [ 'type' => 'integer', 'min' => 1, ], 'IamIdentity' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String', ], 'PrincipalId' => [ 'shape' => 'String', ], 'SourceIdentity' => [ 'shape' => 'String', ], ], ], 'IdempotencyToken' => [ 'type' => 'string', 'max' => 128, 'min' => 32, ], 'IdentityProviderOAuthSetting' => [ 'type' => 'structure', 'members' => [ 'DataSourceName' => [ 'shape' => 'DataSourceName', ], 'Status' => [ 'shape' => 'FeatureStatus', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'IdentityProviderOAuthSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'IdentityProviderOAuthSetting', ], 'max' => 20, ], 'Image' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageName', 'ImageStatus', 'LastModifiedTime', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ImageArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$', ], 'ImageBaseImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'ImageClassificationJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ImageConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryAccessMode', ], 'members' => [ 'RepositoryAccessMode' => [ 'shape' => 'RepositoryAccessMode', ], 'RepositoryAuthConfig' => [ 'shape' => 'RepositoryAuthConfig', ], ], ], 'ImageContainerImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'ImageDeleteProperty' => [ 'type' => 'string', 'max' => 11, 'min' => 1, 'pattern' => '(^DisplayName$)|(^Description$)', ], 'ImageDeletePropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageDeleteProperty', ], 'max' => 2, ], 'ImageDescription' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '.*', ], 'ImageDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ImageDisplayName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^\\S(.*\\S)?$', ], 'ImageName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$', ], 'ImageNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9\\-.]+$', ], 'ImageSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'IMAGE_NAME', ], ], 'ImageSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageUri' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'ImageVersion' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageVersionArn', 'ImageVersionStatus', 'LastModifiedTime', 'Version', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], ], ], 'ImageVersionAlias' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(^\\d+$)|(^\\d+.\\d+$)|(^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$)', ], 'ImageVersionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$', ], 'ImageVersionNumber' => [ 'type' => 'integer', 'min' => 0, ], 'ImageVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'VERSION', ], ], 'ImageVersionSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageVersionStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageVersion', ], ], 'Images' => [ 'type' => 'list', 'member' => [ 'shape' => 'Image', ], ], 'ImportHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubContentDocument', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ImportHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', 'HubContentArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], ], ], 'InferenceComponentArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'InferenceComponentComputeResourceRequirements' => [ 'type' => 'structure', 'required' => [ 'MinMemoryRequiredInMb', ], 'members' => [ 'NumberOfCpuCoresRequired' => [ 'shape' => 'NumberOfCpuCores', ], 'NumberOfAcceleratorDevicesRequired' => [ 'shape' => 'NumberOfAcceleratorDevices', ], 'MinMemoryRequiredInMb' => [ 'shape' => 'MemoryInMb', ], 'MaxMemoryRequiredInMb' => [ 'shape' => 'MemoryInMb', ], ], ], 'InferenceComponentContainerSpecification' => [ 'type' => 'structure', 'members' => [ 'Image' => [ 'shape' => 'ContainerImage', ], 'ArtifactUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'InferenceComponentContainerSpecificationSummary' => [ 'type' => 'structure', 'members' => [ 'DeployedImage' => [ 'shape' => 'DeployedImage', ], 'ArtifactUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'InferenceComponentCopyCount' => [ 'type' => 'integer', 'min' => 0, ], 'InferenceComponentName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$', ], 'InferenceComponentNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'InferenceComponentRuntimeConfig' => [ 'type' => 'structure', 'required' => [ 'CopyCount', ], 'members' => [ 'CopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], ], ], 'InferenceComponentRuntimeConfigSummary' => [ 'type' => 'structure', 'members' => [ 'DesiredCopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], 'CurrentCopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], ], ], 'InferenceComponentSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'InferenceComponentSpecification' => [ 'type' => 'structure', 'required' => [ 'ComputeResourceRequirements', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'Container' => [ 'shape' => 'InferenceComponentContainerSpecification', ], 'StartupParameters' => [ 'shape' => 'InferenceComponentStartupParameters', ], 'ComputeResourceRequirements' => [ 'shape' => 'InferenceComponentComputeResourceRequirements', ], ], ], 'InferenceComponentSpecificationSummary' => [ 'type' => 'structure', 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'Container' => [ 'shape' => 'InferenceComponentContainerSpecificationSummary', ], 'StartupParameters' => [ 'shape' => 'InferenceComponentStartupParameters', ], 'ComputeResourceRequirements' => [ 'shape' => 'InferenceComponentComputeResourceRequirements', ], ], ], 'InferenceComponentStartupParameters' => [ 'type' => 'structure', 'members' => [ 'ModelDataDownloadTimeoutInSeconds' => [ 'shape' => 'ProductionVariantModelDataDownloadTimeoutInSeconds', ], 'ContainerStartupHealthCheckTimeoutInSeconds' => [ 'shape' => 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds', ], ], ], 'InferenceComponentStatus' => [ 'type' => 'string', 'enum' => [ 'InService', 'Creating', 'Updating', 'Failed', 'Deleting', ], ], 'InferenceComponentSummary' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'InferenceComponentArn', 'InferenceComponentName', 'EndpointArn', 'EndpointName', 'VariantName', 'LastModifiedTime', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'InferenceComponentStatus' => [ 'shape' => 'InferenceComponentStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'InferenceComponentSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceComponentSummary', ], ], 'InferenceExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'InferenceExecutionMode', ], ], ], 'InferenceExecutionMode' => [ 'type' => 'string', 'enum' => [ 'Serial', 'Direct', ], ], 'InferenceExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/.*', ], 'InferenceExperimentDataStorageConfig' => [ 'type' => 'structure', 'required' => [ 'Destination', ], 'members' => [ 'Destination' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'ContentType' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'InferenceExperimentDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceExperimentSummary', ], ], 'InferenceExperimentName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'InferenceExperimentSchedule' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'InferenceExperimentStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'Updating', 'Running', 'Starting', 'Stopping', 'Completed', 'Cancelled', ], ], 'InferenceExperimentStatusReason' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentStopDesiredState' => [ 'type' => 'string', 'enum' => [ 'Completed', 'Cancelled', ], ], 'InferenceExperimentSummary' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'Status', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'InferenceExperimentType' => [ 'type' => 'string', 'enum' => [ 'ShadowMode', ], ], 'InferenceImage' => [ 'type' => 'string', 'max' => 256, ], 'InferenceMetrics' => [ 'type' => 'structure', 'required' => [ 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'InferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointConfiguration', 'ModelConfiguration', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'InferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendation', ], 'max' => 10, 'min' => 1, ], 'InferenceRecommendationsJob' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobDescription', 'JobType', 'JobArn', 'Status', 'CreationTime', 'RoleArn', 'LastModifiedTime', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'InferenceRecommendationsJobStep' => [ 'type' => 'structure', 'required' => [ 'StepType', 'JobName', 'Status', ], 'members' => [ 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'InferenceBenchmark' => [ 'shape' => 'RecommendationJobInferenceBenchmark', ], ], ], 'InferenceRecommendationsJobSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJobStep', ], ], 'InferenceRecommendationsJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJob', ], ], 'InferenceSpecification' => [ 'type' => 'structure', 'required' => [ 'Containers', ], 'members' => [ 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'InferenceSpecificationName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'InfraCheckConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInfraCheck' => [ 'shape' => 'EnableInfraCheck', ], ], ], 'InitialInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'InitialNumberOfUsers' => [ 'type' => 'integer', 'min' => 1, ], 'InitialTaskCount' => [ 'type' => 'integer', 'min' => 1, ], 'InputConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'Framework', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], 'Framework' => [ 'shape' => 'Framework', ], 'FrameworkVersion' => [ 'shape' => 'FrameworkVersion', ], ], ], 'InputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'Channel', ], 'max' => 20, 'min' => 1, ], 'InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'InputModes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInputMode', ], 'min' => 1, ], 'InstanceGroup' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'InstanceGroupName', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'InstanceGroupName', ], ], ], 'InstanceGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.+', ], 'InstanceGroupNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupName', ], 'max' => 5, ], 'InstanceGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroup', ], 'max' => 5, ], 'InstanceMetadataServiceConfiguration' => [ 'type' => 'structure', 'required' => [ 'MinimumInstanceMetadataServiceVersion', ], 'members' => [ 'MinimumInstanceMetadataServiceVersion' => [ 'shape' => 'MinimumInstanceMetadataServiceVersion', ], ], ], 'InstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', ], ], 'Integer' => [ 'type' => 'integer', ], 'IntegerParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'IntegerParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'IntegerParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerParameterRange', ], 'max' => 30, 'min' => 0, ], 'InvocationEndTime' => [ 'type' => 'timestamp', ], 'InvocationStartTime' => [ 'type' => 'timestamp', ], 'InvocationsMaxRetries' => [ 'type' => 'integer', 'max' => 3, 'min' => 0, ], 'InvocationsTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 1, ], 'IotRoleAlias' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'ItemIdentifierAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'JobDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'JobReferenceCode' => [ 'type' => 'string', 'min' => 1, 'pattern' => '.+', ], 'JobReferenceCodeContains' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'JobType' => [ 'type' => 'string', 'enum' => [ 'TRAINING', 'INFERENCE', 'NOTEBOOK_KERNEL', ], ], 'JoinSource' => [ 'type' => 'string', 'enum' => [ 'Input', 'None', ], ], 'JsonContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'JsonContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'JsonContentType', ], 'max' => 10, 'min' => 1, ], 'JsonPath' => [ 'type' => 'string', 'max' => 63, 'min' => 0, ], 'JupyterLabAppImageConfig' => [ 'type' => 'structure', 'members' => [ 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], 'ContainerConfig' => [ 'shape' => 'ContainerConfig', ], ], ], 'JupyterLabAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'JupyterServerAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'KeepAlivePeriodInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'KendraSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], ], ], 'KernelDisplayName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelGatewayAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], ], ], 'KernelGatewayImageConfig' => [ 'type' => 'structure', 'required' => [ 'KernelSpecs', ], 'members' => [ 'KernelSpecs' => [ 'shape' => 'KernelSpecs', ], 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], ], ], 'KernelName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelSpec' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'KernelName', ], 'DisplayName' => [ 'shape' => 'KernelDisplayName', ], ], ], 'KernelSpecs' => [ 'type' => 'list', 'member' => [ 'shape' => 'KernelSpec', ], 'max' => 5, 'min' => 1, ], 'Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'LabelAttributeName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}', ], 'LabelCounter' => [ 'type' => 'integer', 'min' => 0, ], 'LabelCounters' => [ 'type' => 'structure', 'members' => [ 'TotalLabeled' => [ 'shape' => 'LabelCounter', ], 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'MachineLabeled' => [ 'shape' => 'LabelCounter', ], 'FailedNonRetryableError' => [ 'shape' => 'LabelCounter', ], 'Unlabeled' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelCountersForWorkteam' => [ 'type' => 'structure', 'members' => [ 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'PendingHuman' => [ 'shape' => 'LabelCounter', ], 'Total' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:.*', ], 'LabelingJobAlgorithmsConfig' => [ 'type' => 'structure', 'required' => [ 'LabelingJobAlgorithmSpecificationArn', ], 'members' => [ 'LabelingJobAlgorithmSpecificationArn' => [ 'shape' => 'LabelingJobAlgorithmSpecificationArn', ], 'InitialActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], 'LabelingJobResourceConfig' => [ 'shape' => 'LabelingJobResourceConfig', ], ], ], 'LabelingJobArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:labeling-job/.*', ], 'LabelingJobDataAttributes' => [ 'type' => 'structure', 'members' => [ 'ContentClassifiers' => [ 'shape' => 'ContentClassifiers', ], ], ], 'LabelingJobDataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'LabelingJobS3DataSource', ], 'SnsDataSource' => [ 'shape' => 'LabelingJobSnsDataSource', ], ], ], 'LabelingJobForWorkteamSummary' => [ 'type' => 'structure', 'required' => [ 'JobReferenceCode', 'WorkRequesterAccountId', 'CreationTime', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'WorkRequesterAccountId' => [ 'shape' => 'AccountId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LabelCounters' => [ 'shape' => 'LabelCountersForWorkteam', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], ], ], 'LabelingJobForWorkteamSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobForWorkteamSummary', ], ], 'LabelingJobInputConfig' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'LabelingJobDataSource', ], 'DataAttributes' => [ 'shape' => 'LabelingJobDataAttributes', ], ], ], 'LabelingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'LabelingJobOutput' => [ 'type' => 'structure', 'required' => [ 'OutputDatasetS3Uri', ], 'members' => [ 'OutputDatasetS3Uri' => [ 'shape' => 'S3Uri', ], 'FinalActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'LabelingJobOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobResourceConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'LabelingJobS3DataSource' => [ 'type' => 'structure', 'required' => [ 'ManifestS3Uri', ], 'members' => [ 'ManifestS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'LabelingJobSnsDataSource' => [ 'type' => 'structure', 'required' => [ 'SnsTopicArn', ], 'members' => [ 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'LabelingJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxHumanLabeledObjectCount' => [ 'shape' => 'MaxHumanLabeledObjectCount', ], 'MaxPercentageOfInputDatasetLabeled' => [ 'shape' => 'MaxPercentageOfInputDatasetLabeled', ], ], ], 'LabelingJobSummary' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelingJobArn', 'CreationTime', 'LastModifiedTime', 'LabelingJobStatus', 'LabelCounters', 'WorkteamArn', 'PreHumanTaskLambdaArn', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], ], ], 'LabelingJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobSummary', ], ], 'LambdaFunctionArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:.*', ], 'LambdaStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'LandingUri' => [ 'type' => 'string', 'max' => 1023, ], 'LastModifiedTime' => [ 'type' => 'timestamp', ], 'LastUpdateStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'LastUpdateStatusValue', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'LastUpdateStatusValue' => [ 'type' => 'string', 'enum' => [ 'Successful', 'Failed', 'InProgress', ], ], 'LifecycleConfigArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], 'LineageEntityParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringParameterValue', ], 'value' => [ 'shape' => 'StringParameterValue', ], 'max' => 30, ], 'LineageGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/.*', ], 'LineageGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'LineageGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageGroupSummary', ], ], 'LineageGroupSummary' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'LineageType' => [ 'type' => 'string', 'enum' => [ 'TrialComponent', 'Artifact', 'Context', 'Action', ], ], 'ListActionsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ActionType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortActionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListActionsResponse' => [ 'type' => 'structure', 'members' => [ 'ActionSummaries' => [ 'shape' => 'ActionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAlgorithmsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'AlgorithmSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAlgorithmsOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSummaryList', ], 'members' => [ 'AlgorithmSummaryList' => [ 'shape' => 'AlgorithmSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageVersionAliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppImageConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'AppImageConfigName', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'AppImageConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAppImageConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'AppImageConfigs' => [ 'shape' => 'AppImageConfigList', ], ], ], 'ListAppsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'AppSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameEquals' => [ 'shape' => 'UserProfileName', ], 'SpaceNameEquals' => [ 'shape' => 'SpaceName', ], ], ], 'ListAppsResponse' => [ 'type' => 'structure', 'members' => [ 'Apps' => [ 'shape' => 'AppList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListArtifactsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortArtifactsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListArtifactsResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactSummaries' => [ 'shape' => 'ArtifactSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortAssociationsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'AssociationSummaries' => [ 'shape' => 'AssociationSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'AutoMLNameContains', ], 'StatusEquals' => [ 'shape' => 'AutoMLJobStatus', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'AutoMLSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobSummaries', ], 'members' => [ 'AutoMLJobSummaries' => [ 'shape' => 'AutoMLJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'StatusEquals' => [ 'shape' => 'CandidateStatus', ], 'CandidateNameEquals' => [ 'shape' => 'CandidateName', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'CandidateSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResultsForTrials', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'Candidates', ], 'members' => [ 'Candidates' => [ 'shape' => 'AutoMLCandidates', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListClusterNodesRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'InstanceGroupNameContains' => [ 'shape' => 'ClusterInstanceGroupName', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ClusterSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListClusterNodesResponse' => [ 'type' => 'structure', 'required' => [ 'NextToken', 'ClusterNodeSummaries', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ClusterNodeSummaries' => [ 'shape' => 'ClusterNodeSummaries', ], ], ], 'ListClustersRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ClusterSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListClustersResponse' => [ 'type' => 'structure', 'required' => [ 'NextToken', 'ClusterSummaries', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ClusterSummaries' => [ 'shape' => 'ClusterSummaries', ], ], ], 'ListCodeRepositoriesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'CodeRepositoryNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'CodeRepositorySortBy', ], 'SortOrder' => [ 'shape' => 'CodeRepositorySortOrder', ], ], ], 'ListCodeRepositoriesOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositorySummaryList', ], 'members' => [ 'CodeRepositorySummaryList' => [ 'shape' => 'CodeRepositorySummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'CompilationJobStatus', ], 'SortBy' => [ 'shape' => 'ListCompilationJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListCompilationJobsResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobSummaries', ], 'members' => [ 'CompilationJobSummaries' => [ 'shape' => 'CompilationJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListContextsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortContextsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListContextsResponse' => [ 'type' => 'structure', 'members' => [ 'ContextSummaries' => [ 'shape' => 'ContextSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListDataQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListDeviceFleetsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListDeviceFleetsResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetSummaries', ], 'members' => [ 'DeviceFleetSummaries' => [ 'shape' => 'DeviceFleetSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListDevicesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'LatestHeartbeatAfter' => [ 'shape' => 'Timestamp', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'ListDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceSummaries', ], 'members' => [ 'DeviceSummaries' => [ 'shape' => 'DeviceSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'Domains' => [ 'shape' => 'DomainList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'DeviceFleetNameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListEdgeDeploymentPlansSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgeDeploymentPlansResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanSummaries', ], 'members' => [ 'EdgeDeploymentPlanSummaries' => [ 'shape' => 'EdgeDeploymentPlanSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'DEVICE_FLEET_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListEdgePackagingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelNameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'EdgePackagingJobStatus', ], 'SortBy' => [ 'shape' => 'ListEdgePackagingJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgePackagingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobSummaries', ], 'members' => [ 'EdgePackagingJobSummaries' => [ 'shape' => 'EdgePackagingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgePackagingJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'MODEL_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'STATUS', ], ], 'ListEndpointConfigsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointConfigSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListEndpointConfigsOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigs', ], 'members' => [ 'EndpointConfigs' => [ 'shape' => 'EndpointConfigSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListEndpointsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'EndpointStatus', ], ], ], 'ListEndpointsOutput' => [ 'type' => 'structure', 'required' => [ 'Endpoints', ], 'members' => [ 'Endpoints' => [ 'shape' => 'EndpointSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentSummaries' => [ 'shape' => 'ExperimentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'FeatureGroupNameContains', ], 'FeatureGroupStatusEquals' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatusEquals' => [ 'shape' => 'OfflineStoreStatusValue', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'SortOrder' => [ 'shape' => 'FeatureGroupSortOrder', ], 'SortBy' => [ 'shape' => 'FeatureGroupSortBy', ], 'MaxResults' => [ 'shape' => 'FeatureGroupMaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupSummaries', ], 'members' => [ 'FeatureGroupSummaries' => [ 'shape' => 'FeatureGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFlowDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListFlowDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionSummaries', ], 'members' => [ 'FlowDefinitionSummaries' => [ 'shape' => 'FlowDefinitionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'MinVersion' => [ 'shape' => 'HubContentVersion', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsResponse' => [ 'type' => 'structure', 'required' => [ 'HubSummaries', ], 'members' => [ 'HubSummaries' => [ 'shape' => 'HubInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHumanTaskUisRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListHumanTaskUisResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiSummaries', ], 'members' => [ 'HumanTaskUiSummaries' => [ 'shape' => 'HumanTaskUiSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHyperParameterTuningJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'SortBy' => [ 'shape' => 'HyperParameterTuningJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'HyperParameterTuningJobStatus', ], ], ], 'ListHyperParameterTuningJobsResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobSummaries', ], 'members' => [ 'HyperParameterTuningJobSummaries' => [ 'shape' => 'HyperParameterTuningJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ImageVersionSortOrder', ], ], ], 'ListImageVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersions' => [ 'shape' => 'ImageVersions', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImagesRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ImageNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageSortBy', ], 'SortOrder' => [ 'shape' => 'ImageSortOrder', ], ], ], 'ListImagesResponse' => [ 'type' => 'structure', 'members' => [ 'Images' => [ 'shape' => 'Images', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceComponentsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'InferenceComponentSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'InferenceComponentNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'InferenceComponentStatus', ], 'EndpointNameEquals' => [ 'shape' => 'EndpointName', ], 'VariantNameEquals' => [ 'shape' => 'VariantName', ], ], ], 'ListInferenceComponentsOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponents', ], 'members' => [ 'InferenceComponents' => [ 'shape' => 'InferenceComponentSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListInferenceExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'StatusEquals' => [ 'shape' => 'InferenceExperimentStatus', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortInferenceExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListInferenceExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceExperiments' => [ 'shape' => 'InferenceExperimentList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'type' => 'structure', 'members' => [ 'Steps' => [ 'shape' => 'InferenceRecommendationsJobSteps', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'RecommendationJobStatus', ], 'SortBy' => [ 'shape' => 'ListInferenceRecommendationsJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelNameEquals' => [ 'shape' => 'ModelName', ], 'ModelPackageVersionArnEquals' => [ 'shape' => 'ModelPackageArn', ], ], ], 'ListInferenceRecommendationsJobsResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobs', ], 'members' => [ 'InferenceRecommendationsJobs' => [ 'shape' => 'InferenceRecommendationsJobs', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'JobReferenceCodeContains' => [ 'shape' => 'JobReferenceCodeContains', ], 'SortBy' => [ 'shape' => 'ListLabelingJobsForWorkteamSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListLabelingJobsForWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobSummaryList', ], 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobForWorkteamSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ListLabelingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'StatusEquals' => [ 'shape' => 'LabelingJobStatus', ], ], ], 'ListLabelingJobsResponse' => [ 'type' => 'structure', 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLineageEntityParameterKey' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringParameterValue', ], ], 'ListLineageGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortLineageGroupsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListLineageGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupSummaries' => [ 'shape' => 'LineageGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMaxResults' => [ 'type' => 'integer', 'max' => 100, ], 'ListModelBiasJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelBiasJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModelCardExportJobNameContains' => [ 'shape' => 'EntityName', ], 'StatusEquals' => [ 'shape' => 'ModelCardExportJobStatus', ], 'SortBy' => [ 'shape' => 'ModelCardExportJobSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardExportJobSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelCardExportJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobSummaries', ], 'members' => [ 'ModelCardExportJobSummaries' => [ 'shape' => 'ModelCardExportJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardVersionSummaryList', ], 'members' => [ 'ModelCardVersionSummaryList' => [ 'shape' => 'ModelCardVersionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EntityName', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardSummaries', ], 'members' => [ 'ModelCardSummaries' => [ 'shape' => 'ModelCardSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelMetadataRequest' => [ 'type' => 'structure', 'members' => [ 'SearchExpression' => [ 'shape' => 'ModelMetadataSearchExpression', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'ModelMetadataSummaries', ], 'members' => [ 'ModelMetadataSummaries' => [ 'shape' => 'ModelMetadataSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackageGroupsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageGroupSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackageGroupsOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupSummaryList', ], 'members' => [ 'ModelPackageGroupSummaryList' => [ 'shape' => 'ModelPackageGroupSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackagesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageType' => [ 'shape' => 'ModelPackageType', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackagesOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageSummaryList', ], 'members' => [ 'ModelPackageSummaryList' => [ 'shape' => 'ModelPackageSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ModelSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ModelNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelsOutput' => [ 'type' => 'structure', 'required' => [ 'Models', ], 'members' => [ 'Models' => [ 'shape' => 'ModelSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListMonitoringAlertHistoryRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'SortBy' => [ 'shape' => 'MonitoringAlertHistorySortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'ListMonitoringAlertHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertHistory' => [ 'shape' => 'MonitoringAlertHistoryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringAlertsRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMonitoringAlertsResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringExecutionsRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringExecutionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ScheduledTimeBefore' => [ 'shape' => 'Timestamp', ], 'ScheduledTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ExecutionStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringExecutionsResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringExecutionSummaries', ], 'members' => [ 'MonitoringExecutionSummaries' => [ 'shape' => 'MonitoringExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringSchedulesRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringScheduleSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringSchedulesResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleSummaries', ], 'members' => [ 'MonitoringScheduleSummaries' => [ 'shape' => 'MonitoringScheduleSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], ], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstanceLifecycleConfigs' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummaryList', ], ], ], 'ListNotebookInstancesInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'StatusEquals' => [ 'shape' => 'NotebookInstanceStatus', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepositoryContains' => [ 'shape' => 'CodeRepositoryContains', ], 'AdditionalCodeRepositoryEquals' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], ], ], 'ListNotebookInstancesOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstances' => [ 'shape' => 'NotebookInstanceSummaryList', ], ], ], 'ListPipelineExecutionStepsRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListPipelineExecutionStepsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSteps' => [ 'shape' => 'PipelineExecutionStepList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineExecutionsRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelineExecutionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineExecutionsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSummaries' => [ 'shape' => 'PipelineExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineParametersForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineParametersForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelinesRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineNamePrefix' => [ 'shape' => 'PipelineName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelinesBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelinesResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineSummaries' => [ 'shape' => 'PipelineSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProcessingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'String', ], 'StatusEquals' => [ 'shape' => 'ProcessingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListProcessingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobSummaries', ], 'members' => [ 'ProcessingJobSummaries' => [ 'shape' => 'ProcessingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProjectsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ProjectEntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ProjectSortBy', ], 'SortOrder' => [ 'shape' => 'ProjectSortOrder', ], ], ], 'ListProjectsOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectSummaryList', ], 'members' => [ 'ProjectSummaryList' => [ 'shape' => 'ProjectSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'ResourceCatalogName', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'ResourceCatalogSortOrder', ], 'SortBy' => [ 'shape' => 'ResourceCatalogSortBy', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceCatalogs' => [ 'shape' => 'ResourceCatalogList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSpacesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'SpaceSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'SpaceNameContains' => [ 'shape' => 'SpaceName', ], ], ], 'ListSpacesResponse' => [ 'type' => 'structure', 'members' => [ 'Spaces' => [ 'shape' => 'SpaceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStageDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ExcludeDevicesDeployedInOtherStage' => [ 'shape' => 'Boolean', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'ListStageDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceDeploymentSummaries', ], 'members' => [ 'DeviceDeploymentSummaries' => [ 'shape' => 'DeviceDeploymentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStudioLifecycleConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'StudioLifecycleConfigName', ], 'AppTypeEquals' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'StudioLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListStudioLifecycleConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'StudioLifecycleConfigs' => [ 'shape' => 'StudioLifecycleConfigsList', ], ], ], 'ListSubscribedWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListSubscribedWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteams', ], 'members' => [ 'SubscribedWorkteams' => [ 'shape' => 'SubscribedWorkteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListTagsMaxResults', ], ], ], 'ListTagsMaxResults' => [ 'type' => 'integer', 'min' => 50, ], 'ListTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'TrainingJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'HyperParameterTrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'WarmPoolStatusEquals' => [ 'shape' => 'WarmPoolResourceStatus', ], ], ], 'ListTrainingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'TrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTransformJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TransformJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListTransformJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobSummaries', ], 'members' => [ 'TransformJobSummaries' => [ 'shape' => 'TransformJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentKey256' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentKey256', ], ], 'ListTrialComponentsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'SourceArn' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialComponentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialSummaries' => [ 'shape' => 'TrialSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListUserProfilesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'UserProfileSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameContains' => [ 'shape' => 'UserProfileName', ], ], ], 'ListUserProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfiles' => [ 'shape' => 'UserProfileList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkforcesSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkforceName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkforcesResponse' => [ 'type' => 'structure', 'required' => [ 'Workforces', ], 'members' => [ 'Workforces' => [ 'shape' => 'Workforces', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'ListWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkteamsSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'Workteams', ], 'members' => [ 'Workteams' => [ 'shape' => 'Workteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkteamsSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'Long' => [ 'type' => 'long', ], 'MLFramework' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'ManagedInstanceScalingMaxInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ManagedInstanceScalingMinInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ManagedInstanceScalingStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxCandidates' => [ 'type' => 'integer', 'max' => 750, 'min' => 1, ], 'MaxConcurrentInvocationsPerInstance' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'MaxConcurrentTaskCount' => [ 'type' => 'integer', 'max' => 5000, 'min' => 1, ], 'MaxConcurrentTransforms' => [ 'type' => 'integer', 'min' => 0, ], 'MaxHumanLabeledObjectCount' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'type' => 'integer', 'min' => 3, ], 'MaxParallelExecutionSteps' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxPayloadInMB' => [ 'type' => 'integer', 'min' => 0, ], 'MaxPendingTimeInSeconds' => [ 'type' => 'integer', 'max' => 2419200, 'min' => 7200, ], 'MaxPercentageOfInputDatasetLabeled' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxWaitTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaximumExecutionTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 28800, 'min' => 600, ], 'MaximumRetryAttempts' => [ 'type' => 'integer', 'max' => 30, 'min' => 1, ], 'MediaType' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[-\\w]+\\/[-\\w+]+$', ], 'MemberDefinition' => [ 'type' => 'structure', 'members' => [ 'CognitoMemberDefinition' => [ 'shape' => 'CognitoMemberDefinition', ], 'OidcMemberDefinition' => [ 'shape' => 'OidcMemberDefinition', ], ], ], 'MemberDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberDefinition', ], 'max' => 10, 'min' => 1, ], 'MemoryInMb' => [ 'type' => 'integer', 'min' => 128, ], 'MetadataProperties' => [ 'type' => 'structure', 'members' => [ 'CommitId' => [ 'shape' => 'MetadataPropertyValue', ], 'Repository' => [ 'shape' => 'MetadataPropertyValue', ], 'GeneratedBy' => [ 'shape' => 'MetadataPropertyValue', ], 'ProjectId' => [ 'shape' => 'MetadataPropertyValue', ], ], ], 'MetadataPropertyValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'MetricData' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'Float', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'MetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDatum', ], 'max' => 40, 'min' => 0, ], 'MetricDatum' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'Float', ], 'Set' => [ 'shape' => 'MetricSetSource', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricExtendedEnum', ], ], ], 'MetricDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Regex', ], 'members' => [ 'Name' => [ 'shape' => 'MetricName', ], 'Regex' => [ 'shape' => 'MetricRegex', ], ], ], 'MetricDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDefinition', ], 'max' => 40, 'min' => 0, ], 'MetricName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'MetricRegex' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '.+', ], 'MetricSetSource' => [ 'type' => 'string', 'enum' => [ 'Train', 'Validation', 'Test', ], ], 'MetricSpecification' => [ 'type' => 'structure', 'members' => [ 'Predefined' => [ 'shape' => 'PredefinedMetricSpecification', ], 'Customized' => [ 'shape' => 'CustomizedMetricSpecification', ], ], 'union' => true, ], 'MetricValue' => [ 'type' => 'float', ], 'MetricsSource' => [ 'type' => 'structure', 'required' => [ 'ContentType', 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'type' => 'string', 'max' => 1, 'pattern' => '1|2', ], 'Model' => [ 'type' => 'structure', 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'ModelAccessConfig' => [ 'type' => 'structure', 'required' => [ 'AcceptEula', ], 'members' => [ 'AcceptEula' => [ 'shape' => 'AcceptEula', ], ], ], 'ModelApprovalStatus' => [ 'type' => 'string', 'enum' => [ 'Approved', 'Rejected', 'PendingManualApproval', ], ], 'ModelArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model/.*', ], 'ModelArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ModelArtifacts', ], 'members' => [ 'S3ModelArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelBiasAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelBiasBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelBiasJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelCacheSetting' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], 'ModelPackageGroupName' => [ 'shape' => 'String', ], ], ], 'ModelCardArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardContent' => [ 'type' => 'string', 'max' => 100000, 'min' => 0, 'pattern' => '.*', 'sensitive' => true, ], 'ModelCardExportArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ExportArtifacts', ], 'members' => [ 'S3ExportArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardExportJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardExportJobSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ModelCardExportJobSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardExportJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', ], ], 'ModelCardExportJobSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardExportJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardExportJobSummary', ], ], 'ModelCardExportOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})', ], 'ModelCardProcessingStatus' => [ 'type' => 'string', 'enum' => [ 'DeleteInProgress', 'DeletePending', 'ContentDeleted', 'ExportJobsDeleted', 'DeleteCompleted', 'DeleteFailed', ], ], 'ModelCardSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ModelCardSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelCardSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardStatus' => [ 'type' => 'string', 'enum' => [ 'Draft', 'PendingReview', 'Approved', 'Archived', ], ], 'ModelCardSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardSummary', ], ], 'ModelCardVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'Version', ], ], 'ModelCardVersionSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'ModelCardVersion', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardVersionSummary', ], ], 'ModelClientConfig' => [ 'type' => 'structure', 'members' => [ 'InvocationsTimeoutInSeconds' => [ 'shape' => 'InvocationsTimeoutInSeconds', ], 'InvocationsMaxRetries' => [ 'shape' => 'InvocationsMaxRetries', ], ], ], 'ModelCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ModelConfiguration' => [ 'type' => 'structure', 'members' => [ 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameters' => [ 'shape' => 'EnvironmentParameters', ], 'CompilationJobName' => [ 'shape' => 'RecommendationJobCompilationJobName', ], ], ], 'ModelDashboardEndpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'ModelDashboardEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardEndpoint', ], ], 'ModelDashboardIndicatorAction' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'ModelDashboardModel' => [ 'type' => 'structure', 'members' => [ 'Model' => [ 'shape' => 'Model', ], 'Endpoints' => [ 'shape' => 'ModelDashboardEndpoints', ], 'LastBatchTransformJob' => [ 'shape' => 'TransformJob', ], 'MonitoringSchedules' => [ 'shape' => 'ModelDashboardMonitoringSchedules', ], 'ModelCard' => [ 'shape' => 'ModelDashboardModelCard', ], ], ], 'ModelDashboardModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], ], ], 'ModelDashboardMonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'ModelDashboardMonitoringSchedules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardMonitoringSchedule', ], ], 'ModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelDataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'S3ModelDataSource', ], ], ], 'ModelDeployConfig' => [ 'type' => 'structure', 'members' => [ 'AutoGenerateEndpointName' => [ 'shape' => 'AutoGenerateEndpointName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDeployResult' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDigests' => [ 'type' => 'structure', 'members' => [ 'ArtifactDigest' => [ 'shape' => 'ArtifactDigest', ], ], ], 'ModelExplainabilityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelExplainabilityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelExplainabilityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'ModelInfrastructureConfig' => [ 'type' => 'structure', 'required' => [ 'InfrastructureType', 'RealTimeInferenceConfig', ], 'members' => [ 'InfrastructureType' => [ 'shape' => 'ModelInfrastructureType', ], 'RealTimeInferenceConfig' => [ 'shape' => 'RealTimeInferenceConfig', ], ], ], 'ModelInfrastructureType' => [ 'type' => 'string', 'enum' => [ 'RealTimeInference', ], ], 'ModelInput' => [ 'type' => 'structure', 'required' => [ 'DataInputConfig', ], 'members' => [ 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], ], ], 'ModelInsightsLocation' => [ 'type' => 'string', 'min' => 1, ], 'ModelLatencyThreshold' => [ 'type' => 'structure', 'members' => [ 'Percentile' => [ 'shape' => 'String64', ], 'ValueInMilliseconds' => [ 'shape' => 'Integer', ], ], ], 'ModelLatencyThresholds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelLatencyThreshold', ], 'max' => 1, 'min' => 1, ], 'ModelMetadataFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'ModelMetadataFilterType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ModelMetadataFilterType' => [ 'type' => 'string', 'enum' => [ 'Domain', 'Framework', 'Task', 'FrameworkVersion', ], ], 'ModelMetadataFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataFilter', ], 'max' => 4, 'min' => 1, ], 'ModelMetadataSearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ModelMetadataFilters', ], ], ], 'ModelMetadataSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataSummary', ], ], 'ModelMetadataSummary' => [ 'type' => 'structure', 'required' => [ 'Domain', 'Framework', 'Task', 'Model', 'FrameworkVersion', ], 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Model' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'String', ], ], ], 'ModelMetrics' => [ 'type' => 'structure', 'members' => [ 'ModelQuality' => [ 'shape' => 'ModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'ModelDataQuality', ], 'Bias' => [ 'shape' => 'Bias', ], 'Explainability' => [ 'shape' => 'Explainability', ], ], ], 'ModelName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?', ], 'ModelNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'ModelPackage' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'Tags' => [ 'shape' => 'TagList', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], ], ], 'ModelPackageArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}$', ], 'ModelPackageArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageArn', ], 'max' => 100, 'min' => 1, ], 'ModelPackageContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', ], 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageDigest' => [ 'shape' => 'ImageDigest', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelInput' => [ 'shape' => 'ModelInput', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'ModelPackageFrameworkVersion', ], 'NearestModelName' => [ 'shape' => 'String', ], 'AdditionalS3DataSource' => [ 'shape' => 'AdditionalS3DataSource', ], ], ], 'ModelPackageContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageContainerDefinition', ], 'max' => 15, 'min' => 1, ], 'ModelPackageFrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.-]+', ], 'ModelPackageGroup' => [ 'type' => 'structure', 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ModelPackageGroupArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package-group/[\\S]{1,2048}$', ], 'ModelPackageGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', 'DeleteFailed', ], ], 'ModelPackageGroupSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'ModelPackageGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageGroupSummary', ], ], 'ModelPackageSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'ModelPackageStatusDetails' => [ 'type' => 'structure', 'required' => [ 'ValidationStatuses', ], 'members' => [ 'ValidationStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], ], ], 'ModelPackageStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedModelPackageStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'ModelPackageStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageStatusItem', ], ], 'ModelPackageSummaries' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageSummary', ], ], 'ModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'ModelPackageSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageSummary', ], ], 'ModelPackageType' => [ 'type' => 'string', 'enum' => [ 'Versioned', 'Unversioned', 'Both', ], ], 'ModelPackageValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TransformJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'ModelPackageValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageValidationProfile', ], 'max' => 1, 'min' => 0, ], 'ModelPackageValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'ModelPackageValidationProfiles', ], ], ], 'ModelPackageVersion' => [ 'type' => 'integer', 'min' => 1, ], 'ModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'ProblemType' => [ 'shape' => 'MonitoringProblemType', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelQualityJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelRegisterSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'CrossAccountModelRegisterRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'ModelSetupTime' => [ 'type' => 'integer', 'min' => 0, ], 'ModelSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelArn', 'CreationTime', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelSummary', ], ], 'ModelVariantAction' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Remove', 'Promote', ], ], 'ModelVariantActionMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelVariantName', ], 'value' => [ 'shape' => 'ModelVariantAction', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], ], ], 'ModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfig', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfigSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', 'Status', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], 'Status' => [ 'shape' => 'ModelVariantStatus', ], ], ], 'ModelVariantConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfigSummary', ], ], 'ModelVariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?', ], 'ModelVariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'InService', 'Deleting', 'Deleted', ], ], 'MonitoringAlertActions' => [ 'type' => 'structure', 'members' => [ 'ModelDashboardIndicator' => [ 'shape' => 'ModelDashboardIndicatorAction', ], ], ], 'MonitoringAlertHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertHistorySummary', ], ], 'MonitoringAlertHistorySortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', ], ], 'MonitoringAlertHistorySummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'CreationTime', 'AlertStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'MonitoringAlertName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringAlertStatus' => [ 'type' => 'string', 'enum' => [ 'InAlert', 'OK', ], ], 'MonitoringAlertSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringAlertName', 'CreationTime', 'LastModifiedTime', 'AlertStatus', 'DatapointsToAlert', 'EvaluationPeriod', 'Actions', ], 'members' => [ 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], 'Actions' => [ 'shape' => 'MonitoringAlertActions', ], ], ], 'MonitoringAlertSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertSummary', ], 'max' => 100, 'min' => 1, ], 'MonitoringAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'MonitoringClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringConstraintsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 50, 'min' => 1, ], 'MonitoringCsvDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Header' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringDatapointsToAlert' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Csv' => [ 'shape' => 'MonitoringCsvDatasetFormat', ], 'Json' => [ 'shape' => 'MonitoringJsonDatasetFormat', ], 'Parquet' => [ 'shape' => 'MonitoringParquetDatasetFormat', ], ], ], 'MonitoringEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 50, ], 'MonitoringEvaluationPeriod' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringExecutionSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'ScheduledTime', 'Status', ], ], 'MonitoringExecutionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'ScheduledTime', 'CreationTime', 'LastModifiedTime', 'MonitoringExecutionStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'ScheduledTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringExecutionStatus' => [ 'shape' => 'ExecutionStatus', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringExecutionSummary', ], ], 'MonitoringGroundTruthS3Input' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], ], ], 'MonitoringInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'MonitoringInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringInput', ], 'max' => 1, 'min' => 1, ], 'MonitoringJobDefinition' => [ 'type' => 'structure', 'required' => [ 'MonitoringInputs', 'MonitoringOutputConfig', 'MonitoringResources', 'MonitoringAppSpecification', 'RoleArn', ], 'members' => [ 'BaselineConfig' => [ 'shape' => 'MonitoringBaselineConfig', ], 'MonitoringInputs' => [ 'shape' => 'MonitoringInputs', ], 'MonitoringOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'MonitoringResources' => [ 'shape' => 'MonitoringResources', ], 'MonitoringAppSpecification' => [ 'shape' => 'MonitoringAppSpecification', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'MonitoringJobDefinitionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringJobDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringJobDefinitionSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'MonitoringJobDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringJobDefinitionName', 'MonitoringJobDefinitionArn', 'CreationTime', 'EndpointName', ], 'members' => [ 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringJobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'MonitoringJobDefinitionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringJobDefinitionSummary', ], ], 'MonitoringJsonDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Line' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 86400, 'min' => 1, ], 'MonitoringNetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'MonitoringOutput' => [ 'type' => 'structure', 'required' => [ 'S3Output', ], 'members' => [ 'S3Output' => [ 'shape' => 'MonitoringS3Output', ], ], ], 'MonitoringOutputConfig' => [ 'type' => 'structure', 'required' => [ 'MonitoringOutputs', ], 'members' => [ 'MonitoringOutputs' => [ 'shape' => 'MonitoringOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringOutput', ], 'max' => 1, 'min' => 1, ], 'MonitoringParquetDatasetFormat' => [ 'type' => 'structure', 'members' => [], ], 'MonitoringProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'MonitoringResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'MonitoringClusterConfig', ], ], ], 'MonitoringS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', ], 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'MonitoringS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'MonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'MonitoringScheduleArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringScheduleConfig' => [ 'type' => 'structure', 'members' => [ 'ScheduleConfig' => [ 'shape' => 'ScheduleConfig', ], 'MonitoringJobDefinition' => [ 'shape' => 'MonitoringJobDefinition', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringSchedule', ], ], 'MonitoringScheduleName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringScheduleSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'MonitoringScheduleSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleArn', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringScheduleSummary', ], ], 'MonitoringStatisticsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MonitoringMaxRuntimeInSeconds', ], ], ], 'MonitoringTimeOffsetString' => [ 'type' => 'string', 'max' => 15, 'min' => 1, 'pattern' => '^.?P.*', ], 'MonitoringType' => [ 'type' => 'string', 'enum' => [ 'DataQuality', 'ModelQuality', 'ModelBias', 'ModelExplainability', ], ], 'MountPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^\\/.*', ], 'MultiModelConfig' => [ 'type' => 'structure', 'members' => [ 'ModelCacheSetting' => [ 'shape' => 'ModelCacheSetting', ], ], ], 'NameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'NeoVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'NeoVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'NeoVpcSubnets', ], ], ], 'NeoVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'NeoVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'NestedFilters' => [ 'type' => 'structure', 'required' => [ 'NestedPropertyName', 'Filters', ], 'members' => [ 'NestedPropertyName' => [ 'shape' => 'ResourcePropertyName', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'NestedFiltersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NestedFilters', ], 'max' => 20, 'min' => 1, ], 'NetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'NetworkInterfaceId' => [ 'type' => 'string', ], 'NextToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'NonEmptyString256' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^(?!\\s*$).+', ], 'NonEmptyString64' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^(?!\\s*$).+', ], 'NotebookInstanceAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'NotebookInstanceAcceleratorTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceAcceleratorType', ], ], 'NotebookInstanceArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'NotebookInstanceLifecycleConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleHook', ], 'max' => 1, ], 'NotebookInstanceLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'NotebookInstanceLifecycleConfigSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', 'NotebookInstanceLifecycleConfigArn', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummary', ], ], 'NotebookInstanceLifecycleHook' => [ 'type' => 'structure', 'members' => [ 'Content' => [ 'shape' => 'NotebookInstanceLifecycleConfigContent', ], ], ], 'NotebookInstanceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'NotebookInstanceSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InService', 'Stopping', 'Stopped', 'Failed', 'Deleting', 'Updating', ], ], 'NotebookInstanceSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'NotebookInstanceArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], ], ], 'NotebookInstanceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceSummary', ], ], 'NotebookInstanceUrl' => [ 'type' => 'string', ], 'NotebookInstanceVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 5, ], 'NotebookOutputOption' => [ 'type' => 'string', 'enum' => [ 'Allowed', 'Disabled', ], ], 'NotificationConfiguration' => [ 'type' => 'structure', 'members' => [ 'NotificationTopicArn' => [ 'shape' => 'NotificationTopicArn', ], ], ], 'NotificationTopicArn' => [ 'type' => 'string', 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*', ], 'NumberOfAcceleratorDevices' => [ 'type' => 'float', 'min' => 1, ], 'NumberOfCpuCores' => [ 'type' => 'float', 'min' => 0.25, ], 'NumberOfHumanWorkersPerDataObject' => [ 'type' => 'integer', 'max' => 9, 'min' => 1, ], 'NumberOfSteps' => [ 'type' => 'integer', 'min' => 1, ], 'ObjectiveStatus' => [ 'type' => 'string', 'enum' => [ 'Succeeded', 'Pending', 'Failed', ], ], 'ObjectiveStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'ObjectiveStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Succeeded' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Pending' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Failed' => [ 'shape' => 'ObjectiveStatusCounter', ], ], ], 'OfflineStoreConfig' => [ 'type' => 'structure', 'required' => [ 'S3StorageConfig', ], 'members' => [ 'S3StorageConfig' => [ 'shape' => 'S3StorageConfig', ], 'DisableGlueTableCreation' => [ 'shape' => 'Boolean', ], 'DataCatalogConfig' => [ 'shape' => 'DataCatalogConfig', ], 'TableFormat' => [ 'shape' => 'TableFormat', ], ], ], 'OfflineStoreStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'OfflineStoreStatusValue', ], 'BlockedReason' => [ 'shape' => 'BlockedReason', ], ], ], 'OfflineStoreStatusValue' => [ 'type' => 'string', 'enum' => [ 'Active', 'Blocked', 'Disabled', ], ], 'OidcConfig' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'ClientSecret', 'Issuer', 'AuthorizationEndpoint', 'TokenEndpoint', 'UserInfoEndpoint', 'LogoutEndpoint', 'JwksUri', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'ClientSecret' => [ 'shape' => 'ClientSecret', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcConfigForResponse' => [ 'type' => 'structure', 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcEndpoint' => [ 'type' => 'string', 'max' => 500, 'pattern' => 'https://\\S+', ], 'OidcMemberDefinition' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'Groups', ], ], ], 'OnlineStoreConfig' => [ 'type' => 'structure', 'members' => [ 'SecurityConfig' => [ 'shape' => 'OnlineStoreSecurityConfig', ], 'EnableOnlineStore' => [ 'shape' => 'Boolean', ], 'TtlDuration' => [ 'shape' => 'TtlDuration', ], 'StorageType' => [ 'shape' => 'StorageType', ], ], ], 'OnlineStoreConfigUpdate' => [ 'type' => 'structure', 'members' => [ 'TtlDuration' => [ 'shape' => 'TtlDuration', ], ], ], 'OnlineStoreSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OnlineStoreTotalSizeBytes' => [ 'type' => 'long', ], 'Operator' => [ 'type' => 'string', 'enum' => [ 'Equals', 'NotEquals', 'GreaterThan', 'GreaterThanOrEqualTo', 'LessThan', 'LessThanOrEqualTo', 'Contains', 'Exists', 'NotExists', 'In', ], ], 'OptionalDouble' => [ 'type' => 'double', ], 'OptionalInteger' => [ 'type' => 'integer', ], 'OptionalVolumeSizeInGB' => [ 'type' => 'integer', 'min' => 0, ], 'OrderKey' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'OutputCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'NONE', ], ], 'OutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'TargetDevice' => [ 'shape' => 'TargetDevice', ], 'TargetPlatform' => [ 'shape' => 'TargetPlatform', ], 'CompilerOptions' => [ 'shape' => 'CompilerOptions', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'CompressionType' => [ 'shape' => 'OutputCompressionType', ], ], ], 'OutputParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String256', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'OutputParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputParameter', ], 'max' => 50, 'min' => 0, ], 'OwnershipSettings' => [ 'type' => 'structure', 'required' => [ 'OwnerUserProfileName', ], 'members' => [ 'OwnerUserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'OwnershipSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'OwnerUserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'PaginationToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'ParallelismConfiguration' => [ 'type' => 'structure', 'required' => [ 'MaxParallelExecutionSteps', ], 'members' => [ 'MaxParallelExecutionSteps' => [ 'shape' => 'MaxParallelExecutionSteps', ], ], ], 'Parameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'PipelineParameterName', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'ParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', ], 'max' => 200, 'min' => 0, ], 'ParameterName' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'ParameterRange' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRangeSpecification' => [ 'shape' => 'IntegerParameterRangeSpecification', ], 'ContinuousParameterRangeSpecification' => [ 'shape' => 'ContinuousParameterRangeSpecification', ], 'CategoricalParameterRangeSpecification' => [ 'shape' => 'CategoricalParameterRangeSpecification', ], ], ], 'ParameterRanges' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRanges' => [ 'shape' => 'IntegerParameterRanges', ], 'ContinuousParameterRanges' => [ 'shape' => 'ContinuousParameterRanges', ], 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameterRanges', ], 'AutoParameters' => [ 'shape' => 'AutoParameters', ], ], ], 'ParameterType' => [ 'type' => 'string', 'enum' => [ 'Integer', 'Continuous', 'Categorical', 'FreeText', ], ], 'ParameterValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterValue', ], 'max' => 30, 'min' => 1, ], 'Parent' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ParentHyperParameterTuningJob' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'ParentHyperParameterTuningJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParentHyperParameterTuningJob', ], 'max' => 5, 'min' => 1, ], 'Parents' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parent', ], ], 'PendingDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'ShadowProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], ], ], 'PendingProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'PendingProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingProductionVariantSummary', ], 'min' => 1, ], 'Percentage' => [ 'type' => 'integer', 'max' => 100, ], 'Phase' => [ 'type' => 'structure', 'members' => [ 'InitialNumberOfUsers' => [ 'shape' => 'InitialNumberOfUsers', ], 'SpawnRate' => [ 'shape' => 'SpawnRate', ], 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], ], ], 'Phases' => [ 'type' => 'list', 'member' => [ 'shape' => 'Phase', ], 'min' => 1, ], 'Pipeline' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PipelineArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*', ], 'PipelineDefinition' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'PipelineDefinitionS3Location' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'ObjectKey', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', ], 'ObjectKey' => [ 'shape' => 'Key', ], 'VersionId' => [ 'shape' => 'VersionId', ], ], ], 'PipelineDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecution' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], ], ], 'PipelineExecutionArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$', ], 'PipelineExecutionDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecutionFailureReason' => [ 'type' => 'string', 'max' => 1300, 'pattern' => '.*', ], 'PipelineExecutionName' => [ 'type' => 'string', 'max' => 82, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}', ], 'PipelineExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'PipelineExecutionStep' => [ 'type' => 'structure', 'members' => [ 'StepName' => [ 'shape' => 'StepName', ], 'StepDisplayName' => [ 'shape' => 'StepDisplayName', ], 'StepDescription' => [ 'shape' => 'StepDescription', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StepStatus' => [ 'shape' => 'StepStatus', ], 'CacheHitResult' => [ 'shape' => 'CacheHitResult', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Metadata' => [ 'shape' => 'PipelineExecutionStepMetadata', ], 'AttemptCount' => [ 'shape' => 'Integer', ], 'SelectiveExecutionResult' => [ 'shape' => 'SelectiveExecutionResult', ], ], ], 'PipelineExecutionStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionStep', ], 'max' => 100, 'min' => 0, ], 'PipelineExecutionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJobStepMetadata', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJobStepMetadata', ], 'TransformJob' => [ 'shape' => 'TransformJobStepMetadata', ], 'TuningJob' => [ 'shape' => 'TuningJobStepMetaData', ], 'Model' => [ 'shape' => 'ModelStepMetadata', ], 'RegisterModel' => [ 'shape' => 'RegisterModelStepMetadata', ], 'Condition' => [ 'shape' => 'ConditionStepMetadata', ], 'Callback' => [ 'shape' => 'CallbackStepMetadata', ], 'Lambda' => [ 'shape' => 'LambdaStepMetadata', ], 'EMR' => [ 'shape' => 'EMRStepMetadata', ], 'QualityCheck' => [ 'shape' => 'QualityCheckStepMetadata', ], 'ClarifyCheck' => [ 'shape' => 'ClarifyCheckStepMetadata', ], 'Fail' => [ 'shape' => 'FailStepMetadata', ], 'AutoMLJob' => [ 'shape' => 'AutoMLJobStepMetadata', ], ], ], 'PipelineExecutionSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionFailureReason' => [ 'shape' => 'String3072', ], ], ], 'PipelineExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionSummary', ], 'max' => 100, 'min' => 0, ], 'PipelineExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'PipelineName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}', ], 'PipelineNameOrArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})', ], 'PipelineParameterName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[A-Za-z0-9\\-_]*$', ], 'PipelineStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'PipelineSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastExecutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'PipelineSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineSummary', ], 'max' => 100, 'min' => 0, ], 'PlatformIdentifier' => [ 'type' => 'string', 'max' => 15, 'pattern' => '^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2)$', ], 'PolicyString' => [ 'type' => 'string', 'max' => 20480, 'min' => 1, 'pattern' => '.*', ], 'PredefinedMetricSpecification' => [ 'type' => 'structure', 'members' => [ 'PredefinedMetricType' => [ 'shape' => 'String', ], ], ], 'PresignedDomainUrl' => [ 'type' => 'string', ], 'ProbabilityThresholdAttribute' => [ 'type' => 'double', ], 'ProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'ProcessingClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingEnvironmentKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'ProcessingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 100, ], 'ProcessingEnvironmentValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\S\\s]*', ], 'ProcessingFeatureStoreOutput' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'ProcessingInput' => [ 'type' => 'structure', 'required' => [ 'InputName', ], 'members' => [ 'InputName' => [ 'shape' => 'String', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], 'S3Input' => [ 'shape' => 'ProcessingS3Input', ], 'DatasetDefinition' => [ 'shape' => 'DatasetDefinition', ], ], ], 'ProcessingInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingInput', ], 'max' => 10, 'min' => 0, ], 'ProcessingInstanceCount' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ProcessingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'ProcessingJob' => [ 'type' => 'structure', 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ProcessingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/.*', ], 'ProcessingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ProcessingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ProcessingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'ProcessingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingJobSummary', ], ], 'ProcessingJobSummary' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingJobArn', 'CreationTime', 'ProcessingJobStatus', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], ], ], 'ProcessingLocalPath' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ProcessingMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 777600, 'min' => 1, ], 'ProcessingOutput' => [ 'type' => 'structure', 'required' => [ 'OutputName', ], 'members' => [ 'OutputName' => [ 'shape' => 'String', ], 'S3Output' => [ 'shape' => 'ProcessingS3Output', ], 'FeatureStoreOutput' => [ 'shape' => 'ProcessingFeatureStoreOutput', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], ], ], 'ProcessingOutputConfig' => [ 'type' => 'structure', 'required' => [ 'Outputs', ], 'members' => [ 'Outputs' => [ 'shape' => 'ProcessingOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingOutput', ], 'max' => 10, 'min' => 0, ], 'ProcessingResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'ProcessingClusterConfig', ], ], ], 'ProcessingS3CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ProcessingS3DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'ProcessingS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', ], ], 'ProcessingS3Input' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3DataType' => [ 'shape' => 'ProcessingS3DataType', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'S3CompressionType' => [ 'shape' => 'ProcessingS3CompressionType', ], ], ], 'ProcessingS3InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'ProcessingS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', 'S3UploadMode', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'ProcessingS3UploadMode' => [ 'type' => 'string', 'enum' => [ 'Continuous', 'EndOfJob', ], ], 'ProcessingStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'ProcessingMaxRuntimeInSeconds', ], ], ], 'ProcessingVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 1, ], 'Processor' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'ProductId' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ProductListings' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ProductionVariant' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'InitialInstanceCount' => [ 'shape' => 'InitialTaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialVariantWeight' => [ 'shape' => 'VariantWeight', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'CoreDumpConfig' => [ 'shape' => 'ProductionVariantCoreDumpConfig', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'ProductionVariantVolumeSizeInGB', ], 'ModelDataDownloadTimeoutInSeconds' => [ 'shape' => 'ProductionVariantModelDataDownloadTimeoutInSeconds', ], 'ContainerStartupHealthCheckTimeoutInSeconds' => [ 'shape' => 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds', ], 'EnableSSMAccess' => [ 'shape' => 'ProductionVariantSSMAccess', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'ProductionVariantAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantCoreDumpConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProductionVariantInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.12xlarge', 'ml.m5d.24xlarge', 'ml.c4.large', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.large', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.12xlarge', 'ml.r5.24xlarge', 'ml.r5d.large', 'ml.r5d.xlarge', 'ml.r5d.2xlarge', 'ml.r5d.4xlarge', 'ml.r5d.12xlarge', 'ml.r5d.24xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.dl1.24xlarge', 'ml.c6i.large', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.4xlarge', 'ml.c6i.8xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.12xlarge', 'ml.g5.16xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.p4d.24xlarge', 'ml.c7g.large', 'ml.c7g.xlarge', 'ml.c7g.2xlarge', 'ml.c7g.4xlarge', 'ml.c7g.8xlarge', 'ml.c7g.12xlarge', 'ml.c7g.16xlarge', 'ml.m6g.large', 'ml.m6g.xlarge', 'ml.m6g.2xlarge', 'ml.m6g.4xlarge', 'ml.m6g.8xlarge', 'ml.m6g.12xlarge', 'ml.m6g.16xlarge', 'ml.m6gd.large', 'ml.m6gd.xlarge', 'ml.m6gd.2xlarge', 'ml.m6gd.4xlarge', 'ml.m6gd.8xlarge', 'ml.m6gd.12xlarge', 'ml.m6gd.16xlarge', 'ml.c6g.large', 'ml.c6g.xlarge', 'ml.c6g.2xlarge', 'ml.c6g.4xlarge', 'ml.c6g.8xlarge', 'ml.c6g.12xlarge', 'ml.c6g.16xlarge', 'ml.c6gd.large', 'ml.c6gd.xlarge', 'ml.c6gd.2xlarge', 'ml.c6gd.4xlarge', 'ml.c6gd.8xlarge', 'ml.c6gd.12xlarge', 'ml.c6gd.16xlarge', 'ml.c6gn.large', 'ml.c6gn.xlarge', 'ml.c6gn.2xlarge', 'ml.c6gn.4xlarge', 'ml.c6gn.8xlarge', 'ml.c6gn.12xlarge', 'ml.c6gn.16xlarge', 'ml.r6g.large', 'ml.r6g.xlarge', 'ml.r6g.2xlarge', 'ml.r6g.4xlarge', 'ml.r6g.8xlarge', 'ml.r6g.12xlarge', 'ml.r6g.16xlarge', 'ml.r6gd.large', 'ml.r6gd.xlarge', 'ml.r6gd.2xlarge', 'ml.r6gd.4xlarge', 'ml.r6gd.8xlarge', 'ml.r6gd.12xlarge', 'ml.r6gd.16xlarge', 'ml.p4de.24xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.inf2.xlarge', 'ml.inf2.8xlarge', 'ml.inf2.24xlarge', 'ml.inf2.48xlarge', 'ml.p5.48xlarge', 'ml.m7i.large', 'ml.m7i.xlarge', 'ml.m7i.2xlarge', 'ml.m7i.4xlarge', 'ml.m7i.8xlarge', 'ml.m7i.12xlarge', 'ml.m7i.16xlarge', 'ml.m7i.24xlarge', 'ml.m7i.48xlarge', 'ml.c7i.large', 'ml.c7i.xlarge', 'ml.c7i.2xlarge', 'ml.c7i.4xlarge', 'ml.c7i.8xlarge', 'ml.c7i.12xlarge', 'ml.c7i.16xlarge', 'ml.c7i.24xlarge', 'ml.c7i.48xlarge', 'ml.r7i.large', 'ml.r7i.xlarge', 'ml.r7i.2xlarge', 'ml.r7i.4xlarge', 'ml.r7i.8xlarge', 'ml.r7i.12xlarge', 'ml.r7i.16xlarge', 'ml.r7i.24xlarge', 'ml.r7i.48xlarge', ], ], 'ProductionVariantList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariant', ], 'max' => 10, 'min' => 1, ], 'ProductionVariantManagedInstanceScaling' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'ManagedInstanceScalingStatus', ], 'MinInstanceCount' => [ 'shape' => 'ManagedInstanceScalingMinInstanceCount', ], 'MaxInstanceCount' => [ 'shape' => 'ManagedInstanceScalingMaxInstanceCount', ], ], ], 'ProductionVariantModelDataDownloadTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantRoutingConfig' => [ 'type' => 'structure', 'required' => [ 'RoutingStrategy', ], 'members' => [ 'RoutingStrategy' => [ 'shape' => 'RoutingStrategy', ], ], ], 'ProductionVariantSSMAccess' => [ 'type' => 'boolean', ], 'ProductionVariantServerlessConfig' => [ 'type' => 'structure', 'required' => [ 'MemorySizeInMB', 'MaxConcurrency', ], 'members' => [ 'MemorySizeInMB' => [ 'shape' => 'ServerlessMemorySizeInMB', ], 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'VariantStatus', ], 'StatusMessage' => [ 'shape' => 'VariantStatusMessage', ], 'StartTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProductionVariantStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantStatus', ], 'max' => 5, 'min' => 0, ], 'ProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'ProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantSummary', ], 'min' => 1, ], 'ProductionVariantVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 512, 'min' => 1, ], 'ProfilerConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'ProfilerRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'ProfilerRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProfilerRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'ProfilingIntervalInMilliseconds' => [ 'type' => 'long', ], 'ProfilingParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'ProfilingStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ProgrammingLang' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'Project' => [ 'type' => 'structure', 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Tags' => [ 'shape' => 'TagList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'ProjectArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:project/[\\S]{1,2048}$', ], 'ProjectEntityName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'ProjectId' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'ProjectSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ProjectSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ProjectStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'CreateInProgress', 'CreateCompleted', 'CreateFailed', 'DeleteInProgress', 'DeleteFailed', 'DeleteCompleted', 'UpdateInProgress', 'UpdateCompleted', 'UpdateFailed', ], ], 'ProjectSummary' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ProjectArn', 'ProjectId', 'CreationTime', 'ProjectStatus', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], ], ], 'ProjectSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProjectSummary', ], ], 'PropertyNameHint' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'pattern' => '.*', ], 'PropertyNameQuery' => [ 'type' => 'structure', 'required' => [ 'PropertyNameHint', ], 'members' => [ 'PropertyNameHint' => [ 'shape' => 'PropertyNameHint', ], ], ], 'PropertyNameSuggestion' => [ 'type' => 'structure', 'members' => [ 'PropertyName' => [ 'shape' => 'ResourcePropertyName', ], ], ], 'PropertyNameSuggestionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PropertyNameSuggestion', ], ], 'ProvisionedProductStatusMessage' => [ 'type' => 'string', 'pattern' => '.*', ], 'ProvisioningParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ProvisioningParameterKey', ], 'Value' => [ 'shape' => 'ProvisioningParameterValue', ], ], ], 'ProvisioningParameterKey' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '.*', ], 'ProvisioningParameterValue' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'ProvisioningParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningParameter', ], ], 'PublicWorkforceTaskPrice' => [ 'type' => 'structure', 'members' => [ 'AmountInUsd' => [ 'shape' => 'USD', ], ], ], 'PutModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ResourcePolicy', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'PutModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'QualityCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckStatistics' => [ 'shape' => 'String1024', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineStatistics' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'QueryFilters' => [ 'type' => 'structure', 'members' => [ 'Types' => [ 'shape' => 'QueryTypes', ], 'LineageTypes' => [ 'shape' => 'QueryLineageTypes', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedAfter' => [ 'shape' => 'Timestamp', ], 'Properties' => [ 'shape' => 'QueryProperties', ], ], ], 'QueryLineageMaxDepth' => [ 'type' => 'integer', 'max' => 10, ], 'QueryLineageMaxResults' => [ 'type' => 'integer', 'max' => 50, ], 'QueryLineageRequest' => [ 'type' => 'structure', 'members' => [ 'StartArns' => [ 'shape' => 'QueryLineageStartArns', ], 'Direction' => [ 'shape' => 'Direction', ], 'IncludeEdges' => [ 'shape' => 'Boolean', ], 'Filters' => [ 'shape' => 'QueryFilters', ], 'MaxDepth' => [ 'shape' => 'QueryLineageMaxDepth', ], 'MaxResults' => [ 'shape' => 'QueryLineageMaxResults', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageResponse' => [ 'type' => 'structure', 'members' => [ 'Vertices' => [ 'shape' => 'Vertices', ], 'Edges' => [ 'shape' => 'Edges', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageStartArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationEntityArn', ], 'max' => 1, 'min' => 0, ], 'QueryLineageTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageType', ], 'max' => 4, ], 'QueryProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'String256', ], 'value' => [ 'shape' => 'String256', ], 'max' => 5, ], 'QueryTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String40', ], 'max' => 5, ], 'RSessionAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], ], ], 'RStudioServerProAccessStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'RStudioServerProAppSettings' => [ 'type' => 'structure', 'members' => [ 'AccessStatus' => [ 'shape' => 'RStudioServerProAccessStatus', ], 'UserGroup' => [ 'shape' => 'RStudioServerProUserGroup', ], ], ], 'RStudioServerProDomainSettings' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'RStudioServerProDomainSettingsForUpdate' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], ], ], 'RStudioServerProUserGroup' => [ 'type' => 'string', 'enum' => [ 'R_STUDIO_ADMIN', 'R_STUDIO_USER', ], ], 'RandomSeed' => [ 'type' => 'integer', 'min' => 0, ], 'RealTimeInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'TaskCount', ], ], ], 'RealTimeInferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationId', 'InstanceType', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'RealTimeInferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeInferenceRecommendation', ], 'max' => 3, 'min' => 0, ], 'RealtimeInferenceInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantInstanceType', ], ], 'RecommendationFailureReason' => [ 'type' => 'string', ], 'RecommendationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/.*', ], 'RecommendationJobCompilationJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'RecommendationJobCompiledOutputConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputUri' => [ 'shape' => 'S3Uri', ], ], ], 'RecommendationJobContainerConfig' => [ 'type' => 'structure', 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'RecommendationJobFrameworkVersion', ], 'PayloadConfig' => [ 'shape' => 'RecommendationJobPayloadConfig', ], 'NearestModelName' => [ 'shape' => 'String', ], 'SupportedInstanceTypes' => [ 'shape' => 'RecommendationJobSupportedInstanceTypes', ], 'SupportedEndpointType' => [ 'shape' => 'RecommendationJobSupportedEndpointType', ], 'DataInputConfig' => [ 'shape' => 'RecommendationJobDataInputConfig', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'RecommendationJobSupportedResponseMIMETypes', ], ], ], 'RecommendationJobDataInputConfig' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'RecommendationJobDescription' => [ 'type' => 'string', 'max' => 128, ], 'RecommendationJobFrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.-]+', ], 'RecommendationJobInferenceBenchmark' => [ 'type' => 'structure', 'required' => [ 'ModelConfiguration', ], 'members' => [ 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointMetrics' => [ 'shape' => 'InferenceMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'FailureReason' => [ 'shape' => 'RecommendationFailureReason', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'RecommendationJobInputConfig' => [ 'type' => 'structure', 'members' => [ 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'JobDurationInSeconds' => [ 'shape' => 'JobDurationInSeconds', ], 'TrafficPattern' => [ 'shape' => 'TrafficPattern', ], 'ResourceLimit' => [ 'shape' => 'RecommendationJobResourceLimit', ], 'EndpointConfigurations' => [ 'shape' => 'EndpointInputConfigurations', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ContainerConfig' => [ 'shape' => 'RecommendationJobContainerConfig', ], 'Endpoints' => [ 'shape' => 'Endpoints', ], 'VpcConfig' => [ 'shape' => 'RecommendationJobVpcConfig', ], ], ], 'RecommendationJobName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'RecommendationJobOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CompiledOutputConfig' => [ 'shape' => 'RecommendationJobCompiledOutputConfig', ], ], ], 'RecommendationJobPayloadConfig' => [ 'type' => 'structure', 'members' => [ 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'SupportedContentTypes' => [ 'shape' => 'RecommendationJobSupportedContentTypes', ], ], ], 'RecommendationJobResourceLimit' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTests' => [ 'shape' => 'MaxNumberOfTests', ], 'MaxParallelOfTests' => [ 'shape' => 'MaxParallelOfTests', ], ], ], 'RecommendationJobStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', 'DELETING', 'DELETED', ], ], 'RecommendationJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatencyThresholds' => [ 'shape' => 'ModelLatencyThresholds', ], 'FlatInvocations' => [ 'shape' => 'FlatInvocations', ], ], ], 'RecommendationJobSupportedContentType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'RecommendationJobSupportedContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobSupportedContentType', ], ], 'RecommendationJobSupportedEndpointType' => [ 'type' => 'string', 'enum' => [ 'RealTime', 'Serverless', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RecommendationJobSupportedResponseMIMEType' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^[-\\w]+\\/.+$', ], 'RecommendationJobSupportedResponseMIMETypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobSupportedResponseMIMEType', ], ], 'RecommendationJobType' => [ 'type' => 'string', 'enum' => [ 'Default', 'Advanced', ], ], 'RecommendationJobVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'RecommendationJobVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'RecommendationJobVpcSubnets', ], ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'RecommendationJobVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'RecommendationMetrics' => [ 'type' => 'structure', 'required' => [ 'CostPerHour', 'CostPerInference', 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'CostPerHour' => [ 'shape' => 'Float', ], 'CostPerInference' => [ 'shape' => 'Float', ], 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], 'CpuUtilization' => [ 'shape' => 'UtilizationMetric', ], 'MemoryUtilization' => [ 'shape' => 'UtilizationMetric', ], 'ModelSetupTime' => [ 'shape' => 'ModelSetupTime', ], ], ], 'RecommendationStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'NOT_APPLICABLE', ], ], 'RecommendationStepType' => [ 'type' => 'string', 'enum' => [ 'BENCHMARK', ], ], 'RecordWrapper' => [ 'type' => 'string', 'enum' => [ 'None', 'RecordIO', ], ], 'RedshiftClusterId' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatabase' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'Database', 'DbUser', 'QueryString', 'ClusterRoleArn', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'ClusterId' => [ 'shape' => 'RedshiftClusterId', ], 'Database' => [ 'shape' => 'RedshiftDatabase', ], 'DbUser' => [ 'shape' => 'RedshiftUserName', ], 'QueryString' => [ 'shape' => 'RedshiftQueryString', ], 'ClusterRoleArn' => [ 'shape' => 'RoleArn', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'RedshiftResultFormat', ], 'OutputCompression' => [ 'shape' => 'RedshiftResultCompressionType', ], ], ], 'RedshiftQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'RedshiftResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'GZIP', 'BZIP2', 'ZSTD', 'SNAPPY', ], ], 'RedshiftResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'CSV', ], ], 'RedshiftUserName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'RegisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'RegisterModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ReleaseNotes' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'RemoteDebugConfig' => [ 'type' => 'structure', 'members' => [ 'EnableRemoteDebug' => [ 'shape' => 'EnableRemoteDebug', ], ], ], 'RemoteDebugConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'EnableRemoteDebug' => [ 'shape' => 'EnableRemoteDebug', ], ], ], 'RenderUiTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'Task', 'RoleArn', ], 'members' => [ 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Task' => [ 'shape' => 'RenderableTask', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'RenderUiTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'RenderedContent', 'Errors', ], 'members' => [ 'RenderedContent' => [ 'shape' => 'String', ], 'Errors' => [ 'shape' => 'RenderingErrorList', ], ], ], 'RenderableTask' => [ 'type' => 'structure', 'required' => [ 'Input', ], 'members' => [ 'Input' => [ 'shape' => 'TaskInput', ], ], ], 'RenderingError' => [ 'type' => 'structure', 'required' => [ 'Code', 'Message', ], 'members' => [ 'Code' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'RenderingErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RenderingError', ], ], 'RepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'RepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryCredentialsProviderArn', ], 'members' => [ 'RepositoryCredentialsProviderArn' => [ 'shape' => 'RepositoryCredentialsProviderArn', ], ], ], 'RepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*', ], 'RepositoryUrl' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$', ], 'ResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+', ], 'ResourceCatalog' => [ 'type' => 'structure', 'required' => [ 'ResourceCatalogArn', 'ResourceCatalogName', 'Description', 'CreationTime', ], 'members' => [ 'ResourceCatalogArn' => [ 'shape' => 'ResourceCatalogArn', ], 'ResourceCatalogName' => [ 'shape' => 'ResourceCatalogName', ], 'Description' => [ 'shape' => 'ResourceCatalogDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ResourceCatalogArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:sagemaker-catalog/.*', ], 'ResourceCatalogDescription' => [ 'type' => 'string', 'max' => 256, ], 'ResourceCatalogList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceCatalog', ], ], 'ResourceCatalogName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ResourceCatalogSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ResourceCatalogSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ResourceConfig' => [ 'type' => 'structure', 'required' => [ 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroups', ], ], ], 'ResourceConfigForUpdate' => [ 'type' => 'structure', 'required' => [ 'KeepAlivePeriodInSeconds', ], 'members' => [ 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], ], ], 'ResourceId' => [ 'type' => 'string', 'max' => 32, ], 'ResourceInUse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimits' => [ 'type' => 'structure', 'required' => [ 'MaxParallelTrainingJobs', ], 'members' => [ 'MaxNumberOfTrainingJobs' => [ 'shape' => 'MaxNumberOfTrainingJobs', ], 'MaxParallelTrainingJobs' => [ 'shape' => 'MaxParallelTrainingJobs', ], 'MaxRuntimeInSeconds' => [ 'shape' => 'HyperParameterTuningMaxRuntimeInSeconds', ], ], ], 'ResourceNotFound' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourcePolicyString' => [ 'type' => 'string', 'max' => 20480, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'ResourcePropertyName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 0, ], 'ResourceSpec' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageArn' => [ 'shape' => 'ImageArn', ], 'SageMakerImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'SageMakerImageVersionAlias' => [ 'shape' => 'ImageVersionAlias', ], 'InstanceType' => [ 'shape' => 'AppInstanceType', ], 'LifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'TrainingJob', 'Experiment', 'ExperimentTrial', 'ExperimentTrialComponent', 'Endpoint', 'Model', 'ModelPackage', 'ModelPackageGroup', 'Pipeline', 'PipelineExecution', 'FeatureGroup', 'FeatureMetadata', 'Image', 'ImageVersion', 'Project', 'HyperParameterTuningJob', 'ModelCard', ], ], 'ResponseMIMEType' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^[-\\w]+\\/.+$', ], 'ResponseMIMETypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResponseMIMEType', ], ], 'RetentionPolicy' => [ 'type' => 'structure', 'members' => [ 'HomeEfsFileSystem' => [ 'shape' => 'RetentionType', ], ], ], 'RetentionType' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Delete', ], ], 'RetryPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'RetryPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'RetryStrategy' => [ 'type' => 'structure', 'required' => [ 'MaximumRetryAttempts', ], 'members' => [ 'MaximumRetryAttempts' => [ 'shape' => 'MaximumRetryAttempts', ], ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'RollingUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'MaximumBatchSize', 'WaitIntervalInSeconds', ], 'members' => [ 'MaximumBatchSize' => [ 'shape' => 'CapacitySize', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], 'RollbackMaximumBatchSize' => [ 'shape' => 'CapacitySize', ], ], ], 'RootAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'RoutingStrategy' => [ 'type' => 'string', 'enum' => [ 'LEAST_OUTSTANDING_REQUESTS', 'RANDOM', ], ], 'RuleConfigurationName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'RuleEvaluationStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'NoIssuesFound', 'IssuesFound', 'Error', 'Stopping', 'Stopped', ], ], 'RuleParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 100, 'min' => 0, ], 'S3DataDistribution' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'S3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'S3DataDistributionType' => [ 'shape' => 'S3DataDistribution', ], 'AttributeNames' => [ 'shape' => 'AttributeNames', ], 'InstanceGroupNames' => [ 'shape' => 'InstanceGroupNames', ], ], ], 'S3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'S3ModelDataSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', 'CompressionType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3ModelUri', ], 'S3DataType' => [ 'shape' => 'S3ModelDataType', ], 'CompressionType' => [ 'shape' => 'ModelCompressionType', ], 'ModelAccessConfig' => [ 'shape' => 'ModelAccessConfig', ], ], ], 'S3ModelDataType' => [ 'type' => 'string', 'enum' => [ 'S3Prefix', 'S3Object', ], ], 'S3ModelUri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3OutputPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3StorageConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ResolvedOutputS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'S3Uri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'SageMakerImageVersionAlias' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(?!^[.-])^([a-zA-Z0-9-_.]+)$', ], 'SageMakerImageVersionAliases' => [ 'type' => 'list', 'member' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], 'SagemakerServicecatalogStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'SampleWeightAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_-]+$', ], 'SamplingPercentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ScalingPolicies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScalingPolicy', ], ], 'ScalingPolicy' => [ 'type' => 'structure', 'members' => [ 'TargetTracking' => [ 'shape' => 'TargetTrackingScalingPolicyConfiguration', ], ], 'union' => true, ], 'ScalingPolicyMetric' => [ 'type' => 'structure', 'members' => [ 'InvocationsPerInstance' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'ScalingPolicyObjective' => [ 'type' => 'structure', 'members' => [ 'MinInvocationsPerMinute' => [ 'shape' => 'Integer', ], 'MaxInvocationsPerMinute' => [ 'shape' => 'Integer', ], ], ], 'ScheduleConfig' => [ 'type' => 'structure', 'required' => [ 'ScheduleExpression', ], 'members' => [ 'ScheduleExpression' => [ 'shape' => 'ScheduleExpression', ], 'DataAnalysisStartTime' => [ 'shape' => 'String', ], 'DataAnalysisEndTime' => [ 'shape' => 'String', ], ], ], 'ScheduleExpression' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ScheduleStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Failed', 'Scheduled', 'Stopped', ], ], 'SearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'NestedFilters' => [ 'shape' => 'NestedFiltersList', ], 'SubExpressions' => [ 'shape' => 'SearchExpressionList', ], 'Operator' => [ 'shape' => 'BooleanOperator', ], ], ], 'SearchExpressionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchExpression', ], 'max' => 20, 'min' => 1, ], 'SearchRecord' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'Experiment' => [ 'shape' => 'Experiment', ], 'Trial' => [ 'shape' => 'Trial', ], 'TrialComponent' => [ 'shape' => 'TrialComponent', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'ModelPackage' => [ 'shape' => 'ModelPackage', ], 'ModelPackageGroup' => [ 'shape' => 'ModelPackageGroup', ], 'Pipeline' => [ 'shape' => 'Pipeline', ], 'PipelineExecution' => [ 'shape' => 'PipelineExecution', ], 'FeatureGroup' => [ 'shape' => 'FeatureGroup', ], 'FeatureMetadata' => [ 'shape' => 'FeatureMetadata', ], 'Project' => [ 'shape' => 'Project', ], 'HyperParameterTuningJob' => [ 'shape' => 'HyperParameterTuningJobSearchEntity', ], 'ModelCard' => [ 'shape' => 'ModelCard', ], 'Model' => [ 'shape' => 'ModelDashboardModel', ], ], ], 'SearchRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SearchExpression' => [ 'shape' => 'SearchExpression', ], 'SortBy' => [ 'shape' => 'ResourcePropertyName', ], 'SortOrder' => [ 'shape' => 'SearchSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CrossAccountFilterOption' => [ 'shape' => 'CrossAccountFilterOption', ], 'VisibilityConditions' => [ 'shape' => 'VisibilityConditionsList', ], ], ], 'SearchResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'SearchResultsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SearchResultsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchRecord', ], ], 'SearchSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'LaunchingMLInstances', 'PreparingTrainingStack', 'Downloading', 'DownloadingTrainingImage', 'Training', 'Uploading', 'Stopping', 'Stopped', 'MaxRuntimeExceeded', 'Completed', 'Failed', 'Interrupted', 'MaxWaitTimeExceeded', 'Updating', 'Restarting', 'Pending', ], ], 'SecondaryStatusTransition' => [ 'type' => 'structure', 'required' => [ 'Status', 'StartTime', ], 'members' => [ 'Status' => [ 'shape' => 'SecondaryStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'SecondaryStatusTransitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecondaryStatusTransition', ], ], 'SecretArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:.*', ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, ], 'Seed' => [ 'type' => 'long', ], 'SelectedStep' => [ 'type' => 'structure', 'required' => [ 'StepName', ], 'members' => [ 'StepName' => [ 'shape' => 'String256', ], ], ], 'SelectedStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SelectedStep', ], 'max' => 50, 'min' => 1, ], 'SelectiveExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'SelectedSteps', ], 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'SelectedSteps' => [ 'shape' => 'SelectedStepList', ], ], ], 'SelectiveExecutionResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'FailureReason' => [ 'shape' => 'String256', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepFailureResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'ServerlessMaxConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServerlessMemorySizeInMB' => [ 'type' => 'integer', 'max' => 6144, 'min' => 1024, ], 'ServerlessProvisionedConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServiceCatalogEntityId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_\\-]*', ], 'ServiceCatalogProvisionedProductDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisionedProductStatusMessage' => [ 'shape' => 'ProvisionedProductStatusMessage', ], ], ], 'ServiceCatalogProvisioningDetails' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'ProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'PathId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'SessionExpirationDurationInSeconds' => [ 'type' => 'integer', 'max' => 43200, 'min' => 1800, ], 'ShadowModeConfig' => [ 'type' => 'structure', 'required' => [ 'SourceModelVariantName', 'ShadowModelVariants', ], 'members' => [ 'SourceModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'ShadowModelVariants' => [ 'shape' => 'ShadowModelVariantConfigList', ], ], ], 'ShadowModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ShadowModelVariantName', 'SamplingPercentage', ], 'members' => [ 'ShadowModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'SamplingPercentage' => [ 'shape' => 'Percentage', ], ], ], 'ShadowModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShadowModelVariantConfig', ], 'max' => 1, 'min' => 1, ], 'SharingSettings' => [ 'type' => 'structure', 'members' => [ 'NotebookOutputOption' => [ 'shape' => 'NotebookOutputOption', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'SharingType' => [ 'type' => 'string', 'enum' => [ 'Private', 'Shared', ], ], 'ShuffleConfig' => [ 'type' => 'structure', 'required' => [ 'Seed', ], 'members' => [ 'Seed' => [ 'shape' => 'Seed', ], ], ], 'SingleSignOnApplicationArn' => [ 'type' => 'string', 'pattern' => '^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application\\/[a-zA-Z0-9-_.]+\\/apl-[a-zA-Z0-9]+$', ], 'SingleSignOnUserIdentifier' => [ 'type' => 'string', 'pattern' => 'UserName', ], 'SkipModelValidation' => [ 'type' => 'string', 'enum' => [ 'All', 'None', ], ], 'SnsTopicArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]+', ], 'SortActionsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortArtifactsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'SortAssociationsBy' => [ 'type' => 'string', 'enum' => [ 'SourceArn', 'DestinationArn', 'SourceType', 'DestinationType', 'CreationTime', ], ], 'SortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortContextsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortInferenceExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortLineageGroupsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SortPipelineExecutionsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'PipelineExecutionArn', ], ], 'SortPipelinesBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialComponentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SourceAlgorithm' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'ModelDataUrl' => [ 'shape' => 'Url', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'SourceAlgorithmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceAlgorithm', ], 'max' => 1, 'min' => 1, ], 'SourceAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'SourceAlgorithms', ], 'members' => [ 'SourceAlgorithms' => [ 'shape' => 'SourceAlgorithmList', ], ], ], 'SourceIpConfig' => [ 'type' => 'structure', 'required' => [ 'Cidrs', ], 'members' => [ 'Cidrs' => [ 'shape' => 'Cidrs', ], ], ], 'SourceType' => [ 'type' => 'string', 'max' => 128, ], 'SourceUri' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*', ], 'SpaceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/.*', ], 'SpaceCodeEditorAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'SpaceDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'SpaceSettingsSummary' => [ 'shape' => 'SpaceSettingsSummary', ], 'SpaceSharingSettingsSummary' => [ 'shape' => 'SpaceSharingSettingsSummary', ], 'OwnershipSettingsSummary' => [ 'shape' => 'OwnershipSettingsSummary', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'SpaceEbsVolumeSizeInGb' => [ 'type' => 'integer', 'max' => 16384, 'min' => 5, ], 'SpaceJupyterLabAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'SpaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SpaceDetails', ], ], 'SpaceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'SpaceSettings' => [ 'type' => 'structure', 'members' => [ 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'CodeEditorAppSettings' => [ 'shape' => 'SpaceCodeEditorAppSettings', ], 'JupyterLabAppSettings' => [ 'shape' => 'SpaceJupyterLabAppSettings', ], 'AppType' => [ 'shape' => 'AppType', ], 'SpaceStorageSettings' => [ 'shape' => 'SpaceStorageSettings', ], 'CustomFileSystems' => [ 'shape' => 'CustomFileSystems', ], ], ], 'SpaceSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'AppType' => [ 'shape' => 'AppType', ], 'SpaceStorageSettings' => [ 'shape' => 'SpaceStorageSettings', ], ], ], 'SpaceSharingSettings' => [ 'type' => 'structure', 'required' => [ 'SharingType', ], 'members' => [ 'SharingType' => [ 'shape' => 'SharingType', ], ], ], 'SpaceSharingSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'SharingType' => [ 'shape' => 'SharingType', ], ], ], 'SpaceSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'SpaceStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'SpaceStorageSettings' => [ 'type' => 'structure', 'members' => [ 'EbsStorageSettings' => [ 'shape' => 'EbsStorageSettings', ], ], ], 'SpawnRate' => [ 'type' => 'integer', 'min' => 0, ], 'SplitType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', 'RecordIO', 'TFRecord', ], ], 'StageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'READYTODEPLOY', 'STARTING', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'Stairs' => [ 'type' => 'structure', 'members' => [ 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], 'NumberOfSteps' => [ 'shape' => 'NumberOfSteps', ], 'UsersPerStep' => [ 'shape' => 'UsersPerStep', ], ], ], 'StartEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StartInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'StartInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StartMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StartNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StartPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'StartPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'Statistic' => [ 'type' => 'string', 'enum' => [ 'Average', 'Minimum', 'Maximum', 'SampleCount', 'Sum', ], ], 'StatusDetails' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'StatusMessage' => [ 'type' => 'string', ], 'StepDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'StepDisplayName' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'StepName' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[A-Za-z0-9\\-_]*$', ], 'StepStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'StopAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'StopCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'StopInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'ModelVariantActions', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'ModelVariantActions' => [ 'shape' => 'ModelVariantActionMap', ], 'DesiredModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DesiredState' => [ 'shape' => 'InferenceExperimentStopDesiredState', ], 'Reason' => [ 'shape' => 'InferenceExperimentStatusReason', ], ], ], 'StopInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StopInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'StopLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'StopMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StopNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StopPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'StopPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'StopProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'StopTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'StopTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'StoppingCondition' => [ 'type' => 'structure', 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MaxRuntimeInSeconds', ], 'MaxWaitTimeInSeconds' => [ 'shape' => 'MaxWaitTimeInSeconds', ], 'MaxPendingTimeInSeconds' => [ 'shape' => 'MaxPendingTimeInSeconds', ], ], ], 'StorageType' => [ 'type' => 'string', 'enum' => [ 'Standard', 'InMemory', ], ], 'String' => [ 'type' => 'string', ], 'String1024' => [ 'type' => 'string', 'max' => 1024, ], 'String128' => [ 'type' => 'string', 'max' => 128, ], 'String200' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '.+', ], 'String256' => [ 'type' => 'string', 'max' => 256, ], 'String3072' => [ 'type' => 'string', 'max' => 3072, ], 'String40' => [ 'type' => 'string', 'max' => 40, ], 'String64' => [ 'type' => 'string', 'max' => 64, ], 'String8192' => [ 'type' => 'string', 'max' => 8192, ], 'StringParameterValue' => [ 'type' => 'string', 'max' => 2500, 'pattern' => '.*', ], 'StudioLifecycleConfigAppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', 'VSCode', 'Savitur', 'CodeEditor', 'JupyterLab', ], ], 'StudioLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*', ], 'StudioLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'StudioLifecycleConfigDetails' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'StudioLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'StudioLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'StudioLifecycleConfigsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigDetails', ], ], 'StudioWebPortal' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'Subnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 16, 'min' => 1, ], 'SubscribedWorkteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MarketplaceTitle' => [ 'shape' => 'String200', ], 'SellerName' => [ 'shape' => 'String', ], 'MarketplaceDescription' => [ 'shape' => 'String200', ], 'ListingId' => [ 'shape' => 'String', ], ], ], 'SubscribedWorkteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubscribedWorkteam', ], ], 'Success' => [ 'type' => 'boolean', ], 'SuggestionQuery' => [ 'type' => 'structure', 'members' => [ 'PropertyNameQuery' => [ 'shape' => 'PropertyNameQuery', ], ], ], 'TableFormat' => [ 'type' => 'string', 'enum' => [ 'Default', 'Glue', 'Iceberg', ], ], 'TableName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'TabularJobConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', ], 'members' => [ 'CandidateGenerationConfig' => [ 'shape' => 'CandidateGenerationConfig', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'TabularResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'ProblemType' => [ 'shape' => 'ProblemType', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TargetAttributeName' => [ 'type' => 'string', 'min' => 1, ], 'TargetDevice' => [ 'type' => 'string', 'enum' => [ 'lambda', 'ml_m4', 'ml_m5', 'ml_m6g', 'ml_c4', 'ml_c5', 'ml_c6g', 'ml_p2', 'ml_p3', 'ml_g4dn', 'ml_inf1', 'ml_inf2', 'ml_trn1', 'ml_eia2', 'jetson_tx1', 'jetson_tx2', 'jetson_nano', 'jetson_xavier', 'rasp3b', 'rasp4b', 'imx8qm', 'deeplens', 'rk3399', 'rk3288', 'aisage', 'sbe_c', 'qcs605', 'qcs603', 'sitara_am57x', 'amba_cv2', 'amba_cv22', 'amba_cv25', 'x86_win32', 'x86_win64', 'coreml', 'jacinto_tda4vm', 'imx8mplus', ], ], 'TargetLabelColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TargetObjectiveMetricValue' => [ 'type' => 'float', ], 'TargetPlatform' => [ 'type' => 'structure', 'required' => [ 'Os', 'Arch', ], 'members' => [ 'Os' => [ 'shape' => 'TargetPlatformOs', ], 'Arch' => [ 'shape' => 'TargetPlatformArch', ], 'Accelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], ], ], 'TargetPlatformAccelerator' => [ 'type' => 'string', 'enum' => [ 'INTEL_GRAPHICS', 'MALI', 'NVIDIA', 'NNA', ], ], 'TargetPlatformArch' => [ 'type' => 'string', 'enum' => [ 'X86_64', 'X86', 'ARM64', 'ARM_EABI', 'ARM_EABIHF', ], ], 'TargetPlatformOs' => [ 'type' => 'string', 'enum' => [ 'ANDROID', 'LINUX', ], ], 'TargetTrackingScalingPolicyConfiguration' => [ 'type' => 'structure', 'members' => [ 'MetricSpecification' => [ 'shape' => 'MetricSpecification', ], 'TargetValue' => [ 'shape' => 'Double', ], ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'min' => 60, ], 'TaskCount' => [ 'type' => 'integer', 'min' => 0, ], 'TaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'TaskInput' => [ 'type' => 'string', 'max' => 128000, 'min' => 2, 'pattern' => '[\\S\\s]+', ], 'TaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'TaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskKeyword', ], 'max' => 5, 'min' => 1, ], 'TaskTimeLimitInSeconds' => [ 'type' => 'integer', 'min' => 30, ], 'TaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'TemplateContent' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'TemplateContentSha256' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, ], 'TemplateUrl' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TensorBoardAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'TensorBoardOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'TenthFractionsOfACent' => [ 'type' => 'integer', 'max' => 9, 'min' => 0, ], 'TerminationWaitInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'TextClassificationJobConfig' => [ 'type' => 'structure', 'required' => [ 'ContentColumn', 'TargetLabelColumn', ], 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ContentColumn' => [ 'shape' => 'ContentColumn', ], 'TargetLabelColumn' => [ 'shape' => 'TargetLabelColumn', ], ], ], 'TextGenerationHyperParameterKey' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^[a-zA-Z0-9._-]+$', ], 'TextGenerationHyperParameterValue' => [ 'type' => 'string', 'max' => 16, 'pattern' => '^[a-zA-Z0-9._-]+$', ], 'TextGenerationHyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'TextGenerationHyperParameterKey', ], 'value' => [ 'shape' => 'TextGenerationHyperParameterValue', ], 'max' => 30, 'min' => 0, ], 'TextGenerationJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'BaseModelName' => [ 'shape' => 'BaseModelName', ], 'TextGenerationHyperParameters' => [ 'shape' => 'TextGenerationHyperParameters', ], 'ModelAccessConfig' => [ 'shape' => 'ModelAccessConfig', ], ], ], 'TextGenerationResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'BaseModelName' => [ 'shape' => 'BaseModelName', ], ], ], 'ThingName' => [ 'type' => 'string', 'max' => 128, 'pattern' => '[a-zA-Z0-9:_-]+', ], 'TimeSeriesConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', 'TimestampAttributeName', 'ItemIdentifierAttributeName', ], 'members' => [ 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'TimestampAttributeName' => [ 'shape' => 'TimestampAttributeName', ], 'ItemIdentifierAttributeName' => [ 'shape' => 'ItemIdentifierAttributeName', ], 'GroupingAttributeNames' => [ 'shape' => 'GroupingAttributeNames', ], ], ], 'TimeSeriesForecastingJobConfig' => [ 'type' => 'structure', 'required' => [ 'ForecastFrequency', 'ForecastHorizon', 'TimeSeriesConfig', ], 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ForecastFrequency' => [ 'shape' => 'ForecastFrequency', ], 'ForecastHorizon' => [ 'shape' => 'ForecastHorizon', ], 'ForecastQuantiles' => [ 'shape' => 'ForecastQuantiles', ], 'Transformations' => [ 'shape' => 'TimeSeriesTransformations', ], 'TimeSeriesConfig' => [ 'shape' => 'TimeSeriesConfig', ], 'HolidayConfig' => [ 'shape' => 'HolidayConfig', ], ], ], 'TimeSeriesForecastingSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'AmazonForecastRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'TimeSeriesTransformations' => [ 'type' => 'structure', 'members' => [ 'Filling' => [ 'shape' => 'FillingTransformations', ], 'Aggregation' => [ 'shape' => 'AggregationTransformations', ], ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TimestampAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TrafficDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TrafficPattern' => [ 'type' => 'structure', 'members' => [ 'TrafficType' => [ 'shape' => 'TrafficType', ], 'Phases' => [ 'shape' => 'Phases', ], 'Stairs' => [ 'shape' => 'Stairs', ], ], ], 'TrafficRoutingConfig' => [ 'type' => 'structure', 'required' => [ 'Type', 'WaitIntervalInSeconds', ], 'members' => [ 'Type' => [ 'shape' => 'TrafficRoutingConfigType', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'CanarySize' => [ 'shape' => 'CapacitySize', ], 'LinearStepSize' => [ 'shape' => 'CapacitySize', ], ], ], 'TrafficRoutingConfigType' => [ 'type' => 'string', 'enum' => [ 'ALL_AT_ONCE', 'CANARY', 'LINEAR', ], ], 'TrafficType' => [ 'type' => 'string', 'enum' => [ 'PHASES', 'STAIRS', ], ], 'TrainingContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerArgument', ], 'max' => 100, 'min' => 1, ], 'TrainingContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerEntrypointString', ], 'max' => 100, 'min' => 1, ], 'TrainingContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'TrainingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrainingEnvironmentKey', ], 'value' => [ 'shape' => 'TrainingEnvironmentValue', ], 'max' => 100, ], 'TrainingEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'TrainingImageConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryAccessMode', ], 'members' => [ 'TrainingRepositoryAccessMode' => [ 'shape' => 'TrainingRepositoryAccessMode', ], 'TrainingRepositoryAuthConfig' => [ 'shape' => 'TrainingRepositoryAuthConfig', ], ], ], 'TrainingInputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', 'FastFile', ], ], 'TrainingInstanceCount' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.p5.48xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5n.xlarge', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.18xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.m6i.large', 'ml.m6i.xlarge', 'ml.m6i.2xlarge', 'ml.m6i.4xlarge', 'ml.m6i.8xlarge', 'ml.m6i.12xlarge', 'ml.m6i.16xlarge', 'ml.m6i.24xlarge', 'ml.m6i.32xlarge', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.8xlarge', 'ml.c6i.4xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', ], ], 'TrainingInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInstanceType', ], ], 'TrainingJob' => [ 'type' => 'structure', 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TrainingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/.*', ], 'TrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', 'InputDataConfig', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], ], ], 'TrainingJobEarlyStoppingType' => [ 'type' => 'string', 'enum' => [ 'Off', 'Auto', ], ], 'TrainingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TrainingJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'TrainingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrainingJobStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingJobStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Completed' => [ 'shape' => 'TrainingJobStatusCounter', ], 'InProgress' => [ 'shape' => 'TrainingJobStatusCounter', ], 'RetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'NonRetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'Stopped' => [ 'shape' => 'TrainingJobStatusCounter', ], ], ], 'TrainingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'TrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingJobSummary', ], ], 'TrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], ], ], 'TrainingRepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'TrainingRepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryCredentialsProviderArn', ], 'members' => [ 'TrainingRepositoryCredentialsProviderArn' => [ 'shape' => 'TrainingRepositoryCredentialsProviderArn', ], ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:[\\p{Alnum}\\-]+:lambda:[\\p{Alnum}\\-]+:[0-9]{12}:function:.*', ], 'TrainingSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingImage', 'SupportedTrainingInstanceTypes', 'TrainingChannels', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'ContainerImage', ], 'TrainingImageDigest' => [ 'shape' => 'ImageDigest', ], 'SupportedHyperParameters' => [ 'shape' => 'HyperParameterSpecifications', ], 'SupportedTrainingInstanceTypes' => [ 'shape' => 'TrainingInstanceTypes', ], 'SupportsDistributedTraining' => [ 'shape' => 'Boolean', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'TrainingChannels' => [ 'shape' => 'ChannelSpecifications', ], 'SupportedTuningJobObjectiveMetrics' => [ 'shape' => 'HyperParameterTuningJobObjectives', ], 'AdditionalS3DataSource' => [ 'shape' => 'AdditionalS3DataSource', ], ], ], 'TrainingTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TransformDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'TransformS3DataSource', ], ], ], 'TransformEnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]{0,1023}', ], 'TransformEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformEnvironmentKey', ], 'value' => [ 'shape' => 'TransformEnvironmentValue', ], 'max' => 16, ], 'TransformEnvironmentValue' => [ 'type' => 'string', 'max' => 10240, 'pattern' => '[\\S\\s]*', ], 'TransformInput' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'TransformDataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'SplitType' => [ 'shape' => 'SplitType', ], ], ], 'TransformInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'TransformInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'TransformInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformInstanceType', ], 'min' => 1, ], 'TransformJob' => [ 'type' => 'structure', 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TransformJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*', ], 'TransformJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], ], ], 'TransformJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TransformJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TransformJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TransformJobArn', ], ], ], 'TransformJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformJobSummary', ], ], 'TransformJobSummary' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'CreationTime', 'TransformJobStatus', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'TransformOutput' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'Accept' => [ 'shape' => 'Accept', ], 'AssembleWith' => [ 'shape' => 'AssemblyType', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformResources' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TransformInstanceType', ], 'InstanceCount' => [ 'shape' => 'TransformInstanceCount', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'TransformationAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Trial' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSimpleSummaries', ], ], ], 'TrialArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/.*', ], 'TrialComponent' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'SourceDetail' => [ 'shape' => 'TrialComponentSourceDetail', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'Parents' => [ 'shape' => 'Parents', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'TrialComponentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/.*', ], 'TrialComponentArtifact' => [ 'type' => 'structure', 'required' => [ 'Value', ], 'members' => [ 'MediaType' => [ 'shape' => 'MediaType', ], 'Value' => [ 'shape' => 'TrialComponentArtifactValue', ], ], ], 'TrialComponentArtifactValue' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'TrialComponentArtifacts' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey128', ], 'value' => [ 'shape' => 'TrialComponentArtifact', ], 'max' => 60, ], 'TrialComponentKey128' => [ 'type' => 'string', 'max' => 128, 'pattern' => '.*', ], 'TrialComponentKey256' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrialComponentKey320' => [ 'type' => 'string', 'max' => 320, 'pattern' => '.*', ], 'TrialComponentMetricSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentMetricSummary', ], ], 'TrialComponentMetricSummary' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TimeStamp' => [ 'shape' => 'Timestamp', ], 'Max' => [ 'shape' => 'OptionalDouble', ], 'Min' => [ 'shape' => 'OptionalDouble', ], 'Last' => [ 'shape' => 'OptionalDouble', ], 'Count' => [ 'shape' => 'OptionalInteger', ], 'Avg' => [ 'shape' => 'OptionalDouble', ], 'StdDev' => [ 'shape' => 'OptionalDouble', ], ], ], 'TrialComponentParameterValue' => [ 'type' => 'structure', 'members' => [ 'StringValue' => [ 'shape' => 'StringParameterValue', ], 'NumberValue' => [ 'shape' => 'DoubleParameterValue', ], ], ], 'TrialComponentParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey320', ], 'value' => [ 'shape' => 'TrialComponentParameterValue', ], 'max' => 300, ], 'TrialComponentPrimaryStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrialComponentSimpleSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSimpleSummary', ], ], 'TrialComponentSimpleSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialComponentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialComponentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialComponentSourceDetail' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJob', ], 'TransformJob' => [ 'shape' => 'TransformJob', ], ], ], 'TrialComponentSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSource', ], ], 'TrialComponentStatus' => [ 'type' => 'structure', 'members' => [ 'PrimaryStatus' => [ 'shape' => 'TrialComponentPrimaryStatus', ], 'Message' => [ 'shape' => 'TrialComponentStatusMessage', ], ], ], 'TrialComponentStatusMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'TrialComponentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSummary', ], ], 'TrialComponentSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialSummary', ], ], 'TrialSummary' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialSource' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'TtlDuration' => [ 'type' => 'structure', 'members' => [ 'Unit' => [ 'shape' => 'TtlDurationUnit', ], 'Value' => [ 'shape' => 'TtlDurationValue', ], ], ], 'TtlDurationUnit' => [ 'type' => 'string', 'enum' => [ 'Seconds', 'Minutes', 'Hours', 'Days', 'Weeks', ], ], 'TtlDurationValue' => [ 'type' => 'integer', 'min' => 1, ], 'TuningJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'TargetObjectiveMetricValue' => [ 'shape' => 'TargetObjectiveMetricValue', ], 'BestObjectiveNotImproving' => [ 'shape' => 'BestObjectiveNotImproving', ], 'ConvergenceDetected' => [ 'shape' => 'ConvergenceDetected', ], ], ], 'TuningJobStepMetaData' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'USD' => [ 'type' => 'structure', 'members' => [ 'Dollars' => [ 'shape' => 'Dollars', ], 'Cents' => [ 'shape' => 'Cents', ], 'TenthFractionsOfACent' => [ 'shape' => 'TenthFractionsOfACent', ], ], ], 'UiConfig' => [ 'type' => 'structure', 'members' => [ 'UiTemplateS3Uri' => [ 'shape' => 'S3Uri', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'UiTemplate' => [ 'type' => 'structure', 'required' => [ 'Content', ], 'members' => [ 'Content' => [ 'shape' => 'TemplateContent', ], ], ], 'UiTemplateInfo' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'TemplateUrl', ], 'ContentSha256' => [ 'shape' => 'TemplateContentSha256', ], ], ], 'Uid' => [ 'type' => 'long', 'max' => 4000000, 'min' => 10000, ], 'UpdateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'UpdateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], ], ], 'UpdateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'UpdateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Properties' => [ 'shape' => 'ArtifactProperties', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'UpdateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'InstanceGroups', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupSpecifications', ], ], ], 'UpdateClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'UpdateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfigForUpdate', ], ], ], 'UpdateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'UpdateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'UpdateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'UpdateDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], ], ], 'UpdateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettingsForUpdate' => [ 'shape' => 'DomainSettingsForUpdate', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], ], ], 'UpdateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], ], ], 'UpdateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'RetainAllVariantProperties' => [ 'shape' => 'Boolean', ], 'ExcludeRetainedVariantProperties' => [ 'shape' => 'VariantPropertyList', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'RetainDeploymentConfig' => [ 'shape' => 'Boolean', ], ], ], 'UpdateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'DesiredWeightsAndCapacities', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'DesiredWeightsAndCapacities' => [ 'shape' => 'DesiredWeightAndCapacityList', ], ], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], ], ], 'UpdateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'UpdateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureAdditions' => [ 'shape' => 'FeatureAdditions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfigUpdate', ], ], ], 'UpdateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'UpdateFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'ParameterAdditions' => [ 'shape' => 'FeatureParameterAdditions', ], 'ParameterRemovals' => [ 'shape' => 'FeatureParameterRemovals', ], ], ], 'UpdateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], ], ], 'UpdateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'UpdateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'DeleteProperties' => [ 'shape' => 'ImageDeletePropertyList', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'UpdateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'AliasesToAdd' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'AliasesToDelete' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'UpdateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'UpdateInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecification', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], ], ], 'UpdateInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'UpdateInferenceComponentRuntimeConfigInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'DesiredRuntimeConfig', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'DesiredRuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], ], ], 'UpdateInferenceComponentRuntimeConfigOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'UpdateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], ], ], 'UpdateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'UpdateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], ], ], 'UpdateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'UpdateModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'CustomerMetadataPropertiesToRemove' => [ 'shape' => 'CustomerMetadataKeyList', ], 'AdditionalInferenceSpecificationsToAdd' => [ 'shape' => 'AdditionalInferenceSpecifications', ], ], ], 'UpdateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'UpdateMonitoringAlertRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'DatapointsToAlert', 'EvaluationPeriod', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], ], ], 'UpdateMonitoringAlertResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], ], ], 'UpdateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], ], ], 'UpdateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'UpdateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DisassociateLifecycleConfig' => [ 'shape' => 'DisassociateNotebookInstanceLifecycleConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DisassociateAcceleratorTypes' => [ 'shape' => 'DisassociateNotebookInstanceAcceleratorTypes', ], 'DisassociateDefaultCodeRepository' => [ 'shape' => 'DisassociateDefaultCodeRepository', ], 'DisassociateAdditionalCodeRepositories' => [ 'shape' => 'DisassociateAdditionalCodeRepositories', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'UpdatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'UpdateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'shape' => 'ServiceCatalogProvisioningUpdateDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'UpdateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], ], ], 'UpdateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'UpdateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'UpdateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfigForUpdate', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfigForUpdate', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfigForUpdate', ], ], ], 'UpdateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'UpdateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'ParametersToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'InputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], ], ], 'UpdateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'UpdateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'UpdateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'UpdateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'UpdateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'UpdateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'UpdateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'UpdateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'UpdateWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Url' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'UserContext' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'String', ], 'UserProfileName' => [ 'shape' => 'String', ], 'DomainId' => [ 'shape' => 'String', ], 'IamIdentity' => [ 'shape' => 'IamIdentity', ], ], ], 'UserProfileArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/.*', ], 'UserProfileDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'UserProfileList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserProfileDetails', ], ], 'UserProfileName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'UserProfileSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'UserProfileStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'UserSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'SharingSettings' => [ 'shape' => 'SharingSettings', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'TensorBoardAppSettings' => [ 'shape' => 'TensorBoardAppSettings', ], 'RStudioServerProAppSettings' => [ 'shape' => 'RStudioServerProAppSettings', ], 'RSessionAppSettings' => [ 'shape' => 'RSessionAppSettings', ], 'CanvasAppSettings' => [ 'shape' => 'CanvasAppSettings', ], 'CodeEditorAppSettings' => [ 'shape' => 'CodeEditorAppSettings', ], 'JupyterLabAppSettings' => [ 'shape' => 'JupyterLabAppSettings', ], 'SpaceStorageSettings' => [ 'shape' => 'DefaultSpaceStorageSettings', ], 'DefaultLandingUri' => [ 'shape' => 'LandingUri', ], 'StudioWebPortal' => [ 'shape' => 'StudioWebPortal', ], 'CustomPosixUserConfig' => [ 'shape' => 'CustomPosixUserConfig', ], 'CustomFileSystemConfigs' => [ 'shape' => 'CustomFileSystemConfigs', ], ], ], 'UsersPerStep' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'UtilizationMetric' => [ 'type' => 'float', 'min' => 0.0, ], 'UtilizationPercentagePerCore' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ValidationFraction' => [ 'type' => 'float', 'max' => 1, 'min' => 0, ], 'VariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'VariantProperty' => [ 'type' => 'structure', 'required' => [ 'VariantPropertyType', ], 'members' => [ 'VariantPropertyType' => [ 'shape' => 'VariantPropertyType', ], ], ], 'VariantPropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantProperty', ], 'max' => 3, 'min' => 0, ], 'VariantPropertyType' => [ 'type' => 'string', 'enum' => [ 'DesiredInstanceCount', 'DesiredWeight', 'DataCaptureConfig', ], ], 'VariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'Deleting', 'ActivatingTraffic', 'Baking', ], ], 'VariantStatusMessage' => [ 'type' => 'string', 'max' => 1024, ], 'VariantWeight' => [ 'type' => 'float', 'min' => 0, ], 'VectorConfig' => [ 'type' => 'structure', 'required' => [ 'Dimension', ], 'members' => [ 'Dimension' => [ 'shape' => 'Dimension', ], ], ], 'VendorGuidance' => [ 'type' => 'string', 'enum' => [ 'NOT_PROVIDED', 'STABLE', 'TO_BE_ARCHIVED', 'ARCHIVED', ], ], 'VersionId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'VersionedArnOrName' => [ 'type' => 'string', 'max' => 176, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AssociationEntityArn', ], 'Type' => [ 'shape' => 'String40', ], 'LineageType' => [ 'shape' => 'LineageType', ], ], ], 'Vertices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Vertex', ], ], 'VisibilityConditions' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'VisibilityConditionsKey', ], 'Value' => [ 'shape' => 'VisibilityConditionsValue', ], ], ], 'VisibilityConditionsKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'VisibilityConditionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VisibilityConditions', ], 'max' => 5, 'min' => 1, ], 'VisibilityConditionsValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'VolumeSizeInGB' => [ 'type' => 'integer', 'min' => 1, ], 'VpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'Subnets', ], ], ], 'VpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'VpcOnlyTrustedAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], ], 'VpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WaitIntervalInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'WarmPoolResourceStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Terminated', 'Reused', 'InUse', ], ], 'WarmPoolStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'WarmPoolResourceStatus', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'shape' => 'ResourceRetainedBillableTimeInSeconds', ], 'ReusedByJob' => [ 'shape' => 'TrainingJobName', ], ], ], 'Workforce' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', 'WorkforceArn', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'SubDomain' => [ 'shape' => 'String', ], 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfigForResponse', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigResponse', ], 'Status' => [ 'shape' => 'WorkforceStatus', ], 'FailureReason' => [ 'shape' => 'WorkforceFailureReason', ], ], ], 'WorkforceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/.*', ], 'WorkforceFailureReason' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'WorkforceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}$', ], 'WorkforceSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^sg-[0-9a-z]*$', ], 'WorkforceSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WorkforceStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Updating', 'Deleting', 'Failed', 'Active', ], ], 'WorkforceSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^subnet-[0-9a-z]*$', ], 'WorkforceSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSubnetId', ], 'max' => 16, 'min' => 1, ], 'WorkforceVpcConfigRequest' => [ 'type' => 'structure', 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], ], ], 'WorkforceVpcConfigResponse' => [ 'type' => 'structure', 'required' => [ 'VpcId', 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], 'VpcEndpointId' => [ 'shape' => 'WorkforceVpcEndpointId', ], ], ], 'WorkforceVpcEndpointId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^vpce-[0-9a-z]*$', ], 'WorkforceVpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^vpc-[0-9a-z]*$', ], 'Workforces' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workforce', ], ], 'WorkspaceSettings' => [ 'type' => 'structure', 'members' => [ 'S3ArtifactPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'Workteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'WorkteamArn', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'ProductListingIds' => [ 'shape' => 'ProductListings', ], 'Description' => [ 'shape' => 'String200', ], 'SubDomain' => [ 'shape' => 'String', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'WorkteamArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/.*', ], 'WorkteamName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'Workteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workteam', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2017-07-24', 'endpointPrefix' => 'api.sagemaker', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'SageMaker', 'serviceFullName' => 'Amazon SageMaker Service', 'serviceId' => 'SageMaker', 'signatureVersion' => 'v4', 'signingName' => 'sagemaker', 'targetPrefix' => 'SageMaker', 'uid' => 'sagemaker-2017-07-24', ], 'operations' => [ 'AddAssociation' => [ 'name' => 'AddAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddAssociationRequest', ], 'output' => [ 'shape' => 'AddAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsInput', ], 'output' => [ 'shape' => 'AddTagsOutput', ], ], 'AssociateTrialComponent' => [ 'name' => 'AssociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateTrialComponentRequest', ], 'output' => [ 'shape' => 'AssociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'BatchDescribeModelPackage' => [ 'name' => 'BatchDescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDescribeModelPackageInput', ], 'output' => [ 'shape' => 'BatchDescribeModelPackageOutput', ], ], 'CreateAction' => [ 'name' => 'CreateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateActionRequest', ], 'output' => [ 'shape' => 'CreateActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAlgorithm' => [ 'name' => 'CreateAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAlgorithmInput', ], 'output' => [ 'shape' => 'CreateAlgorithmOutput', ], ], 'CreateApp' => [ 'name' => 'CreateApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppRequest', ], 'output' => [ 'shape' => 'CreateAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateAppImageConfig' => [ 'name' => 'CreateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAppImageConfigRequest', ], 'output' => [ 'shape' => 'CreateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateArtifact' => [ 'name' => 'CreateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateArtifactRequest', ], 'output' => [ 'shape' => 'CreateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJob' => [ 'name' => 'CreateAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobRequest', ], 'output' => [ 'shape' => 'CreateAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateAutoMLJobV2' => [ 'name' => 'CreateAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAutoMLJobV2Request', ], 'output' => [ 'shape' => 'CreateAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateCodeRepository' => [ 'name' => 'CreateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCodeRepositoryInput', ], 'output' => [ 'shape' => 'CreateCodeRepositoryOutput', ], ], 'CreateCompilationJob' => [ 'name' => 'CreateCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCompilationJobRequest', ], 'output' => [ 'shape' => 'CreateCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateContext' => [ 'name' => 'CreateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateContextRequest', ], 'output' => [ 'shape' => 'CreateContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDataQualityJobDefinition' => [ 'name' => 'CreateDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateDeviceFleet' => [ 'name' => 'CreateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateDomain' => [ 'name' => 'CreateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDomainRequest', ], 'output' => [ 'shape' => 'CreateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateEdgeDeploymentPlan' => [ 'name' => 'CreateEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'CreateEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgeDeploymentStage' => [ 'name' => 'CreateEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEdgePackagingJob' => [ 'name' => 'CreateEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEdgePackagingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpoint' => [ 'name' => 'CreateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointInput', ], 'output' => [ 'shape' => 'CreateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateEndpointConfig' => [ 'name' => 'CreateEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateEndpointConfigInput', ], 'output' => [ 'shape' => 'CreateEndpointConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateExperiment' => [ 'name' => 'CreateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateExperimentRequest', ], 'output' => [ 'shape' => 'CreateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFeatureGroup' => [ 'name' => 'CreateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFeatureGroupRequest', ], 'output' => [ 'shape' => 'CreateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateFlowDefinition' => [ 'name' => 'CreateFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateFlowDefinitionRequest', ], 'output' => [ 'shape' => 'CreateFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHub' => [ 'name' => 'CreateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHubRequest', ], 'output' => [ 'shape' => 'CreateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateHumanTaskUi' => [ 'name' => 'CreateHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHumanTaskUiRequest', ], 'output' => [ 'shape' => 'CreateHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateHyperParameterTuningJob' => [ 'name' => 'CreateHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'CreateHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImage' => [ 'name' => 'CreateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageRequest', ], 'output' => [ 'shape' => 'CreateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateImageVersion' => [ 'name' => 'CreateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImageVersionRequest', ], 'output' => [ 'shape' => 'CreateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateInferenceComponent' => [ 'name' => 'CreateInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceComponentInput', ], 'output' => [ 'shape' => 'CreateInferenceComponentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateInferenceExperiment' => [ 'name' => 'CreateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'CreateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateInferenceRecommendationsJob' => [ 'name' => 'CreateInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'CreateInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateLabelingJob' => [ 'name' => 'CreateLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLabelingJobRequest', ], 'output' => [ 'shape' => 'CreateLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModel' => [ 'name' => 'CreateModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelInput', ], 'output' => [ 'shape' => 'CreateModelOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelBiasJobDefinition' => [ 'name' => 'CreateModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelCard' => [ 'name' => 'CreateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardRequest', ], 'output' => [ 'shape' => 'CreateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelCardExportJob' => [ 'name' => 'CreateModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelCardExportJobRequest', ], 'output' => [ 'shape' => 'CreateModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreateModelExplainabilityJobDefinition' => [ 'name' => 'CreateModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateModelPackage' => [ 'name' => 'CreateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageInput', ], 'output' => [ 'shape' => 'CreateModelPackageOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelPackageGroup' => [ 'name' => 'CreateModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelPackageGroupInput', ], 'output' => [ 'shape' => 'CreateModelPackageGroupOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateModelQualityJobDefinition' => [ 'name' => 'CreateModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'CreateModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateMonitoringSchedule' => [ 'name' => 'CreateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'CreateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateNotebookInstance' => [ 'name' => 'CreateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateNotebookInstanceLifecycleConfig' => [ 'name' => 'CreateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'CreateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreatePipeline' => [ 'name' => 'CreatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePipelineRequest', ], 'output' => [ 'shape' => 'CreatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'CreatePresignedDomainUrl' => [ 'name' => 'CreatePresignedDomainUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedDomainUrlRequest', ], 'output' => [ 'shape' => 'CreatePresignedDomainUrlResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'CreatePresignedNotebookInstanceUrl' => [ 'name' => 'CreatePresignedNotebookInstanceUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlInput', ], 'output' => [ 'shape' => 'CreatePresignedNotebookInstanceUrlOutput', ], ], 'CreateProcessingJob' => [ 'name' => 'CreateProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProcessingJobRequest', ], 'output' => [ 'shape' => 'CreateProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateProject' => [ 'name' => 'CreateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProjectInput', ], 'output' => [ 'shape' => 'CreateProjectOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateSpace' => [ 'name' => 'CreateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSpaceRequest', ], 'output' => [ 'shape' => 'CreateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateStudioLifecycleConfig' => [ 'name' => 'CreateStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'CreateStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'CreateTrainingJob' => [ 'name' => 'CreateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrainingJobRequest', ], 'output' => [ 'shape' => 'CreateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTransformJob' => [ 'name' => 'CreateTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTransformJobRequest', ], 'output' => [ 'shape' => 'CreateTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'CreateTrial' => [ 'name' => 'CreateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialRequest', ], 'output' => [ 'shape' => 'CreateTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateTrialComponent' => [ 'name' => 'CreateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTrialComponentRequest', ], 'output' => [ 'shape' => 'CreateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'CreateUserProfile' => [ 'name' => 'CreateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserProfileRequest', ], 'output' => [ 'shape' => 'CreateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], ], ], 'CreateWorkforce' => [ 'name' => 'CreateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkforceRequest', ], 'output' => [ 'shape' => 'CreateWorkforceResponse', ], ], 'CreateWorkteam' => [ 'name' => 'CreateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateWorkteamRequest', ], 'output' => [ 'shape' => 'CreateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeleteAction' => [ 'name' => 'DeleteAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteActionRequest', ], 'output' => [ 'shape' => 'DeleteActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAlgorithm' => [ 'name' => 'DeleteAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAlgorithmInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteApp' => [ 'name' => 'DeleteApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAppImageConfig' => [ 'name' => 'DeleteAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAppImageConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteArtifact' => [ 'name' => 'DeleteArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteArtifactRequest', ], 'output' => [ 'shape' => 'DeleteArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteAssociation' => [ 'name' => 'DeleteAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAssociationRequest', ], 'output' => [ 'shape' => 'DeleteAssociationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteCodeRepository' => [ 'name' => 'DeleteCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCodeRepositoryInput', ], ], 'DeleteCompilationJob' => [ 'name' => 'DeleteCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCompilationJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteContext' => [ 'name' => 'DeleteContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteContextRequest', ], 'output' => [ 'shape' => 'DeleteContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDataQualityJobDefinition' => [ 'name' => 'DeleteDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDataQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteDeviceFleet' => [ 'name' => 'DeleteDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteDomain' => [ 'name' => 'DeleteDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDomainRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteEdgeDeploymentPlan' => [ 'name' => 'DeleteEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentPlanRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEdgeDeploymentStage' => [ 'name' => 'DeleteEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEdgeDeploymentStageRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteEndpoint' => [ 'name' => 'DeleteEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointInput', ], ], 'DeleteEndpointConfig' => [ 'name' => 'DeleteEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEndpointConfigInput', ], ], 'DeleteExperiment' => [ 'name' => 'DeleteExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteExperimentRequest', ], 'output' => [ 'shape' => 'DeleteExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFeatureGroup' => [ 'name' => 'DeleteFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFeatureGroupRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteFlowDefinition' => [ 'name' => 'DeleteFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DeleteFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHub' => [ 'name' => 'DeleteHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHubContent' => [ 'name' => 'DeleteHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHubContentRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteHumanTaskUi' => [ 'name' => 'DeleteHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DeleteHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteImage' => [ 'name' => 'DeleteImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageRequest', ], 'output' => [ 'shape' => 'DeleteImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteImageVersion' => [ 'name' => 'DeleteImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImageVersionRequest', ], 'output' => [ 'shape' => 'DeleteImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteInferenceComponent' => [ 'name' => 'DeleteInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInferenceComponentInput', ], ], 'DeleteInferenceExperiment' => [ 'name' => 'DeleteInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DeleteInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModel' => [ 'name' => 'DeleteModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelInput', ], ], 'DeleteModelBiasJobDefinition' => [ 'name' => 'DeleteModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelBiasJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelCard' => [ 'name' => 'DeleteModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelCardRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelExplainabilityJobDefinition' => [ 'name' => 'DeleteModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelExplainabilityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteModelPackage' => [ 'name' => 'DeleteModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroup' => [ 'name' => 'DeleteModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteModelPackageGroupPolicy' => [ 'name' => 'DeleteModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelPackageGroupPolicyInput', ], ], 'DeleteModelQualityJobDefinition' => [ 'name' => 'DeleteModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteModelQualityJobDefinitionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteMonitoringSchedule' => [ 'name' => 'DeleteMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteNotebookInstance' => [ 'name' => 'DeleteNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceInput', ], ], 'DeleteNotebookInstanceLifecycleConfig' => [ 'name' => 'DeleteNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNotebookInstanceLifecycleConfigInput', ], ], 'DeletePipeline' => [ 'name' => 'DeletePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePipelineRequest', ], 'output' => [ 'shape' => 'DeletePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'DeleteProject' => [ 'name' => 'DeleteProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProjectInput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'DeleteSpace' => [ 'name' => 'DeleteSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSpaceRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteStudioLifecycleConfig' => [ 'name' => 'DeleteStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStudioLifecycleConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceInUse', ], ], ], 'DeleteTags' => [ 'name' => 'DeleteTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTagsInput', ], 'output' => [ 'shape' => 'DeleteTagsOutput', ], ], 'DeleteTrial' => [ 'name' => 'DeleteTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialRequest', ], 'output' => [ 'shape' => 'DeleteTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteTrialComponent' => [ 'name' => 'DeleteTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTrialComponentRequest', ], 'output' => [ 'shape' => 'DeleteTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteUserProfile' => [ 'name' => 'DeleteUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserProfileRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'DeleteWorkforce' => [ 'name' => 'DeleteWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkforceRequest', ], 'output' => [ 'shape' => 'DeleteWorkforceResponse', ], ], 'DeleteWorkteam' => [ 'name' => 'DeleteWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteWorkteamRequest', ], 'output' => [ 'shape' => 'DeleteWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DeregisterDevices' => [ 'name' => 'DeregisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterDevicesRequest', ], ], 'DescribeAction' => [ 'name' => 'DescribeAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeActionRequest', ], 'output' => [ 'shape' => 'DescribeActionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAlgorithm' => [ 'name' => 'DescribeAlgorithm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAlgorithmInput', ], 'output' => [ 'shape' => 'DescribeAlgorithmOutput', ], ], 'DescribeApp' => [ 'name' => 'DescribeApp', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppRequest', ], 'output' => [ 'shape' => 'DescribeAppResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAppImageConfig' => [ 'name' => 'DescribeAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAppImageConfigRequest', ], 'output' => [ 'shape' => 'DescribeAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeArtifact' => [ 'name' => 'DescribeArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeArtifactRequest', ], 'output' => [ 'shape' => 'DescribeArtifactResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJob' => [ 'name' => 'DescribeAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobRequest', ], 'output' => [ 'shape' => 'DescribeAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeAutoMLJobV2' => [ 'name' => 'DescribeAutoMLJobV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAutoMLJobV2Request', ], 'output' => [ 'shape' => 'DescribeAutoMLJobV2Response', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeCluster' => [ 'name' => 'DescribeCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClusterRequest', ], 'output' => [ 'shape' => 'DescribeClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeClusterNode' => [ 'name' => 'DescribeClusterNode', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClusterNodeRequest', ], 'output' => [ 'shape' => 'DescribeClusterNodeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeCodeRepository' => [ 'name' => 'DescribeCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCodeRepositoryInput', ], 'output' => [ 'shape' => 'DescribeCodeRepositoryOutput', ], ], 'DescribeCompilationJob' => [ 'name' => 'DescribeCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCompilationJobRequest', ], 'output' => [ 'shape' => 'DescribeCompilationJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeContext' => [ 'name' => 'DescribeContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContextRequest', ], 'output' => [ 'shape' => 'DescribeContextResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDataQualityJobDefinition' => [ 'name' => 'DescribeDataQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDataQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeDataQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDevice' => [ 'name' => 'DescribeDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceRequest', ], 'output' => [ 'shape' => 'DescribeDeviceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDeviceFleet' => [ 'name' => 'DescribeDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDeviceFleetRequest', ], 'output' => [ 'shape' => 'DescribeDeviceFleetResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeDomain' => [ 'name' => 'DescribeDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDomainRequest', ], 'output' => [ 'shape' => 'DescribeDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgeDeploymentPlan' => [ 'name' => 'DescribeEdgeDeploymentPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgeDeploymentPlanRequest', ], 'output' => [ 'shape' => 'DescribeEdgeDeploymentPlanResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEdgePackagingJob' => [ 'name' => 'DescribeEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEdgePackagingJobRequest', ], 'output' => [ 'shape' => 'DescribeEdgePackagingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeEndpoint' => [ 'name' => 'DescribeEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointInput', ], 'output' => [ 'shape' => 'DescribeEndpointOutput', ], ], 'DescribeEndpointConfig' => [ 'name' => 'DescribeEndpointConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEndpointConfigInput', ], 'output' => [ 'shape' => 'DescribeEndpointConfigOutput', ], ], 'DescribeExperiment' => [ 'name' => 'DescribeExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExperimentRequest', ], 'output' => [ 'shape' => 'DescribeExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureGroup' => [ 'name' => 'DescribeFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureGroupRequest', ], 'output' => [ 'shape' => 'DescribeFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFeatureMetadata' => [ 'name' => 'DescribeFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFeatureMetadataRequest', ], 'output' => [ 'shape' => 'DescribeFeatureMetadataResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeFlowDefinition' => [ 'name' => 'DescribeFlowDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeFlowDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeFlowDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHub' => [ 'name' => 'DescribeHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubRequest', ], 'output' => [ 'shape' => 'DescribeHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHubContent' => [ 'name' => 'DescribeHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHubContentRequest', ], 'output' => [ 'shape' => 'DescribeHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHumanTaskUi' => [ 'name' => 'DescribeHumanTaskUi', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHumanTaskUiRequest', ], 'output' => [ 'shape' => 'DescribeHumanTaskUiResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeHyperParameterTuningJob' => [ 'name' => 'DescribeHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'DescribeHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImage' => [ 'name' => 'DescribeImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageRequest', ], 'output' => [ 'shape' => 'DescribeImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeImageVersion' => [ 'name' => 'DescribeImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImageVersionRequest', ], 'output' => [ 'shape' => 'DescribeImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceComponent' => [ 'name' => 'DescribeInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceComponentInput', ], 'output' => [ 'shape' => 'DescribeInferenceComponentOutput', ], ], 'DescribeInferenceExperiment' => [ 'name' => 'DescribeInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceExperimentRequest', ], 'output' => [ 'shape' => 'DescribeInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeInferenceRecommendationsJob' => [ 'name' => 'DescribeInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInferenceRecommendationsJobRequest', ], 'output' => [ 'shape' => 'DescribeInferenceRecommendationsJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLabelingJob' => [ 'name' => 'DescribeLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLabelingJobRequest', ], 'output' => [ 'shape' => 'DescribeLabelingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeLineageGroup' => [ 'name' => 'DescribeLineageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLineageGroupRequest', ], 'output' => [ 'shape' => 'DescribeLineageGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModel' => [ 'name' => 'DescribeModel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelInput', ], 'output' => [ 'shape' => 'DescribeModelOutput', ], ], 'DescribeModelBiasJobDefinition' => [ 'name' => 'DescribeModelBiasJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelBiasJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelBiasJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCard' => [ 'name' => 'DescribeModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardRequest', ], 'output' => [ 'shape' => 'DescribeModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelCardExportJob' => [ 'name' => 'DescribeModelCardExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelCardExportJobRequest', ], 'output' => [ 'shape' => 'DescribeModelCardExportJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelExplainabilityJobDefinition' => [ 'name' => 'DescribeModelExplainabilityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelExplainabilityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeModelPackage' => [ 'name' => 'DescribeModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageInput', ], 'output' => [ 'shape' => 'DescribeModelPackageOutput', ], ], 'DescribeModelPackageGroup' => [ 'name' => 'DescribeModelPackageGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelPackageGroupInput', ], 'output' => [ 'shape' => 'DescribeModelPackageGroupOutput', ], ], 'DescribeModelQualityJobDefinition' => [ 'name' => 'DescribeModelQualityJobDefinition', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeModelQualityJobDefinitionRequest', ], 'output' => [ 'shape' => 'DescribeModelQualityJobDefinitionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeMonitoringSchedule' => [ 'name' => 'DescribeMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'DescribeMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeNotebookInstance' => [ 'name' => 'DescribeNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceOutput', ], ], 'DescribeNotebookInstanceLifecycleConfig' => [ 'name' => 'DescribeNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'DescribeNotebookInstanceLifecycleConfigOutput', ], ], 'DescribePipeline' => [ 'name' => 'DescribePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineRequest', ], 'output' => [ 'shape' => 'DescribePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineDefinitionForExecution' => [ 'name' => 'DescribePipelineDefinitionForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineDefinitionForExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineDefinitionForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribePipelineExecution' => [ 'name' => 'DescribePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePipelineExecutionRequest', ], 'output' => [ 'shape' => 'DescribePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProcessingJob' => [ 'name' => 'DescribeProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProcessingJobRequest', ], 'output' => [ 'shape' => 'DescribeProcessingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeProject' => [ 'name' => 'DescribeProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProjectInput', ], 'output' => [ 'shape' => 'DescribeProjectOutput', ], ], 'DescribeSpace' => [ 'name' => 'DescribeSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSpaceRequest', ], 'output' => [ 'shape' => 'DescribeSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeStudioLifecycleConfig' => [ 'name' => 'DescribeStudioLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStudioLifecycleConfigRequest', ], 'output' => [ 'shape' => 'DescribeStudioLifecycleConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeSubscribedWorkteam' => [ 'name' => 'DescribeSubscribedWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSubscribedWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeSubscribedWorkteamResponse', ], ], 'DescribeTrainingJob' => [ 'name' => 'DescribeTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrainingJobRequest', ], 'output' => [ 'shape' => 'DescribeTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTransformJob' => [ 'name' => 'DescribeTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTransformJobRequest', ], 'output' => [ 'shape' => 'DescribeTransformJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrial' => [ 'name' => 'DescribeTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialRequest', ], 'output' => [ 'shape' => 'DescribeTrialResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeTrialComponent' => [ 'name' => 'DescribeTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTrialComponentRequest', ], 'output' => [ 'shape' => 'DescribeTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'DescribeUserProfile' => [ 'name' => 'DescribeUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserProfileRequest', ], 'output' => [ 'shape' => 'DescribeUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'DescribeWorkforce' => [ 'name' => 'DescribeWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkforceRequest', ], 'output' => [ 'shape' => 'DescribeWorkforceResponse', ], ], 'DescribeWorkteam' => [ 'name' => 'DescribeWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeWorkteamRequest', ], 'output' => [ 'shape' => 'DescribeWorkteamResponse', ], ], 'DisableSagemakerServicecatalogPortfolio' => [ 'name' => 'DisableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'DisableSagemakerServicecatalogPortfolioOutput', ], ], 'DisassociateTrialComponent' => [ 'name' => 'DisassociateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateTrialComponentRequest', ], 'output' => [ 'shape' => 'DisassociateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'EnableSagemakerServicecatalogPortfolio' => [ 'name' => 'EnableSagemakerServicecatalogPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioInput', ], 'output' => [ 'shape' => 'EnableSagemakerServicecatalogPortfolioOutput', ], ], 'GetDeviceFleetReport' => [ 'name' => 'GetDeviceFleetReport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceFleetReportRequest', ], 'output' => [ 'shape' => 'GetDeviceFleetReportResponse', ], ], 'GetLineageGroupPolicy' => [ 'name' => 'GetLineageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetLineageGroupPolicyRequest', ], 'output' => [ 'shape' => 'GetLineageGroupPolicyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetModelPackageGroupPolicy' => [ 'name' => 'GetModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'GetModelPackageGroupPolicyOutput', ], ], 'GetSagemakerServicecatalogPortfolioStatus' => [ 'name' => 'GetSagemakerServicecatalogPortfolioStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusInput', ], 'output' => [ 'shape' => 'GetSagemakerServicecatalogPortfolioStatusOutput', ], ], 'GetScalingConfigurationRecommendation' => [ 'name' => 'GetScalingConfigurationRecommendation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetScalingConfigurationRecommendationRequest', ], 'output' => [ 'shape' => 'GetScalingConfigurationRecommendationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'GetSearchSuggestions' => [ 'name' => 'GetSearchSuggestions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSearchSuggestionsRequest', ], 'output' => [ 'shape' => 'GetSearchSuggestionsResponse', ], ], 'ImportHubContent' => [ 'name' => 'ImportHubContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportHubContentRequest', ], 'output' => [ 'shape' => 'ImportHubContentResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'ListActions' => [ 'name' => 'ListActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListActionsRequest', ], 'output' => [ 'shape' => 'ListActionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAlgorithms' => [ 'name' => 'ListAlgorithms', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAlgorithmsInput', ], 'output' => [ 'shape' => 'ListAlgorithmsOutput', ], ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAliasesRequest', ], 'output' => [ 'shape' => 'ListAliasesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAppImageConfigs' => [ 'name' => 'ListAppImageConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppImageConfigsRequest', ], 'output' => [ 'shape' => 'ListAppImageConfigsResponse', ], ], 'ListApps' => [ 'name' => 'ListApps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAppsRequest', ], 'output' => [ 'shape' => 'ListAppsResponse', ], ], 'ListArtifacts' => [ 'name' => 'ListArtifacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListArtifactsRequest', ], 'output' => [ 'shape' => 'ListArtifactsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAssociations' => [ 'name' => 'ListAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAssociationsRequest', ], 'output' => [ 'shape' => 'ListAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListAutoMLJobs' => [ 'name' => 'ListAutoMLJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAutoMLJobsRequest', ], 'output' => [ 'shape' => 'ListAutoMLJobsResponse', ], ], 'ListCandidatesForAutoMLJob' => [ 'name' => 'ListCandidatesForAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCandidatesForAutoMLJobRequest', ], 'output' => [ 'shape' => 'ListCandidatesForAutoMLJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListClusterNodes' => [ 'name' => 'ListClusterNodes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClusterNodesRequest', ], 'output' => [ 'shape' => 'ListClusterNodesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersRequest', ], 'output' => [ 'shape' => 'ListClustersResponse', ], ], 'ListCodeRepositories' => [ 'name' => 'ListCodeRepositories', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCodeRepositoriesInput', ], 'output' => [ 'shape' => 'ListCodeRepositoriesOutput', ], ], 'ListCompilationJobs' => [ 'name' => 'ListCompilationJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCompilationJobsRequest', ], 'output' => [ 'shape' => 'ListCompilationJobsResponse', ], ], 'ListContexts' => [ 'name' => 'ListContexts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListContextsRequest', ], 'output' => [ 'shape' => 'ListContextsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListDataQualityJobDefinitions' => [ 'name' => 'ListDataQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDataQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListDataQualityJobDefinitionsResponse', ], ], 'ListDeviceFleets' => [ 'name' => 'ListDeviceFleets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDeviceFleetsRequest', ], 'output' => [ 'shape' => 'ListDeviceFleetsResponse', ], ], 'ListDevices' => [ 'name' => 'ListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicesRequest', ], 'output' => [ 'shape' => 'ListDevicesResponse', ], ], 'ListDomains' => [ 'name' => 'ListDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDomainsRequest', ], 'output' => [ 'shape' => 'ListDomainsResponse', ], ], 'ListEdgeDeploymentPlans' => [ 'name' => 'ListEdgeDeploymentPlans', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgeDeploymentPlansRequest', ], 'output' => [ 'shape' => 'ListEdgeDeploymentPlansResponse', ], ], 'ListEdgePackagingJobs' => [ 'name' => 'ListEdgePackagingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEdgePackagingJobsRequest', ], 'output' => [ 'shape' => 'ListEdgePackagingJobsResponse', ], ], 'ListEndpointConfigs' => [ 'name' => 'ListEndpointConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointConfigsInput', ], 'output' => [ 'shape' => 'ListEndpointConfigsOutput', ], ], 'ListEndpoints' => [ 'name' => 'ListEndpoints', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListEndpointsInput', ], 'output' => [ 'shape' => 'ListEndpointsOutput', ], ], 'ListExperiments' => [ 'name' => 'ListExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListExperimentsRequest', ], 'output' => [ 'shape' => 'ListExperimentsResponse', ], ], 'ListFeatureGroups' => [ 'name' => 'ListFeatureGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFeatureGroupsRequest', ], 'output' => [ 'shape' => 'ListFeatureGroupsResponse', ], ], 'ListFlowDefinitions' => [ 'name' => 'ListFlowDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListFlowDefinitionsRequest', ], 'output' => [ 'shape' => 'ListFlowDefinitionsResponse', ], ], 'ListHubContentVersions' => [ 'name' => 'ListHubContentVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentVersionsRequest', ], 'output' => [ 'shape' => 'ListHubContentVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubContents' => [ 'name' => 'ListHubContents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubContentsRequest', ], 'output' => [ 'shape' => 'ListHubContentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListHubs' => [ 'name' => 'ListHubs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHubsRequest', ], 'output' => [ 'shape' => 'ListHubsResponse', ], ], 'ListHumanTaskUis' => [ 'name' => 'ListHumanTaskUis', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHumanTaskUisRequest', ], 'output' => [ 'shape' => 'ListHumanTaskUisResponse', ], ], 'ListHyperParameterTuningJobs' => [ 'name' => 'ListHyperParameterTuningJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListHyperParameterTuningJobsRequest', ], 'output' => [ 'shape' => 'ListHyperParameterTuningJobsResponse', ], ], 'ListImageVersions' => [ 'name' => 'ListImageVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImageVersionsRequest', ], 'output' => [ 'shape' => 'ListImageVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListImages' => [ 'name' => 'ListImages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImagesRequest', ], 'output' => [ 'shape' => 'ListImagesResponse', ], ], 'ListInferenceComponents' => [ 'name' => 'ListInferenceComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceComponentsInput', ], 'output' => [ 'shape' => 'ListInferenceComponentsOutput', ], ], 'ListInferenceExperiments' => [ 'name' => 'ListInferenceExperiments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceExperimentsRequest', ], 'output' => [ 'shape' => 'ListInferenceExperimentsResponse', ], ], 'ListInferenceRecommendationsJobSteps' => [ 'name' => 'ListInferenceRecommendationsJobSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobStepsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListInferenceRecommendationsJobs' => [ 'name' => 'ListInferenceRecommendationsJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInferenceRecommendationsJobsRequest', ], 'output' => [ 'shape' => 'ListInferenceRecommendationsJobsResponse', ], ], 'ListLabelingJobs' => [ 'name' => 'ListLabelingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsResponse', ], ], 'ListLabelingJobsForWorkteam' => [ 'name' => 'ListLabelingJobsForWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLabelingJobsForWorkteamRequest', ], 'output' => [ 'shape' => 'ListLabelingJobsForWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListLineageGroups' => [ 'name' => 'ListLineageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLineageGroupsRequest', ], 'output' => [ 'shape' => 'ListLineageGroupsResponse', ], ], 'ListModelBiasJobDefinitions' => [ 'name' => 'ListModelBiasJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelBiasJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelBiasJobDefinitionsResponse', ], ], 'ListModelCardExportJobs' => [ 'name' => 'ListModelCardExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardExportJobsRequest', ], 'output' => [ 'shape' => 'ListModelCardExportJobsResponse', ], ], 'ListModelCardVersions' => [ 'name' => 'ListModelCardVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardVersionsRequest', ], 'output' => [ 'shape' => 'ListModelCardVersionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListModelCards' => [ 'name' => 'ListModelCards', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelCardsRequest', ], 'output' => [ 'shape' => 'ListModelCardsResponse', ], ], 'ListModelExplainabilityJobDefinitions' => [ 'name' => 'ListModelExplainabilityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelExplainabilityJobDefinitionsResponse', ], ], 'ListModelMetadata' => [ 'name' => 'ListModelMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelMetadataRequest', ], 'output' => [ 'shape' => 'ListModelMetadataResponse', ], ], 'ListModelPackageGroups' => [ 'name' => 'ListModelPackageGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackageGroupsInput', ], 'output' => [ 'shape' => 'ListModelPackageGroupsOutput', ], ], 'ListModelPackages' => [ 'name' => 'ListModelPackages', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelPackagesInput', ], 'output' => [ 'shape' => 'ListModelPackagesOutput', ], ], 'ListModelQualityJobDefinitions' => [ 'name' => 'ListModelQualityJobDefinitions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelQualityJobDefinitionsRequest', ], 'output' => [ 'shape' => 'ListModelQualityJobDefinitionsResponse', ], ], 'ListModels' => [ 'name' => 'ListModels', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListModelsInput', ], 'output' => [ 'shape' => 'ListModelsOutput', ], ], 'ListMonitoringAlertHistory' => [ 'name' => 'ListMonitoringAlertHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertHistoryRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertHistoryResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringAlerts' => [ 'name' => 'ListMonitoringAlerts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringAlertsRequest', ], 'output' => [ 'shape' => 'ListMonitoringAlertsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListMonitoringExecutions' => [ 'name' => 'ListMonitoringExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringExecutionsRequest', ], 'output' => [ 'shape' => 'ListMonitoringExecutionsResponse', ], ], 'ListMonitoringSchedules' => [ 'name' => 'ListMonitoringSchedules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMonitoringSchedulesRequest', ], 'output' => [ 'shape' => 'ListMonitoringSchedulesResponse', ], ], 'ListNotebookInstanceLifecycleConfigs' => [ 'name' => 'ListNotebookInstanceLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsInput', ], 'output' => [ 'shape' => 'ListNotebookInstanceLifecycleConfigsOutput', ], ], 'ListNotebookInstances' => [ 'name' => 'ListNotebookInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookInstancesInput', ], 'output' => [ 'shape' => 'ListNotebookInstancesOutput', ], ], 'ListPipelineExecutionSteps' => [ 'name' => 'ListPipelineExecutionSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionStepsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionStepsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineExecutions' => [ 'name' => 'ListPipelineExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineExecutionsRequest', ], 'output' => [ 'shape' => 'ListPipelineExecutionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelineParametersForExecution' => [ 'name' => 'ListPipelineParametersForExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelineParametersForExecutionRequest', ], 'output' => [ 'shape' => 'ListPipelineParametersForExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListPipelines' => [ 'name' => 'ListPipelines', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPipelinesRequest', ], 'output' => [ 'shape' => 'ListPipelinesResponse', ], ], 'ListProcessingJobs' => [ 'name' => 'ListProcessingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProcessingJobsRequest', ], 'output' => [ 'shape' => 'ListProcessingJobsResponse', ], ], 'ListProjects' => [ 'name' => 'ListProjects', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProjectsInput', ], 'output' => [ 'shape' => 'ListProjectsOutput', ], ], 'ListResourceCatalogs' => [ 'name' => 'ListResourceCatalogs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceCatalogsRequest', ], 'output' => [ 'shape' => 'ListResourceCatalogsResponse', ], ], 'ListSpaces' => [ 'name' => 'ListSpaces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSpacesRequest', ], 'output' => [ 'shape' => 'ListSpacesResponse', ], ], 'ListStageDevices' => [ 'name' => 'ListStageDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStageDevicesRequest', ], 'output' => [ 'shape' => 'ListStageDevicesResponse', ], ], 'ListStudioLifecycleConfigs' => [ 'name' => 'ListStudioLifecycleConfigs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStudioLifecycleConfigsRequest', ], 'output' => [ 'shape' => 'ListStudioLifecycleConfigsResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'ListSubscribedWorkteams' => [ 'name' => 'ListSubscribedWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSubscribedWorkteamsRequest', ], 'output' => [ 'shape' => 'ListSubscribedWorkteamsResponse', ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsInput', ], 'output' => [ 'shape' => 'ListTagsOutput', ], ], 'ListTrainingJobs' => [ 'name' => 'ListTrainingJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsResponse', ], ], 'ListTrainingJobsForHyperParameterTuningJob' => [ 'name' => 'ListTrainingJobsForHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobRequest', ], 'output' => [ 'shape' => 'ListTrainingJobsForHyperParameterTuningJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTransformJobs' => [ 'name' => 'ListTransformJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTransformJobsRequest', ], 'output' => [ 'shape' => 'ListTransformJobsResponse', ], ], 'ListTrialComponents' => [ 'name' => 'ListTrialComponents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialComponentsRequest', ], 'output' => [ 'shape' => 'ListTrialComponentsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListTrials' => [ 'name' => 'ListTrials', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTrialsRequest', ], 'output' => [ 'shape' => 'ListTrialsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'ListUserProfiles' => [ 'name' => 'ListUserProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUserProfilesRequest', ], 'output' => [ 'shape' => 'ListUserProfilesResponse', ], ], 'ListWorkforces' => [ 'name' => 'ListWorkforces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkforcesRequest', ], 'output' => [ 'shape' => 'ListWorkforcesResponse', ], ], 'ListWorkteams' => [ 'name' => 'ListWorkteams', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListWorkteamsRequest', ], 'output' => [ 'shape' => 'ListWorkteamsResponse', ], ], 'PutModelPackageGroupPolicy' => [ 'name' => 'PutModelPackageGroupPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutModelPackageGroupPolicyInput', ], 'output' => [ 'shape' => 'PutModelPackageGroupPolicyOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'QueryLineage' => [ 'name' => 'QueryLineage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'QueryLineageRequest', ], 'output' => [ 'shape' => 'QueryLineageResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RegisterDevices' => [ 'name' => 'RegisterDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterDevicesRequest', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'RenderUiTemplate' => [ 'name' => 'RenderUiTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RenderUiTemplateRequest', ], 'output' => [ 'shape' => 'RenderUiTemplateResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'RetryPipelineExecution' => [ 'name' => 'RetryPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RetryPipelineExecutionRequest', ], 'output' => [ 'shape' => 'RetryPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'Search' => [ 'name' => 'Search', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchRequest', ], 'output' => [ 'shape' => 'SearchResponse', ], ], 'SendPipelineExecutionStepFailure' => [ 'name' => 'SendPipelineExecutionStepFailure', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepFailureRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepFailureResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'SendPipelineExecutionStepSuccess' => [ 'name' => 'SendPipelineExecutionStepSuccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SendPipelineExecutionStepSuccessRequest', ], 'output' => [ 'shape' => 'SendPipelineExecutionStepSuccessResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'StartEdgeDeploymentStage' => [ 'name' => 'StartEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartEdgeDeploymentStageRequest', ], ], 'StartInferenceExperiment' => [ 'name' => 'StartInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StartInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StartMonitoringSchedule' => [ 'name' => 'StartMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StartNotebookInstance' => [ 'name' => 'StartNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartNotebookInstanceInput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'StartPipelineExecution' => [ 'name' => 'StartPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StartPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'StopAutoMLJob' => [ 'name' => 'StopAutoMLJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopAutoMLJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopCompilationJob' => [ 'name' => 'StopCompilationJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopCompilationJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopEdgeDeploymentStage' => [ 'name' => 'StopEdgeDeploymentStage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgeDeploymentStageRequest', ], ], 'StopEdgePackagingJob' => [ 'name' => 'StopEdgePackagingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopEdgePackagingJobRequest', ], ], 'StopHyperParameterTuningJob' => [ 'name' => 'StopHyperParameterTuningJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopHyperParameterTuningJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceExperiment' => [ 'name' => 'StopInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceExperimentRequest', ], 'output' => [ 'shape' => 'StopInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'StopInferenceRecommendationsJob' => [ 'name' => 'StopInferenceRecommendationsJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopInferenceRecommendationsJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopLabelingJob' => [ 'name' => 'StopLabelingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopLabelingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopMonitoringSchedule' => [ 'name' => 'StopMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopMonitoringScheduleRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopNotebookInstance' => [ 'name' => 'StopNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopNotebookInstanceInput', ], ], 'StopPipelineExecution' => [ 'name' => 'StopPipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopPipelineExecutionRequest', ], 'output' => [ 'shape' => 'StopPipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'StopProcessingJob' => [ 'name' => 'StopProcessingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopProcessingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTrainingJob' => [ 'name' => 'StopTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTrainingJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'StopTransformJob' => [ 'name' => 'StopTransformJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopTransformJobRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAction' => [ 'name' => 'UpdateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateActionRequest', ], 'output' => [ 'shape' => 'UpdateActionResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateAppImageConfig' => [ 'name' => 'UpdateAppImageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAppImageConfigRequest', ], 'output' => [ 'shape' => 'UpdateAppImageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateArtifact' => [ 'name' => 'UpdateArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateArtifactRequest', ], 'output' => [ 'shape' => 'UpdateArtifactResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateCluster' => [ 'name' => 'UpdateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateClusterRequest', ], 'output' => [ 'shape' => 'UpdateClusterResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateCodeRepository' => [ 'name' => 'UpdateCodeRepository', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCodeRepositoryInput', ], 'output' => [ 'shape' => 'UpdateCodeRepositoryOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateContext' => [ 'name' => 'UpdateContext', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateContextRequest', ], 'output' => [ 'shape' => 'UpdateContextResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateDeviceFleet' => [ 'name' => 'UpdateDeviceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDeviceFleetRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], ], ], 'UpdateDevices' => [ 'name' => 'UpdateDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDevicesRequest', ], ], 'UpdateDomain' => [ 'name' => 'UpdateDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDomainRequest', ], 'output' => [ 'shape' => 'UpdateDomainResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateEndpoint' => [ 'name' => 'UpdateEndpoint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointInput', ], 'output' => [ 'shape' => 'UpdateEndpointOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateEndpointWeightsAndCapacities' => [ 'name' => 'UpdateEndpointWeightsAndCapacities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesInput', ], 'output' => [ 'shape' => 'UpdateEndpointWeightsAndCapacitiesOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateExperiment' => [ 'name' => 'UpdateExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateExperimentRequest', ], 'output' => [ 'shape' => 'UpdateExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateFeatureGroup' => [ 'name' => 'UpdateFeatureGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureGroupRequest', ], 'output' => [ 'shape' => 'UpdateFeatureGroupResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateFeatureMetadata' => [ 'name' => 'UpdateFeatureMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateFeatureMetadataRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateHub' => [ 'name' => 'UpdateHub', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateHubRequest', ], 'output' => [ 'shape' => 'UpdateHubResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImage' => [ 'name' => 'UpdateImage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageRequest', ], 'output' => [ 'shape' => 'UpdateImageResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateImageVersion' => [ 'name' => 'UpdateImageVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImageVersionRequest', ], 'output' => [ 'shape' => 'UpdateImageVersionResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateInferenceComponent' => [ 'name' => 'UpdateInferenceComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceComponentInput', ], 'output' => [ 'shape' => 'UpdateInferenceComponentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateInferenceComponentRuntimeConfig' => [ 'name' => 'UpdateInferenceComponentRuntimeConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceComponentRuntimeConfigInput', ], 'output' => [ 'shape' => 'UpdateInferenceComponentRuntimeConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateInferenceExperiment' => [ 'name' => 'UpdateInferenceExperiment', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInferenceExperimentRequest', ], 'output' => [ 'shape' => 'UpdateInferenceExperimentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateModelCard' => [ 'name' => 'UpdateModelCard', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelCardRequest', ], 'output' => [ 'shape' => 'UpdateModelCardResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateModelPackage' => [ 'name' => 'UpdateModelPackage', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateModelPackageInput', ], 'output' => [ 'shape' => 'UpdateModelPackageOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateMonitoringAlert' => [ 'name' => 'UpdateMonitoringAlert', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringAlertRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringAlertResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateMonitoringSchedule' => [ 'name' => 'UpdateMonitoringSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMonitoringScheduleRequest', ], 'output' => [ 'shape' => 'UpdateMonitoringScheduleResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateNotebookInstance' => [ 'name' => 'UpdateNotebookInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateNotebookInstanceLifecycleConfig' => [ 'name' => 'UpdateNotebookInstanceLifecycleConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigInput', ], 'output' => [ 'shape' => 'UpdateNotebookInstanceLifecycleConfigOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdatePipeline' => [ 'name' => 'UpdatePipeline', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineRequest', ], 'output' => [ 'shape' => 'UpdatePipelineResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdatePipelineExecution' => [ 'name' => 'UpdatePipelineExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePipelineExecutionRequest', ], 'output' => [ 'shape' => 'UpdatePipelineExecutionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ConflictException', ], ], ], 'UpdateProject' => [ 'name' => 'UpdateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProjectInput', ], 'output' => [ 'shape' => 'UpdateProjectOutput', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateSpace' => [ 'name' => 'UpdateSpace', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateSpaceRequest', ], 'output' => [ 'shape' => 'UpdateSpaceResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrainingJob' => [ 'name' => 'UpdateTrainingJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrainingJobRequest', ], 'output' => [ 'shape' => 'UpdateTrainingJobResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFound', ], [ 'shape' => 'ResourceLimitExceeded', ], ], ], 'UpdateTrial' => [ 'name' => 'UpdateTrial', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialRequest', ], 'output' => [ 'shape' => 'UpdateTrialResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateTrialComponent' => [ 'name' => 'UpdateTrialComponent', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTrialComponentRequest', ], 'output' => [ 'shape' => 'UpdateTrialComponentResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateUserProfile' => [ 'name' => 'UpdateUserProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserProfileRequest', ], 'output' => [ 'shape' => 'UpdateUserProfileResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], [ 'shape' => 'ResourceInUse', ], [ 'shape' => 'ResourceNotFound', ], ], ], 'UpdateWorkforce' => [ 'name' => 'UpdateWorkforce', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkforceRequest', ], 'output' => [ 'shape' => 'UpdateWorkforceResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], ], ], 'UpdateWorkteam' => [ 'name' => 'UpdateWorkteam', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateWorkteamRequest', ], 'output' => [ 'shape' => 'UpdateWorkteamResponse', ], 'errors' => [ [ 'shape' => 'ResourceLimitExceeded', ], ], ], ], 'shapes' => [ 'Accept' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'AcceptEula' => [ 'type' => 'boolean', ], 'AccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^\\d+$', ], 'ActionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/.*', ], 'ActionSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ActionStatus' => [ 'type' => 'string', 'enum' => [ 'Unknown', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ActionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionSummary', ], ], 'ActionSummary' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String64', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AddAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'AddAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'AddTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AddTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'max' => 3, ], 'AdditionalInferenceSpecificationDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Containers', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'AdditionalInferenceSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'AdditionalInferenceSpecificationDefinition', ], 'max' => 15, 'min' => 1, ], 'AdditionalS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'AdditionalS3DataSourceDataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], ], ], 'AdditionalS3DataSourceDataType' => [ 'type' => 'string', 'enum' => [ 'S3Object', ], ], 'AgentVersion' => [ 'type' => 'structure', 'required' => [ 'Version', 'AgentCount', ], 'members' => [ 'Version' => [ 'shape' => 'EdgeVersion', ], 'AgentCount' => [ 'shape' => 'Long', ], ], ], 'AgentVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentVersion', ], ], 'AggregationTransformationValue' => [ 'type' => 'string', 'enum' => [ 'sum', 'avg', 'first', 'min', 'max', ], ], 'AggregationTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'AggregationTransformationValue', ], 'max' => 50, 'min' => 1, ], 'Alarm' => [ 'type' => 'structure', 'members' => [ 'AlarmName' => [ 'shape' => 'AlarmName', ], ], ], 'AlarmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Alarm', ], 'max' => 10, 'min' => 1, ], 'AlarmName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^(?!\\s*$).+', ], 'AlgorithmArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}$', ], 'AlgorithmImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'AlgorithmSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'AlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'EnableSageMakerMetricsTimeSeries' => [ 'shape' => 'Boolean', ], 'ContainerEntrypoint' => [ 'shape' => 'TrainingContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'TrainingContainerArguments', ], 'TrainingImageConfig' => [ 'shape' => 'TrainingImageConfig', ], ], ], 'AlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'AlgorithmStatusDetails' => [ 'type' => 'structure', 'members' => [ 'ValidationStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'AlgorithmStatusItemList', ], ], ], 'AlgorithmStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedAlgorithmStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'AlgorithmStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmStatusItem', ], ], 'AlgorithmSummary' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'AlgorithmStatus', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], ], ], 'AlgorithmSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmSummary', ], ], 'AlgorithmValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TrainingJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TrainingJobDefinition' => [ 'shape' => 'TrainingJobDefinition', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'AlgorithmValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'AlgorithmValidationProfile', ], 'max' => 1, 'min' => 1, ], 'AlgorithmValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'AlgorithmValidationProfiles', ], ], ], 'AnnotationConsolidationConfig' => [ 'type' => 'structure', 'required' => [ 'AnnotationConsolidationLambdaArn', ], 'members' => [ 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], ], ], 'AppArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*', ], 'AppDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'AppImageConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*', ], 'AppImageConfigDetails' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], ], ], 'AppImageConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppImageConfigDetails', ], ], 'AppImageConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppImageConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'AppInstanceType' => [ 'type' => 'string', 'enum' => [ 'system', 'ml.t3.micro', 'ml.t3.small', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.8xlarge', 'ml.m5.12xlarge', 'ml.m5.16xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.12xlarge', 'ml.c5.18xlarge', 'ml.c5.24xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.geospatial.interactive', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', ], ], 'AppList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AppDetails', ], ], 'AppManaged' => [ 'type' => 'boolean', ], 'AppName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'AppNetworkAccessType' => [ 'type' => 'string', 'enum' => [ 'PublicInternetOnly', 'VpcOnly', ], ], 'AppSecurityGroupManagement' => [ 'type' => 'string', 'enum' => [ 'Service', 'Customer', ], ], 'AppSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'AppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'ContainerArguments', ], ], ], 'AppStatus' => [ 'type' => 'string', 'enum' => [ 'Deleted', 'Deleting', 'Failed', 'InService', 'Pending', ], ], 'AppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', 'DetailedProfiler', 'TensorBoard', 'VSCode', 'Savitur', 'CodeEditor', 'JupyterLab', 'RStudioServerPro', 'RSession', 'RSessionGateway', 'Canvas', 'DatasetManager', 'SageMakerLite', 'Local', ], ], 'ApprovalDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'ArnOrName' => [ 'type' => 'string', 'max' => 170, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:artifact/.*', ], 'ArtifactDigest' => [ 'type' => 'string', 'pattern' => '^[\\w:]+$', ], 'ArtifactProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringParameterValue', ], 'value' => [ 'shape' => 'ArtifactPropertyValue', ], 'max' => 30, ], 'ArtifactPropertyValue' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'ArtifactSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceTypes' => [ 'shape' => 'ArtifactSourceTypes', ], ], ], 'ArtifactSourceIdType' => [ 'type' => 'string', 'enum' => [ 'MD5Hash', 'S3ETag', 'S3Version', 'Custom', ], ], 'ArtifactSourceType' => [ 'type' => 'structure', 'required' => [ 'SourceIdType', 'Value', ], 'members' => [ 'SourceIdType' => [ 'shape' => 'ArtifactSourceIdType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ArtifactSourceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSourceType', ], ], 'ArtifactSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ArtifactSummary', ], ], 'ArtifactSummary' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'AssemblyType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', ], ], 'AssociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'AssociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'AssociationEdgeType' => [ 'type' => 'string', 'enum' => [ 'ContributedTo', 'AssociatedWith', 'DerivedFrom', 'Produced', 'SameAs', ], ], 'AssociationEntityArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*', ], 'AssociationSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationSummary', ], ], 'AssociationSummary' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'SourceName' => [ 'shape' => 'ExperimentEntityName', ], 'DestinationName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'AsyncInferenceClientConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrentInvocationsPerInstance' => [ 'shape' => 'MaxConcurrentInvocationsPerInstance', ], ], ], 'AsyncInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'OutputConfig', ], 'members' => [ 'ClientConfig' => [ 'shape' => 'AsyncInferenceClientConfig', ], 'OutputConfig' => [ 'shape' => 'AsyncInferenceOutputConfig', ], ], ], 'AsyncInferenceNotificationConfig' => [ 'type' => 'structure', 'members' => [ 'SuccessTopic' => [ 'shape' => 'SnsTopicArn', ], 'ErrorTopic' => [ 'shape' => 'SnsTopicArn', ], 'IncludeInferenceResponseIn' => [ 'shape' => 'AsyncNotificationTopicTypeList', ], ], ], 'AsyncInferenceOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'DestinationS3Uri', ], 'NotificationConfig' => [ 'shape' => 'AsyncInferenceNotificationConfig', ], 'S3FailurePath' => [ 'shape' => 'DestinationS3Uri', ], ], ], 'AsyncNotificationTopicTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AsyncNotificationTopicTypes', ], 'max' => 2, 'min' => 0, ], 'AsyncNotificationTopicTypes' => [ 'type' => 'string', 'enum' => [ 'SUCCESS_NOTIFICATION_TOPIC', 'ERROR_NOTIFICATION_TOPIC', ], ], 'AthenaCatalog' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'AthenaDatabase' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'AthenaDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'Catalog', 'Database', 'QueryString', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'Catalog' => [ 'shape' => 'AthenaCatalog', ], 'Database' => [ 'shape' => 'AthenaDatabase', ], 'QueryString' => [ 'shape' => 'AthenaQueryString', ], 'WorkGroup' => [ 'shape' => 'AthenaWorkGroup', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'AthenaResultFormat', ], 'OutputCompression' => [ 'shape' => 'AthenaResultCompressionType', ], ], ], 'AthenaQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'AthenaResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'SNAPPY', 'ZLIB', ], ], 'AthenaResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'ORC', 'AVRO', 'JSON', 'TEXTFILE', ], ], 'AthenaWorkGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9._-]+', ], 'AttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.+', ], 'AttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeName', ], 'max' => 16, ], 'AuthMode' => [ 'type' => 'string', 'enum' => [ 'SSO', 'IAM', ], ], 'AutoGenerateEndpointName' => [ 'type' => 'boolean', ], 'AutoMLAlgorithm' => [ 'type' => 'string', 'enum' => [ 'xgboost', 'linear-learner', 'mlp', 'lightgbm', 'catboost', 'randomforest', 'extra-trees', 'nn-torch', 'fastai', ], ], 'AutoMLAlgorithmConfig' => [ 'type' => 'structure', 'required' => [ 'AutoMLAlgorithms', ], 'members' => [ 'AutoMLAlgorithms' => [ 'shape' => 'AutoMLAlgorithms', ], ], ], 'AutoMLAlgorithms' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithm', ], 'max' => 11, ], 'AutoMLAlgorithmsConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLAlgorithmConfig', ], 'max' => 1, ], 'AutoMLCandidate' => [ 'type' => 'structure', 'required' => [ 'CandidateName', 'ObjectiveStatus', 'CandidateSteps', 'CandidateStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CandidateName' => [ 'shape' => 'CandidateName', ], 'FinalAutoMLJobObjectiveMetric' => [ 'shape' => 'FinalAutoMLJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], 'CandidateSteps' => [ 'shape' => 'CandidateSteps', ], 'CandidateStatus' => [ 'shape' => 'CandidateStatus', ], 'InferenceContainers' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'CandidateProperties' => [ 'shape' => 'CandidateProperties', ], 'InferenceContainerDefinitions' => [ 'shape' => 'AutoMLInferenceContainerDefinitions', ], ], ], 'AutoMLCandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'AutoMLCandidateStep' => [ 'type' => 'structure', 'required' => [ 'CandidateStepType', 'CandidateStepArn', 'CandidateStepName', ], 'members' => [ 'CandidateStepType' => [ 'shape' => 'CandidateStepType', ], 'CandidateStepArn' => [ 'shape' => 'CandidateStepArn', ], 'CandidateStepName' => [ 'shape' => 'CandidateStepName', ], ], ], 'AutoMLCandidates' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidate', ], ], 'AutoMLChannel' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', ], 'members' => [ 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'AutoMLChannelType' => [ 'type' => 'string', 'enum' => [ 'training', 'validation', ], ], 'AutoMLContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', 'ModelDataUrl', ], 'members' => [ 'Image' => [ 'shape' => 'ContainerImage', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'AutoMLContainerDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLContainerDefinition', ], 'max' => 5, ], 'AutoMLDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'AutoMLS3DataSource', ], ], ], 'AutoMLDataSplitConfig' => [ 'type' => 'structure', 'members' => [ 'ValidationFraction' => [ 'shape' => 'ValidationFraction', ], ], ], 'AutoMLFailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'AutoMLInferenceContainerDefinitions' => [ 'type' => 'map', 'key' => [ 'shape' => 'AutoMLProcessingUnit', ], 'value' => [ 'shape' => 'AutoMLContainerDefinitions', ], 'max' => 2, ], 'AutoMLInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:automl-job/.*', ], 'AutoMLJobArtifacts' => [ 'type' => 'structure', 'members' => [ 'CandidateDefinitionNotebookLocation' => [ 'shape' => 'CandidateDefinitionNotebookLocation', ], 'DataExplorationNotebookLocation' => [ 'shape' => 'DataExplorationNotebookLocation', ], ], ], 'AutoMLJobChannel' => [ 'type' => 'structure', 'members' => [ 'ChannelType' => [ 'shape' => 'AutoMLChannelType', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'DataSource' => [ 'shape' => 'AutoMLDataSource', ], ], ], 'AutoMLJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'MaxCandidates' => [ 'shape' => 'MaxCandidates', ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'shape' => 'MaxRuntimePerTrainingJobInSeconds', ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'shape' => 'MaxAutoMLJobRuntimeInSeconds', ], ], ], 'AutoMLJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'CandidateGenerationConfig' => [ 'shape' => 'AutoMLCandidateGenerationConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], ], ], 'AutoMLJobInputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobChannel', ], 'max' => 2, 'min' => 1, ], 'AutoMLJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'AutoMLJobObjective' => [ 'type' => 'structure', 'required' => [ 'MetricName', ], 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'AutoMLJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'AutoMLJobSecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'MaxCandidatesReached', 'Failed', 'Stopped', 'MaxAutoMLJobRuntimeReached', 'Stopping', 'CandidateDefinitionsGenerated', 'Completed', 'ExplainabilityError', 'DeployingModel', 'ModelDeploymentError', 'GeneratingModelInsightsReport', 'ModelInsightsError', 'AnalyzingData', 'FeatureEngineering', 'ModelTuning', 'GeneratingExplainabilityReport', 'TrainingModels', 'PreTraining', ], ], 'AutoMLJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'AutoMLJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'AutoMLJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLJobSummary', ], ], 'AutoMLJobSummary' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], ], ], 'AutoMLMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'AutoMLMaxResultsForTrials' => [ 'type' => 'integer', 'max' => 300, 'min' => 1, ], 'AutoMLMetricEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'BalancedAccuracy', 'R2', 'Recall', 'RecallMacro', 'Precision', 'PrecisionMacro', 'MAE', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', ], ], 'AutoMLMetricExtendedEnum' => [ 'type' => 'string', 'enum' => [ 'Accuracy', 'MSE', 'F1', 'F1macro', 'AUC', 'RMSE', 'MAE', 'R2', 'BalancedAccuracy', 'Precision', 'PrecisionMacro', 'Recall', 'RecallMacro', 'LogLoss', 'InferenceLatency', 'MAPE', 'MASE', 'WAPE', 'AverageWeightedQuantileLoss', 'Rouge1', 'Rouge2', 'RougeL', 'RougeLSum', 'Perplexity', 'ValidationLoss', 'TrainingLoss', ], ], 'AutoMLMode' => [ 'type' => 'string', 'enum' => [ 'AUTO', 'ENSEMBLING', 'HYPERPARAMETER_TUNING', ], ], 'AutoMLNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'AutoMLOutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLPartialFailureReason' => [ 'type' => 'structure', 'members' => [ 'PartialFailureMessage' => [ 'shape' => 'AutoMLFailureReason', ], ], ], 'AutoMLPartialFailureReasons' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLPartialFailureReason', ], 'max' => 5, 'min' => 1, ], 'AutoMLProblemTypeConfig' => [ 'type' => 'structure', 'members' => [ 'ImageClassificationJobConfig' => [ 'shape' => 'ImageClassificationJobConfig', ], 'TextClassificationJobConfig' => [ 'shape' => 'TextClassificationJobConfig', ], 'TimeSeriesForecastingJobConfig' => [ 'shape' => 'TimeSeriesForecastingJobConfig', ], 'TabularJobConfig' => [ 'shape' => 'TabularJobConfig', ], 'TextGenerationJobConfig' => [ 'shape' => 'TextGenerationJobConfig', ], ], 'union' => true, ], 'AutoMLProblemTypeConfigName' => [ 'type' => 'string', 'enum' => [ 'ImageClassification', 'TextClassification', 'TimeSeriesForecasting', 'Tabular', 'TextGeneration', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'TabularResolvedAttributes' => [ 'shape' => 'TabularResolvedAttributes', ], 'TextGenerationResolvedAttributes' => [ 'shape' => 'TextGenerationResolvedAttributes', ], ], 'union' => true, ], 'AutoMLProcessingUnit' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'AutoMLResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'AutoMLProblemTypeResolvedAttributes' => [ 'shape' => 'AutoMLProblemTypeResolvedAttributes', ], ], ], 'AutoMLS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'AutoMLS3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'AutoMLS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'AutoMLSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'AutoMLSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'AutoMLSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'AutoParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'ValueHint', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'ValueHint' => [ 'shape' => 'ParameterValue', ], ], ], 'AutoParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoParameter', ], 'max' => 100, 'min' => 0, ], 'AutoRollbackConfig' => [ 'type' => 'structure', 'members' => [ 'Alarms' => [ 'shape' => 'AlarmList', ], ], ], 'Autotune' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'AutotuneMode', ], ], ], 'AutotuneMode' => [ 'type' => 'string', 'enum' => [ 'Enabled', ], ], 'AwsManagedHumanLoopRequestSource' => [ 'type' => 'string', 'enum' => [ 'AWS/Rekognition/DetectModerationLabels/Image/V3', 'AWS/Textract/AnalyzeDocument/Forms/V1', 'AWS/Textract/AnalyzeExpense', 'AWS/Handshake/VerifyIdentity', 'AWS/Bedrock/ModelEvaluation', ], ], 'BacktestResultsLocation' => [ 'type' => 'string', 'min' => 1, ], 'BaseModelName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'BatchDataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'GenerateInferenceId' => [ 'shape' => 'Boolean', ], ], ], 'BatchDescribeModelPackageError' => [ 'type' => 'structure', 'required' => [ 'ErrorCode', 'ErrorResponse', ], 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorResponse' => [ 'shape' => 'String', ], ], ], 'BatchDescribeModelPackageErrorMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageError', ], ], 'BatchDescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArnList', ], 'members' => [ 'ModelPackageArnList' => [ 'shape' => 'ModelPackageArnList', ], ], ], 'BatchDescribeModelPackageOutput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageSummaries' => [ 'shape' => 'ModelPackageSummaries', ], 'BatchDescribeModelPackageErrorMap' => [ 'shape' => 'BatchDescribeModelPackageErrorMap', ], ], ], 'BatchDescribeModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageArn', 'CreationTime', 'InferenceSpecification', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'BatchStrategy' => [ 'type' => 'string', 'enum' => [ 'MultiRecord', 'SingleRecord', ], ], 'BatchTransformInput' => [ 'type' => 'structure', 'required' => [ 'DataCapturedDestinationS3Uri', 'DatasetFormat', 'LocalPath', ], 'members' => [ 'DataCapturedDestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'DatasetFormat' => [ 'shape' => 'MonitoringDatasetFormat', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'ExcludeFeaturesAttribute' => [ 'shape' => 'ExcludeFeaturesAttribute', ], ], ], 'BestObjectiveNotImproving' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTrainingJobsNotImproving' => [ 'shape' => 'MaxNumberOfTrainingJobsNotImproving', ], ], ], 'Bias' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], 'PreTrainingReport' => [ 'shape' => 'MetricsSource', ], 'PostTrainingReport' => [ 'shape' => 'MetricsSource', ], ], ], 'BillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'BlockedReason' => [ 'type' => 'string', 'max' => 1024, ], 'BlueGreenUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'TrafficRoutingConfiguration', ], 'members' => [ 'TrafficRoutingConfiguration' => [ 'shape' => 'TrafficRoutingConfig', ], 'TerminationWaitInSeconds' => [ 'shape' => 'TerminationWaitInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOperator' => [ 'type' => 'string', 'enum' => [ 'And', 'Or', ], ], 'Branch' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[^ ~^:?*\\[]+', ], 'BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, 'pattern' => '[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]', ], 'CacheHitResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'CallbackStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'SqsQueueUrl' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'CallbackToken' => [ 'type' => 'string', 'max' => 10, 'min' => 10, 'pattern' => '^[a-zA-Z0-9]+$', ], 'CandidateArtifactLocations' => [ 'type' => 'structure', 'required' => [ 'Explainability', ], 'members' => [ 'Explainability' => [ 'shape' => 'ExplainabilityLocation', ], 'ModelInsights' => [ 'shape' => 'ModelInsightsLocation', ], 'BacktestResults' => [ 'shape' => 'BacktestResultsLocation', ], ], ], 'CandidateDefinitionNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'CandidateGenerationConfig' => [ 'type' => 'structure', 'members' => [ 'AlgorithmsConfig' => [ 'shape' => 'AutoMLAlgorithmsConfig', ], ], ], 'CandidateName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateProperties' => [ 'type' => 'structure', 'members' => [ 'CandidateArtifactLocations' => [ 'shape' => 'CandidateArtifactLocations', ], 'CandidateMetrics' => [ 'shape' => 'MetricDataList', ], ], ], 'CandidateSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'CandidateStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', ], ], 'CandidateStepArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/.*', ], 'CandidateStepName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'CandidateStepType' => [ 'type' => 'string', 'enum' => [ 'AWS::SageMaker::TrainingJob', 'AWS::SageMaker::TransformJob', 'AWS::SageMaker::ProcessingJob', ], ], 'CandidateSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'AutoMLCandidateStep', ], ], 'CanvasAppSettings' => [ 'type' => 'structure', 'members' => [ 'TimeSeriesForecastingSettings' => [ 'shape' => 'TimeSeriesForecastingSettings', ], 'ModelRegisterSettings' => [ 'shape' => 'ModelRegisterSettings', ], 'WorkspaceSettings' => [ 'shape' => 'WorkspaceSettings', ], 'IdentityProviderOAuthSettings' => [ 'shape' => 'IdentityProviderOAuthSettings', ], 'DirectDeploySettings' => [ 'shape' => 'DirectDeploySettings', ], 'KendraSettings' => [ 'shape' => 'KendraSettings', ], ], ], 'CapacitySize' => [ 'type' => 'structure', 'required' => [ 'Type', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'CapacitySizeType', ], 'Value' => [ 'shape' => 'CapacitySizeValue', ], ], ], 'CapacitySizeType' => [ 'type' => 'string', 'enum' => [ 'INSTANCE_COUNT', 'CAPACITY_PERCENT', ], ], 'CapacitySizeValue' => [ 'type' => 'integer', 'min' => 1, ], 'CapacityUnit' => [ 'type' => 'integer', 'max' => 10000000, 'min' => 0, ], 'CaptureContentTypeHeader' => [ 'type' => 'structure', 'members' => [ 'CsvContentTypes' => [ 'shape' => 'CsvContentTypes', ], 'JsonContentTypes' => [ 'shape' => 'JsonContentTypes', ], ], ], 'CaptureMode' => [ 'type' => 'string', 'enum' => [ 'Input', 'Output', 'InputAndOutput', ], ], 'CaptureOption' => [ 'type' => 'structure', 'required' => [ 'CaptureMode', ], 'members' => [ 'CaptureMode' => [ 'shape' => 'CaptureMode', ], ], ], 'CaptureOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CaptureOption', ], 'max' => 32, 'min' => 1, ], 'CaptureStatus' => [ 'type' => 'string', 'enum' => [ 'Started', 'Stopped', ], ], 'Catalog' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'CategoricalParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String64', ], 'Value' => [ 'shape' => 'CategoricalParameterRangeValues', ], ], ], 'CategoricalParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'Values', ], 'members' => [ 'Values' => [ 'shape' => 'ParameterValues', ], ], ], 'CategoricalParameterRangeValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'String128', ], 'max' => 3, 'min' => 1, ], 'CategoricalParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameterRange', ], 'max' => 30, 'min' => 0, ], 'CategoricalParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoricalParameter', ], 'max' => 5, 'min' => 1, ], 'Cents' => [ 'type' => 'integer', 'max' => 99, 'min' => 0, ], 'CertifyForMarketplace' => [ 'type' => 'boolean', ], 'Channel' => [ 'type' => 'structure', 'required' => [ 'ChannelName', 'DataSource', ], 'members' => [ 'ChannelName' => [ 'shape' => 'ChannelName', ], 'DataSource' => [ 'shape' => 'DataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'RecordWrapperType' => [ 'shape' => 'RecordWrapper', ], 'InputMode' => [ 'shape' => 'TrainingInputMode', ], 'ShuffleConfig' => [ 'shape' => 'ShuffleConfig', ], ], ], 'ChannelName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[A-Za-z0-9\\.\\-_]+', ], 'ChannelSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'SupportedContentTypes', 'SupportedInputModes', ], 'members' => [ 'Name' => [ 'shape' => 'ChannelName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedCompressionTypes' => [ 'shape' => 'CompressionTypes', ], 'SupportedInputModes' => [ 'shape' => 'InputModes', ], ], ], 'ChannelSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChannelSpecification', ], 'max' => 8, 'min' => 1, ], 'CheckpointConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'Cidr' => [ 'type' => 'string', 'max' => 64, 'min' => 4, 'pattern' => '(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)', ], 'Cidrs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cidr', ], ], 'ClarifyCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'ClarifyContentTemplate' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyEnableExplanations' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyExplainerConfig' => [ 'type' => 'structure', 'required' => [ 'ShapConfig', ], 'members' => [ 'EnableExplanations' => [ 'shape' => 'ClarifyEnableExplanations', ], 'InferenceConfig' => [ 'shape' => 'ClarifyInferenceConfig', ], 'ShapConfig' => [ 'shape' => 'ClarifyShapConfig', ], ], ], 'ClarifyFeatureHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeatureType' => [ 'type' => 'string', 'enum' => [ 'numerical', 'categorical', 'text', ], ], 'ClarifyFeatureTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyFeatureType', ], 'max' => 256, 'min' => 1, ], 'ClarifyFeaturesAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyHeader' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyInferenceConfig' => [ 'type' => 'structure', 'members' => [ 'FeaturesAttribute' => [ 'shape' => 'ClarifyFeaturesAttribute', ], 'ContentTemplate' => [ 'shape' => 'ClarifyContentTemplate', ], 'MaxRecordCount' => [ 'shape' => 'ClarifyMaxRecordCount', ], 'MaxPayloadInMB' => [ 'shape' => 'ClarifyMaxPayloadInMB', ], 'ProbabilityIndex' => [ 'shape' => 'ClarifyProbabilityIndex', ], 'LabelIndex' => [ 'shape' => 'ClarifyLabelIndex', ], 'ProbabilityAttribute' => [ 'shape' => 'ClarifyProbabilityAttribute', ], 'LabelAttribute' => [ 'shape' => 'ClarifyLabelAttribute', ], 'LabelHeaders' => [ 'shape' => 'ClarifyLabelHeaders', ], 'FeatureHeaders' => [ 'shape' => 'ClarifyFeatureHeaders', ], 'FeatureTypes' => [ 'shape' => 'ClarifyFeatureTypes', ], ], ], 'ClarifyLabelAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyLabelHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClarifyHeader', ], 'max' => 16, 'min' => 1, ], 'ClarifyLabelIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyMaxPayloadInMB' => [ 'type' => 'integer', 'max' => 25, 'min' => 1, ], 'ClarifyMaxRecordCount' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyMimeType' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*', ], 'ClarifyProbabilityAttribute' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'ClarifyProbabilityIndex' => [ 'type' => 'integer', 'min' => 0, ], 'ClarifyShapBaseline' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'ClarifyShapBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'MimeType' => [ 'shape' => 'ClarifyMimeType', ], 'ShapBaseline' => [ 'shape' => 'ClarifyShapBaseline', ], 'ShapBaselineUri' => [ 'shape' => 'Url', ], ], ], 'ClarifyShapConfig' => [ 'type' => 'structure', 'required' => [ 'ShapBaselineConfig', ], 'members' => [ 'ShapBaselineConfig' => [ 'shape' => 'ClarifyShapBaselineConfig', ], 'NumberOfSamples' => [ 'shape' => 'ClarifyShapNumberOfSamples', ], 'UseLogit' => [ 'shape' => 'ClarifyShapUseLogit', ], 'Seed' => [ 'shape' => 'ClarifyShapSeed', ], 'TextConfig' => [ 'shape' => 'ClarifyTextConfig', ], ], ], 'ClarifyShapNumberOfSamples' => [ 'type' => 'integer', 'min' => 1, ], 'ClarifyShapSeed' => [ 'type' => 'integer', ], 'ClarifyShapUseLogit' => [ 'type' => 'boolean', ], 'ClarifyTextConfig' => [ 'type' => 'structure', 'required' => [ 'Language', 'Granularity', ], 'members' => [ 'Language' => [ 'shape' => 'ClarifyTextLanguage', ], 'Granularity' => [ 'shape' => 'ClarifyTextGranularity', ], ], ], 'ClarifyTextGranularity' => [ 'type' => 'string', 'enum' => [ 'token', 'sentence', 'paragraph', ], ], 'ClarifyTextLanguage' => [ 'type' => 'string', 'enum' => [ 'af', 'sq', 'ar', 'hy', 'eu', 'bn', 'bg', 'ca', 'zh', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fi', 'fr', 'de', 'el', 'gu', 'he', 'hi', 'hu', 'is', 'id', 'ga', 'it', 'kn', 'ky', 'lv', 'lt', 'lb', 'mk', 'ml', 'mr', 'ne', 'nb', 'fa', 'pl', 'pt', 'ro', 'ru', 'sa', 'sr', 'tn', 'si', 'sk', 'sl', 'es', 'sv', 'tl', 'ta', 'tt', 'te', 'tr', 'uk', 'ur', 'yo', 'lij', 'xx', ], ], 'ClientId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', ], 'ClientSecret' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[ -~]+', 'sensitive' => true, ], 'ClientToken' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'ClusterArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$', ], 'ClusterInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ClusterInstanceGroupDetails' => [ 'type' => 'structure', 'members' => [ 'CurrentCount' => [ 'shape' => 'ClusterNonNegativeInstanceCount', ], 'TargetCount' => [ 'shape' => 'ClusterInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterInstanceGroupDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterInstanceGroupDetails', ], ], 'ClusterInstanceGroupName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ClusterInstanceGroupSpecification' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceGroupName', 'InstanceType', 'LifeCycleConfig', 'ExecutionRole', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ClusterInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterInstanceGroupSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterInstanceGroupSpecification', ], 'max' => 5, 'min' => 1, ], 'ClusterInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'Running', 'Failure', 'Pending', 'ShuttingDown', 'SystemUpdating', ], ], 'ClusterInstanceStatusDetails' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'ClusterInstanceStatus', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ClusterInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.p5.48xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.12xlarge', 'ml.g5.16xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.12xlarge', 'ml.c5.18xlarge', 'ml.c5.24xlarge', 'ml.c5n.large', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.8xlarge', 'ml.m5.12xlarge', 'ml.m5.16xlarge', 'ml.m5.24xlarge', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', ], ], 'ClusterLifeCycleConfig' => [ 'type' => 'structure', 'required' => [ 'SourceS3Uri', 'OnCreate', ], 'members' => [ 'SourceS3Uri' => [ 'shape' => 'S3Uri', ], 'OnCreate' => [ 'shape' => 'ClusterLifeCycleConfigFileName', ], ], ], 'ClusterLifeCycleConfigFileName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\S\\s]+$', ], 'ClusterName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ClusterNameOrArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$', ], 'ClusterNodeDetails' => [ 'type' => 'structure', 'members' => [ 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceId' => [ 'shape' => 'String', ], 'InstanceStatus' => [ 'shape' => 'ClusterInstanceStatusDetails', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LaunchTime' => [ 'shape' => 'Timestamp', ], 'LifeCycleConfig' => [ 'shape' => 'ClusterLifeCycleConfig', ], 'ThreadsPerCore' => [ 'shape' => 'ClusterThreadsPerCore', ], ], ], 'ClusterNodeId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z][-a-zA-Z0-9]*$', ], 'ClusterNodeSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterNodeSummary', ], ], 'ClusterNodeSummary' => [ 'type' => 'structure', 'required' => [ 'InstanceGroupName', 'InstanceId', 'InstanceType', 'LaunchTime', 'InstanceStatus', ], 'members' => [ 'InstanceGroupName' => [ 'shape' => 'ClusterInstanceGroupName', ], 'InstanceId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ClusterInstanceType', ], 'LaunchTime' => [ 'shape' => 'Timestamp', ], 'InstanceStatus' => [ 'shape' => 'ClusterInstanceStatusDetails', ], ], ], 'ClusterNonNegativeInstanceCount' => [ 'type' => 'integer', 'min' => 0, ], 'ClusterSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'NAME', ], ], 'ClusterStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Deleting', 'Failed', 'InService', 'RollingBack', 'SystemUpdating', 'Updating', ], ], 'ClusterSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterSummary', ], ], 'ClusterSummary' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', 'ClusterName', 'CreationTime', 'ClusterStatus', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], 'ClusterName' => [ 'shape' => 'ClusterName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ClusterStatus' => [ 'shape' => 'ClusterStatus', ], ], ], 'ClusterThreadsPerCore' => [ 'type' => 'integer', 'max' => 2, 'min' => 1, ], 'CodeEditorAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], ], ], 'CodeRepositories' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepository', ], 'max' => 10, ], 'CodeRepository' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'RepositoryUrl', ], ], ], 'CodeRepositoryArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:code-repository/[\\S]{1,2048}$', ], 'CodeRepositoryContains' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'CodeRepositoryNameOrUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'CodeRepositorySortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'CodeRepositorySortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'CodeRepositorySummary' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'CodeRepositorySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeRepositorySummary', ], ], 'CognitoConfig' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoMemberDefinition' => [ 'type' => 'structure', 'required' => [ 'UserPool', 'UserGroup', 'ClientId', ], 'members' => [ 'UserPool' => [ 'shape' => 'CognitoUserPool', ], 'UserGroup' => [ 'shape' => 'CognitoUserGroup', ], 'ClientId' => [ 'shape' => 'ClientId', ], ], ], 'CognitoUserGroup' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'CognitoUserPool' => [ 'type' => 'string', 'max' => 55, 'min' => 1, 'pattern' => '[\\w-]+_[0-9a-zA-Z]+', ], 'CollectionConfig' => [ 'type' => 'structure', 'members' => [ 'VectorConfig' => [ 'shape' => 'VectorConfig', ], ], 'union' => true, ], 'CollectionConfiguration' => [ 'type' => 'structure', 'members' => [ 'CollectionName' => [ 'shape' => 'CollectionName', ], 'CollectionParameters' => [ 'shape' => 'CollectionParameters', ], ], ], 'CollectionConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'CollectionConfiguration', ], 'max' => 20, 'min' => 0, ], 'CollectionName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'CollectionParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'CollectionType' => [ 'type' => 'string', 'enum' => [ 'List', 'Set', 'Vector', ], ], 'CompilationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/.*', ], 'CompilationJobStatus' => [ 'type' => 'string', 'enum' => [ 'INPROGRESS', 'COMPLETED', 'FAILED', 'STARTING', 'STOPPING', 'STOPPED', ], ], 'CompilationJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompilationJobSummary', ], ], 'CompilationJobSummary' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CreationTime', 'CompilationJobStatus', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'CompilationTargetDevice' => [ 'shape' => 'TargetDevice', ], 'CompilationTargetPlatformOs' => [ 'shape' => 'TargetPlatformOs', ], 'CompilationTargetPlatformArch' => [ 'shape' => 'TargetPlatformArch', ], 'CompilationTargetPlatformAccelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], ], ], 'CompilerOptions' => [ 'type' => 'string', 'max' => 1024, 'min' => 3, 'pattern' => '.*', ], 'CompleteOnConvergence' => [ 'type' => 'string', 'enum' => [ 'Disabled', 'Enabled', ], ], 'CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'CompressionTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompressionType', ], ], 'ConditionOutcome' => [ 'type' => 'string', 'enum' => [ 'True', 'False', ], ], 'ConditionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Outcome' => [ 'shape' => 'ConditionOutcome', ], ], ], 'ConfigKey' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'ConfigValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 100, 'min' => 1, ], 'ContainerConfig' => [ 'type' => 'structure', 'members' => [ 'ContainerArguments' => [ 'shape' => 'CustomImageContainerArguments', ], 'ContainerEntrypoint' => [ 'shape' => 'CustomImageContainerEntrypoint', ], 'ContainerEnvironmentVariables' => [ 'shape' => 'CustomImageContainerEnvironmentVariables', ], ], ], 'ContainerDefinition' => [ 'type' => 'structure', 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageConfig' => [ 'shape' => 'ImageConfig', ], 'Mode' => [ 'shape' => 'ContainerMode', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ModelDataSource' => [ 'shape' => 'ModelDataSource', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'MultiModelConfig' => [ 'shape' => 'MultiModelConfig', ], ], ], 'ContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerDefinition', ], 'max' => 15, ], 'ContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerEntrypointString', ], 'max' => 100, 'min' => 1, ], 'ContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContainerHostname' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ContainerImage' => [ 'type' => 'string', 'max' => 255, 'pattern' => '[\\S]+', ], 'ContainerMode' => [ 'type' => 'string', 'enum' => [ 'SingleModel', 'MultiModel', ], ], 'ContentClassifier' => [ 'type' => 'string', 'enum' => [ 'FreeOfPersonallyIdentifiableInformation', 'FreeOfAdultContent', ], ], 'ContentClassifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentClassifier', ], 'max' => 256, ], 'ContentColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ContentDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ContentType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContentType', ], ], 'ContextArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/.*', ], 'ContextName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}', ], 'ContextNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context\\/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119})', ], 'ContextSource' => [ 'type' => 'structure', 'required' => [ 'SourceUri', ], 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'SourceType' => [ 'shape' => 'String256', ], 'SourceId' => [ 'shape' => 'String256', ], ], ], 'ContextSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContextSummary', ], ], 'ContextSummary' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], 'ContextName' => [ 'shape' => 'ContextName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ContinuousParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'ContinuousParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'ContinuousParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContinuousParameterRange', ], 'max' => 30, 'min' => 0, ], 'ConvergenceDetected' => [ 'type' => 'structure', 'members' => [ 'CompleteOnConvergence' => [ 'shape' => 'CompleteOnConvergence', ], ], ], 'CountryCode' => [ 'type' => 'string', 'max' => 2, 'min' => 2, 'pattern' => '[A-Z]{2}', ], 'CreateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', 'Source', 'ActionType', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'CreateAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'TrainingSpecification', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmArn', ], 'members' => [ 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], ], ], 'CreateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'Tags' => [ 'shape' => 'TagList', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], ], ], 'CreateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'CreateAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'CreateAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], ], ], 'CreateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'Source', 'ArtifactType', ], 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'ArtifactProperties', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'CreateAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], ], ], 'CreateAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'AutoMLProblemTypeConfig', 'RoleArn', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], ], ], 'CreateAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobArn', ], 'members' => [ 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'InstanceGroups', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterName', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupSpecifications', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'CreateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'GitConfig', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'CreateCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'RoleArn', 'OutputConfig', 'StoppingCondition', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobArn', ], 'members' => [ 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], ], ], 'CreateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', 'Source', 'ContextType', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'CreateDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'CreateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainName', 'AuthMode', 'DefaultUserSettings', 'SubnetIds', 'VpcId', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'Tags' => [ 'shape' => 'TagList', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'CreateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'CreateEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], ], ], 'CreateEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'Stages' => [ 'shape' => 'DeploymentStages', ], ], ], 'CreateEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', 'CompilationJobName', 'ModelName', 'ModelVersion', 'RoleArn', 'OutputConfig', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'ProductionVariants', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'CreateEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigArn', ], 'members' => [ 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], ], ], 'CreateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'CreateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'CreateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'ThroughputConfig' => [ 'shape' => 'ThroughputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'CreateFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], ], ], 'CreateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubDescription', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'CreateHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'UiTemplate', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'CreateHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobConfig', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'Autotune' => [ 'shape' => 'Autotune', ], ], ], 'CreateHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobArn', ], 'members' => [ 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'CreateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'RoleArn', ], 'members' => [ 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'CreateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'BaseImage', 'ClientToken', 'ImageName', ], 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ImageName' => [ 'shape' => 'ImageName', ], 'Aliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'CreateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'CreateInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'EndpointName', 'VariantName', 'Specification', 'RuntimeConfig', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecification', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'CreateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'RoleArn', 'EndpointName', 'ModelVariants', 'ShadowModeConfig', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'CreateInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'RoleArn', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'OutputConfig' => [ 'shape' => 'RecommendationJobOutputConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobArn', ], 'members' => [ 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], ], ], 'CreateLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelAttributeName', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobArn', ], 'members' => [ 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], ], ], 'CreateModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardExportJobName', 'OutputConfig', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], ], ], 'CreateModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'CreateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'Content', 'ModelCardStatus', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'CreateModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelArn', ], 'members' => [ 'ModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'CreateModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'CreateModelPackageInput' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], ], ], 'CreateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'CreateModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], ], ], 'CreateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'CreateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'InstanceType', 'RoleArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'Tags' => [ 'shape' => 'TagList', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], ], ], 'CreateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], ], ], 'CreatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', 'RoleArn', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'CreatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'CreatePresignedDomainUrlRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], 'ExpiresInSeconds' => [ 'shape' => 'ExpiresInSeconds', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'LandingUri' => [ 'shape' => 'LandingUri', ], ], ], 'CreatePresignedDomainUrlResponse' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'PresignedDomainUrl', ], ], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], ], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'NotebookInstanceUrl', ], ], ], 'CreateProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'RoleArn', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobArn', ], 'members' => [ 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'CreateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ServiceCatalogProvisioningDetails', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectId', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], ], ], 'CreateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'OwnershipSettings' => [ 'shape' => 'OwnershipSettings', ], 'SpaceSharingSettings' => [ 'shape' => 'SpaceSharingSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'CreateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'CreateStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', 'StudioLifecycleConfigContent', 'StudioLifecycleConfigAppType', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'CreateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'Tags' => [ 'shape' => 'TagList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfig', ], 'InfraCheckConfig' => [ 'shape' => 'InfraCheckConfig', ], ], ], 'CreateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'CreateTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'ModelName', 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'Tags' => [ 'shape' => 'TagList', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'CreateTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobArn', ], 'members' => [ 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], ], ], 'CreateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'CreateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', 'ExperimentName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'CreateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'Tags' => [ 'shape' => 'TagList', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'CreateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'CreateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'Tags' => [ 'shape' => 'TagList', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'CreateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'WorkforceArn', ], 'members' => [ 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], ], ], 'CreateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateWorkteamResponse' => [ 'type' => 'structure', 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'CreationTime' => [ 'type' => 'timestamp', ], 'CrossAccountFilterOption' => [ 'type' => 'string', 'enum' => [ 'SameAccount', 'CrossAccount', ], ], 'CsvContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'CsvContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'CsvContentType', ], 'max' => 10, 'min' => 1, ], 'CustomFileSystem' => [ 'type' => 'structure', 'members' => [ 'EFSFileSystem' => [ 'shape' => 'EFSFileSystem', ], ], 'union' => true, ], 'CustomFileSystemConfig' => [ 'type' => 'structure', 'members' => [ 'EFSFileSystemConfig' => [ 'shape' => 'EFSFileSystemConfig', ], ], 'union' => true, ], 'CustomFileSystemConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomFileSystemConfig', ], 'max' => 2, ], 'CustomFileSystems' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomFileSystem', ], 'max' => 1, ], 'CustomImage' => [ 'type' => 'structure', 'required' => [ 'ImageName', 'AppImageConfigName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageVersionNumber' => [ 'shape' => 'ImageVersionNumber', 'box' => true, ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'CustomImageContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString64', ], 'max' => 50, ], 'CustomImageContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'NonEmptyString256', ], 'max' => 1, ], 'CustomImageContainerEnvironmentVariables' => [ 'type' => 'map', 'key' => [ 'shape' => 'NonEmptyString256', ], 'value' => [ 'shape' => 'String256', ], 'max' => 25, ], 'CustomImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomImage', ], 'max' => 200, ], 'CustomPosixUserConfig' => [ 'type' => 'structure', 'required' => [ 'Uid', 'Gid', ], 'members' => [ 'Uid' => [ 'shape' => 'Uid', ], 'Gid' => [ 'shape' => 'Gid', ], ], ], 'CustomerMetadataKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}', ], 'CustomerMetadataKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerMetadataKey', ], ], 'CustomerMetadataMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'CustomerMetadataKey', ], 'value' => [ 'shape' => 'CustomerMetadataValue', ], 'max' => 50, 'min' => 1, ], 'CustomerMetadataValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}', ], 'CustomizedMetricSpecification' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'String', ], 'Namespace' => [ 'shape' => 'String', ], 'Statistic' => [ 'shape' => 'Statistic', ], ], ], 'DataCaptureConfig' => [ 'type' => 'structure', 'required' => [ 'InitialSamplingPercentage', 'DestinationS3Uri', 'CaptureOptions', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'InitialSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CaptureOptions' => [ 'shape' => 'CaptureOptionList', ], 'CaptureContentTypeHeader' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'DataCaptureConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EnableCapture', 'CaptureStatus', 'CurrentSamplingPercentage', 'DestinationS3Uri', 'KmsKeyId', ], 'members' => [ 'EnableCapture' => [ 'shape' => 'EnableCapture', ], 'CaptureStatus' => [ 'shape' => 'CaptureStatus', ], 'CurrentSamplingPercentage' => [ 'shape' => 'SamplingPercentage', ], 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'DataCatalogConfig' => [ 'type' => 'structure', 'required' => [ 'TableName', 'Catalog', 'Database', ], 'members' => [ 'TableName' => [ 'shape' => 'TableName', ], 'Catalog' => [ 'shape' => 'Catalog', ], 'Database' => [ 'shape' => 'Database', ], ], ], 'DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'DataExplorationNotebookLocation' => [ 'type' => 'string', 'min' => 1, ], 'DataInputConfig' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'DataProcessing' => [ 'type' => 'structure', 'members' => [ 'InputFilter' => [ 'shape' => 'JsonPath', ], 'OutputFilter' => [ 'shape' => 'JsonPath', ], 'JoinSource' => [ 'shape' => 'JoinSource', ], ], ], 'DataQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'DataQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'DataQualityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'DataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'S3DataSource', ], 'FileSystemDataSource' => [ 'shape' => 'FileSystemDataSource', ], ], ], 'DataSourceName' => [ 'type' => 'string', 'enum' => [ 'SalesforceGenie', 'Snowflake', ], ], 'Database' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'DatasetDefinition' => [ 'type' => 'structure', 'members' => [ 'AthenaDatasetDefinition' => [ 'shape' => 'AthenaDatasetDefinition', ], 'RedshiftDatasetDefinition' => [ 'shape' => 'RedshiftDatasetDefinition', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'DataDistributionType' => [ 'shape' => 'DataDistributionType', ], 'InputMode' => [ 'shape' => 'InputMode', ], ], ], 'DebugHookConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'HookParameters' => [ 'shape' => 'HookParameters', ], 'CollectionConfigurations' => [ 'shape' => 'CollectionConfigurations', ], ], ], 'DebugRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'DebugRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'DebugRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DebugRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'DebugRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'DefaultEbsStorageSettings' => [ 'type' => 'structure', 'required' => [ 'DefaultEbsVolumeSizeInGb', 'MaximumEbsVolumeSizeInGb', ], 'members' => [ 'DefaultEbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], 'MaximumEbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], ], ], 'DefaultGid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DefaultSpaceSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], ], ], 'DefaultSpaceStorageSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultEbsStorageSettings' => [ 'shape' => 'DefaultEbsStorageSettings', ], ], ], 'DefaultUid' => [ 'type' => 'integer', 'max' => 65535, 'min' => 0, ], 'DeleteActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'DeleteAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DeleteAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], ], ], 'DeleteArtifactRequest' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], ], ], 'DeleteArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DeleteAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'SourceArn', 'DestinationArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], ], ], 'DeleteClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], ], ], 'DeleteClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'DeleteCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], ], ], 'DeleteContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'DeleteDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'RetentionPolicy' => [ 'shape' => 'RetentionPolicy', ], ], ], 'DeleteEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DeleteEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DeleteExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'DeleteFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'DeleteFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DeleteFlowDefinitionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', 'HubContentVersion', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DeleteHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DeleteHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DeleteHumanTaskUiResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DeleteImageResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DeleteImageVersionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], ], ], 'DeleteInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DeleteInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'DeleteModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DeleteModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DeleteModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'DeleteModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DeleteModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DeleteMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DeleteNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DeleteNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DeletePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'DeletePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'DeleteProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DeleteSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DeleteStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DeleteTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'DeleteTagsOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'DeleteTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DeleteTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DeleteUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DeleteWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DeleteWorkforceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DeleteWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Success', ], 'members' => [ 'Success' => [ 'shape' => 'Success', ], ], ], 'DependencyCopyPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DependencyOriginPath' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'DeployedImage' => [ 'type' => 'structure', 'members' => [ 'SpecifiedImage' => [ 'shape' => 'ContainerImage', ], 'ResolvedImage' => [ 'shape' => 'ContainerImage', ], 'ResolutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeployedImages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeployedImage', ], ], 'DeploymentConfig' => [ 'type' => 'structure', 'members' => [ 'BlueGreenUpdatePolicy' => [ 'shape' => 'BlueGreenUpdatePolicy', ], 'RollingUpdatePolicy' => [ 'shape' => 'RollingUpdatePolicy', ], 'AutoRollbackConfiguration' => [ 'shape' => 'AutoRollbackConfig', ], ], ], 'DeploymentRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationStatus', ], 'members' => [ 'RecommendationStatus' => [ 'shape' => 'RecommendationStatus', ], 'RealTimeInferenceRecommendations' => [ 'shape' => 'RealTimeInferenceRecommendations', ], ], ], 'DeploymentStage' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], ], ], 'DeploymentStageMaxResults' => [ 'type' => 'integer', 'max' => 10, ], 'DeploymentStageStatusSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStageStatusSummary', ], ], 'DeploymentStageStatusSummary' => [ 'type' => 'structure', 'required' => [ 'StageName', 'DeviceSelectionConfig', 'DeploymentConfig', 'DeploymentStatus', ], 'members' => [ 'StageName' => [ 'shape' => 'EntityName', ], 'DeviceSelectionConfig' => [ 'shape' => 'DeviceSelectionConfig', ], 'DeploymentConfig' => [ 'shape' => 'EdgeDeploymentConfig', ], 'DeploymentStatus' => [ 'shape' => 'EdgeDeploymentStatus', ], ], ], 'DeploymentStages' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentStage', ], ], 'DeregisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceNames', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], ], ], 'DerivedInformation' => [ 'type' => 'structure', 'members' => [ 'DerivedDataInputConfig' => [ 'shape' => 'DataInputConfig', ], ], ], 'DescribeActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ActionArn' => [ 'shape' => 'ActionArn', ], 'Source' => [ 'shape' => 'ActionSource', ], 'ActionType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAlgorithmInput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeAlgorithmOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', 'AlgorithmArn', 'CreationTime', 'TrainingSpecification', 'AlgorithmStatus', 'AlgorithmStatusDetails', ], 'members' => [ 'AlgorithmName' => [ 'shape' => 'EntityName', ], 'AlgorithmArn' => [ 'shape' => 'AlgorithmArn', ], 'AlgorithmDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'TrainingSpecification' => [ 'shape' => 'TrainingSpecification', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'ValidationSpecification' => [ 'shape' => 'AlgorithmValidationSpecification', ], 'AlgorithmStatus' => [ 'shape' => 'AlgorithmStatus', ], 'AlgorithmStatusDetails' => [ 'shape' => 'AlgorithmStatusDetails', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], ], ], 'DescribeAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], ], ], 'DescribeAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], ], ], 'DescribeAppRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'AppType', 'AppName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], ], ], 'DescribeAppResponse' => [ 'type' => 'structure', 'members' => [ 'AppArn' => [ 'shape' => 'AppArn', ], 'AppType' => [ 'shape' => 'AppType', ], 'AppName' => [ 'shape' => 'AppName', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Status' => [ 'shape' => 'AppStatus', ], 'LastHealthCheckTimestamp' => [ 'shape' => 'Timestamp', ], 'LastUserActivityTimestamp' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'DescribeArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'DescribeArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'Source' => [ 'shape' => 'ArtifactSource', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'InputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'InputDataConfig' => [ 'shape' => 'AutoMLInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'AutoMLJobConfig' => [ 'shape' => 'AutoMLJobConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'ResolvedAttributes', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], ], ], 'DescribeAutoMLJobV2Request' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'DescribeAutoMLJobV2Response' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', 'AutoMLJobArn', 'AutoMLJobInputDataConfig', 'OutputDataConfig', 'RoleArn', 'CreationTime', 'LastModifiedTime', 'AutoMLJobStatus', 'AutoMLJobSecondaryStatus', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'AutoMLJobInputDataConfig' => [ 'shape' => 'AutoMLJobInputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'AutoMLOutputDataConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'AutoMLProblemTypeConfig' => [ 'shape' => 'AutoMLProblemTypeConfig', ], 'AutoMLProblemTypeConfigName' => [ 'shape' => 'AutoMLProblemTypeConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'AutoMLFailureReason', ], 'PartialFailureReasons' => [ 'shape' => 'AutoMLPartialFailureReasons', ], 'BestCandidate' => [ 'shape' => 'AutoMLCandidate', ], 'AutoMLJobStatus' => [ 'shape' => 'AutoMLJobStatus', ], 'AutoMLJobSecondaryStatus' => [ 'shape' => 'AutoMLJobSecondaryStatus', ], 'AutoMLJobArtifacts' => [ 'shape' => 'AutoMLJobArtifacts', ], 'ResolvedAttributes' => [ 'shape' => 'AutoMLResolvedAttributes', ], 'ModelDeployConfig' => [ 'shape' => 'ModelDeployConfig', ], 'ModelDeployResult' => [ 'shape' => 'ModelDeployResult', ], 'DataSplitConfig' => [ 'shape' => 'AutoMLDataSplitConfig', ], 'SecurityConfig' => [ 'shape' => 'AutoMLSecurityConfig', ], ], ], 'DescribeClusterNodeRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'NodeId', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'NodeId' => [ 'shape' => 'ClusterNodeId', ], ], ], 'DescribeClusterNodeResponse' => [ 'type' => 'structure', 'required' => [ 'NodeDetails', ], 'members' => [ 'NodeDetails' => [ 'shape' => 'ClusterNodeDetails', ], ], ], 'DescribeClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], ], ], 'DescribeClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', 'ClusterStatus', 'InstanceGroups', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], 'ClusterName' => [ 'shape' => 'ClusterName', ], 'ClusterStatus' => [ 'shape' => 'ClusterStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureMessage' => [ 'shape' => 'String', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupDetailsList', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'DescribeCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', 'CodeRepositoryArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'GitConfig' => [ 'shape' => 'GitConfig', ], ], ], 'DescribeCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeCompilationJobResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', 'CompilationJobArn', 'CompilationJobStatus', 'StoppingCondition', 'CreationTime', 'LastModifiedTime', 'FailureReason', 'ModelArtifacts', 'RoleArn', 'InputConfig', 'OutputConfig', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobArn' => [ 'shape' => 'CompilationJobArn', ], 'CompilationJobStatus' => [ 'shape' => 'CompilationJobStatus', ], 'CompilationStartTime' => [ 'shape' => 'Timestamp', ], 'CompilationEndTime' => [ 'shape' => 'Timestamp', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'InferenceImage' => [ 'shape' => 'InferenceImage', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'ModelDigests' => [ 'shape' => 'ModelDigests', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputConfig' => [ 'shape' => 'InputConfig', ], 'OutputConfig' => [ 'shape' => 'OutputConfig', ], 'VpcConfig' => [ 'shape' => 'NeoVpcConfig', ], 'DerivedInformation' => [ 'shape' => 'DerivedInformation', ], ], ], 'DescribeContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextNameOrArn', ], ], ], 'DescribeContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'ContextArn' => [ 'shape' => 'ContextArn', ], 'Source' => [ 'shape' => 'ContextSource', ], 'ContextType' => [ 'shape' => 'String256', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], ], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'DataQualityAppSpecification', 'DataQualityJobInput', 'DataQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'DataQualityBaselineConfig' => [ 'shape' => 'DataQualityBaselineConfig', ], 'DataQualityAppSpecification' => [ 'shape' => 'DataQualityAppSpecification', ], 'DataQualityJobInput' => [ 'shape' => 'DataQualityJobInput', ], 'DataQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceFleetResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'DeviceFleetArn', 'OutputConfig', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'IotRoleAlias' => [ 'shape' => 'IotRoleAlias', ], ], ], 'DescribeDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeDeviceResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceFleetName', 'RegistrationTime', ], 'members' => [ 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceName' => [ 'shape' => 'EntityName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModels', ], 'MaxModels' => [ 'shape' => 'Integer', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'DescribeDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], ], ], 'DescribeDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'HomeEfsFileSystemId' => [ 'shape' => 'ResourceId', ], 'SingleSignOnManagedApplicationInstanceId' => [ 'shape' => 'String256', ], 'SingleSignOnApplicationArn' => [ 'shape' => 'SingleSignOnApplicationArn', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SecurityGroupIdForDomainBoundary' => [ 'shape' => 'SecurityGroupId', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettings' => [ 'shape' => 'DomainSettings', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], 'HomeEfsFileSystemKmsKeyId' => [ 'shape' => 'KmsKeyId', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated, use KmsKeyId instead.', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'Url' => [ 'shape' => 'String1024', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], ], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'DeploymentStageMaxResults', ], ], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'ModelConfigs', 'DeviceFleetName', 'Stages', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ModelConfigs' => [ 'shape' => 'EdgeDeploymentModelConfigs', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'Stages' => [ 'shape' => 'DeploymentStageStatusSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'DescribeEdgePackagingJobResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'ResourceKey' => [ 'shape' => 'KmsKeyId', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'EdgePackagingJobStatusMessage' => [ 'shape' => 'String', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ModelArtifact' => [ 'shape' => 'S3Uri', ], 'ModelSignature' => [ 'shape' => 'String', ], 'PresetDeploymentOutput' => [ 'shape' => 'EdgePresetDeploymentOutput', ], ], ], 'DescribeEndpointConfigInput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], ], ], 'DescribeEndpointConfigOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'ProductionVariants', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfig', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantList', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], ], ], 'DescribeEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'DescribeEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastDeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'AsyncInferenceConfig' => [ 'shape' => 'AsyncInferenceConfig', ], 'PendingDeploymentSummary' => [ 'shape' => 'PendingDeploymentSummary', ], 'ExplainerConfig' => [ 'shape' => 'ExplainerConfig', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'DescribeExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'RecordIdentifierFeatureName', 'EventTimeFeatureName', 'FeatureDefinitions', 'CreationTime', 'NextToken', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'ThroughputConfig' => [ 'shape' => 'ThroughputConfigDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'OnlineStoreTotalSizeBytes' => [ 'shape' => 'OnlineStoreTotalSizeBytes', ], ], ], 'DescribeFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], ], ], 'DescribeFeatureMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', 'FeatureGroupName', 'FeatureName', 'FeatureType', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'DescribeFlowDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], ], ], 'DescribeFlowDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionArn', 'FlowDefinitionName', 'FlowDefinitionStatus', 'CreationTime', 'OutputConfig', 'RoleArn', ], 'members' => [ 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HumanLoopRequestSource' => [ 'shape' => 'HumanLoopRequestSource', ], 'HumanLoopActivationConfig' => [ 'shape' => 'HumanLoopActivationConfig', ], 'HumanLoopConfig' => [ 'shape' => 'HumanLoopConfig', ], 'OutputConfig' => [ 'shape' => 'FlowDefinitionOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'DescribeHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], ], ], 'DescribeHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubArn', 'HubContentDocument', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentDependencies' => [ 'shape' => 'HubContentDependencyList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], ], ], 'DescribeHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'S3StorageConfig' => [ 'shape' => 'HubS3StorageConfig', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeHumanTaskUiRequest' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], ], ], 'DescribeHumanTaskUiResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiArn', 'HumanTaskUiName', 'CreationTime', 'UiTemplate', ], 'members' => [ 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiStatus' => [ 'shape' => 'HumanTaskUiStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'UiTemplate' => [ 'shape' => 'UiTemplateInfo', ], ], ], 'DescribeHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'DescribeHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobConfig', 'HyperParameterTuningJobStatus', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'Autotune' => [ 'shape' => 'Autotune', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], ], ], 'DescribeImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], ], ], 'DescribeImageResponse' => [ 'type' => 'structure', 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'DescribeImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], ], 'DescribeImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'BaseImage' => [ 'shape' => 'ImageBaseImage', ], 'ContainerImage' => [ 'shape' => 'ImageContainerImage', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'DescribeInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], ], ], 'DescribeInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'InferenceComponentArn', 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecificationSummary', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfigSummary', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'InferenceComponentStatus' => [ 'shape' => 'InferenceComponentStatus', ], ], ], 'DescribeInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'DescribeInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'Arn', 'Name', 'Type', 'Status', 'EndpointMetadata', 'ModelVariants', ], 'members' => [ 'Arn' => [ 'shape' => 'InferenceExperimentArn', ], 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'EndpointMetadata' => [ 'shape' => 'EndpointMetadata', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigSummaryList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], ], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobType', 'JobArn', 'RoleArn', 'Status', 'CreationTime', 'LastModifiedTime', 'InputConfig', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'InputConfig' => [ 'shape' => 'RecommendationJobInputConfig', ], 'StoppingConditions' => [ 'shape' => 'RecommendationJobStoppingConditions', ], 'InferenceRecommendations' => [ 'shape' => 'InferenceRecommendations', ], 'EndpointPerformances' => [ 'shape' => 'EndpointPerformances', ], ], ], 'DescribeLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'DescribeLabelingJobResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobStatus', 'LabelCounters', 'CreationTime', 'LastModifiedTime', 'JobReferenceCode', 'LabelingJobName', 'LabelingJobArn', 'InputConfig', 'OutputConfig', 'RoleArn', 'HumanTaskConfig', ], 'members' => [ 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'LabelAttributeName' => [ 'shape' => 'LabelAttributeName', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], 'OutputConfig' => [ 'shape' => 'LabelingJobOutputConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LabelCategoryConfigS3Uri' => [ 'shape' => 'S3Uri', ], 'StoppingConditions' => [ 'shape' => 'LabelingJobStoppingConditions', ], 'LabelingJobAlgorithmsConfig' => [ 'shape' => 'LabelingJobAlgorithmsConfig', ], 'HumanTaskConfig' => [ 'shape' => 'HumanTaskConfig', ], 'Tags' => [ 'shape' => 'TagList', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], ], ], 'DescribeLineageGroupRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeLineageGroupResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelBiasAppSpecification', 'ModelBiasJobInput', 'ModelBiasJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelBiasBaselineConfig' => [ 'shape' => 'ModelBiasBaselineConfig', ], 'ModelBiasAppSpecification' => [ 'shape' => 'ModelBiasAppSpecification', ], 'ModelBiasJobInput' => [ 'shape' => 'ModelBiasJobInput', ], 'ModelBiasJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelCardExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobArn', ], 'members' => [ 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], ], ], 'DescribeModelCardExportJobResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'OutputConfig', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'OutputConfig' => [ 'shape' => 'ModelCardExportOutputConfig', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExportArtifacts' => [ 'shape' => 'ModelCardExportArtifacts', ], ], ], 'DescribeModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], ], ], 'DescribeModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', 'ModelCardName', 'ModelCardVersion', 'Content', 'ModelCardStatus', 'CreationTime', 'CreatedBy', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ModelCardProcessingStatus' => [ 'shape' => 'ModelCardProcessingStatus', ], ], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelExplainabilityAppSpecification', 'ModelExplainabilityJobInput', 'ModelExplainabilityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelExplainabilityBaselineConfig' => [ 'shape' => 'ModelExplainabilityBaselineConfig', ], 'ModelExplainabilityAppSpecification' => [ 'shape' => 'ModelExplainabilityAppSpecification', ], 'ModelExplainabilityJobInput' => [ 'shape' => 'ModelExplainabilityJobInput', ], 'ModelExplainabilityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeModelInput' => [ 'type' => 'structure', 'required' => [ 'ModelName', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], ], ], 'DescribeModelOutput' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'CreationTime', 'ModelArn', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'DescribeModelPackageGroupInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], ], ], 'DescribeModelPackageGroupOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'CreatedBy', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'DescribeModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'VersionedArnOrName', ], ], ], 'DescribeModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageName', 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', 'ModelPackageStatusDetails', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], ], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionName', ], 'members' => [ 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], ], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionArn', 'JobDefinitionName', 'CreationTime', 'ModelQualityAppSpecification', 'ModelQualityJobInput', 'ModelQualityJobOutputConfig', 'JobResources', 'RoleArn', ], 'members' => [ 'JobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'JobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelQualityBaselineConfig' => [ 'shape' => 'ModelQualityBaselineConfig', ], 'ModelQualityAppSpecification' => [ 'shape' => 'ModelQualityAppSpecification', ], 'ModelQualityJobInput' => [ 'shape' => 'ModelQualityJobInput', ], 'ModelQualityJobOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'JobResources' => [ 'shape' => 'MonitoringResources', ], 'NetworkConfig' => [ 'shape' => 'MonitoringNetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], ], ], 'DescribeMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'DescribeMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', 'MonitoringScheduleName', 'MonitoringScheduleStatus', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], ], ], 'DescribeNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], ], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], ], ], 'DescribeNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'NetworkInterfaceId' => [ 'shape' => 'NetworkInterfaceId', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DirectInternetAccess' => [ 'shape' => 'DirectInternetAccess', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'PlatformIdentifier' => [ 'shape' => 'PlatformIdentifier', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'DescribePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'DescribePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], ], ], 'DescribePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'DescribeProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'DescribeProcessingJobResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingResources', 'AppSpecification', 'ProcessingJobArn', 'ProcessingJobStatus', 'CreationTime', ], 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'DescribeProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], ], ], 'DescribeProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', 'ProjectName', 'ProjectId', 'ServiceCatalogProvisioningDetails', 'ProjectStatus', 'CreationTime', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'DescribeSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], ], ], 'DescribeSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceArn' => [ 'shape' => 'SpaceArn', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'OwnershipSettings' => [ 'shape' => 'OwnershipSettings', ], 'SpaceSharingSettings' => [ 'shape' => 'SpaceSharingSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'DescribeStudioLifecycleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'StudioLifecycleConfigName', ], 'members' => [ 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], ], ], 'DescribeStudioLifecycleConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigContent' => [ 'shape' => 'StudioLifecycleConfigContent', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'DescribeSubscribedWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], ], ], 'DescribeSubscribedWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteam', ], 'members' => [ 'SubscribedWorkteam' => [ 'shape' => 'SubscribedWorkteam', ], ], ], 'DescribeTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'DescribeTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'ModelArtifacts', 'TrainingJobStatus', 'SecondaryStatus', 'AlgorithmSpecification', 'ResourceConfig', 'StoppingCondition', 'CreationTime', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ProfilerRuleEvaluationStatuses' => [ 'shape' => 'ProfilerRuleEvaluationStatuses', ], 'ProfilingStatus' => [ 'shape' => 'ProfilingStatus', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfig', ], 'InfraCheckConfig' => [ 'shape' => 'InfraCheckConfig', ], ], ], 'DescribeTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'DescribeTransformJobResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'TransformJobStatus', 'ModelName', 'TransformInput', 'TransformResources', 'CreationTime', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], ], ], 'DescribeTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityNameOrArn', ], ], ], 'DescribeTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Sources' => [ 'shape' => 'TrialComponentSources', ], ], ], 'DescribeTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DescribeTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], ], ], 'DescribeUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'DescribeUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'HomeEfsFileSystemUid' => [ 'shape' => 'EfsUid', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'SingleSignOnUserIdentifier' => [ 'shape' => 'SingleSignOnUserIdentifier', ], 'SingleSignOnUserValue' => [ 'shape' => 'String256', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'DescribeWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], ], ], 'DescribeWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'DescribeWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], ], ], 'DescribeWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 128, ], 'DesiredWeightAndCapacity' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'ServerlessUpdateConfig' => [ 'shape' => 'ProductionVariantServerlessUpdateConfig', ], ], ], 'DesiredWeightAndCapacityList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DesiredWeightAndCapacity', ], 'min' => 1, ], 'DestinationS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/])/?(.*)$', ], 'DetailedAlgorithmStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'DetailedModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'NotStarted', 'InProgress', 'Completed', 'Failed', ], ], 'Device' => [ 'type' => 'structure', 'required' => [ 'DeviceName', ], 'members' => [ 'DeviceName' => [ 'shape' => 'DeviceName', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'IotThingName' => [ 'shape' => 'ThingName', ], ], ], 'DeviceArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'READYTODEPLOY', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'DeviceDeploymentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceDeploymentSummary', ], ], 'DeviceDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'StageName', 'DeviceName', 'DeviceArn', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], 'DeployedStageName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'DeviceName' => [ 'shape' => 'DeviceName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'DeviceDeploymentStatus' => [ 'shape' => 'DeviceDeploymentStatus', ], 'DeviceDeploymentStatusMessage' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeploymentStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceDescription' => [ 'type' => 'string', 'max' => 40, 'min' => 1, 'pattern' => '^[-a-zA-Z0-9_.,;:! ]*$', ], 'DeviceFleetArn' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'DeviceFleetDescription' => [ 'type' => 'string', 'max' => 800, 'min' => 1, 'pattern' => '^[-a-zA-Z0-9_.,;:! ]*$', ], 'DeviceFleetSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceFleetSummary', ], ], 'DeviceFleetSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'DeviceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'DeviceNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceName', ], ], 'DeviceSelectionConfig' => [ 'type' => 'structure', 'required' => [ 'DeviceSubsetType', ], 'members' => [ 'DeviceSubsetType' => [ 'shape' => 'DeviceSubsetType', ], 'Percentage' => [ 'shape' => 'Percentage', ], 'DeviceNames' => [ 'shape' => 'DeviceNames', ], 'DeviceNameContains' => [ 'shape' => 'DeviceName', ], ], ], 'DeviceStats' => [ 'type' => 'structure', 'required' => [ 'ConnectedDeviceCount', 'RegisteredDeviceCount', ], 'members' => [ 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'RegisteredDeviceCount' => [ 'shape' => 'Long', ], ], ], 'DeviceSubsetType' => [ 'type' => 'string', 'enum' => [ 'PERCENTAGE', 'SELECTION', 'NAMECONTAINS', ], ], 'DeviceSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceSummary', ], ], 'DeviceSummary' => [ 'type' => 'structure', 'required' => [ 'DeviceName', 'DeviceArn', ], 'members' => [ 'DeviceName' => [ 'shape' => 'EntityName', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'Description' => [ 'shape' => 'DeviceDescription', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'IotThingName' => [ 'shape' => 'ThingName', ], 'RegistrationTime' => [ 'shape' => 'Timestamp', ], 'LatestHeartbeat' => [ 'shape' => 'Timestamp', ], 'Models' => [ 'shape' => 'EdgeModelSummaries', ], 'AgentVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'Devices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'Dimension' => [ 'type' => 'integer', 'max' => 8192, 'min' => 1, ], 'DirectDeploySettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], ], ], 'DirectInternetAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Direction' => [ 'type' => 'string', 'enum' => [ 'Both', 'Ascendants', 'Descendants', ], ], 'DirectoryPath' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'DisableProfiler' => [ 'type' => 'boolean', ], 'DisableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'DisableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateAdditionalCodeRepositories' => [ 'type' => 'boolean', ], 'DisassociateDefaultCodeRepository' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'type' => 'boolean', ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'type' => 'boolean', ], 'DisassociateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', 'TrialName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'DisassociateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'DockerSettings' => [ 'type' => 'structure', 'members' => [ 'EnableDockerAccess' => [ 'shape' => 'FeatureStatus', ], 'VpcOnlyTrustedAccounts' => [ 'shape' => 'VpcOnlyTrustedAccounts', ], ], ], 'DocumentSchemaVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'Dollars' => [ 'type' => 'integer', 'max' => 2, 'min' => 0, ], 'DomainArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*', ], 'DomainDetails' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], 'DomainId' => [ 'shape' => 'DomainId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'Status' => [ 'shape' => 'DomainStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Url' => [ 'shape' => 'String1024', ], ], ], 'DomainId' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^d-(-*[a-z0-9]){1,61}', ], 'DomainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DomainDetails', ], ], 'DomainName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'DomainSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 3, ], 'DomainSettings' => [ 'type' => 'structure', 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], 'RStudioServerProDomainSettings' => [ 'shape' => 'RStudioServerProDomainSettings', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], 'DockerSettings' => [ 'shape' => 'DockerSettings', ], ], ], 'DomainSettingsForUpdate' => [ 'type' => 'structure', 'members' => [ 'RStudioServerProDomainSettingsForUpdate' => [ 'shape' => 'RStudioServerProDomainSettingsForUpdate', ], 'ExecutionRoleIdentityConfig' => [ 'shape' => 'ExecutionRoleIdentityConfig', ], 'SecurityGroupIds' => [ 'shape' => 'DomainSecurityGroupIds', ], 'DockerSettings' => [ 'shape' => 'DockerSettings', ], ], ], 'DomainStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'Double' => [ 'type' => 'double', ], 'DoubleParameterValue' => [ 'type' => 'double', ], 'DriftCheckBaselines' => [ 'type' => 'structure', 'members' => [ 'Bias' => [ 'shape' => 'DriftCheckBias', ], 'Explainability' => [ 'shape' => 'DriftCheckExplainability', ], 'ModelQuality' => [ 'shape' => 'DriftCheckModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'DriftCheckModelDataQuality', ], ], ], 'DriftCheckBias' => [ 'type' => 'structure', 'members' => [ 'ConfigFile' => [ 'shape' => 'FileSource', ], 'PreTrainingConstraints' => [ 'shape' => 'MetricsSource', ], 'PostTrainingConstraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckExplainability' => [ 'type' => 'structure', 'members' => [ 'Constraints' => [ 'shape' => 'MetricsSource', ], 'ConfigFile' => [ 'shape' => 'FileSource', ], ], ], 'DriftCheckModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DriftCheckModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'DynamicScalingConfiguration' => [ 'type' => 'structure', 'members' => [ 'MinCapacity' => [ 'shape' => 'Integer', ], 'MaxCapacity' => [ 'shape' => 'Integer', ], 'ScaleInCooldown' => [ 'shape' => 'Integer', ], 'ScaleOutCooldown' => [ 'shape' => 'Integer', ], 'ScalingPolicies' => [ 'shape' => 'ScalingPolicies', ], ], ], 'EFSFileSystem' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], ], ], 'EFSFileSystemConfig' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], 'FileSystemPath' => [ 'shape' => 'FileSystemPath', ], ], ], 'EMRStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'String256', ], 'StepId' => [ 'shape' => 'String256', ], 'StepName' => [ 'shape' => 'String256', ], 'LogFilePath' => [ 'shape' => 'String1024', ], ], ], 'EbsStorageSettings' => [ 'type' => 'structure', 'required' => [ 'EbsVolumeSizeInGb', ], 'members' => [ 'EbsVolumeSizeInGb' => [ 'shape' => 'SpaceEbsVolumeSizeInGb', ], ], ], 'Edge' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], ], ], 'EdgeDeploymentConfig' => [ 'type' => 'structure', 'required' => [ 'FailureHandlingPolicy', ], 'members' => [ 'FailureHandlingPolicy' => [ 'shape' => 'FailureHandlingPolicy', ], ], ], 'EdgeDeploymentModelConfig' => [ 'type' => 'structure', 'required' => [ 'ModelHandle', 'EdgePackagingJobName', ], 'members' => [ 'ModelHandle' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'EdgeDeploymentModelConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentModelConfig', ], ], 'EdgeDeploymentPlanArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgeDeploymentPlanSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeDeploymentPlanSummary', ], ], 'EdgeDeploymentPlanSummary' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanArn', 'EdgeDeploymentPlanName', 'DeviceFleetName', 'EdgeDeploymentSuccess', 'EdgeDeploymentPending', 'EdgeDeploymentFailed', ], 'members' => [ 'EdgeDeploymentPlanArn' => [ 'shape' => 'EdgeDeploymentPlanArn', ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'EdgeDeploymentSuccess' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPending' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailed' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeDeploymentStatus' => [ 'type' => 'structure', 'required' => [ 'StageStatus', 'EdgeDeploymentSuccessInStage', 'EdgeDeploymentPendingInStage', 'EdgeDeploymentFailedInStage', ], 'members' => [ 'StageStatus' => [ 'shape' => 'StageStatus', ], 'EdgeDeploymentSuccessInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentPendingInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentFailedInStage' => [ 'shape' => 'Integer', ], 'EdgeDeploymentStatusMessage' => [ 'shape' => 'String', ], 'EdgeDeploymentStageStartTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModel' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'LatestSampleTime' => [ 'shape' => 'Timestamp', ], 'LatestInference' => [ 'shape' => 'Timestamp', ], ], ], 'EdgeModelStat' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', 'OfflineDeviceCount', 'ConnectedDeviceCount', 'ActiveDeviceCount', 'SamplingDeviceCount', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'OfflineDeviceCount' => [ 'shape' => 'Long', ], 'ConnectedDeviceCount' => [ 'shape' => 'Long', ], 'ActiveDeviceCount' => [ 'shape' => 'Long', ], 'SamplingDeviceCount' => [ 'shape' => 'Long', ], ], ], 'EdgeModelStats' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelStat', ], ], 'EdgeModelSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModelSummary', ], ], 'EdgeModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelVersion', ], 'members' => [ 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], ], ], 'EdgeModels' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeModel', ], ], 'EdgeOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'PresetDeploymentType' => [ 'shape' => 'EdgePresetDeploymentType', ], 'PresetDeploymentConfig' => [ 'shape' => 'String', ], ], ], 'EdgePackagingJobArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'EdgePackagingJobStatus' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'INPROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'EdgePackagingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgePackagingJobSummary', ], ], 'EdgePackagingJobSummary' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobArn', 'EdgePackagingJobName', 'EdgePackagingJobStatus', ], 'members' => [ 'EdgePackagingJobArn' => [ 'shape' => 'EdgePackagingJobArn', ], 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], 'EdgePackagingJobStatus' => [ 'shape' => 'EdgePackagingJobStatus', ], 'CompilationJobName' => [ 'shape' => 'EntityName', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'ModelVersion' => [ 'shape' => 'EdgeVersion', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EdgePresetDeploymentArtifact' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'EdgePresetDeploymentOutput' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'EdgePresetDeploymentType', ], 'Artifact' => [ 'shape' => 'EdgePresetDeploymentArtifact', ], 'Status' => [ 'shape' => 'EdgePresetDeploymentStatus', ], 'StatusMessage' => [ 'shape' => 'String', ], ], ], 'EdgePresetDeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETED', 'FAILED', ], ], 'EdgePresetDeploymentType' => [ 'type' => 'string', 'enum' => [ 'GreengrassV2Component', ], ], 'EdgeVersion' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[a-zA-Z0-9\\ \\_\\.]+', ], 'Edges' => [ 'type' => 'list', 'member' => [ 'shape' => 'Edge', ], ], 'EfsUid' => [ 'type' => 'string', 'max' => 10, 'pattern' => '\\d+', ], 'EnableCapture' => [ 'type' => 'boolean', ], 'EnableInfraCheck' => [ 'type' => 'boolean', ], 'EnableIotRoleAlias' => [ 'type' => 'boolean', ], 'EnableRemoteDebug' => [ 'type' => 'boolean', ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'type' => 'structure', 'members' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'Endpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'EndpointConfigName', 'EndpointStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], 'DataCaptureConfig' => [ 'shape' => 'DataCaptureConfigSummary', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringSchedules' => [ 'shape' => 'MonitoringScheduleList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ShadowProductionVariants' => [ 'shape' => 'ProductionVariantSummaryList', ], ], ], 'EndpointArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/.*', ], 'EndpointConfigArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/.*', ], 'EndpointConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'EndpointConfigSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', 'EndpointConfigArn', 'CreationTime', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointConfigArn' => [ 'shape' => 'EndpointConfigArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'EndpointConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointConfigSummary', ], ], 'EndpointInfo' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'EndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'LocalPath', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'FeaturesAttribute' => [ 'shape' => 'String', ], 'InferenceAttribute' => [ 'shape' => 'String', ], 'ProbabilityAttribute' => [ 'shape' => 'String', ], 'ProbabilityThresholdAttribute' => [ 'shape' => 'ProbabilityThresholdAttribute', ], 'StartTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'EndTimeOffset' => [ 'shape' => 'MonitoringTimeOffsetString', ], 'ExcludeFeaturesAttribute' => [ 'shape' => 'ExcludeFeaturesAttribute', ], ], ], 'EndpointInputConfiguration' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameterRanges' => [ 'shape' => 'EnvironmentParameterRanges', ], ], ], 'EndpointInputConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInputConfiguration', ], 'max' => 10, 'min' => 1, ], 'EndpointMetadata' => [ 'type' => 'structure', 'required' => [ 'EndpointName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'EndpointName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'EndpointNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'EndpointOutputConfiguration' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'VariantName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'String', ], 'VariantName' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialInstanceCount' => [ 'shape' => 'InitialInstanceCount', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], ], ], 'EndpointPerformance' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointInfo', ], 'members' => [ 'Metrics' => [ 'shape' => 'InferenceMetrics', ], 'EndpointInfo' => [ 'shape' => 'EndpointInfo', ], ], ], 'EndpointPerformances' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointPerformance', ], 'max' => 1, ], 'EndpointSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'EndpointStatus' => [ 'type' => 'string', 'enum' => [ 'OutOfService', 'Creating', 'Updating', 'SystemUpdating', 'RollingBack', 'InService', 'Deleting', 'Failed', 'UpdateRollbackFailed', ], ], 'EndpointSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'EndpointSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointSummary', ], ], 'Endpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'EndpointInfo', ], 'max' => 1, ], 'EntityDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'EntityName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'EnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'EnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'EnvironmentKey', ], 'value' => [ 'shape' => 'EnvironmentValue', ], 'max' => 16, ], 'EnvironmentParameter' => [ 'type' => 'structure', 'required' => [ 'Key', 'ValueType', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'String', ], 'ValueType' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'EnvironmentParameterRanges' => [ 'type' => 'structure', 'members' => [ 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameters', ], ], ], 'EnvironmentParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'EnvironmentParameter', ], 'max' => 10, 'min' => 1, ], 'EnvironmentValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'ExcludeFeaturesAttribute' => [ 'type' => 'string', 'max' => 100, ], 'ExecutionRoleIdentityConfig' => [ 'type' => 'string', 'enum' => [ 'USER_PROFILE_NAME', 'DISABLED', ], ], 'ExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Completed', 'CompletedWithViolations', 'InProgress', 'Failed', 'Stopping', 'Stopped', ], ], 'ExitMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[\\S\\s]*', ], 'Experiment' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'ExperimentSource', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/.*', ], 'ExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentDisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ExperimentDescription' => [ 'type' => 'string', 'max' => 3072, 'pattern' => '.*', ], 'ExperimentEntityName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'ExperimentEntityNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'ExperimentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'ExperimentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'ExperimentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'ExperimentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExperimentSummary', ], ], 'ExperimentSummary' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentSource' => [ 'shape' => 'ExperimentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ExpiresInSeconds' => [ 'type' => 'integer', 'max' => 300, 'min' => 5, ], 'Explainability' => [ 'type' => 'structure', 'members' => [ 'Report' => [ 'shape' => 'MetricsSource', ], ], ], 'ExplainabilityLocation' => [ 'type' => 'string', 'min' => 1, ], 'ExplainerConfig' => [ 'type' => 'structure', 'members' => [ 'ClarifyExplainerConfig' => [ 'shape' => 'ClarifyExplainerConfig', ], ], ], 'FailStepMetadata' => [ 'type' => 'structure', 'members' => [ 'ErrorMessage' => [ 'shape' => 'String3072', ], ], ], 'FailureHandlingPolicy' => [ 'type' => 'string', 'enum' => [ 'ROLLBACK_ON_FAILURE', 'DO_NOTHING', ], ], 'FailureReason' => [ 'type' => 'string', 'max' => 1024, ], 'FeatureAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 100, 'min' => 1, ], 'FeatureDefinition' => [ 'type' => 'structure', 'required' => [ 'FeatureName', 'FeatureType', ], 'members' => [ 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CollectionType' => [ 'shape' => 'CollectionType', ], 'CollectionConfig' => [ 'shape' => 'CollectionConfig', ], ], ], 'FeatureDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureDefinition', ], 'max' => 2500, 'min' => 1, ], 'FeatureDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 0, 'pattern' => '.*', ], 'FeatureGroup' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'RecordIdentifierFeatureName' => [ 'shape' => 'FeatureName', ], 'EventTimeFeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureDefinitions' => [ 'shape' => 'FeatureDefinitions', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfig', ], 'OfflineStoreConfig' => [ 'shape' => 'OfflineStoreConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], 'LastUpdateStatus' => [ 'shape' => 'LastUpdateStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Description' => [ 'shape' => 'Description', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'FeatureGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/.*', ], 'FeatureGroupMaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'FeatureGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}', ], 'FeatureGroupNameContains' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'FeatureGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group\\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})', ], 'FeatureGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'FeatureGroupStatus', 'OfflineStoreStatus', 'CreationTime', ], ], 'FeatureGroupSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'FeatureGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'CreateFailed', 'Deleting', 'DeleteFailed', ], ], 'FeatureGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureGroupSummary', ], ], 'FeatureGroupSummary' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureGroupArn', 'CreationTime', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FeatureGroupStatus' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatus' => [ 'shape' => 'OfflineStoreStatus', ], ], ], 'FeatureMetadata' => [ 'type' => 'structure', 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'FeatureType' => [ 'shape' => 'FeatureType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'Parameters' => [ 'shape' => 'FeatureParameters', ], ], ], 'FeatureName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}', ], 'FeatureParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'FeatureParameterKey', ], 'Value' => [ 'shape' => 'FeatureParameterValue', ], ], ], 'FeatureParameterAdditions' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, ], 'FeatureParameterKey' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameterRemovals' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameterKey', ], 'max' => 25, ], 'FeatureParameterValue' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$', ], 'FeatureParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'FeatureParameter', ], 'max' => 25, 'min' => 0, ], 'FeatureStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'FeatureType' => [ 'type' => 'string', 'enum' => [ 'Integral', 'Fractional', 'String', ], ], 'FileSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'FileSystemAccessMode' => [ 'type' => 'string', 'enum' => [ 'rw', 'ro', ], ], 'FileSystemConfig' => [ 'type' => 'structure', 'members' => [ 'MountPath' => [ 'shape' => 'MountPath', ], 'DefaultUid' => [ 'shape' => 'DefaultUid', 'box' => true, ], 'DefaultGid' => [ 'shape' => 'DefaultGid', 'box' => true, ], ], ], 'FileSystemDataSource' => [ 'type' => 'structure', 'required' => [ 'FileSystemId', 'FileSystemAccessMode', 'FileSystemType', 'DirectoryPath', ], 'members' => [ 'FileSystemId' => [ 'shape' => 'FileSystemId', ], 'FileSystemAccessMode' => [ 'shape' => 'FileSystemAccessMode', ], 'FileSystemType' => [ 'shape' => 'FileSystemType', ], 'DirectoryPath' => [ 'shape' => 'DirectoryPath', ], ], ], 'FileSystemId' => [ 'type' => 'string', 'max' => 21, 'min' => 11, 'pattern' => '^(fs-[0-9a-f]{8,})$', ], 'FileSystemPath' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^\\/\\S*$', ], 'FileSystemType' => [ 'type' => 'string', 'enum' => [ 'EFS', 'FSxLustre', ], ], 'FillingTransformationMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'FillingType', ], 'value' => [ 'shape' => 'FillingTransformationValue', ], 'max' => 6, 'min' => 1, ], 'FillingTransformationValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\_\\-]+$', ], 'FillingTransformations' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformationAttributeName', ], 'value' => [ 'shape' => 'FillingTransformationMap', ], 'max' => 50, 'min' => 1, ], 'FillingType' => [ 'type' => 'string', 'enum' => [ 'frontfill', 'middlefill', 'backfill', 'futurefill', 'frontfill_value', 'middlefill_value', 'backfill_value', 'futurefill_value', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'ResourcePropertyName', ], 'Operator' => [ 'shape' => 'Operator', ], 'Value' => [ 'shape' => 'FilterValue', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], 'max' => 20, 'min' => 1, ], 'FilterValue' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'FinalAutoMLJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'AutoMLJobObjectiveType', ], 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'MetricValue', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricEnum', ], ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'type' => 'structure', 'required' => [ 'MetricName', 'Value', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'MetricValue', ], ], ], 'FinalMetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricData', ], 'max' => 40, 'min' => 0, ], 'FlatInvocations' => [ 'type' => 'string', 'enum' => [ 'Continue', 'Stop', ], ], 'Float' => [ 'type' => 'float', ], 'FlowDefinitionArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:flow-definition/.*', ], 'FlowDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9]){0,62}', ], 'FlowDefinitionOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'FlowDefinitionStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Active', 'Failed', 'Deleting', ], ], 'FlowDefinitionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionSummary', ], ], 'FlowDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionName', 'FlowDefinitionArn', 'FlowDefinitionStatus', 'CreationTime', ], 'members' => [ 'FlowDefinitionName' => [ 'shape' => 'FlowDefinitionName', ], 'FlowDefinitionArn' => [ 'shape' => 'FlowDefinitionArn', ], 'FlowDefinitionStatus' => [ 'shape' => 'FlowDefinitionStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'FlowDefinitionTaskCount' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'FlowDefinitionTaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'FlowDefinitionTaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'FlowDefinitionTaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowDefinitionTaskKeyword', ], 'max' => 5, 'min' => 1, ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'type' => 'integer', 'min' => 30, ], 'FlowDefinitionTaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'ForecastFrequency' => [ 'type' => 'string', 'max' => 5, 'min' => 1, 'pattern' => '^1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min$', ], 'ForecastHorizon' => [ 'type' => 'integer', 'min' => 1, ], 'ForecastQuantile' => [ 'type' => 'string', 'max' => 4, 'min' => 2, 'pattern' => '(^p[1-9]\\d?$)', ], 'ForecastQuantiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ForecastQuantile', ], 'max' => 5, 'min' => 1, ], 'Framework' => [ 'type' => 'string', 'enum' => [ 'TENSORFLOW', 'KERAS', 'MXNET', 'ONNX', 'PYTORCH', 'XGBOOST', 'TFLITE', 'DARKNET', 'SKLEARN', ], ], 'FrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.]+', ], 'GenerateCandidateDefinitionsOnly' => [ 'type' => 'boolean', ], 'GetDeviceFleetReportRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'GetDeviceFleetReportResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetArn', 'DeviceFleetName', ], 'members' => [ 'DeviceFleetArn' => [ 'shape' => 'DeviceFleetArn', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'ReportGenerated' => [ 'shape' => 'Timestamp', ], 'DeviceStats' => [ 'shape' => 'DeviceStats', ], 'AgentVersions' => [ 'shape' => 'AgentVersions', ], 'ModelStats' => [ 'shape' => 'EdgeModelStats', ], ], ], 'GetLineageGroupPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'LineageGroupName', ], 'members' => [ 'LineageGroupName' => [ 'shape' => 'LineageGroupNameOrArn', ], ], ], 'GetLineageGroupPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'ResourcePolicy' => [ 'shape' => 'ResourcePolicyString', ], ], ], 'GetModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], ], ], 'GetModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ResourcePolicy', ], 'members' => [ 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'type' => 'structure', 'members' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'SagemakerServicecatalogStatus', ], ], ], 'GetScalingConfigurationRecommendationRequest' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobName', ], 'members' => [ 'InferenceRecommendationsJobName' => [ 'shape' => 'RecommendationJobName', ], 'RecommendationId' => [ 'shape' => 'String', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'TargetCpuUtilizationPerCore' => [ 'shape' => 'UtilizationPercentagePerCore', ], 'ScalingPolicyObjective' => [ 'shape' => 'ScalingPolicyObjective', ], ], ], 'GetScalingConfigurationRecommendationResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceRecommendationsJobName' => [ 'shape' => 'RecommendationJobName', ], 'RecommendationId' => [ 'shape' => 'String', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'TargetCpuUtilizationPerCore' => [ 'shape' => 'UtilizationPercentagePerCore', ], 'ScalingPolicyObjective' => [ 'shape' => 'ScalingPolicyObjective', ], 'Metric' => [ 'shape' => 'ScalingPolicyMetric', ], 'DynamicScalingConfiguration' => [ 'shape' => 'DynamicScalingConfiguration', ], ], ], 'GetSearchSuggestionsRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SuggestionQuery' => [ 'shape' => 'SuggestionQuery', ], ], ], 'GetSearchSuggestionsResponse' => [ 'type' => 'structure', 'members' => [ 'PropertyNameSuggestions' => [ 'shape' => 'PropertyNameSuggestionList', ], ], ], 'Gid' => [ 'type' => 'long', 'max' => 4000000, 'min' => 1001, ], 'GitConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryUrl', ], 'members' => [ 'RepositoryUrl' => [ 'shape' => 'GitConfigUrl', ], 'Branch' => [ 'shape' => 'Branch', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'GitConfigUrl' => [ 'type' => 'string', 'max' => 1024, 'min' => 11, 'pattern' => '^https://([^/]+)/?.{3,1016}$', ], 'Group' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+', ], 'GroupingAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'GroupingAttributeNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupingAttributeName', ], 'max' => 5, 'min' => 1, ], 'Groups' => [ 'type' => 'list', 'member' => [ 'shape' => 'Group', ], 'max' => 10, 'min' => 1, ], 'HolidayConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'HolidayConfigAttributes', ], 'max' => 1, 'min' => 1, ], 'HolidayConfigAttributes' => [ 'type' => 'structure', 'members' => [ 'CountryCode' => [ 'shape' => 'CountryCode', ], ], ], 'HookParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'Horovod' => [ 'type' => 'boolean', ], 'HubArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentArn' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDependency' => [ 'type' => 'structure', 'members' => [ 'DependencyOriginPath' => [ 'shape' => 'DependencyOriginPath', ], 'DependencyCopyPath' => [ 'shape' => 'DependencyCopyPath', ], ], ], 'HubContentDependencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentDependency', ], 'max' => 50, ], 'HubContentDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubContentDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubContentDocument' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentInfo' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentArn', 'HubContentVersion', 'HubContentType', 'DocumentSchemaVersion', 'HubContentStatus', 'CreationTime', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'HubContentStatus' => [ 'shape' => 'HubContentStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubContentInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubContentInfo', ], ], 'HubContentMarkdown' => [ 'type' => 'string', 'max' => 65535, 'pattern' => '.*', ], 'HubContentName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubContentSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubContentSortBy' => [ 'type' => 'string', 'enum' => [ 'HubContentName', 'CreationTime', 'HubContentStatus', ], ], 'HubContentStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Importing', 'Deleting', 'ImportFailed', 'DeleteFailed', ], ], 'HubContentType' => [ 'type' => 'string', 'enum' => [ 'Model', 'Notebook', ], ], 'HubContentVersion' => [ 'type' => 'string', 'max' => 14, 'min' => 5, 'pattern' => '^\\d{1,4}.\\d{1,4}.\\d{1,4}$', ], 'HubDescription' => [ 'type' => 'string', 'max' => 1023, 'pattern' => '.*', ], 'HubDisplayName' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'HubInfo' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubArn', 'HubStatus', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubArn' => [ 'shape' => 'HubArn', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], 'HubStatus' => [ 'shape' => 'HubStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HubInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubInfo', ], ], 'HubName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'HubS3StorageConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3OutputPath', ], ], ], 'HubSearchKeyword' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[^A-Z]*$', ], 'HubSearchKeywordList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HubSearchKeyword', ], 'max' => 50, ], 'HubSortBy' => [ 'type' => 'string', 'enum' => [ 'HubName', 'CreationTime', 'HubStatus', 'AccountIdOwner', ], ], 'HubStatus' => [ 'type' => 'string', 'enum' => [ 'InService', 'Creating', 'Updating', 'Deleting', 'CreateFailed', 'UpdateFailed', 'DeleteFailed', ], ], 'HumanLoopActivationConditions' => [ 'type' => 'string', 'max' => 10240, ], 'HumanLoopActivationConditionsConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditions', ], 'members' => [ 'HumanLoopActivationConditions' => [ 'shape' => 'HumanLoopActivationConditions', 'jsonvalue' => true, ], ], ], 'HumanLoopActivationConfig' => [ 'type' => 'structure', 'required' => [ 'HumanLoopActivationConditionsConfig', ], 'members' => [ 'HumanLoopActivationConditionsConfig' => [ 'shape' => 'HumanLoopActivationConditionsConfig', ], ], ], 'HumanLoopConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'HumanTaskUiArn', 'TaskTitle', 'TaskDescription', 'TaskCount', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'TaskTitle' => [ 'shape' => 'FlowDefinitionTaskTitle', ], 'TaskDescription' => [ 'shape' => 'FlowDefinitionTaskDescription', ], 'TaskCount' => [ 'shape' => 'FlowDefinitionTaskCount', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'FlowDefinitionTaskAvailabilityLifetimeInSeconds', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'FlowDefinitionTaskTimeLimitInSeconds', ], 'TaskKeywords' => [ 'shape' => 'FlowDefinitionTaskKeywords', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanLoopRequestSource' => [ 'type' => 'structure', 'required' => [ 'AwsManagedHumanLoopRequestSource', ], 'members' => [ 'AwsManagedHumanLoopRequestSource' => [ 'shape' => 'AwsManagedHumanLoopRequestSource', ], ], ], 'HumanTaskConfig' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', 'UiConfig', 'PreHumanTaskLambdaArn', 'TaskTitle', 'TaskDescription', 'NumberOfHumanWorkersPerDataObject', 'TaskTimeLimitInSeconds', 'AnnotationConsolidationConfig', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'UiConfig' => [ 'shape' => 'UiConfig', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'TaskKeywords' => [ 'shape' => 'TaskKeywords', ], 'TaskTitle' => [ 'shape' => 'TaskTitle', ], 'TaskDescription' => [ 'shape' => 'TaskDescription', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], 'TaskTimeLimitInSeconds' => [ 'shape' => 'TaskTimeLimitInSeconds', ], 'TaskAvailabilityLifetimeInSeconds' => [ 'shape' => 'TaskAvailabilityLifetimeInSeconds', ], 'MaxConcurrentTaskCount' => [ 'shape' => 'MaxConcurrentTaskCount', ], 'AnnotationConsolidationConfig' => [ 'shape' => 'AnnotationConsolidationConfig', ], 'PublicWorkforceTaskPrice' => [ 'shape' => 'PublicWorkforceTaskPrice', ], ], ], 'HumanTaskUiArn' => [ 'type' => 'string', 'max' => 1024, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:human-task-ui/.*', ], 'HumanTaskUiName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-z0-9](-*[a-z0-9])*', ], 'HumanTaskUiStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'HumanTaskUiSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HumanTaskUiSummary', ], ], 'HumanTaskUiSummary' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiName', 'HumanTaskUiArn', 'CreationTime', ], 'members' => [ 'HumanTaskUiName' => [ 'shape' => 'HumanTaskUiName', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'AlgorithmImage', ], 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], ], ], 'HyperParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'HyperParameterScalingType' => [ 'type' => 'string', 'enum' => [ 'Auto', 'Linear', 'Logarithmic', 'ReverseLogarithmic', ], ], 'HyperParameterSpecification' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterName', ], 'Description' => [ 'shape' => 'EntityDescription', ], 'Type' => [ 'shape' => 'ParameterType', ], 'Range' => [ 'shape' => 'ParameterRange', ], 'IsTunable' => [ 'shape' => 'Boolean', ], 'IsRequired' => [ 'shape' => 'Boolean', ], 'DefaultValue' => [ 'shape' => 'HyperParameterValue', ], ], ], 'HyperParameterSpecifications' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterSpecification', ], 'max' => 100, 'min' => 0, ], 'HyperParameterTrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSpecification', 'RoleArn', 'OutputDataConfig', 'StoppingCondition', ], 'members' => [ 'DefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TuningObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'HyperParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'StaticHyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'HyperParameterAlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'HyperParameterTuningResourceConfig' => [ 'shape' => 'HyperParameterTuningResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Environment' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentMap', ], ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'HyperParameterTrainingJobDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'max' => 10, 'min' => 1, ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentKey', ], 'value' => [ 'shape' => 'HyperParameterTrainingJobEnvironmentValue', ], 'max' => 48, ], 'HyperParameterTrainingJobEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'HyperParameterTrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], ], 'HyperParameterTrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', 'TunedHyperParameters', ], 'members' => [ 'TrainingJobDefinitionName' => [ 'shape' => 'HyperParameterTrainingJobDefinitionName', ], 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'TunedHyperParameters' => [ 'shape' => 'HyperParameters', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'shape' => 'FinalHyperParameterTuningJobObjectiveMetric', ], 'ObjectiveStatus' => [ 'shape' => 'ObjectiveStatus', ], ], ], 'HyperParameterTuningAllocationStrategy' => [ 'type' => 'string', 'enum' => [ 'Prioritized', ], ], 'HyperParameterTuningInstanceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], ], ], 'HyperParameterTuningInstanceConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningInstanceConfig', ], 'max' => 6, 'min' => 1, ], 'HyperParameterTuningJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*', ], 'HyperParameterTuningJobCompletionDetails' => [ 'type' => 'structure', 'members' => [ 'NumberOfTrainingJobsObjectiveNotImproving' => [ 'shape' => 'Integer', ], 'ConvergenceDetectedTime' => [ 'shape' => 'Timestamp', ], ], ], 'HyperParameterTuningJobConfig' => [ 'type' => 'structure', 'required' => [ 'Strategy', 'ResourceLimits', ], 'members' => [ 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'StrategyConfig' => [ 'shape' => 'HyperParameterTuningJobStrategyConfig', ], 'HyperParameterTuningJobObjective' => [ 'shape' => 'HyperParameterTuningJobObjective', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], 'ParameterRanges' => [ 'shape' => 'ParameterRanges', ], 'TrainingJobEarlyStoppingType' => [ 'shape' => 'TrainingJobEarlyStoppingType', ], 'TuningJobCompletionCriteria' => [ 'shape' => 'TuningJobCompletionCriteria', ], 'RandomSeed' => [ 'shape' => 'RandomSeed', ], ], ], 'HyperParameterTuningJobConsumedResources' => [ 'type' => 'structure', 'members' => [ 'RuntimeInSeconds' => [ 'shape' => 'Integer', ], ], ], 'HyperParameterTuningJobName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'HyperParameterTuningJobObjective' => [ 'type' => 'structure', 'required' => [ 'Type', 'MetricName', ], 'members' => [ 'Type' => [ 'shape' => 'HyperParameterTuningJobObjectiveType', ], 'MetricName' => [ 'shape' => 'MetricName', ], ], ], 'HyperParameterTuningJobObjectiveType' => [ 'type' => 'string', 'enum' => [ 'Maximize', 'Minimize', ], ], 'HyperParameterTuningJobObjectives' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobObjective', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobConfig' => [ 'shape' => 'HyperParameterTuningJobConfig', ], 'TrainingJobDefinition' => [ 'shape' => 'HyperParameterTrainingJobDefinition', ], 'TrainingJobDefinitions' => [ 'shape' => 'HyperParameterTrainingJobDefinitions', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'BestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'OverallBestTrainingJob' => [ 'shape' => 'HyperParameterTrainingJobSummary', ], 'WarmStartConfig' => [ 'shape' => 'HyperParameterTuningJobWarmStartConfig', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'TuningJobCompletionDetails' => [ 'shape' => 'HyperParameterTuningJobCompletionDetails', ], 'ConsumedResources' => [ 'shape' => 'HyperParameterTuningJobConsumedResources', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'HyperParameterTuningJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'Status', 'CreationTime', ], ], 'HyperParameterTuningJobStatus' => [ 'type' => 'string', 'enum' => [ 'Completed', 'InProgress', 'Failed', 'Stopped', 'Stopping', 'Deleting', 'DeleteFailed', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'HyperbandStrategyConfig' => [ 'shape' => 'HyperbandStrategyConfig', ], ], ], 'HyperParameterTuningJobStrategyType' => [ 'type' => 'string', 'enum' => [ 'Bayesian', 'Random', 'Hyperband', 'Grid', ], ], 'HyperParameterTuningJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'HyperParameterTuningJobSummary', ], ], 'HyperParameterTuningJobSummary' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', 'HyperParameterTuningJobArn', 'HyperParameterTuningJobStatus', 'Strategy', 'CreationTime', 'TrainingJobStatusCounters', 'ObjectiveStatusCounters', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'HyperParameterTuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'HyperParameterTuningJobStatus' => [ 'shape' => 'HyperParameterTuningJobStatus', ], 'Strategy' => [ 'shape' => 'HyperParameterTuningJobStrategyType', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'HyperParameterTuningEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatusCounters' => [ 'shape' => 'TrainingJobStatusCounters', ], 'ObjectiveStatusCounters' => [ 'shape' => 'ObjectiveStatusCounters', ], 'ResourceLimits' => [ 'shape' => 'ResourceLimits', ], ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'type' => 'structure', 'required' => [ 'ParentHyperParameterTuningJobs', 'WarmStartType', ], 'members' => [ 'ParentHyperParameterTuningJobs' => [ 'shape' => 'ParentHyperParameterTuningJobs', ], 'WarmStartType' => [ 'shape' => 'HyperParameterTuningJobWarmStartType', ], ], ], 'HyperParameterTuningJobWarmStartType' => [ 'type' => 'string', 'enum' => [ 'IdenticalDataAndAlgorithm', 'TransferLearning', ], ], 'HyperParameterTuningMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 15768000, 'min' => 120, ], 'HyperParameterTuningResourceConfig' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'AllocationStrategy' => [ 'shape' => 'HyperParameterTuningAllocationStrategy', ], 'InstanceConfigs' => [ 'shape' => 'HyperParameterTuningInstanceConfigs', ], ], ], 'HyperParameterValue' => [ 'type' => 'string', 'max' => 2500, 'pattern' => '.*', ], 'HyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'HyperParameterKey', ], 'value' => [ 'shape' => 'HyperParameterValue', ], 'max' => 100, 'min' => 0, ], 'HyperbandStrategyConfig' => [ 'type' => 'structure', 'members' => [ 'MinResource' => [ 'shape' => 'HyperbandStrategyMinResource', ], 'MaxResource' => [ 'shape' => 'HyperbandStrategyMaxResource', ], ], ], 'HyperbandStrategyMaxResource' => [ 'type' => 'integer', 'min' => 1, ], 'HyperbandStrategyMinResource' => [ 'type' => 'integer', 'min' => 1, ], 'IamIdentity' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String', ], 'PrincipalId' => [ 'shape' => 'String', ], 'SourceIdentity' => [ 'shape' => 'String', ], ], ], 'IdempotencyToken' => [ 'type' => 'string', 'max' => 128, 'min' => 32, ], 'IdentityProviderOAuthSetting' => [ 'type' => 'structure', 'members' => [ 'DataSourceName' => [ 'shape' => 'DataSourceName', ], 'Status' => [ 'shape' => 'FeatureStatus', ], 'SecretArn' => [ 'shape' => 'SecretArn', ], ], ], 'IdentityProviderOAuthSettings' => [ 'type' => 'list', 'member' => [ 'shape' => 'IdentityProviderOAuthSetting', ], 'max' => 20, ], 'Image' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageName', 'ImageStatus', 'LastModifiedTime', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'ImageStatus' => [ 'shape' => 'ImageStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ImageArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$', ], 'ImageBaseImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'ImageClassificationJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ImageConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryAccessMode', ], 'members' => [ 'RepositoryAccessMode' => [ 'shape' => 'RepositoryAccessMode', ], 'RepositoryAuthConfig' => [ 'shape' => 'RepositoryAuthConfig', ], ], ], 'ImageContainerImage' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'ImageDeleteProperty' => [ 'type' => 'string', 'max' => 11, 'min' => 1, 'pattern' => '(^DisplayName$)|(^Description$)', ], 'ImageDeletePropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageDeleteProperty', ], 'max' => 2, ], 'ImageDescription' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '.*', ], 'ImageDigest' => [ 'type' => 'string', 'max' => 72, 'pattern' => '^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$', ], 'ImageDisplayName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^\\S(.*\\S)?$', ], 'ImageName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$', ], 'ImageNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9\\-.]+$', ], 'ImageSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'IMAGE_NAME', ], ], 'ImageSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'UPDATING', 'UPDATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageUri' => [ 'type' => 'string', 'max' => 255, 'pattern' => '.*', ], 'ImageVersion' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'ImageArn', 'ImageVersionArn', 'ImageVersionStatus', 'LastModifiedTime', 'Version', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ImageArn' => [ 'shape' => 'ImageArn', ], 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'ImageVersionStatus' => [ 'shape' => 'ImageVersionStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], ], ], 'ImageVersionAlias' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(^\\d+$)|(^\\d+.\\d+$)|(^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$)', ], 'ImageVersionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$', ], 'ImageVersionNumber' => [ 'type' => 'integer', 'min' => 0, ], 'ImageVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'VERSION', ], ], 'ImageVersionSortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'ImageVersionStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'CREATED', 'CREATE_FAILED', 'DELETING', 'DELETE_FAILED', ], ], 'ImageVersions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImageVersion', ], ], 'Images' => [ 'type' => 'list', 'member' => [ 'shape' => 'Image', ], ], 'ImportHubContentRequest' => [ 'type' => 'structure', 'required' => [ 'HubContentName', 'HubContentType', 'DocumentSchemaVersion', 'HubName', 'HubContentDocument', ], 'members' => [ 'HubContentName' => [ 'shape' => 'HubContentName', ], 'HubContentVersion' => [ 'shape' => 'HubContentVersion', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'DocumentSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'HubName' => [ 'shape' => 'HubName', ], 'HubContentDisplayName' => [ 'shape' => 'HubContentDisplayName', ], 'HubContentDescription' => [ 'shape' => 'HubContentDescription', ], 'HubContentMarkdown' => [ 'shape' => 'HubContentMarkdown', ], 'HubContentDocument' => [ 'shape' => 'HubContentDocument', ], 'HubContentSearchKeywords' => [ 'shape' => 'HubContentSearchKeywordList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ImportHubContentResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', 'HubContentArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], 'HubContentArn' => [ 'shape' => 'HubContentArn', ], ], ], 'InferenceComponentArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'InferenceComponentComputeResourceRequirements' => [ 'type' => 'structure', 'required' => [ 'MinMemoryRequiredInMb', ], 'members' => [ 'NumberOfCpuCoresRequired' => [ 'shape' => 'NumberOfCpuCores', ], 'NumberOfAcceleratorDevicesRequired' => [ 'shape' => 'NumberOfAcceleratorDevices', ], 'MinMemoryRequiredInMb' => [ 'shape' => 'MemoryInMb', ], 'MaxMemoryRequiredInMb' => [ 'shape' => 'MemoryInMb', ], ], ], 'InferenceComponentContainerSpecification' => [ 'type' => 'structure', 'members' => [ 'Image' => [ 'shape' => 'ContainerImage', ], 'ArtifactUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'InferenceComponentContainerSpecificationSummary' => [ 'type' => 'structure', 'members' => [ 'DeployedImage' => [ 'shape' => 'DeployedImage', ], 'ArtifactUrl' => [ 'shape' => 'Url', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'InferenceComponentCopyCount' => [ 'type' => 'integer', 'min' => 0, ], 'InferenceComponentName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$', ], 'InferenceComponentNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'InferenceComponentRuntimeConfig' => [ 'type' => 'structure', 'required' => [ 'CopyCount', ], 'members' => [ 'CopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], ], ], 'InferenceComponentRuntimeConfigSummary' => [ 'type' => 'structure', 'members' => [ 'DesiredCopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], 'CurrentCopyCount' => [ 'shape' => 'InferenceComponentCopyCount', ], ], ], 'InferenceComponentSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'InferenceComponentSpecification' => [ 'type' => 'structure', 'required' => [ 'ComputeResourceRequirements', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'Container' => [ 'shape' => 'InferenceComponentContainerSpecification', ], 'StartupParameters' => [ 'shape' => 'InferenceComponentStartupParameters', ], 'ComputeResourceRequirements' => [ 'shape' => 'InferenceComponentComputeResourceRequirements', ], ], ], 'InferenceComponentSpecificationSummary' => [ 'type' => 'structure', 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'Container' => [ 'shape' => 'InferenceComponentContainerSpecificationSummary', ], 'StartupParameters' => [ 'shape' => 'InferenceComponentStartupParameters', ], 'ComputeResourceRequirements' => [ 'shape' => 'InferenceComponentComputeResourceRequirements', ], ], ], 'InferenceComponentStartupParameters' => [ 'type' => 'structure', 'members' => [ 'ModelDataDownloadTimeoutInSeconds' => [ 'shape' => 'ProductionVariantModelDataDownloadTimeoutInSeconds', ], 'ContainerStartupHealthCheckTimeoutInSeconds' => [ 'shape' => 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds', ], ], ], 'InferenceComponentStatus' => [ 'type' => 'string', 'enum' => [ 'InService', 'Creating', 'Updating', 'Failed', 'Deleting', ], ], 'InferenceComponentSummary' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'InferenceComponentArn', 'InferenceComponentName', 'EndpointArn', 'EndpointName', 'VariantName', 'LastModifiedTime', ], 'members' => [ 'CreationTime' => [ 'shape' => 'Timestamp', ], 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'VariantName' => [ 'shape' => 'VariantName', ], 'InferenceComponentStatus' => [ 'shape' => 'InferenceComponentStatus', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'InferenceComponentSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceComponentSummary', ], ], 'InferenceExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'Mode', ], 'members' => [ 'Mode' => [ 'shape' => 'InferenceExecutionMode', ], ], ], 'InferenceExecutionMode' => [ 'type' => 'string', 'enum' => [ 'Serial', 'Direct', ], ], 'InferenceExperimentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/.*', ], 'InferenceExperimentDataStorageConfig' => [ 'type' => 'structure', 'required' => [ 'Destination', ], 'members' => [ 'Destination' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKey' => [ 'shape' => 'KmsKeyId', ], 'ContentType' => [ 'shape' => 'CaptureContentTypeHeader', ], ], ], 'InferenceExperimentDescription' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceExperimentSummary', ], ], 'InferenceExperimentName' => [ 'type' => 'string', 'max' => 120, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}', ], 'InferenceExperimentSchedule' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'InferenceExperimentStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Created', 'Updating', 'Running', 'Starting', 'Stopping', 'Completed', 'Cancelled', ], ], 'InferenceExperimentStatusReason' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'InferenceExperimentStopDesiredState' => [ 'type' => 'string', 'enum' => [ 'Completed', 'Cancelled', ], ], 'InferenceExperimentSummary' => [ 'type' => 'structure', 'required' => [ 'Name', 'Type', 'Status', 'CreationTime', 'LastModifiedTime', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Status' => [ 'shape' => 'InferenceExperimentStatus', ], 'StatusReason' => [ 'shape' => 'InferenceExperimentStatusReason', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'InferenceExperimentType' => [ 'type' => 'string', 'enum' => [ 'ShadowMode', ], ], 'InferenceImage' => [ 'type' => 'string', 'max' => 256, ], 'InferenceMetrics' => [ 'type' => 'structure', 'required' => [ 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'InferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'Metrics', 'EndpointConfiguration', 'ModelConfiguration', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'InferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendation', ], 'max' => 10, 'min' => 1, ], 'InferenceRecommendationsJob' => [ 'type' => 'structure', 'required' => [ 'JobName', 'JobDescription', 'JobType', 'JobArn', 'Status', 'CreationTime', 'RoleArn', 'LastModifiedTime', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'JobDescription' => [ 'shape' => 'RecommendationJobDescription', ], 'JobType' => [ 'shape' => 'RecommendationJobType', ], 'JobArn' => [ 'shape' => 'RecommendationJobArn', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CompletionTime' => [ 'shape' => 'Timestamp', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'InferenceRecommendationsJobStep' => [ 'type' => 'structure', 'required' => [ 'StepType', 'JobName', 'Status', ], 'members' => [ 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'InferenceBenchmark' => [ 'shape' => 'RecommendationJobInferenceBenchmark', ], ], ], 'InferenceRecommendationsJobSteps' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJobStep', ], ], 'InferenceRecommendationsJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'InferenceRecommendationsJob', ], ], 'InferenceSpecification' => [ 'type' => 'structure', 'required' => [ 'Containers', ], 'members' => [ 'Containers' => [ 'shape' => 'ModelPackageContainerDefinitionList', ], 'SupportedTransformInstanceTypes' => [ 'shape' => 'TransformInstanceTypes', ], 'SupportedRealtimeInferenceInstanceTypes' => [ 'shape' => 'RealtimeInferenceInstanceTypes', ], 'SupportedContentTypes' => [ 'shape' => 'ContentTypes', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'ResponseMIMETypes', ], ], ], 'InferenceSpecificationName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'InfraCheckConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInfraCheck' => [ 'shape' => 'EnableInfraCheck', ], ], ], 'InitialInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'InitialNumberOfUsers' => [ 'type' => 'integer', 'min' => 1, ], 'InitialTaskCount' => [ 'type' => 'integer', 'min' => 1, ], 'InputConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'Framework', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], 'Framework' => [ 'shape' => 'Framework', ], 'FrameworkVersion' => [ 'shape' => 'FrameworkVersion', ], ], ], 'InputDataConfig' => [ 'type' => 'list', 'member' => [ 'shape' => 'Channel', ], 'max' => 20, 'min' => 1, ], 'InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'InputModes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInputMode', ], 'min' => 1, ], 'InstanceGroup' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', 'InstanceGroupName', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'InstanceGroupName' => [ 'shape' => 'InstanceGroupName', ], ], ], 'InstanceGroupName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.+', ], 'InstanceGroupNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupName', ], 'max' => 5, ], 'InstanceGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroup', ], 'max' => 5, ], 'InstanceMetadataServiceConfiguration' => [ 'type' => 'structure', 'required' => [ 'MinimumInstanceMetadataServiceVersion', ], 'members' => [ 'MinimumInstanceMetadataServiceVersion' => [ 'shape' => 'MinimumInstanceMetadataServiceVersion', ], ], ], 'InstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.8xlarge', 'ml.m5d.12xlarge', 'ml.m5d.16xlarge', 'ml.m5d.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', ], ], 'Integer' => [ 'type' => 'integer', ], 'IntegerParameterRange' => [ 'type' => 'structure', 'required' => [ 'Name', 'MinValue', 'MaxValue', ], 'members' => [ 'Name' => [ 'shape' => 'ParameterKey', ], 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], 'ScalingType' => [ 'shape' => 'HyperParameterScalingType', ], ], ], 'IntegerParameterRangeSpecification' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'ParameterValue', ], 'MaxValue' => [ 'shape' => 'ParameterValue', ], ], ], 'IntegerParameterRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegerParameterRange', ], 'max' => 30, 'min' => 0, ], 'InvocationEndTime' => [ 'type' => 'timestamp', ], 'InvocationStartTime' => [ 'type' => 'timestamp', ], 'InvocationsMaxRetries' => [ 'type' => 'integer', 'max' => 3, 'min' => 0, ], 'InvocationsTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 1, ], 'IotRoleAlias' => [ 'type' => 'string', 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'ItemIdentifierAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'JobDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'JobReferenceCode' => [ 'type' => 'string', 'min' => 1, 'pattern' => '.+', ], 'JobReferenceCodeContains' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'JobType' => [ 'type' => 'string', 'enum' => [ 'TRAINING', 'INFERENCE', 'NOTEBOOK_KERNEL', ], ], 'JoinSource' => [ 'type' => 'string', 'enum' => [ 'Input', 'None', ], ], 'JsonContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*', ], 'JsonContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'JsonContentType', ], 'max' => 10, 'min' => 1, ], 'JsonPath' => [ 'type' => 'string', 'max' => 63, 'min' => 0, ], 'JupyterLabAppImageConfig' => [ 'type' => 'structure', 'members' => [ 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], 'ContainerConfig' => [ 'shape' => 'ContainerConfig', ], ], ], 'JupyterLabAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'JupyterServerAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'KeepAlivePeriodInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'KendraSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], ], ], 'KernelDisplayName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelGatewayAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], 'LifecycleConfigArns' => [ 'shape' => 'LifecycleConfigArns', ], ], ], 'KernelGatewayImageConfig' => [ 'type' => 'structure', 'required' => [ 'KernelSpecs', ], 'members' => [ 'KernelSpecs' => [ 'shape' => 'KernelSpecs', ], 'FileSystemConfig' => [ 'shape' => 'FileSystemConfig', ], ], ], 'KernelName' => [ 'type' => 'string', 'max' => 1024, ], 'KernelSpec' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'KernelName', ], 'DisplayName' => [ 'shape' => 'KernelDisplayName', ], ], ], 'KernelSpecs' => [ 'type' => 'list', 'member' => [ 'shape' => 'KernelSpec', ], 'max' => 5, 'min' => 1, ], 'Key' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'KmsKeyId' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'LabelAttributeName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}', ], 'LabelCounter' => [ 'type' => 'integer', 'min' => 0, ], 'LabelCounters' => [ 'type' => 'structure', 'members' => [ 'TotalLabeled' => [ 'shape' => 'LabelCounter', ], 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'MachineLabeled' => [ 'shape' => 'LabelCounter', ], 'FailedNonRetryableError' => [ 'shape' => 'LabelCounter', ], 'Unlabeled' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelCountersForWorkteam' => [ 'type' => 'structure', 'members' => [ 'HumanLabeled' => [ 'shape' => 'LabelCounter', ], 'PendingHuman' => [ 'shape' => 'LabelCounter', ], 'Total' => [ 'shape' => 'LabelCounter', ], ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:.*', ], 'LabelingJobAlgorithmsConfig' => [ 'type' => 'structure', 'required' => [ 'LabelingJobAlgorithmSpecificationArn', ], 'members' => [ 'LabelingJobAlgorithmSpecificationArn' => [ 'shape' => 'LabelingJobAlgorithmSpecificationArn', ], 'InitialActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], 'LabelingJobResourceConfig' => [ 'shape' => 'LabelingJobResourceConfig', ], ], ], 'LabelingJobArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:labeling-job/.*', ], 'LabelingJobDataAttributes' => [ 'type' => 'structure', 'members' => [ 'ContentClassifiers' => [ 'shape' => 'ContentClassifiers', ], ], ], 'LabelingJobDataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'LabelingJobS3DataSource', ], 'SnsDataSource' => [ 'shape' => 'LabelingJobSnsDataSource', ], ], ], 'LabelingJobForWorkteamSummary' => [ 'type' => 'structure', 'required' => [ 'JobReferenceCode', 'WorkRequesterAccountId', 'CreationTime', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'JobReferenceCode' => [ 'shape' => 'JobReferenceCode', ], 'WorkRequesterAccountId' => [ 'shape' => 'AccountId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LabelCounters' => [ 'shape' => 'LabelCountersForWorkteam', ], 'NumberOfHumanWorkersPerDataObject' => [ 'shape' => 'NumberOfHumanWorkersPerDataObject', ], ], ], 'LabelingJobForWorkteamSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobForWorkteamSummary', ], ], 'LabelingJobInputConfig' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'LabelingJobDataSource', ], 'DataAttributes' => [ 'shape' => 'LabelingJobDataAttributes', ], ], ], 'LabelingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'LabelingJobOutput' => [ 'type' => 'structure', 'required' => [ 'OutputDatasetS3Uri', ], 'members' => [ 'OutputDatasetS3Uri' => [ 'shape' => 'S3Uri', ], 'FinalActiveLearningModelArn' => [ 'shape' => 'ModelArn', ], ], ], 'LabelingJobOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobResourceConfig' => [ 'type' => 'structure', 'members' => [ 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'LabelingJobS3DataSource' => [ 'type' => 'structure', 'required' => [ 'ManifestS3Uri', ], 'members' => [ 'ManifestS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'LabelingJobSnsDataSource' => [ 'type' => 'structure', 'required' => [ 'SnsTopicArn', ], 'members' => [ 'SnsTopicArn' => [ 'shape' => 'SnsTopicArn', ], ], ], 'LabelingJobStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'LabelingJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxHumanLabeledObjectCount' => [ 'shape' => 'MaxHumanLabeledObjectCount', ], 'MaxPercentageOfInputDatasetLabeled' => [ 'shape' => 'MaxPercentageOfInputDatasetLabeled', ], ], ], 'LabelingJobSummary' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', 'LabelingJobArn', 'CreationTime', 'LastModifiedTime', 'LabelingJobStatus', 'LabelCounters', 'WorkteamArn', 'PreHumanTaskLambdaArn', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobStatus' => [ 'shape' => 'LabelingJobStatus', ], 'LabelCounters' => [ 'shape' => 'LabelCounters', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'PreHumanTaskLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'AnnotationConsolidationLambdaArn' => [ 'shape' => 'LambdaFunctionArn', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'LabelingJobOutput' => [ 'shape' => 'LabelingJobOutput', ], 'InputConfig' => [ 'shape' => 'LabelingJobInputConfig', ], ], ], 'LabelingJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LabelingJobSummary', ], ], 'LambdaFunctionArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:.*', ], 'LambdaStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], ], ], 'LandingUri' => [ 'type' => 'string', 'max' => 1023, ], 'LastModifiedTime' => [ 'type' => 'timestamp', ], 'LastUpdateStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'LastUpdateStatusValue', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'LastUpdateStatusValue' => [ 'type' => 'string', 'enum' => [ 'Successful', 'Failed', 'InProgress', ], ], 'LifecycleConfigArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], 'LineageEntityParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'StringParameterValue', ], 'value' => [ 'shape' => 'StringParameterValue', ], 'max' => 30, ], 'LineageGroupArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/.*', ], 'LineageGroupNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})', ], 'LineageGroupSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageGroupSummary', ], ], 'LineageGroupSummary' => [ 'type' => 'structure', 'members' => [ 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'LineageGroupName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'LineageType' => [ 'type' => 'string', 'enum' => [ 'TrialComponent', 'Artifact', 'Context', 'Action', ], ], 'ListActionsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ActionType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortActionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListActionsResponse' => [ 'type' => 'structure', 'members' => [ 'ActionSummaries' => [ 'shape' => 'ActionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAlgorithmsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'AlgorithmSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAlgorithmsOutput' => [ 'type' => 'structure', 'required' => [ 'AlgorithmSummaryList', ], 'members' => [ 'AlgorithmSummaryList' => [ 'shape' => 'AlgorithmSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageVersionAliases' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAppImageConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'AppImageConfigName', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'AppImageConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListAppImageConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'AppImageConfigs' => [ 'shape' => 'AppImageConfigList', ], ], ], 'ListAppsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'AppSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameEquals' => [ 'shape' => 'UserProfileName', ], 'SpaceNameEquals' => [ 'shape' => 'SpaceName', ], ], ], 'ListAppsResponse' => [ 'type' => 'structure', 'members' => [ 'Apps' => [ 'shape' => 'AppList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListArtifactsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ArtifactType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortArtifactsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListArtifactsResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactSummaries' => [ 'shape' => 'ArtifactSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'AssociationEntityArn', ], 'DestinationArn' => [ 'shape' => 'AssociationEntityArn', ], 'SourceType' => [ 'shape' => 'String256', ], 'DestinationType' => [ 'shape' => 'String256', ], 'AssociationType' => [ 'shape' => 'AssociationEdgeType', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortAssociationsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'AssociationSummaries' => [ 'shape' => 'AssociationSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'AutoMLNameContains', ], 'StatusEquals' => [ 'shape' => 'AutoMLJobStatus', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'AutoMLSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResults', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAutoMLJobsResponse' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobSummaries', ], 'members' => [ 'AutoMLJobSummaries' => [ 'shape' => 'AutoMLJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], 'StatusEquals' => [ 'shape' => 'CandidateStatus', ], 'CandidateNameEquals' => [ 'shape' => 'CandidateName', ], 'SortOrder' => [ 'shape' => 'AutoMLSortOrder', ], 'SortBy' => [ 'shape' => 'CandidateSortBy', ], 'MaxResults' => [ 'shape' => 'AutoMLMaxResultsForTrials', 'box' => true, ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCandidatesForAutoMLJobResponse' => [ 'type' => 'structure', 'required' => [ 'Candidates', ], 'members' => [ 'Candidates' => [ 'shape' => 'AutoMLCandidates', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListClusterNodesRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'InstanceGroupNameContains' => [ 'shape' => 'ClusterInstanceGroupName', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ClusterSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListClusterNodesResponse' => [ 'type' => 'structure', 'required' => [ 'NextToken', 'ClusterNodeSummaries', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ClusterNodeSummaries' => [ 'shape' => 'ClusterNodeSummaries', ], ], ], 'ListClustersRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ClusterSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListClustersResponse' => [ 'type' => 'structure', 'required' => [ 'NextToken', 'ClusterSummaries', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'ClusterSummaries' => [ 'shape' => 'ClusterSummaries', ], ], ], 'ListCodeRepositoriesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'CodeRepositoryNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'CodeRepositorySortBy', ], 'SortOrder' => [ 'shape' => 'CodeRepositorySortOrder', ], ], ], 'ListCodeRepositoriesOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositorySummaryList', ], 'members' => [ 'CodeRepositorySummaryList' => [ 'shape' => 'CodeRepositorySummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'CompilationJobStatus', ], 'SortBy' => [ 'shape' => 'ListCompilationJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListCompilationJobsResponse' => [ 'type' => 'structure', 'required' => [ 'CompilationJobSummaries', ], 'members' => [ 'CompilationJobSummaries' => [ 'shape' => 'CompilationJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCompilationJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListContextsRequest' => [ 'type' => 'structure', 'members' => [ 'SourceUri' => [ 'shape' => 'SourceUri', ], 'ContextType' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortContextsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListContextsResponse' => [ 'type' => 'structure', 'members' => [ 'ContextSummaries' => [ 'shape' => 'ContextSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDataQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListDataQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListDeviceFleetsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListDeviceFleetsResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetSummaries', ], 'members' => [ 'DeviceFleetSummaries' => [ 'shape' => 'DeviceFleetSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeviceFleetsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListDevicesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'LatestHeartbeatAfter' => [ 'shape' => 'Timestamp', ], 'ModelName' => [ 'shape' => 'EntityName', ], 'DeviceFleetName' => [ 'shape' => 'EntityName', ], ], ], 'ListDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceSummaries', ], 'members' => [ 'DeviceSummaries' => [ 'shape' => 'DeviceSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDomainsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'Domains' => [ 'shape' => 'DomainList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'DeviceFleetNameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'ListEdgeDeploymentPlansSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgeDeploymentPlansResponse' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanSummaries', ], 'members' => [ 'EdgeDeploymentPlanSummaries' => [ 'shape' => 'EdgeDeploymentPlanSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgeDeploymentPlansSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'DEVICE_FLEET_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', ], ], 'ListEdgePackagingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelNameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'EdgePackagingJobStatus', ], 'SortBy' => [ 'shape' => 'ListEdgePackagingJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListEdgePackagingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobSummaries', ], 'members' => [ 'EdgePackagingJobSummaries' => [ 'shape' => 'EdgePackagingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEdgePackagingJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'NAME', 'MODEL_NAME', 'CREATION_TIME', 'LAST_MODIFIED_TIME', 'STATUS', ], ], 'ListEndpointConfigsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointConfigSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListEndpointConfigsOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigs', ], 'members' => [ 'EndpointConfigs' => [ 'shape' => 'EndpointConfigSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListEndpointsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'EndpointSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EndpointNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'EndpointStatus', ], ], ], 'ListEndpointsOutput' => [ 'type' => 'structure', 'required' => [ 'Endpoints', ], 'members' => [ 'Endpoints' => [ 'shape' => 'EndpointSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentSummaries' => [ 'shape' => 'ExperimentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'FeatureGroupNameContains', ], 'FeatureGroupStatusEquals' => [ 'shape' => 'FeatureGroupStatus', ], 'OfflineStoreStatusEquals' => [ 'shape' => 'OfflineStoreStatusValue', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'SortOrder' => [ 'shape' => 'FeatureGroupSortOrder', ], 'SortBy' => [ 'shape' => 'FeatureGroupSortBy', ], 'MaxResults' => [ 'shape' => 'FeatureGroupMaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFeatureGroupsResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupSummaries', ], 'members' => [ 'FeatureGroupSummaries' => [ 'shape' => 'FeatureGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFlowDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListFlowDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'FlowDefinitionSummaries', ], 'members' => [ 'FlowDefinitionSummaries' => [ 'shape' => 'FlowDefinitionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', 'HubContentName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'HubContentName' => [ 'shape' => 'HubContentName', ], 'MinVersion' => [ 'shape' => 'HubContentVersion', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', 'HubContentType', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubContentType' => [ 'shape' => 'HubContentType', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'MaxSchemaVersion' => [ 'shape' => 'DocumentSchemaVersion', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubContentSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubContentsResponse' => [ 'type' => 'structure', 'required' => [ 'HubContentSummaries', ], 'members' => [ 'HubContentSummaries' => [ 'shape' => 'HubContentInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'HubSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHubsResponse' => [ 'type' => 'structure', 'required' => [ 'HubSummaries', ], 'members' => [ 'HubSummaries' => [ 'shape' => 'HubInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHumanTaskUisRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListHumanTaskUisResponse' => [ 'type' => 'structure', 'required' => [ 'HumanTaskUiSummaries', ], 'members' => [ 'HumanTaskUiSummaries' => [ 'shape' => 'HumanTaskUiSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHyperParameterTuningJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'SortBy' => [ 'shape' => 'HyperParameterTuningJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'HyperParameterTuningJobStatus', ], ], ], 'ListHyperParameterTuningJobsResponse' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobSummaries', ], 'members' => [ 'HyperParameterTuningJobSummaries' => [ 'shape' => 'HyperParameterTuningJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImageVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ImageVersionSortOrder', ], ], ], 'ListImageVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersions' => [ 'shape' => 'ImageVersions', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImagesRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ImageNameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ImageSortBy', ], 'SortOrder' => [ 'shape' => 'ImageSortOrder', ], ], ], 'ListImagesResponse' => [ 'type' => 'structure', 'members' => [ 'Images' => [ 'shape' => 'Images', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceComponentsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'InferenceComponentSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'InferenceComponentNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'InferenceComponentStatus', ], 'EndpointNameEquals' => [ 'shape' => 'EndpointName', ], 'VariantNameEquals' => [ 'shape' => 'VariantName', ], ], ], 'ListInferenceComponentsOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponents', ], 'members' => [ 'InferenceComponents' => [ 'shape' => 'InferenceComponentSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListInferenceExperimentsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'NameContains', ], 'Type' => [ 'shape' => 'InferenceExperimentType', ], 'StatusEquals' => [ 'shape' => 'InferenceExperimentStatus', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortInferenceExperimentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListInferenceExperimentsResponse' => [ 'type' => 'structure', 'members' => [ 'InferenceExperiments' => [ 'shape' => 'InferenceExperimentList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], 'Status' => [ 'shape' => 'RecommendationJobStatus', ], 'StepType' => [ 'shape' => 'RecommendationStepType', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'type' => 'structure', 'members' => [ 'Steps' => [ 'shape' => 'InferenceRecommendationsJobSteps', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'RecommendationJobStatus', ], 'SortBy' => [ 'shape' => 'ListInferenceRecommendationsJobsSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelNameEquals' => [ 'shape' => 'ModelName', ], 'ModelPackageVersionArnEquals' => [ 'shape' => 'ModelPackageArn', ], ], ], 'ListInferenceRecommendationsJobsResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceRecommendationsJobs', ], 'members' => [ 'InferenceRecommendationsJobs' => [ 'shape' => 'InferenceRecommendationsJobs', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'JobReferenceCodeContains' => [ 'shape' => 'JobReferenceCodeContains', ], 'SortBy' => [ 'shape' => 'ListLabelingJobsForWorkteamSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListLabelingJobsForWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'LabelingJobSummaryList', ], 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobForWorkteamSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ListLabelingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'StatusEquals' => [ 'shape' => 'LabelingJobStatus', ], ], ], 'ListLabelingJobsResponse' => [ 'type' => 'structure', 'members' => [ 'LabelingJobSummaryList' => [ 'shape' => 'LabelingJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLineageEntityParameterKey' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringParameterValue', ], ], 'ListLineageGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortLineageGroupsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListLineageGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'LineageGroupSummaries' => [ 'shape' => 'LineageGroupSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMaxResults' => [ 'type' => 'integer', 'max' => 100, ], 'ListModelBiasJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelBiasJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModelCardExportJobNameContains' => [ 'shape' => 'EntityName', ], 'StatusEquals' => [ 'shape' => 'ModelCardExportJobStatus', ], 'SortBy' => [ 'shape' => 'ModelCardExportJobSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardExportJobSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelCardExportJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobSummaries', ], 'members' => [ 'ModelCardExportJobSummaries' => [ 'shape' => 'ModelCardExportJobSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardVersionSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardVersionSummaryList', ], 'members' => [ 'ModelCardVersionSummaryList' => [ 'shape' => 'ModelCardVersionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelCardsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'EntityName', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelCardSortBy', ], 'SortOrder' => [ 'shape' => 'ModelCardSortOrder', ], ], ], 'ListModelCardsResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardSummaries', ], 'members' => [ 'ModelCardSummaries' => [ 'shape' => 'ModelCardSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelMetadataRequest' => [ 'type' => 'structure', 'members' => [ 'SearchExpression' => [ 'shape' => 'ModelMetadataSearchExpression', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListModelMetadataResponse' => [ 'type' => 'structure', 'required' => [ 'ModelMetadataSummaries', ], 'members' => [ 'ModelMetadataSummaries' => [ 'shape' => 'ModelMetadataSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackageGroupsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageGroupSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackageGroupsOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupSummaryList', ], 'members' => [ 'ModelPackageGroupSummaryList' => [ 'shape' => 'ModelPackageGroupSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelPackagesInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ModelPackageGroupName' => [ 'shape' => 'ArnOrName', ], 'ModelPackageType' => [ 'shape' => 'ModelPackageType', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ModelPackageSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListModelPackagesOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageSummaryList', ], 'members' => [ 'ModelPackageSummaryList' => [ 'shape' => 'ModelPackageSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelQualityJobDefinitionsRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringJobDefinitionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelQualityJobDefinitionsResponse' => [ 'type' => 'structure', 'required' => [ 'JobDefinitionSummaries', ], 'members' => [ 'JobDefinitionSummaries' => [ 'shape' => 'MonitoringJobDefinitionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListModelsInput' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ModelSortKey', ], 'SortOrder' => [ 'shape' => 'OrderKey', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ModelNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], ], ], 'ListModelsOutput' => [ 'type' => 'structure', 'required' => [ 'Models', ], 'members' => [ 'Models' => [ 'shape' => 'ModelSummaryList', ], 'NextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListMonitoringAlertHistoryRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'SortBy' => [ 'shape' => 'MonitoringAlertHistorySortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'ListMonitoringAlertHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertHistory' => [ 'shape' => 'MonitoringAlertHistoryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringAlertsRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMonitoringAlertsResponse' => [ 'type' => 'structure', 'members' => [ 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringExecutionsRequest' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringExecutionSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ScheduledTimeBefore' => [ 'shape' => 'Timestamp', ], 'ScheduledTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ExecutionStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringExecutionsResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringExecutionSummaries', ], 'members' => [ 'MonitoringExecutionSummaries' => [ 'shape' => 'MonitoringExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMonitoringSchedulesRequest' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'SortBy' => [ 'shape' => 'MonitoringScheduleSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'StatusEquals' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringTypeEquals' => [ 'shape' => 'MonitoringType', ], ], ], 'ListMonitoringSchedulesResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleSummaries', ], 'members' => [ 'MonitoringScheduleSummaries' => [ 'shape' => 'MonitoringScheduleSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceLifecycleConfigSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], ], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstanceLifecycleConfigs' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummaryList', ], ], ], 'ListNotebookInstancesInput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortBy' => [ 'shape' => 'NotebookInstanceSortKey', ], 'SortOrder' => [ 'shape' => 'NotebookInstanceSortOrder', ], 'NameContains' => [ 'shape' => 'NotebookInstanceNameContains', ], 'CreationTimeBefore' => [ 'shape' => 'CreationTime', ], 'CreationTimeAfter' => [ 'shape' => 'CreationTime', ], 'LastModifiedTimeBefore' => [ 'shape' => 'LastModifiedTime', ], 'LastModifiedTimeAfter' => [ 'shape' => 'LastModifiedTime', ], 'StatusEquals' => [ 'shape' => 'NotebookInstanceStatus', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepositoryContains' => [ 'shape' => 'CodeRepositoryContains', ], 'AdditionalCodeRepositoryEquals' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], ], ], 'ListNotebookInstancesOutput' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'NotebookInstances' => [ 'shape' => 'NotebookInstanceSummaryList', ], ], ], 'ListPipelineExecutionStepsRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListPipelineExecutionStepsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSteps' => [ 'shape' => 'PipelineExecutionStepList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineExecutionsRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelineExecutionsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineExecutionsResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionSummaries' => [ 'shape' => 'PipelineExecutionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelineParametersForExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelineParametersForExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPipelinesRequest' => [ 'type' => 'structure', 'members' => [ 'PipelineNamePrefix' => [ 'shape' => 'PipelineName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortPipelinesBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPipelinesResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineSummaries' => [ 'shape' => 'PipelineSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProcessingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'String', ], 'StatusEquals' => [ 'shape' => 'ProcessingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListProcessingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobSummaries', ], 'members' => [ 'ProcessingJobSummaries' => [ 'shape' => 'ProcessingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListProjectsInput' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NameContains' => [ 'shape' => 'ProjectEntityName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'SortBy' => [ 'shape' => 'ProjectSortBy', ], 'SortOrder' => [ 'shape' => 'ProjectSortOrder', ], ], ], 'ListProjectsOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectSummaryList', ], 'members' => [ 'ProjectSummaryList' => [ 'shape' => 'ProjectSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'ResourceCatalogName', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'SortOrder' => [ 'shape' => 'ResourceCatalogSortOrder', ], 'SortBy' => [ 'shape' => 'ResourceCatalogSortBy', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceCatalogsResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceCatalogs' => [ 'shape' => 'ResourceCatalogList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSpacesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'SpaceSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'SpaceNameContains' => [ 'shape' => 'SpaceName', ], ], ], 'ListSpacesResponse' => [ 'type' => 'structure', 'members' => [ 'Spaces' => [ 'shape' => 'SpaceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStageDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListMaxResults', 'box' => true, ], 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'ExcludeDevicesDeployedInOtherStage' => [ 'shape' => 'Boolean', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'ListStageDevicesResponse' => [ 'type' => 'structure', 'required' => [ 'DeviceDeploymentSummaries', ], 'members' => [ 'DeviceDeploymentSummaries' => [ 'shape' => 'DeviceDeploymentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListStudioLifecycleConfigsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'NameContains' => [ 'shape' => 'StudioLifecycleConfigName', ], 'AppTypeEquals' => [ 'shape' => 'StudioLifecycleConfigAppType', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'StudioLifecycleConfigSortKey', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListStudioLifecycleConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'StudioLifecycleConfigs' => [ 'shape' => 'StudioLifecycleConfigsList', ], ], ], 'ListSubscribedWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListSubscribedWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'SubscribedWorkteams', ], 'members' => [ 'SubscribedWorkteams' => [ 'shape' => 'SubscribedWorkteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ListTagsMaxResults', ], ], ], 'ListTagsMaxResults' => [ 'type' => 'integer', 'min' => 50, ], 'ListTagsOutput' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'TrainingJobSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'HyperParameterTrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrainingJobsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TrainingJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'WarmPoolStatusEquals' => [ 'shape' => 'WarmPoolResourceStatus', ], ], ], 'ListTrainingJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobSummaries', ], 'members' => [ 'TrainingJobSummaries' => [ 'shape' => 'TrainingJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTransformJobsRequest' => [ 'type' => 'structure', 'members' => [ 'CreationTimeAfter' => [ 'shape' => 'Timestamp', ], 'CreationTimeBefore' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeAfter' => [ 'shape' => 'Timestamp', ], 'LastModifiedTimeBefore' => [ 'shape' => 'Timestamp', ], 'NameContains' => [ 'shape' => 'NameContains', ], 'StatusEquals' => [ 'shape' => 'TransformJobStatus', ], 'SortBy' => [ 'shape' => 'SortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListTransformJobsResponse' => [ 'type' => 'structure', 'required' => [ 'TransformJobSummaries', ], 'members' => [ 'TransformJobSummaries' => [ 'shape' => 'TransformJobSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentKey256' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentKey256', ], ], 'ListTrialComponentsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'SourceArn' => [ 'shape' => 'String256', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialComponentsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialComponentsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsRequest' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'SortBy' => [ 'shape' => 'SortTrialsBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrialsResponse' => [ 'type' => 'structure', 'members' => [ 'TrialSummaries' => [ 'shape' => 'TrialSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListUserProfilesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'SortBy' => [ 'shape' => 'UserProfileSortKey', ], 'DomainIdEquals' => [ 'shape' => 'DomainId', ], 'UserProfileNameContains' => [ 'shape' => 'UserProfileName', ], ], ], 'ListUserProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfiles' => [ 'shape' => 'UserProfileList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkforcesSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkforceName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkforcesResponse' => [ 'type' => 'structure', 'required' => [ 'Workforces', ], 'members' => [ 'Workforces' => [ 'shape' => 'Workforces', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkforcesSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'ListWorkteamsRequest' => [ 'type' => 'structure', 'members' => [ 'SortBy' => [ 'shape' => 'ListWorkteamsSortByOptions', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'NameContains' => [ 'shape' => 'WorkteamName', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], ], ], 'ListWorkteamsResponse' => [ 'type' => 'structure', 'required' => [ 'Workteams', ], 'members' => [ 'Workteams' => [ 'shape' => 'Workteams', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkteamsSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreateDate', ], ], 'Long' => [ 'type' => 'long', ], 'MLFramework' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'ManagedInstanceScalingMaxInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ManagedInstanceScalingMinInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'ManagedInstanceScalingStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxCandidates' => [ 'type' => 'integer', 'max' => 750, 'min' => 1, ], 'MaxConcurrentInvocationsPerInstance' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'MaxConcurrentTaskCount' => [ 'type' => 'integer', 'max' => 5000, 'min' => 1, ], 'MaxConcurrentTransforms' => [ 'type' => 'integer', 'min' => 0, ], 'MaxHumanLabeledObjectCount' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'type' => 'integer', 'min' => 3, ], 'MaxParallelExecutionSteps' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelOfTests' => [ 'type' => 'integer', 'min' => 1, ], 'MaxParallelTrainingJobs' => [ 'type' => 'integer', 'min' => 1, ], 'MaxPayloadInMB' => [ 'type' => 'integer', 'min' => 0, ], 'MaxPendingTimeInSeconds' => [ 'type' => 'integer', 'max' => 2419200, 'min' => 7200, ], 'MaxPercentageOfInputDatasetLabeled' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxRuntimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaxWaitTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'MaximumExecutionTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 28800, 'min' => 600, ], 'MaximumRetryAttempts' => [ 'type' => 'integer', 'max' => 30, 'min' => 1, ], 'MediaType' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[-\\w]+\\/[-\\w+]+$', ], 'MemberDefinition' => [ 'type' => 'structure', 'members' => [ 'CognitoMemberDefinition' => [ 'shape' => 'CognitoMemberDefinition', ], 'OidcMemberDefinition' => [ 'shape' => 'OidcMemberDefinition', ], ], ], 'MemberDefinitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'MemberDefinition', ], 'max' => 10, 'min' => 1, ], 'MemoryInMb' => [ 'type' => 'integer', 'min' => 128, ], 'MetadataProperties' => [ 'type' => 'structure', 'members' => [ 'CommitId' => [ 'shape' => 'MetadataPropertyValue', ], 'Repository' => [ 'shape' => 'MetadataPropertyValue', ], 'GeneratedBy' => [ 'shape' => 'MetadataPropertyValue', ], 'ProjectId' => [ 'shape' => 'MetadataPropertyValue', ], ], ], 'MetadataPropertyValue' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'MetricData' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'Value' => [ 'shape' => 'Float', ], 'Timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'MetricDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDatum', ], 'max' => 40, 'min' => 0, ], 'MetricDatum' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'AutoMLMetricEnum', ], 'Value' => [ 'shape' => 'Float', ], 'Set' => [ 'shape' => 'MetricSetSource', ], 'StandardMetricName' => [ 'shape' => 'AutoMLMetricExtendedEnum', ], ], ], 'MetricDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'Regex', ], 'members' => [ 'Name' => [ 'shape' => 'MetricName', ], 'Regex' => [ 'shape' => 'MetricRegex', ], ], ], 'MetricDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDefinition', ], 'max' => 40, 'min' => 0, ], 'MetricName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'MetricRegex' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '.+', ], 'MetricSetSource' => [ 'type' => 'string', 'enum' => [ 'Train', 'Validation', 'Test', ], ], 'MetricSpecification' => [ 'type' => 'structure', 'members' => [ 'Predefined' => [ 'shape' => 'PredefinedMetricSpecification', ], 'Customized' => [ 'shape' => 'CustomizedMetricSpecification', ], ], 'union' => true, ], 'MetricValue' => [ 'type' => 'float', ], 'MetricsSource' => [ 'type' => 'structure', 'required' => [ 'ContentType', 'S3Uri', ], 'members' => [ 'ContentType' => [ 'shape' => 'ContentType', ], 'ContentDigest' => [ 'shape' => 'ContentDigest', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'type' => 'string', 'max' => 1, 'pattern' => '1|2', ], 'Model' => [ 'type' => 'structure', 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'PrimaryContainer' => [ 'shape' => 'ContainerDefinition', ], 'Containers' => [ 'shape' => 'ContainerDefinitionList', ], 'InferenceExecutionConfig' => [ 'shape' => 'InferenceExecutionConfig', ], 'ExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'Tags' => [ 'shape' => 'TagList', ], 'DeploymentRecommendation' => [ 'shape' => 'DeploymentRecommendation', ], ], ], 'ModelAccessConfig' => [ 'type' => 'structure', 'required' => [ 'AcceptEula', ], 'members' => [ 'AcceptEula' => [ 'shape' => 'AcceptEula', ], ], ], 'ModelApprovalStatus' => [ 'type' => 'string', 'enum' => [ 'Approved', 'Rejected', 'PendingManualApproval', ], ], 'ModelArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model/.*', ], 'ModelArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ModelArtifacts', ], 'members' => [ 'S3ModelArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelBiasAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelBiasBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelBiasJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelCacheSetting' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], 'ModelPackageGroupName' => [ 'shape' => 'String', ], ], ], 'ModelCardArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardContent' => [ 'type' => 'string', 'max' => 100000, 'min' => 0, 'pattern' => '.*', 'sensitive' => true, ], 'ModelCardExportArtifacts' => [ 'type' => 'structure', 'required' => [ 'S3ExportArtifacts', ], 'members' => [ 'S3ExportArtifacts' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardExportJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'ModelCardExportJobSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'ModelCardExportJobSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardExportJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', ], ], 'ModelCardExportJobSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardExportJobName', 'ModelCardExportJobArn', 'Status', 'ModelCardName', 'ModelCardVersion', 'CreatedAt', 'LastModifiedAt', ], 'members' => [ 'ModelCardExportJobName' => [ 'shape' => 'EntityName', ], 'ModelCardExportJobArn' => [ 'shape' => 'ModelCardExportJobArn', ], 'Status' => [ 'shape' => 'ModelCardExportJobStatus', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreatedAt' => [ 'shape' => 'Timestamp', ], 'LastModifiedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardExportJobSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardExportJobSummary', ], ], 'ModelCardExportOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'ModelCardNameOrArn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})', ], 'ModelCardProcessingStatus' => [ 'type' => 'string', 'enum' => [ 'DeleteInProgress', 'DeletePending', 'ContentDeleted', 'ExportJobsDeleted', 'DeleteCompleted', 'DeleteFailed', ], ], 'ModelCardSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ModelCardSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelCardSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ModelCardStatus' => [ 'type' => 'string', 'enum' => [ 'Draft', 'PendingReview', 'Approved', 'Archived', ], ], 'ModelCardSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardSummary', ], ], 'ModelCardVersionSortBy' => [ 'type' => 'string', 'enum' => [ 'Version', ], ], 'ModelCardVersionSummary' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', 'ModelCardArn', 'ModelCardStatus', 'ModelCardVersion', 'CreationTime', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelCardVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelCardVersionSummary', ], ], 'ModelClientConfig' => [ 'type' => 'structure', 'members' => [ 'InvocationsTimeoutInSeconds' => [ 'shape' => 'InvocationsTimeoutInSeconds', ], 'InvocationsMaxRetries' => [ 'shape' => 'InvocationsMaxRetries', ], ], ], 'ModelCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ModelConfiguration' => [ 'type' => 'structure', 'members' => [ 'InferenceSpecificationName' => [ 'shape' => 'InferenceSpecificationName', ], 'EnvironmentParameters' => [ 'shape' => 'EnvironmentParameters', ], 'CompilationJobName' => [ 'shape' => 'RecommendationJobCompilationJobName', ], ], ], 'ModelDashboardEndpoint' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointArn', 'CreationTime', 'LastModifiedTime', 'EndpointStatus', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointArn' => [ 'shape' => 'EndpointArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'EndpointStatus' => [ 'shape' => 'EndpointStatus', ], ], ], 'ModelDashboardEndpoints' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardEndpoint', ], ], 'ModelDashboardIndicatorAction' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'ModelDashboardModel' => [ 'type' => 'structure', 'members' => [ 'Model' => [ 'shape' => 'Model', ], 'Endpoints' => [ 'shape' => 'ModelDashboardEndpoints', ], 'LastBatchTransformJob' => [ 'shape' => 'TransformJob', ], 'MonitoringSchedules' => [ 'shape' => 'ModelDashboardMonitoringSchedules', ], 'ModelCard' => [ 'shape' => 'ModelDashboardModelCard', ], ], ], 'ModelDashboardModelCard' => [ 'type' => 'structure', 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], 'ModelCardName' => [ 'shape' => 'EntityName', ], 'ModelCardVersion' => [ 'shape' => 'Integer', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], 'SecurityConfig' => [ 'shape' => 'ModelCardSecurityConfig', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Tags' => [ 'shape' => 'TagList', ], 'ModelId' => [ 'shape' => 'String', ], 'RiskRating' => [ 'shape' => 'String', ], ], ], 'ModelDashboardMonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringAlertSummaries' => [ 'shape' => 'MonitoringAlertSummaryList', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'ModelDashboardMonitoringSchedules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelDashboardMonitoringSchedule', ], ], 'ModelDataQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelDataSource' => [ 'type' => 'structure', 'members' => [ 'S3DataSource' => [ 'shape' => 'S3ModelDataSource', ], ], ], 'ModelDeployConfig' => [ 'type' => 'structure', 'members' => [ 'AutoGenerateEndpointName' => [ 'shape' => 'AutoGenerateEndpointName', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDeployResult' => [ 'type' => 'structure', 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'ModelDigests' => [ 'type' => 'structure', 'members' => [ 'ArtifactDigest' => [ 'shape' => 'ArtifactDigest', ], ], ], 'ModelExplainabilityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', 'ConfigUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ConfigUri' => [ 'shape' => 'S3Uri', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelExplainabilityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelExplainabilityJobInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'ModelInfrastructureConfig' => [ 'type' => 'structure', 'required' => [ 'InfrastructureType', 'RealTimeInferenceConfig', ], 'members' => [ 'InfrastructureType' => [ 'shape' => 'ModelInfrastructureType', ], 'RealTimeInferenceConfig' => [ 'shape' => 'RealTimeInferenceConfig', ], ], ], 'ModelInfrastructureType' => [ 'type' => 'string', 'enum' => [ 'RealTimeInference', ], ], 'ModelInput' => [ 'type' => 'structure', 'required' => [ 'DataInputConfig', ], 'members' => [ 'DataInputConfig' => [ 'shape' => 'DataInputConfig', ], ], ], 'ModelInsightsLocation' => [ 'type' => 'string', 'min' => 1, ], 'ModelLatencyThreshold' => [ 'type' => 'structure', 'members' => [ 'Percentile' => [ 'shape' => 'String64', ], 'ValueInMilliseconds' => [ 'shape' => 'Integer', ], ], ], 'ModelLatencyThresholds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelLatencyThreshold', ], 'max' => 1, 'min' => 1, ], 'ModelMetadataFilter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'ModelMetadataFilterType', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'ModelMetadataFilterType' => [ 'type' => 'string', 'enum' => [ 'Domain', 'Framework', 'Task', 'FrameworkVersion', ], ], 'ModelMetadataFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataFilter', ], 'max' => 4, 'min' => 1, ], 'ModelMetadataSearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ModelMetadataFilters', ], ], ], 'ModelMetadataSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelMetadataSummary', ], ], 'ModelMetadataSummary' => [ 'type' => 'structure', 'required' => [ 'Domain', 'Framework', 'Task', 'Model', 'FrameworkVersion', ], 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Model' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'String', ], ], ], 'ModelMetrics' => [ 'type' => 'structure', 'members' => [ 'ModelQuality' => [ 'shape' => 'ModelQuality', ], 'ModelDataQuality' => [ 'shape' => 'ModelDataQuality', ], 'Bias' => [ 'shape' => 'Bias', ], 'Explainability' => [ 'shape' => 'Explainability', ], ], ], 'ModelName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?', ], 'ModelNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'ModelPackage' => [ 'type' => 'structure', 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'InferenceSpecification' => [ 'shape' => 'InferenceSpecification', ], 'SourceAlgorithmSpecification' => [ 'shape' => 'SourceAlgorithmSpecification', ], 'ValidationSpecification' => [ 'shape' => 'ModelPackageValidationSpecification', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelPackageStatusDetails' => [ 'shape' => 'ModelPackageStatusDetails', ], 'CertifyForMarketplace' => [ 'shape' => 'CertifyForMarketplace', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'ModelMetrics' => [ 'shape' => 'ModelMetrics', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'SamplePayloadUrl' => [ 'shape' => 'String', ], 'AdditionalInferenceSpecifications' => [ 'shape' => 'AdditionalInferenceSpecifications', ], 'Tags' => [ 'shape' => 'TagList', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'DriftCheckBaselines' => [ 'shape' => 'DriftCheckBaselines', ], 'SkipModelValidation' => [ 'shape' => 'SkipModelValidation', ], ], ], 'ModelPackageArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}$', ], 'ModelPackageArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageArn', ], 'max' => 100, 'min' => 1, ], 'ModelPackageContainerDefinition' => [ 'type' => 'structure', 'required' => [ 'Image', ], 'members' => [ 'ContainerHostname' => [ 'shape' => 'ContainerHostname', ], 'Image' => [ 'shape' => 'ContainerImage', ], 'ImageDigest' => [ 'shape' => 'ImageDigest', ], 'ModelDataUrl' => [ 'shape' => 'Url', ], 'ProductId' => [ 'shape' => 'ProductId', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], 'ModelInput' => [ 'shape' => 'ModelInput', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'ModelPackageFrameworkVersion', ], 'NearestModelName' => [ 'shape' => 'String', ], 'AdditionalS3DataSource' => [ 'shape' => 'AdditionalS3DataSource', ], ], ], 'ModelPackageContainerDefinitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageContainerDefinition', ], 'max' => 15, 'min' => 1, ], 'ModelPackageFrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.-]+', ], 'ModelPackageGroup' => [ 'type' => 'structure', 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ModelPackageGroupArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package-group/[\\S]{1,2048}$', ], 'ModelPackageGroupSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageGroupStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', 'DeleteFailed', ], ], 'ModelPackageGroupSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ModelPackageGroupArn', 'CreationTime', 'ModelPackageGroupStatus', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], 'ModelPackageGroupDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageGroupStatus' => [ 'shape' => 'ModelPackageGroupStatus', ], ], ], 'ModelPackageGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageGroupSummary', ], ], 'ModelPackageSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelPackageStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InProgress', 'Completed', 'Failed', 'Deleting', ], ], 'ModelPackageStatusDetails' => [ 'type' => 'structure', 'required' => [ 'ValidationStatuses', ], 'members' => [ 'ValidationStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], 'ImageScanStatuses' => [ 'shape' => 'ModelPackageStatusItemList', ], ], ], 'ModelPackageStatusItem' => [ 'type' => 'structure', 'required' => [ 'Name', 'Status', ], 'members' => [ 'Name' => [ 'shape' => 'EntityName', ], 'Status' => [ 'shape' => 'DetailedModelPackageStatus', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'ModelPackageStatusItemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageStatusItem', ], ], 'ModelPackageSummaries' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelPackageArn', ], 'value' => [ 'shape' => 'BatchDescribeModelPackageSummary', ], ], 'ModelPackageSummary' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', 'CreationTime', 'ModelPackageStatus', ], 'members' => [ 'ModelPackageName' => [ 'shape' => 'EntityName', ], 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ModelPackageVersion' => [ 'shape' => 'ModelPackageVersion', ], 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelPackageDescription' => [ 'shape' => 'EntityDescription', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'ModelPackageStatus' => [ 'shape' => 'ModelPackageStatus', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], ], ], 'ModelPackageSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageSummary', ], ], 'ModelPackageType' => [ 'type' => 'string', 'enum' => [ 'Versioned', 'Unversioned', 'Both', ], ], 'ModelPackageValidationProfile' => [ 'type' => 'structure', 'required' => [ 'ProfileName', 'TransformJobDefinition', ], 'members' => [ 'ProfileName' => [ 'shape' => 'EntityName', ], 'TransformJobDefinition' => [ 'shape' => 'TransformJobDefinition', ], ], ], 'ModelPackageValidationProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelPackageValidationProfile', ], 'max' => 1, 'min' => 0, ], 'ModelPackageValidationSpecification' => [ 'type' => 'structure', 'required' => [ 'ValidationRole', 'ValidationProfiles', ], 'members' => [ 'ValidationRole' => [ 'shape' => 'RoleArn', ], 'ValidationProfiles' => [ 'shape' => 'ModelPackageValidationProfiles', ], ], ], 'ModelPackageVersion' => [ 'type' => 'integer', 'min' => 1, ], 'ModelQuality' => [ 'type' => 'structure', 'members' => [ 'Statistics' => [ 'shape' => 'MetricsSource', ], 'Constraints' => [ 'shape' => 'MetricsSource', ], ], ], 'ModelQualityAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], 'ProblemType' => [ 'shape' => 'MonitoringProblemType', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], ], ], 'ModelQualityBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], ], ], 'ModelQualityJobInput' => [ 'type' => 'structure', 'required' => [ 'GroundTruthS3Input', ], 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], 'GroundTruthS3Input' => [ 'shape' => 'MonitoringGroundTruthS3Input', ], ], ], 'ModelRegisterSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'CrossAccountModelRegisterRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'ModelSetupTime' => [ 'type' => 'integer', 'min' => 0, ], 'ModelSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ModelSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'ModelArn', 'CreationTime', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'ModelArn' => [ 'shape' => 'ModelArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ModelSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelSummary', ], ], 'ModelVariantAction' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Remove', 'Promote', ], ], 'ModelVariantActionMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ModelVariantName', ], 'value' => [ 'shape' => 'ModelVariantAction', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], ], ], 'ModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfig', ], 'max' => 2, 'min' => 1, ], 'ModelVariantConfigSummary' => [ 'type' => 'structure', 'required' => [ 'ModelName', 'VariantName', 'InfrastructureConfig', 'Status', ], 'members' => [ 'ModelName' => [ 'shape' => 'ModelName', ], 'VariantName' => [ 'shape' => 'ModelVariantName', ], 'InfrastructureConfig' => [ 'shape' => 'ModelInfrastructureConfig', ], 'Status' => [ 'shape' => 'ModelVariantStatus', ], ], ], 'ModelVariantConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ModelVariantConfigSummary', ], ], 'ModelVariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?', ], 'ModelVariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'InService', 'Deleting', 'Deleted', ], ], 'MonitoringAlertActions' => [ 'type' => 'structure', 'members' => [ 'ModelDashboardIndicator' => [ 'shape' => 'ModelDashboardIndicatorAction', ], ], ], 'MonitoringAlertHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertHistorySummary', ], ], 'MonitoringAlertHistorySortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'Status', ], ], 'MonitoringAlertHistorySummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'CreationTime', 'AlertStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], ], ], 'MonitoringAlertName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringAlertStatus' => [ 'type' => 'string', 'enum' => [ 'InAlert', 'OK', ], ], 'MonitoringAlertSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringAlertName', 'CreationTime', 'LastModifiedTime', 'AlertStatus', 'DatapointsToAlert', 'EvaluationPeriod', 'Actions', ], 'members' => [ 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'AlertStatus' => [ 'shape' => 'MonitoringAlertStatus', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], 'Actions' => [ 'shape' => 'MonitoringAlertActions', ], ], ], 'MonitoringAlertSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringAlertSummary', ], 'max' => 100, 'min' => 1, ], 'MonitoringAppSpecification' => [ 'type' => 'structure', 'required' => [ 'ImageUri', ], 'members' => [ 'ImageUri' => [ 'shape' => 'ImageUri', ], 'ContainerEntrypoint' => [ 'shape' => 'ContainerEntrypoint', ], 'ContainerArguments' => [ 'shape' => 'MonitoringContainerArguments', ], 'RecordPreprocessorSourceUri' => [ 'shape' => 'S3Uri', ], 'PostAnalyticsProcessorSourceUri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringBaselineConfig' => [ 'type' => 'structure', 'members' => [ 'BaseliningJobName' => [ 'shape' => 'ProcessingJobName', ], 'ConstraintsResource' => [ 'shape' => 'MonitoringConstraintsResource', ], 'StatisticsResource' => [ 'shape' => 'MonitoringStatisticsResource', ], ], ], 'MonitoringClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringConstraintsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContainerArgument', ], 'max' => 50, 'min' => 1, ], 'MonitoringCsvDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Header' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringDatapointsToAlert' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Csv' => [ 'shape' => 'MonitoringCsvDatasetFormat', ], 'Json' => [ 'shape' => 'MonitoringJsonDatasetFormat', ], 'Parquet' => [ 'shape' => 'MonitoringParquetDatasetFormat', ], ], ], 'MonitoringEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 50, ], 'MonitoringEvaluationPeriod' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MonitoringExecutionSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'ScheduledTime', 'Status', ], ], 'MonitoringExecutionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'ScheduledTime', 'CreationTime', 'LastModifiedTime', 'MonitoringExecutionStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'ScheduledTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringExecutionStatus' => [ 'shape' => 'ExecutionStatus', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringExecutionSummary', ], ], 'MonitoringGroundTruthS3Input' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], ], ], 'MonitoringInput' => [ 'type' => 'structure', 'members' => [ 'EndpointInput' => [ 'shape' => 'EndpointInput', ], 'BatchTransformInput' => [ 'shape' => 'BatchTransformInput', ], ], ], 'MonitoringInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringInput', ], 'max' => 1, 'min' => 1, ], 'MonitoringJobDefinition' => [ 'type' => 'structure', 'required' => [ 'MonitoringInputs', 'MonitoringOutputConfig', 'MonitoringResources', 'MonitoringAppSpecification', 'RoleArn', ], 'members' => [ 'BaselineConfig' => [ 'shape' => 'MonitoringBaselineConfig', ], 'MonitoringInputs' => [ 'shape' => 'MonitoringInputs', ], 'MonitoringOutputConfig' => [ 'shape' => 'MonitoringOutputConfig', ], 'MonitoringResources' => [ 'shape' => 'MonitoringResources', ], 'MonitoringAppSpecification' => [ 'shape' => 'MonitoringAppSpecification', ], 'StoppingCondition' => [ 'shape' => 'MonitoringStoppingCondition', ], 'Environment' => [ 'shape' => 'MonitoringEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'MonitoringJobDefinitionArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringJobDefinitionName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringJobDefinitionSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'MonitoringJobDefinitionSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringJobDefinitionName', 'MonitoringJobDefinitionArn', 'CreationTime', 'EndpointName', ], 'members' => [ 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringJobDefinitionArn' => [ 'shape' => 'MonitoringJobDefinitionArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], ], ], 'MonitoringJobDefinitionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringJobDefinitionSummary', ], ], 'MonitoringJsonDatasetFormat' => [ 'type' => 'structure', 'members' => [ 'Line' => [ 'shape' => 'Boolean', ], ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 86400, 'min' => 1, ], 'MonitoringNetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'MonitoringOutput' => [ 'type' => 'structure', 'required' => [ 'S3Output', ], 'members' => [ 'S3Output' => [ 'shape' => 'MonitoringS3Output', ], ], ], 'MonitoringOutputConfig' => [ 'type' => 'structure', 'required' => [ 'MonitoringOutputs', ], 'members' => [ 'MonitoringOutputs' => [ 'shape' => 'MonitoringOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'MonitoringOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringOutput', ], 'max' => 1, 'min' => 1, ], 'MonitoringParquetDatasetFormat' => [ 'type' => 'structure', 'members' => [], ], 'MonitoringProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'MonitoringResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'MonitoringClusterConfig', ], ], ], 'MonitoringS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', ], 'members' => [ 'S3Uri' => [ 'shape' => 'MonitoringS3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'MonitoringS3Uri' => [ 'type' => 'string', 'max' => 512, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'MonitoringSchedule' => [ 'type' => 'structure', 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'LastMonitoringExecutionSummary' => [ 'shape' => 'MonitoringExecutionSummary', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'MonitoringScheduleArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'MonitoringScheduleConfig' => [ 'type' => 'structure', 'members' => [ 'ScheduleConfig' => [ 'shape' => 'ScheduleConfig', ], 'MonitoringJobDefinition' => [ 'shape' => 'MonitoringJobDefinition', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringSchedule', ], ], 'MonitoringScheduleName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'MonitoringScheduleSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'MonitoringScheduleSummary' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleArn', 'CreationTime', 'LastModifiedTime', 'MonitoringScheduleStatus', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleStatus' => [ 'shape' => 'ScheduleStatus', ], 'EndpointName' => [ 'shape' => 'EndpointName', ], 'MonitoringJobDefinitionName' => [ 'shape' => 'MonitoringJobDefinitionName', ], 'MonitoringType' => [ 'shape' => 'MonitoringType', ], ], ], 'MonitoringScheduleSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitoringScheduleSummary', ], ], 'MonitoringStatisticsResource' => [ 'type' => 'structure', 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'MonitoringStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MonitoringMaxRuntimeInSeconds', ], ], ], 'MonitoringTimeOffsetString' => [ 'type' => 'string', 'max' => 15, 'min' => 1, 'pattern' => '^.?P.*', ], 'MonitoringType' => [ 'type' => 'string', 'enum' => [ 'DataQuality', 'ModelQuality', 'ModelBias', 'ModelExplainability', ], ], 'MountPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^\\/.*', ], 'MultiModelConfig' => [ 'type' => 'structure', 'members' => [ 'ModelCacheSetting' => [ 'shape' => 'ModelCacheSetting', ], ], ], 'NameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9\\-]+', ], 'NeoVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'NeoVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'NeoVpcSubnets', ], ], ], 'NeoVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'NeoVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'NeoVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeoVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'NestedFilters' => [ 'type' => 'structure', 'required' => [ 'NestedPropertyName', 'Filters', ], 'members' => [ 'NestedPropertyName' => [ 'shape' => 'ResourcePropertyName', ], 'Filters' => [ 'shape' => 'FilterList', ], ], ], 'NestedFiltersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NestedFilters', ], 'max' => 20, 'min' => 1, ], 'NetworkConfig' => [ 'type' => 'structure', 'members' => [ 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], ], ], 'NetworkInterfaceId' => [ 'type' => 'string', ], 'NextToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'NonEmptyString256' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^(?!\\s*$).+', ], 'NonEmptyString64' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^(?!\\s*$).+', ], 'NotebookInstanceAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'NotebookInstanceAcceleratorTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceAcceleratorType', ], ], 'NotebookInstanceArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, ], 'NotebookInstanceLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'NotebookInstanceLifecycleConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleHook', ], 'max' => 1, ], 'NotebookInstanceLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'LastModifiedTime', ], ], 'NotebookInstanceLifecycleConfigSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', 'NotebookInstanceLifecycleConfigArn', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'NotebookInstanceLifecycleConfigArn' => [ 'shape' => 'NotebookInstanceLifecycleConfigArn', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceLifecycleConfigSummary', ], ], 'NotebookInstanceLifecycleHook' => [ 'type' => 'structure', 'members' => [ 'Content' => [ 'shape' => 'NotebookInstanceLifecycleConfigContent', ], ], ], 'NotebookInstanceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'NotebookInstanceNameContains' => [ 'type' => 'string', 'max' => 63, 'pattern' => '[a-zA-Z0-9-]+', ], 'NotebookInstanceSortKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'NotebookInstanceSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'NotebookInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'InService', 'Stopping', 'Stopped', 'Failed', 'Deleting', 'Updating', ], ], 'NotebookInstanceSummary' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', 'NotebookInstanceArn', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'NotebookInstanceArn' => [ 'shape' => 'NotebookInstanceArn', ], 'NotebookInstanceStatus' => [ 'shape' => 'NotebookInstanceStatus', ], 'Url' => [ 'shape' => 'NotebookInstanceUrl', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], ], ], 'NotebookInstanceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookInstanceSummary', ], ], 'NotebookInstanceUrl' => [ 'type' => 'string', ], 'NotebookInstanceVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 5, ], 'NotebookOutputOption' => [ 'type' => 'string', 'enum' => [ 'Allowed', 'Disabled', ], ], 'NotificationConfiguration' => [ 'type' => 'structure', 'members' => [ 'NotificationTopicArn' => [ 'shape' => 'NotificationTopicArn', ], ], ], 'NotificationTopicArn' => [ 'type' => 'string', 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*', ], 'NumberOfAcceleratorDevices' => [ 'type' => 'float', 'min' => 1, ], 'NumberOfCpuCores' => [ 'type' => 'float', 'min' => 0.25, ], 'NumberOfHumanWorkersPerDataObject' => [ 'type' => 'integer', 'max' => 9, 'min' => 1, ], 'NumberOfSteps' => [ 'type' => 'integer', 'min' => 1, ], 'ObjectiveStatus' => [ 'type' => 'string', 'enum' => [ 'Succeeded', 'Pending', 'Failed', ], ], 'ObjectiveStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'ObjectiveStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Succeeded' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Pending' => [ 'shape' => 'ObjectiveStatusCounter', ], 'Failed' => [ 'shape' => 'ObjectiveStatusCounter', ], ], ], 'OfflineStoreConfig' => [ 'type' => 'structure', 'required' => [ 'S3StorageConfig', ], 'members' => [ 'S3StorageConfig' => [ 'shape' => 'S3StorageConfig', ], 'DisableGlueTableCreation' => [ 'shape' => 'Boolean', ], 'DataCatalogConfig' => [ 'shape' => 'DataCatalogConfig', ], 'TableFormat' => [ 'shape' => 'TableFormat', ], ], ], 'OfflineStoreStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'OfflineStoreStatusValue', ], 'BlockedReason' => [ 'shape' => 'BlockedReason', ], ], ], 'OfflineStoreStatusValue' => [ 'type' => 'string', 'enum' => [ 'Active', 'Blocked', 'Disabled', ], ], 'OidcConfig' => [ 'type' => 'structure', 'required' => [ 'ClientId', 'ClientSecret', 'Issuer', 'AuthorizationEndpoint', 'TokenEndpoint', 'UserInfoEndpoint', 'LogoutEndpoint', 'JwksUri', ], 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'ClientSecret' => [ 'shape' => 'ClientSecret', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcConfigForResponse' => [ 'type' => 'structure', 'members' => [ 'ClientId' => [ 'shape' => 'ClientId', ], 'Issuer' => [ 'shape' => 'OidcEndpoint', ], 'AuthorizationEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'TokenEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'UserInfoEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'LogoutEndpoint' => [ 'shape' => 'OidcEndpoint', ], 'JwksUri' => [ 'shape' => 'OidcEndpoint', ], ], ], 'OidcEndpoint' => [ 'type' => 'string', 'max' => 500, 'pattern' => 'https://\\S+', ], 'OidcMemberDefinition' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'Groups', ], ], ], 'OnlineStoreConfig' => [ 'type' => 'structure', 'members' => [ 'SecurityConfig' => [ 'shape' => 'OnlineStoreSecurityConfig', ], 'EnableOnlineStore' => [ 'shape' => 'Boolean', ], 'TtlDuration' => [ 'shape' => 'TtlDuration', ], 'StorageType' => [ 'shape' => 'StorageType', ], ], ], 'OnlineStoreConfigUpdate' => [ 'type' => 'structure', 'members' => [ 'TtlDuration' => [ 'shape' => 'TtlDuration', ], ], ], 'OnlineStoreSecurityConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OnlineStoreTotalSizeBytes' => [ 'type' => 'long', ], 'Operator' => [ 'type' => 'string', 'enum' => [ 'Equals', 'NotEquals', 'GreaterThan', 'GreaterThanOrEqualTo', 'LessThan', 'LessThanOrEqualTo', 'Contains', 'Exists', 'NotExists', 'In', ], ], 'OptionalDouble' => [ 'type' => 'double', ], 'OptionalInteger' => [ 'type' => 'integer', ], 'OptionalVolumeSizeInGB' => [ 'type' => 'integer', 'min' => 0, ], 'OrderKey' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'OutputCompressionType' => [ 'type' => 'string', 'enum' => [ 'GZIP', 'NONE', ], ], 'OutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputLocation', ], 'members' => [ 'S3OutputLocation' => [ 'shape' => 'S3Uri', ], 'TargetDevice' => [ 'shape' => 'TargetDevice', ], 'TargetPlatform' => [ 'shape' => 'TargetPlatform', ], 'CompilerOptions' => [ 'shape' => 'CompilerOptions', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'OutputDataConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'CompressionType' => [ 'shape' => 'OutputCompressionType', ], ], ], 'OutputParameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'String256', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'OutputParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputParameter', ], 'max' => 50, 'min' => 0, ], 'OwnershipSettings' => [ 'type' => 'structure', 'required' => [ 'OwnerUserProfileName', ], 'members' => [ 'OwnerUserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'OwnershipSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'OwnerUserProfileName' => [ 'shape' => 'UserProfileName', ], ], ], 'PaginationToken' => [ 'type' => 'string', 'max' => 8192, 'pattern' => '.*', ], 'ParallelismConfiguration' => [ 'type' => 'structure', 'required' => [ 'MaxParallelExecutionSteps', ], 'members' => [ 'MaxParallelExecutionSteps' => [ 'shape' => 'MaxParallelExecutionSteps', ], ], ], 'Parameter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Value', ], 'members' => [ 'Name' => [ 'shape' => 'PipelineParameterName', ], 'Value' => [ 'shape' => 'String1024', ], ], ], 'ParameterKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', ], 'max' => 200, 'min' => 0, ], 'ParameterName' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*', ], 'ParameterRange' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRangeSpecification' => [ 'shape' => 'IntegerParameterRangeSpecification', ], 'ContinuousParameterRangeSpecification' => [ 'shape' => 'ContinuousParameterRangeSpecification', ], 'CategoricalParameterRangeSpecification' => [ 'shape' => 'CategoricalParameterRangeSpecification', ], ], ], 'ParameterRanges' => [ 'type' => 'structure', 'members' => [ 'IntegerParameterRanges' => [ 'shape' => 'IntegerParameterRanges', ], 'ContinuousParameterRanges' => [ 'shape' => 'ContinuousParameterRanges', ], 'CategoricalParameterRanges' => [ 'shape' => 'CategoricalParameterRanges', ], 'AutoParameters' => [ 'shape' => 'AutoParameters', ], ], ], 'ParameterType' => [ 'type' => 'string', 'enum' => [ 'Integer', 'Continuous', 'Categorical', 'FreeText', ], ], 'ParameterValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ParameterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterValue', ], 'max' => 30, 'min' => 1, ], 'Parent' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'ParentHyperParameterTuningJob' => [ 'type' => 'structure', 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'ParentHyperParameterTuningJobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParentHyperParameterTuningJob', ], 'max' => 5, 'min' => 1, ], 'Parents' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parent', ], ], 'PendingDeploymentSummary' => [ 'type' => 'structure', 'required' => [ 'EndpointConfigName', ], 'members' => [ 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'ProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'ShadowProductionVariants' => [ 'shape' => 'PendingProductionVariantSummaryList', ], ], ], 'PendingProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'PendingProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingProductionVariantSummary', ], 'min' => 1, ], 'Percentage' => [ 'type' => 'integer', 'max' => 100, ], 'Phase' => [ 'type' => 'structure', 'members' => [ 'InitialNumberOfUsers' => [ 'shape' => 'InitialNumberOfUsers', ], 'SpawnRate' => [ 'shape' => 'SpawnRate', ], 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], ], ], 'Phases' => [ 'type' => 'list', 'member' => [ 'shape' => 'Phase', ], 'min' => 1, ], 'Pipeline' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'PipelineStatus' => [ 'shape' => 'PipelineStatus', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastRunTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PipelineArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*', ], 'PipelineDefinition' => [ 'type' => 'string', 'max' => 1048576, 'min' => 1, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'PipelineDefinitionS3Location' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'ObjectKey', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', ], 'ObjectKey' => [ 'shape' => 'Key', ], 'VersionId' => [ 'shape' => 'VersionId', ], ], ], 'PipelineDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecution' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExperimentConfig' => [ 'shape' => 'PipelineExperimentConfig', ], 'FailureReason' => [ 'shape' => 'PipelineExecutionFailureReason', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], ], ], 'PipelineExecutionArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$', ], 'PipelineExecutionDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'PipelineExecutionFailureReason' => [ 'type' => 'string', 'max' => 1300, 'pattern' => '.*', ], 'PipelineExecutionName' => [ 'type' => 'string', 'max' => 82, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}', ], 'PipelineExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'PipelineExecutionStep' => [ 'type' => 'structure', 'members' => [ 'StepName' => [ 'shape' => 'StepName', ], 'StepDisplayName' => [ 'shape' => 'StepDisplayName', ], 'StepDescription' => [ 'shape' => 'StepDescription', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StepStatus' => [ 'shape' => 'StepStatus', ], 'CacheHitResult' => [ 'shape' => 'CacheHitResult', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'Metadata' => [ 'shape' => 'PipelineExecutionStepMetadata', ], 'AttemptCount' => [ 'shape' => 'Integer', ], 'SelectiveExecutionResult' => [ 'shape' => 'SelectiveExecutionResult', ], ], ], 'PipelineExecutionStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionStep', ], 'max' => 100, 'min' => 0, ], 'PipelineExecutionStepMetadata' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJobStepMetadata', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJobStepMetadata', ], 'TransformJob' => [ 'shape' => 'TransformJobStepMetadata', ], 'TuningJob' => [ 'shape' => 'TuningJobStepMetaData', ], 'Model' => [ 'shape' => 'ModelStepMetadata', ], 'RegisterModel' => [ 'shape' => 'RegisterModelStepMetadata', ], 'Condition' => [ 'shape' => 'ConditionStepMetadata', ], 'Callback' => [ 'shape' => 'CallbackStepMetadata', ], 'Lambda' => [ 'shape' => 'LambdaStepMetadata', ], 'EMR' => [ 'shape' => 'EMRStepMetadata', ], 'QualityCheck' => [ 'shape' => 'QualityCheckStepMetadata', ], 'ClarifyCheck' => [ 'shape' => 'ClarifyCheckStepMetadata', ], 'Fail' => [ 'shape' => 'FailStepMetadata', ], 'AutoMLJob' => [ 'shape' => 'AutoMLJobStepMetadata', ], ], ], 'PipelineExecutionSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'PipelineExecutionStatus' => [ 'shape' => 'PipelineExecutionStatus', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineExecutionFailureReason' => [ 'shape' => 'String3072', ], ], ], 'PipelineExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineExecutionSummary', ], 'max' => 100, 'min' => 0, ], 'PipelineExperimentConfig' => [ 'type' => 'structure', 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'PipelineName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}', ], 'PipelineNameOrArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})', ], 'PipelineParameterName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[A-Za-z0-9\\-_]*$', ], 'PipelineStatus' => [ 'type' => 'string', 'enum' => [ 'Active', 'Deleting', ], ], 'PipelineSummary' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastExecutionTime' => [ 'shape' => 'Timestamp', ], ], ], 'PipelineSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PipelineSummary', ], 'max' => 100, 'min' => 0, ], 'PlatformIdentifier' => [ 'type' => 'string', 'max' => 15, 'pattern' => '^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2)$', ], 'PolicyString' => [ 'type' => 'string', 'max' => 20480, 'min' => 1, 'pattern' => '.*', ], 'PredefinedMetricSpecification' => [ 'type' => 'structure', 'members' => [ 'PredefinedMetricType' => [ 'shape' => 'String', ], ], ], 'PresignedDomainUrl' => [ 'type' => 'string', ], 'ProbabilityThresholdAttribute' => [ 'type' => 'double', ], 'ProblemType' => [ 'type' => 'string', 'enum' => [ 'BinaryClassification', 'MulticlassClassification', 'Regression', ], ], 'ProcessingClusterConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceCount', 'InstanceType', 'VolumeSizeInGB', ], 'members' => [ 'InstanceCount' => [ 'shape' => 'ProcessingInstanceCount', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'ProcessingVolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingEnvironmentKey' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'ProcessingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProcessingEnvironmentKey', ], 'value' => [ 'shape' => 'ProcessingEnvironmentValue', ], 'max' => 100, ], 'ProcessingEnvironmentValue' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\S\\s]*', ], 'ProcessingFeatureStoreOutput' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupName', ], ], ], 'ProcessingInput' => [ 'type' => 'structure', 'required' => [ 'InputName', ], 'members' => [ 'InputName' => [ 'shape' => 'String', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], 'S3Input' => [ 'shape' => 'ProcessingS3Input', ], 'DatasetDefinition' => [ 'shape' => 'DatasetDefinition', ], ], ], 'ProcessingInputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingInput', ], 'max' => 10, 'min' => 0, ], 'ProcessingInstanceCount' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ProcessingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t3.medium', 'ml.t3.large', 'ml.t3.xlarge', 'ml.t3.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.8xlarge', 'ml.r5.12xlarge', 'ml.r5.16xlarge', 'ml.r5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'ProcessingJob' => [ 'type' => 'structure', 'members' => [ 'ProcessingInputs' => [ 'shape' => 'ProcessingInputs', ], 'ProcessingOutputConfig' => [ 'shape' => 'ProcessingOutputConfig', ], 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingResources' => [ 'shape' => 'ProcessingResources', ], 'StoppingCondition' => [ 'shape' => 'ProcessingStoppingCondition', ], 'AppSpecification' => [ 'shape' => 'AppSpecification', ], 'Environment' => [ 'shape' => 'ProcessingEnvironmentMap', ], 'NetworkConfig' => [ 'shape' => 'NetworkConfig', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'ProcessingStartTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ProcessingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/.*', ], 'ProcessingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'ProcessingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'ProcessingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ProcessingJobArn', ], ], ], 'ProcessingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingJobSummary', ], ], 'ProcessingJobSummary' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', 'ProcessingJobArn', 'CreationTime', 'ProcessingJobStatus', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], 'ProcessingJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProcessingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ProcessingJobStatus' => [ 'shape' => 'ProcessingJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ExitMessage' => [ 'shape' => 'ExitMessage', ], ], ], 'ProcessingLocalPath' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'ProcessingMaxRuntimeInSeconds' => [ 'type' => 'integer', 'max' => 777600, 'min' => 1, ], 'ProcessingOutput' => [ 'type' => 'structure', 'required' => [ 'OutputName', ], 'members' => [ 'OutputName' => [ 'shape' => 'String', ], 'S3Output' => [ 'shape' => 'ProcessingS3Output', ], 'FeatureStoreOutput' => [ 'shape' => 'ProcessingFeatureStoreOutput', ], 'AppManaged' => [ 'shape' => 'AppManaged', ], ], ], 'ProcessingOutputConfig' => [ 'type' => 'structure', 'required' => [ 'Outputs', ], 'members' => [ 'Outputs' => [ 'shape' => 'ProcessingOutputs', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProcessingOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessingOutput', ], 'max' => 10, 'min' => 0, ], 'ProcessingResources' => [ 'type' => 'structure', 'required' => [ 'ClusterConfig', ], 'members' => [ 'ClusterConfig' => [ 'shape' => 'ProcessingClusterConfig', ], ], ], 'ProcessingS3CompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'Gzip', ], ], 'ProcessingS3DataDistributionType' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'ProcessingS3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', ], ], 'ProcessingS3Input' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3DataType' => [ 'shape' => 'ProcessingS3DataType', ], 'S3InputMode' => [ 'shape' => 'ProcessingS3InputMode', ], 'S3DataDistributionType' => [ 'shape' => 'ProcessingS3DataDistributionType', ], 'S3CompressionType' => [ 'shape' => 'ProcessingS3CompressionType', ], ], ], 'ProcessingS3InputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', ], ], 'ProcessingS3Output' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'LocalPath', 'S3UploadMode', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'LocalPath' => [ 'shape' => 'ProcessingLocalPath', ], 'S3UploadMode' => [ 'shape' => 'ProcessingS3UploadMode', ], ], ], 'ProcessingS3UploadMode' => [ 'type' => 'string', 'enum' => [ 'Continuous', 'EndOfJob', ], ], 'ProcessingStoppingCondition' => [ 'type' => 'structure', 'required' => [ 'MaxRuntimeInSeconds', ], 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'ProcessingMaxRuntimeInSeconds', ], ], ], 'ProcessingVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 16384, 'min' => 1, ], 'Processor' => [ 'type' => 'string', 'enum' => [ 'CPU', 'GPU', ], ], 'ProductId' => [ 'type' => 'string', 'max' => 256, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*$', ], 'ProductListings' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ProductionVariant' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'InitialInstanceCount' => [ 'shape' => 'InitialTaskCount', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'InitialVariantWeight' => [ 'shape' => 'VariantWeight', ], 'AcceleratorType' => [ 'shape' => 'ProductionVariantAcceleratorType', ], 'CoreDumpConfig' => [ 'shape' => 'ProductionVariantCoreDumpConfig', ], 'ServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'ProductionVariantVolumeSizeInGB', ], 'ModelDataDownloadTimeoutInSeconds' => [ 'shape' => 'ProductionVariantModelDataDownloadTimeoutInSeconds', ], 'ContainerStartupHealthCheckTimeoutInSeconds' => [ 'shape' => 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds', ], 'EnableSSMAccess' => [ 'shape' => 'ProductionVariantSSMAccess', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'ProductionVariantAcceleratorType' => [ 'type' => 'string', 'enum' => [ 'ml.eia1.medium', 'ml.eia1.large', 'ml.eia1.xlarge', 'ml.eia2.medium', 'ml.eia2.large', 'ml.eia2.xlarge', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantCoreDumpConfig' => [ 'type' => 'structure', 'required' => [ 'DestinationS3Uri', ], 'members' => [ 'DestinationS3Uri' => [ 'shape' => 'DestinationS3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'ProductionVariantInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.t2.medium', 'ml.t2.large', 'ml.t2.xlarge', 'ml.t2.2xlarge', 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.m5d.large', 'ml.m5d.xlarge', 'ml.m5d.2xlarge', 'ml.m5d.4xlarge', 'ml.m5d.12xlarge', 'ml.m5d.24xlarge', 'ml.c4.large', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.large', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5d.large', 'ml.c5d.xlarge', 'ml.c5d.2xlarge', 'ml.c5d.4xlarge', 'ml.c5d.9xlarge', 'ml.c5d.18xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.r5.large', 'ml.r5.xlarge', 'ml.r5.2xlarge', 'ml.r5.4xlarge', 'ml.r5.12xlarge', 'ml.r5.24xlarge', 'ml.r5d.large', 'ml.r5d.xlarge', 'ml.r5d.2xlarge', 'ml.r5d.4xlarge', 'ml.r5d.12xlarge', 'ml.r5d.24xlarge', 'ml.inf1.xlarge', 'ml.inf1.2xlarge', 'ml.inf1.6xlarge', 'ml.inf1.24xlarge', 'ml.dl1.24xlarge', 'ml.c6i.large', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.4xlarge', 'ml.c6i.8xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.12xlarge', 'ml.g5.16xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.p4d.24xlarge', 'ml.c7g.large', 'ml.c7g.xlarge', 'ml.c7g.2xlarge', 'ml.c7g.4xlarge', 'ml.c7g.8xlarge', 'ml.c7g.12xlarge', 'ml.c7g.16xlarge', 'ml.m6g.large', 'ml.m6g.xlarge', 'ml.m6g.2xlarge', 'ml.m6g.4xlarge', 'ml.m6g.8xlarge', 'ml.m6g.12xlarge', 'ml.m6g.16xlarge', 'ml.m6gd.large', 'ml.m6gd.xlarge', 'ml.m6gd.2xlarge', 'ml.m6gd.4xlarge', 'ml.m6gd.8xlarge', 'ml.m6gd.12xlarge', 'ml.m6gd.16xlarge', 'ml.c6g.large', 'ml.c6g.xlarge', 'ml.c6g.2xlarge', 'ml.c6g.4xlarge', 'ml.c6g.8xlarge', 'ml.c6g.12xlarge', 'ml.c6g.16xlarge', 'ml.c6gd.large', 'ml.c6gd.xlarge', 'ml.c6gd.2xlarge', 'ml.c6gd.4xlarge', 'ml.c6gd.8xlarge', 'ml.c6gd.12xlarge', 'ml.c6gd.16xlarge', 'ml.c6gn.large', 'ml.c6gn.xlarge', 'ml.c6gn.2xlarge', 'ml.c6gn.4xlarge', 'ml.c6gn.8xlarge', 'ml.c6gn.12xlarge', 'ml.c6gn.16xlarge', 'ml.r6g.large', 'ml.r6g.xlarge', 'ml.r6g.2xlarge', 'ml.r6g.4xlarge', 'ml.r6g.8xlarge', 'ml.r6g.12xlarge', 'ml.r6g.16xlarge', 'ml.r6gd.large', 'ml.r6gd.xlarge', 'ml.r6gd.2xlarge', 'ml.r6gd.4xlarge', 'ml.r6gd.8xlarge', 'ml.r6gd.12xlarge', 'ml.r6gd.16xlarge', 'ml.p4de.24xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.inf2.xlarge', 'ml.inf2.8xlarge', 'ml.inf2.24xlarge', 'ml.inf2.48xlarge', 'ml.p5.48xlarge', 'ml.m7i.large', 'ml.m7i.xlarge', 'ml.m7i.2xlarge', 'ml.m7i.4xlarge', 'ml.m7i.8xlarge', 'ml.m7i.12xlarge', 'ml.m7i.16xlarge', 'ml.m7i.24xlarge', 'ml.m7i.48xlarge', 'ml.c7i.large', 'ml.c7i.xlarge', 'ml.c7i.2xlarge', 'ml.c7i.4xlarge', 'ml.c7i.8xlarge', 'ml.c7i.12xlarge', 'ml.c7i.16xlarge', 'ml.c7i.24xlarge', 'ml.c7i.48xlarge', 'ml.r7i.large', 'ml.r7i.xlarge', 'ml.r7i.2xlarge', 'ml.r7i.4xlarge', 'ml.r7i.8xlarge', 'ml.r7i.12xlarge', 'ml.r7i.16xlarge', 'ml.r7i.24xlarge', 'ml.r7i.48xlarge', ], ], 'ProductionVariantList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariant', ], 'max' => 10, 'min' => 1, ], 'ProductionVariantManagedInstanceScaling' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'ManagedInstanceScalingStatus', ], 'MinInstanceCount' => [ 'shape' => 'ManagedInstanceScalingMinInstanceCount', ], 'MaxInstanceCount' => [ 'shape' => 'ManagedInstanceScalingMaxInstanceCount', ], ], ], 'ProductionVariantModelDataDownloadTimeoutInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 60, ], 'ProductionVariantRoutingConfig' => [ 'type' => 'structure', 'required' => [ 'RoutingStrategy', ], 'members' => [ 'RoutingStrategy' => [ 'shape' => 'RoutingStrategy', ], ], ], 'ProductionVariantSSMAccess' => [ 'type' => 'boolean', ], 'ProductionVariantServerlessConfig' => [ 'type' => 'structure', 'required' => [ 'MemorySizeInMB', 'MaxConcurrency', ], 'members' => [ 'MemorySizeInMB' => [ 'shape' => 'ServerlessMemorySizeInMB', ], 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'type' => 'structure', 'members' => [ 'MaxConcurrency' => [ 'shape' => 'ServerlessMaxConcurrency', ], 'ProvisionedConcurrency' => [ 'shape' => 'ServerlessProvisionedConcurrency', ], ], ], 'ProductionVariantStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'VariantStatus', ], 'StatusMessage' => [ 'shape' => 'VariantStatusMessage', ], 'StartTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProductionVariantStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantStatus', ], 'max' => 5, 'min' => 0, ], 'ProductionVariantSummary' => [ 'type' => 'structure', 'required' => [ 'VariantName', ], 'members' => [ 'VariantName' => [ 'shape' => 'VariantName', ], 'DeployedImages' => [ 'shape' => 'DeployedImages', ], 'CurrentWeight' => [ 'shape' => 'VariantWeight', ], 'DesiredWeight' => [ 'shape' => 'VariantWeight', ], 'CurrentInstanceCount' => [ 'shape' => 'TaskCount', ], 'DesiredInstanceCount' => [ 'shape' => 'TaskCount', ], 'VariantStatus' => [ 'shape' => 'ProductionVariantStatusList', ], 'CurrentServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'DesiredServerlessConfig' => [ 'shape' => 'ProductionVariantServerlessConfig', ], 'ManagedInstanceScaling' => [ 'shape' => 'ProductionVariantManagedInstanceScaling', ], 'RoutingConfig' => [ 'shape' => 'ProductionVariantRoutingConfig', ], ], ], 'ProductionVariantSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantSummary', ], 'min' => 1, ], 'ProductionVariantVolumeSizeInGB' => [ 'type' => 'integer', 'max' => 512, 'min' => 1, ], 'ProfilerConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'ProfilingIntervalInMilliseconds' => [ 'shape' => 'ProfilingIntervalInMilliseconds', ], 'ProfilingParameters' => [ 'shape' => 'ProfilingParameters', ], 'DisableProfiler' => [ 'shape' => 'DisableProfiler', ], ], ], 'ProfilerRuleConfiguration' => [ 'type' => 'structure', 'required' => [ 'RuleConfigurationName', 'RuleEvaluatorImage', ], 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'RuleEvaluatorImage' => [ 'shape' => 'AlgorithmImage', ], 'InstanceType' => [ 'shape' => 'ProcessingInstanceType', ], 'VolumeSizeInGB' => [ 'shape' => 'OptionalVolumeSizeInGB', ], 'RuleParameters' => [ 'shape' => 'RuleParameters', ], ], ], 'ProfilerRuleConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleConfiguration', ], 'max' => 20, 'min' => 0, ], 'ProfilerRuleEvaluationStatus' => [ 'type' => 'structure', 'members' => [ 'RuleConfigurationName' => [ 'shape' => 'RuleConfigurationName', ], 'RuleEvaluationJobArn' => [ 'shape' => 'ProcessingJobArn', ], 'RuleEvaluationStatus' => [ 'shape' => 'RuleEvaluationStatus', ], 'StatusDetails' => [ 'shape' => 'StatusDetails', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'ProfilerRuleEvaluationStatuses' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProfilerRuleEvaluationStatus', ], 'max' => 20, 'min' => 0, ], 'ProfilingIntervalInMilliseconds' => [ 'type' => 'long', ], 'ProfilingParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 20, 'min' => 0, ], 'ProfilingStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ProgrammingLang' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$', ], 'Project' => [ 'type' => 'structure', 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningDetails' => [ 'shape' => 'ServiceCatalogProvisioningDetails', ], 'ServiceCatalogProvisionedProductDetails' => [ 'shape' => 'ServiceCatalogProvisionedProductDetails', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'Tags' => [ 'shape' => 'TagList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'ProjectArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:project/[\\S]{1,2048}$', ], 'ProjectEntityName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}', ], 'ProjectId' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9])*', ], 'ProjectSortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'ProjectSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ProjectStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'CreateInProgress', 'CreateCompleted', 'CreateFailed', 'DeleteInProgress', 'DeleteFailed', 'DeleteCompleted', 'UpdateInProgress', 'UpdateCompleted', 'UpdateFailed', ], ], 'ProjectSummary' => [ 'type' => 'structure', 'required' => [ 'ProjectName', 'ProjectArn', 'ProjectId', 'CreationTime', 'ProjectStatus', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ProjectArn' => [ 'shape' => 'ProjectArn', ], 'ProjectId' => [ 'shape' => 'ProjectId', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'ProjectStatus' => [ 'shape' => 'ProjectStatus', ], ], ], 'ProjectSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProjectSummary', ], ], 'PropertyNameHint' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'pattern' => '.*', ], 'PropertyNameQuery' => [ 'type' => 'structure', 'required' => [ 'PropertyNameHint', ], 'members' => [ 'PropertyNameHint' => [ 'shape' => 'PropertyNameHint', ], ], ], 'PropertyNameSuggestion' => [ 'type' => 'structure', 'members' => [ 'PropertyName' => [ 'shape' => 'ResourcePropertyName', ], ], ], 'PropertyNameSuggestionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PropertyNameSuggestion', ], ], 'ProvisionedProductStatusMessage' => [ 'type' => 'string', 'pattern' => '.*', ], 'ProvisioningParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ProvisioningParameterKey', ], 'Value' => [ 'shape' => 'ProvisioningParameterValue', ], ], ], 'ProvisioningParameterKey' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, 'pattern' => '.*', ], 'ProvisioningParameterValue' => [ 'type' => 'string', 'max' => 4096, 'pattern' => '.*', ], 'ProvisioningParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningParameter', ], ], 'PublicWorkforceTaskPrice' => [ 'type' => 'structure', 'members' => [ 'AmountInUsd' => [ 'shape' => 'USD', ], ], ], 'PutModelPackageGroupPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupName', 'ResourcePolicy', ], 'members' => [ 'ModelPackageGroupName' => [ 'shape' => 'EntityName', ], 'ResourcePolicy' => [ 'shape' => 'PolicyString', ], ], ], 'PutModelPackageGroupPolicyOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageGroupArn', ], 'members' => [ 'ModelPackageGroupArn' => [ 'shape' => 'ModelPackageGroupArn', ], ], ], 'QualityCheckStepMetadata' => [ 'type' => 'structure', 'members' => [ 'CheckType' => [ 'shape' => 'String256', ], 'BaselineUsedForDriftCheckStatistics' => [ 'shape' => 'String1024', ], 'BaselineUsedForDriftCheckConstraints' => [ 'shape' => 'String1024', ], 'CalculatedBaselineStatistics' => [ 'shape' => 'String1024', ], 'CalculatedBaselineConstraints' => [ 'shape' => 'String1024', ], 'ModelPackageGroupName' => [ 'shape' => 'String256', ], 'ViolationReport' => [ 'shape' => 'String1024', ], 'CheckJobArn' => [ 'shape' => 'String256', ], 'SkipCheck' => [ 'shape' => 'Boolean', ], 'RegisterNewBaseline' => [ 'shape' => 'Boolean', ], ], ], 'QueryFilters' => [ 'type' => 'structure', 'members' => [ 'Types' => [ 'shape' => 'QueryTypes', ], 'LineageTypes' => [ 'shape' => 'QueryLineageTypes', ], 'CreatedBefore' => [ 'shape' => 'Timestamp', ], 'CreatedAfter' => [ 'shape' => 'Timestamp', ], 'ModifiedBefore' => [ 'shape' => 'Timestamp', ], 'ModifiedAfter' => [ 'shape' => 'Timestamp', ], 'Properties' => [ 'shape' => 'QueryProperties', ], ], ], 'QueryLineageMaxDepth' => [ 'type' => 'integer', 'max' => 10, ], 'QueryLineageMaxResults' => [ 'type' => 'integer', 'max' => 50, ], 'QueryLineageRequest' => [ 'type' => 'structure', 'members' => [ 'StartArns' => [ 'shape' => 'QueryLineageStartArns', ], 'Direction' => [ 'shape' => 'Direction', ], 'IncludeEdges' => [ 'shape' => 'Boolean', ], 'Filters' => [ 'shape' => 'QueryFilters', ], 'MaxDepth' => [ 'shape' => 'QueryLineageMaxDepth', ], 'MaxResults' => [ 'shape' => 'QueryLineageMaxResults', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageResponse' => [ 'type' => 'structure', 'members' => [ 'Vertices' => [ 'shape' => 'Vertices', ], 'Edges' => [ 'shape' => 'Edges', ], 'NextToken' => [ 'shape' => 'String8192', ], ], ], 'QueryLineageStartArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'AssociationEntityArn', ], 'max' => 1, 'min' => 0, ], 'QueryLineageTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'LineageType', ], 'max' => 4, ], 'QueryProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'String256', ], 'value' => [ 'shape' => 'String256', ], 'max' => 5, ], 'QueryTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String40', ], 'max' => 5, ], 'RSessionAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CustomImages' => [ 'shape' => 'CustomImages', ], ], ], 'RStudioServerProAccessStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'RStudioServerProAppSettings' => [ 'type' => 'structure', 'members' => [ 'AccessStatus' => [ 'shape' => 'RStudioServerProAccessStatus', ], 'UserGroup' => [ 'shape' => 'RStudioServerProUserGroup', ], ], ], 'RStudioServerProDomainSettings' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'RStudioServerProDomainSettingsForUpdate' => [ 'type' => 'structure', 'required' => [ 'DomainExecutionRoleArn', ], 'members' => [ 'DomainExecutionRoleArn' => [ 'shape' => 'RoleArn', ], 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'RStudioConnectUrl' => [ 'shape' => 'String', ], 'RStudioPackageManagerUrl' => [ 'shape' => 'String', ], ], ], 'RStudioServerProUserGroup' => [ 'type' => 'string', 'enum' => [ 'R_STUDIO_ADMIN', 'R_STUDIO_USER', ], ], 'RandomSeed' => [ 'type' => 'integer', 'min' => 0, ], 'RealTimeInferenceConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'TaskCount', ], ], ], 'RealTimeInferenceRecommendation' => [ 'type' => 'structure', 'required' => [ 'RecommendationId', 'InstanceType', ], 'members' => [ 'RecommendationId' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'ProductionVariantInstanceType', ], 'Environment' => [ 'shape' => 'EnvironmentMap', ], ], ], 'RealTimeInferenceRecommendations' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeInferenceRecommendation', ], 'max' => 3, 'min' => 0, ], 'RealtimeInferenceInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductionVariantInstanceType', ], ], 'RecommendationFailureReason' => [ 'type' => 'string', ], 'RecommendationJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/.*', ], 'RecommendationJobCompilationJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$', ], 'RecommendationJobCompiledOutputConfig' => [ 'type' => 'structure', 'members' => [ 'S3OutputUri' => [ 'shape' => 'S3Uri', ], ], ], 'RecommendationJobContainerConfig' => [ 'type' => 'structure', 'members' => [ 'Domain' => [ 'shape' => 'String', ], 'Task' => [ 'shape' => 'String', ], 'Framework' => [ 'shape' => 'String', ], 'FrameworkVersion' => [ 'shape' => 'RecommendationJobFrameworkVersion', ], 'PayloadConfig' => [ 'shape' => 'RecommendationJobPayloadConfig', ], 'NearestModelName' => [ 'shape' => 'String', ], 'SupportedInstanceTypes' => [ 'shape' => 'RecommendationJobSupportedInstanceTypes', ], 'SupportedEndpointType' => [ 'shape' => 'RecommendationJobSupportedEndpointType', ], 'DataInputConfig' => [ 'shape' => 'RecommendationJobDataInputConfig', ], 'SupportedResponseMIMETypes' => [ 'shape' => 'RecommendationJobSupportedResponseMIMETypes', ], ], ], 'RecommendationJobDataInputConfig' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'RecommendationJobDescription' => [ 'type' => 'string', 'max' => 128, ], 'RecommendationJobFrameworkVersion' => [ 'type' => 'string', 'max' => 10, 'min' => 3, 'pattern' => '[0-9]\\.[A-Za-z0-9.-]+', ], 'RecommendationJobInferenceBenchmark' => [ 'type' => 'structure', 'required' => [ 'ModelConfiguration', ], 'members' => [ 'Metrics' => [ 'shape' => 'RecommendationMetrics', ], 'EndpointMetrics' => [ 'shape' => 'InferenceMetrics', ], 'EndpointConfiguration' => [ 'shape' => 'EndpointOutputConfiguration', ], 'ModelConfiguration' => [ 'shape' => 'ModelConfiguration', ], 'FailureReason' => [ 'shape' => 'RecommendationFailureReason', ], 'InvocationEndTime' => [ 'shape' => 'InvocationEndTime', ], 'InvocationStartTime' => [ 'shape' => 'InvocationStartTime', ], ], ], 'RecommendationJobInputConfig' => [ 'type' => 'structure', 'members' => [ 'ModelPackageVersionArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'JobDurationInSeconds' => [ 'shape' => 'JobDurationInSeconds', ], 'TrafficPattern' => [ 'shape' => 'TrafficPattern', ], 'ResourceLimit' => [ 'shape' => 'RecommendationJobResourceLimit', ], 'EndpointConfigurations' => [ 'shape' => 'EndpointInputConfigurations', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ContainerConfig' => [ 'shape' => 'RecommendationJobContainerConfig', ], 'Endpoints' => [ 'shape' => 'Endpoints', ], 'VpcConfig' => [ 'shape' => 'RecommendationJobVpcConfig', ], ], ], 'RecommendationJobName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}', ], 'RecommendationJobOutputConfig' => [ 'type' => 'structure', 'members' => [ 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'CompiledOutputConfig' => [ 'shape' => 'RecommendationJobCompiledOutputConfig', ], ], ], 'RecommendationJobPayloadConfig' => [ 'type' => 'structure', 'members' => [ 'SamplePayloadUrl' => [ 'shape' => 'S3Uri', ], 'SupportedContentTypes' => [ 'shape' => 'RecommendationJobSupportedContentTypes', ], ], ], 'RecommendationJobResourceLimit' => [ 'type' => 'structure', 'members' => [ 'MaxNumberOfTests' => [ 'shape' => 'MaxNumberOfTests', ], 'MaxParallelOfTests' => [ 'shape' => 'MaxParallelOfTests', ], ], ], 'RecommendationJobStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'STOPPING', 'STOPPED', 'DELETING', 'DELETED', ], ], 'RecommendationJobStoppingConditions' => [ 'type' => 'structure', 'members' => [ 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatencyThresholds' => [ 'shape' => 'ModelLatencyThresholds', ], 'FlatInvocations' => [ 'shape' => 'FlatInvocations', ], ], ], 'RecommendationJobSupportedContentType' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'RecommendationJobSupportedContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobSupportedContentType', ], ], 'RecommendationJobSupportedEndpointType' => [ 'type' => 'string', 'enum' => [ 'RealTime', 'Serverless', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RecommendationJobSupportedResponseMIMEType' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^[-\\w]+\\/.+$', ], 'RecommendationJobSupportedResponseMIMETypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobSupportedResponseMIMEType', ], ], 'RecommendationJobType' => [ 'type' => 'string', 'enum' => [ 'Default', 'Advanced', ], ], 'RecommendationJobVpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'RecommendationJobVpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'RecommendationJobVpcSubnets', ], ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'RecommendationJobVpcSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'RecommendationJobVpcSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecommendationJobVpcSubnetId', ], 'max' => 16, 'min' => 1, ], 'RecommendationMetrics' => [ 'type' => 'structure', 'required' => [ 'CostPerHour', 'CostPerInference', 'MaxInvocations', 'ModelLatency', ], 'members' => [ 'CostPerHour' => [ 'shape' => 'Float', ], 'CostPerInference' => [ 'shape' => 'Float', ], 'MaxInvocations' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], 'CpuUtilization' => [ 'shape' => 'UtilizationMetric', ], 'MemoryUtilization' => [ 'shape' => 'UtilizationMetric', ], 'ModelSetupTime' => [ 'shape' => 'ModelSetupTime', ], ], ], 'RecommendationStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'COMPLETED', 'FAILED', 'NOT_APPLICABLE', ], ], 'RecommendationStepType' => [ 'type' => 'string', 'enum' => [ 'BENCHMARK', ], ], 'RecordWrapper' => [ 'type' => 'string', 'enum' => [ 'None', 'RecordIO', ], ], 'RedshiftClusterId' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatabase' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '.*', ], 'RedshiftDatasetDefinition' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'Database', 'DbUser', 'QueryString', 'ClusterRoleArn', 'OutputS3Uri', 'OutputFormat', ], 'members' => [ 'ClusterId' => [ 'shape' => 'RedshiftClusterId', ], 'Database' => [ 'shape' => 'RedshiftDatabase', ], 'DbUser' => [ 'shape' => 'RedshiftUserName', ], 'QueryString' => [ 'shape' => 'RedshiftQueryString', ], 'ClusterRoleArn' => [ 'shape' => 'RoleArn', ], 'OutputS3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'OutputFormat' => [ 'shape' => 'RedshiftResultFormat', ], 'OutputCompression' => [ 'shape' => 'RedshiftResultCompressionType', ], ], ], 'RedshiftQueryString' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '[\\s\\S]+', ], 'RedshiftResultCompressionType' => [ 'type' => 'string', 'enum' => [ 'None', 'GZIP', 'BZIP2', 'ZSTD', 'SNAPPY', ], ], 'RedshiftResultFormat' => [ 'type' => 'string', 'enum' => [ 'PARQUET', 'CSV', ], ], 'RedshiftUserName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '.*', ], 'RegisterDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'RegisterModelStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'String256', ], ], ], 'ReleaseNotes' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.*', ], 'RemoteDebugConfig' => [ 'type' => 'structure', 'members' => [ 'EnableRemoteDebug' => [ 'shape' => 'EnableRemoteDebug', ], ], ], 'RemoteDebugConfigForUpdate' => [ 'type' => 'structure', 'members' => [ 'EnableRemoteDebug' => [ 'shape' => 'EnableRemoteDebug', ], ], ], 'RenderUiTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'Task', 'RoleArn', ], 'members' => [ 'UiTemplate' => [ 'shape' => 'UiTemplate', ], 'Task' => [ 'shape' => 'RenderableTask', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'RenderUiTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'RenderedContent', 'Errors', ], 'members' => [ 'RenderedContent' => [ 'shape' => 'String', ], 'Errors' => [ 'shape' => 'RenderingErrorList', ], ], ], 'RenderableTask' => [ 'type' => 'structure', 'required' => [ 'Input', ], 'members' => [ 'Input' => [ 'shape' => 'TaskInput', ], ], ], 'RenderingError' => [ 'type' => 'structure', 'required' => [ 'Code', 'Message', ], 'members' => [ 'Code' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], ], ], 'RenderingErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RenderingError', ], ], 'RepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'RepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'RepositoryCredentialsProviderArn', ], 'members' => [ 'RepositoryCredentialsProviderArn' => [ 'shape' => 'RepositoryCredentialsProviderArn', ], ], ], 'RepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*', ], 'RepositoryUrl' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$', ], 'ResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'AutoMLJobObjective' => [ 'shape' => 'AutoMLJobObjective', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+', ], 'ResourceCatalog' => [ 'type' => 'structure', 'required' => [ 'ResourceCatalogArn', 'ResourceCatalogName', 'Description', 'CreationTime', ], 'members' => [ 'ResourceCatalogArn' => [ 'shape' => 'ResourceCatalogArn', ], 'ResourceCatalogName' => [ 'shape' => 'ResourceCatalogName', ], 'Description' => [ 'shape' => 'ResourceCatalogDescription', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], ], ], 'ResourceCatalogArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:sagemaker-catalog/.*', ], 'ResourceCatalogDescription' => [ 'type' => 'string', 'max' => 256, ], 'ResourceCatalogList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceCatalog', ], ], 'ResourceCatalogName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ResourceCatalogSortBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'ResourceCatalogSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'ResourceConfig' => [ 'type' => 'structure', 'required' => [ 'VolumeSizeInGB', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TrainingInstanceType', ], 'InstanceCount' => [ 'shape' => 'TrainingInstanceCount', ], 'VolumeSizeInGB' => [ 'shape' => 'VolumeSizeInGB', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroups', ], ], ], 'ResourceConfigForUpdate' => [ 'type' => 'structure', 'required' => [ 'KeepAlivePeriodInSeconds', ], 'members' => [ 'KeepAlivePeriodInSeconds' => [ 'shape' => 'KeepAlivePeriodInSeconds', ], ], ], 'ResourceId' => [ 'type' => 'string', 'max' => 32, ], 'ResourceInUse' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimitExceeded' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourceLimits' => [ 'type' => 'structure', 'required' => [ 'MaxParallelTrainingJobs', ], 'members' => [ 'MaxNumberOfTrainingJobs' => [ 'shape' => 'MaxNumberOfTrainingJobs', ], 'MaxParallelTrainingJobs' => [ 'shape' => 'MaxParallelTrainingJobs', ], 'MaxRuntimeInSeconds' => [ 'shape' => 'HyperParameterTuningMaxRuntimeInSeconds', ], ], ], 'ResourceNotFound' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'FailureReason', ], ], 'exception' => true, ], 'ResourcePolicyString' => [ 'type' => 'string', 'max' => 20480, 'pattern' => '.*(?:[ \\r\\n\\t].*)*', ], 'ResourcePropertyName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'type' => 'integer', 'min' => 0, ], 'ResourceSpec' => [ 'type' => 'structure', 'members' => [ 'SageMakerImageArn' => [ 'shape' => 'ImageArn', ], 'SageMakerImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], 'SageMakerImageVersionAlias' => [ 'shape' => 'ImageVersionAlias', ], 'InstanceType' => [ 'shape' => 'AppInstanceType', ], 'LifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'TrainingJob', 'Experiment', 'ExperimentTrial', 'ExperimentTrialComponent', 'Endpoint', 'Model', 'ModelPackage', 'ModelPackageGroup', 'Pipeline', 'PipelineExecution', 'FeatureGroup', 'FeatureMetadata', 'Image', 'ImageVersion', 'Project', 'HyperParameterTuningJob', 'ModelCard', ], ], 'ResponseMIMEType' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^[-\\w]+\\/.+$', ], 'ResponseMIMETypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResponseMIMEType', ], ], 'RetentionPolicy' => [ 'type' => 'structure', 'members' => [ 'HomeEfsFileSystem' => [ 'shape' => 'RetentionType', ], ], ], 'RetentionType' => [ 'type' => 'string', 'enum' => [ 'Retain', 'Delete', ], ], 'RetryPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'RetryPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'RetryStrategy' => [ 'type' => 'structure', 'required' => [ 'MaximumRetryAttempts', ], 'members' => [ 'MaximumRetryAttempts' => [ 'shape' => 'MaximumRetryAttempts', ], ], ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$', ], 'RollingUpdatePolicy' => [ 'type' => 'structure', 'required' => [ 'MaximumBatchSize', 'WaitIntervalInSeconds', ], 'members' => [ 'MaximumBatchSize' => [ 'shape' => 'CapacitySize', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'MaximumExecutionTimeoutInSeconds' => [ 'shape' => 'MaximumExecutionTimeoutInSeconds', ], 'RollbackMaximumBatchSize' => [ 'shape' => 'CapacitySize', ], ], ], 'RootAccess' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'RoutingStrategy' => [ 'type' => 'string', 'enum' => [ 'LEAST_OUTSTANDING_REQUESTS', 'RANDOM', ], ], 'RuleConfigurationName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '.*', ], 'RuleEvaluationStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'NoIssuesFound', 'IssuesFound', 'Error', 'Stopping', 'Stopped', ], ], 'RuleParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConfigKey', ], 'value' => [ 'shape' => 'ConfigValue', ], 'max' => 100, 'min' => 0, ], 'S3DataDistribution' => [ 'type' => 'string', 'enum' => [ 'FullyReplicated', 'ShardedByS3Key', ], ], 'S3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'S3DataDistributionType' => [ 'shape' => 'S3DataDistribution', ], 'AttributeNames' => [ 'shape' => 'AttributeNames', ], 'InstanceGroupNames' => [ 'shape' => 'InstanceGroupNames', ], ], ], 'S3DataType' => [ 'type' => 'string', 'enum' => [ 'ManifestFile', 'S3Prefix', 'AugmentedManifestFile', ], ], 'S3ModelDataSource' => [ 'type' => 'structure', 'required' => [ 'S3Uri', 'S3DataType', 'CompressionType', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3ModelUri', ], 'S3DataType' => [ 'shape' => 'S3ModelDataType', ], 'CompressionType' => [ 'shape' => 'ModelCompressionType', ], 'ModelAccessConfig' => [ 'shape' => 'ModelAccessConfig', ], ], ], 'S3ModelDataType' => [ 'type' => 'string', 'enum' => [ 'S3Prefix', 'S3Object', ], ], 'S3ModelUri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3OutputPath' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'S3StorageConfig' => [ 'type' => 'structure', 'required' => [ 'S3Uri', ], 'members' => [ 'S3Uri' => [ 'shape' => 'S3Uri', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], 'ResolvedOutputS3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'S3Uri' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'SageMakerImageVersionAlias' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(?!^[.-])^([a-zA-Z0-9-_.]+)$', ], 'SageMakerImageVersionAliases' => [ 'type' => 'list', 'member' => [ 'shape' => 'SageMakerImageVersionAlias', ], ], 'SagemakerServicecatalogStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'SampleWeightAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_-]+$', ], 'SamplingPercentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ScalingPolicies' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScalingPolicy', ], ], 'ScalingPolicy' => [ 'type' => 'structure', 'members' => [ 'TargetTracking' => [ 'shape' => 'TargetTrackingScalingPolicyConfiguration', ], ], 'union' => true, ], 'ScalingPolicyMetric' => [ 'type' => 'structure', 'members' => [ 'InvocationsPerInstance' => [ 'shape' => 'Integer', ], 'ModelLatency' => [ 'shape' => 'Integer', ], ], ], 'ScalingPolicyObjective' => [ 'type' => 'structure', 'members' => [ 'MinInvocationsPerMinute' => [ 'shape' => 'Integer', ], 'MaxInvocationsPerMinute' => [ 'shape' => 'Integer', ], ], ], 'ScheduleConfig' => [ 'type' => 'structure', 'required' => [ 'ScheduleExpression', ], 'members' => [ 'ScheduleExpression' => [ 'shape' => 'ScheduleExpression', ], 'DataAnalysisStartTime' => [ 'shape' => 'String', ], 'DataAnalysisEndTime' => [ 'shape' => 'String', ], ], ], 'ScheduleExpression' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ScheduleStatus' => [ 'type' => 'string', 'enum' => [ 'Pending', 'Failed', 'Scheduled', 'Stopped', ], ], 'SearchExpression' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'FilterList', ], 'NestedFilters' => [ 'shape' => 'NestedFiltersList', ], 'SubExpressions' => [ 'shape' => 'SearchExpressionList', ], 'Operator' => [ 'shape' => 'BooleanOperator', ], ], ], 'SearchExpressionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchExpression', ], 'max' => 20, 'min' => 1, ], 'SearchRecord' => [ 'type' => 'structure', 'members' => [ 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'Experiment' => [ 'shape' => 'Experiment', ], 'Trial' => [ 'shape' => 'Trial', ], 'TrialComponent' => [ 'shape' => 'TrialComponent', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'ModelPackage' => [ 'shape' => 'ModelPackage', ], 'ModelPackageGroup' => [ 'shape' => 'ModelPackageGroup', ], 'Pipeline' => [ 'shape' => 'Pipeline', ], 'PipelineExecution' => [ 'shape' => 'PipelineExecution', ], 'FeatureGroup' => [ 'shape' => 'FeatureGroup', ], 'FeatureMetadata' => [ 'shape' => 'FeatureMetadata', ], 'Project' => [ 'shape' => 'Project', ], 'HyperParameterTuningJob' => [ 'shape' => 'HyperParameterTuningJobSearchEntity', ], 'ModelCard' => [ 'shape' => 'ModelCard', ], 'Model' => [ 'shape' => 'ModelDashboardModel', ], ], ], 'SearchRequest' => [ 'type' => 'structure', 'required' => [ 'Resource', ], 'members' => [ 'Resource' => [ 'shape' => 'ResourceType', ], 'SearchExpression' => [ 'shape' => 'SearchExpression', ], 'SortBy' => [ 'shape' => 'ResourcePropertyName', ], 'SortOrder' => [ 'shape' => 'SearchSortOrder', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, ], 'CrossAccountFilterOption' => [ 'shape' => 'CrossAccountFilterOption', ], 'VisibilityConditions' => [ 'shape' => 'VisibilityConditionsList', ], ], ], 'SearchResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'SearchResultsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'SearchResultsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchRecord', ], ], 'SearchSortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SecondaryStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'LaunchingMLInstances', 'PreparingTrainingStack', 'Downloading', 'DownloadingTrainingImage', 'Training', 'Uploading', 'Stopping', 'Stopped', 'MaxRuntimeExceeded', 'Completed', 'Failed', 'Interrupted', 'MaxWaitTimeExceeded', 'Updating', 'Restarting', 'Pending', ], ], 'SecondaryStatusTransition' => [ 'type' => 'structure', 'required' => [ 'Status', 'StartTime', ], 'members' => [ 'Status' => [ 'shape' => 'SecondaryStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'SecondaryStatusTransitions' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecondaryStatusTransition', ], ], 'SecretArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:.*', ], 'SecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, ], 'Seed' => [ 'type' => 'long', ], 'SelectedStep' => [ 'type' => 'structure', 'required' => [ 'StepName', ], 'members' => [ 'StepName' => [ 'shape' => 'String256', ], ], ], 'SelectedStepList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SelectedStep', ], 'max' => 50, 'min' => 1, ], 'SelectiveExecutionConfig' => [ 'type' => 'structure', 'required' => [ 'SelectedSteps', ], 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'SelectedSteps' => [ 'shape' => 'SelectedStepList', ], ], ], 'SelectiveExecutionResult' => [ 'type' => 'structure', 'members' => [ 'SourcePipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'FailureReason' => [ 'shape' => 'String256', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepFailureResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'type' => 'structure', 'required' => [ 'CallbackToken', ], 'members' => [ 'CallbackToken' => [ 'shape' => 'CallbackToken', ], 'OutputParameters' => [ 'shape' => 'OutputParameterList', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'ServerlessMaxConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServerlessMemorySizeInMB' => [ 'type' => 'integer', 'max' => 6144, 'min' => 1024, ], 'ServerlessProvisionedConcurrency' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'ServiceCatalogEntityId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_\\-]*', ], 'ServiceCatalogProvisionedProductDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisionedProductStatusMessage' => [ 'shape' => 'ProvisionedProductStatusMessage', ], ], ], 'ServiceCatalogProvisioningDetails' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'ProductId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'PathId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactId' => [ 'shape' => 'ServiceCatalogEntityId', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], ], ], 'SessionExpirationDurationInSeconds' => [ 'type' => 'integer', 'max' => 43200, 'min' => 1800, ], 'ShadowModeConfig' => [ 'type' => 'structure', 'required' => [ 'SourceModelVariantName', 'ShadowModelVariants', ], 'members' => [ 'SourceModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'ShadowModelVariants' => [ 'shape' => 'ShadowModelVariantConfigList', ], ], ], 'ShadowModelVariantConfig' => [ 'type' => 'structure', 'required' => [ 'ShadowModelVariantName', 'SamplingPercentage', ], 'members' => [ 'ShadowModelVariantName' => [ 'shape' => 'ModelVariantName', ], 'SamplingPercentage' => [ 'shape' => 'Percentage', ], ], ], 'ShadowModelVariantConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShadowModelVariantConfig', ], 'max' => 1, 'min' => 1, ], 'SharingSettings' => [ 'type' => 'structure', 'members' => [ 'NotebookOutputOption' => [ 'shape' => 'NotebookOutputOption', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'SharingType' => [ 'type' => 'string', 'enum' => [ 'Private', 'Shared', ], ], 'ShuffleConfig' => [ 'type' => 'structure', 'required' => [ 'Seed', ], 'members' => [ 'Seed' => [ 'shape' => 'Seed', ], ], ], 'SingleSignOnApplicationArn' => [ 'type' => 'string', 'pattern' => '^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application\\/[a-zA-Z0-9-_.]+\\/apl-[a-zA-Z0-9]+$', ], 'SingleSignOnUserIdentifier' => [ 'type' => 'string', 'pattern' => 'UserName', ], 'SkipModelValidation' => [ 'type' => 'string', 'enum' => [ 'All', 'None', ], ], 'SnsTopicArn' => [ 'type' => 'string', 'max' => 2048, 'pattern' => 'arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]+', ], 'SortActionsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortArtifactsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', ], ], 'SortAssociationsBy' => [ 'type' => 'string', 'enum' => [ 'SourceArn', 'DestinationArn', 'SourceType', 'DestinationType', 'CreationTime', ], ], 'SortBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortContextsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortInferenceExperimentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', ], ], 'SortLineageGroupsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'Ascending', 'Descending', ], ], 'SortPipelineExecutionsBy' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'PipelineExecutionArn', ], ], 'SortPipelinesBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialComponentsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SortTrialsBy' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', ], ], 'SourceAlgorithm' => [ 'type' => 'structure', 'required' => [ 'AlgorithmName', ], 'members' => [ 'ModelDataUrl' => [ 'shape' => 'Url', ], 'AlgorithmName' => [ 'shape' => 'ArnOrName', ], ], ], 'SourceAlgorithmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceAlgorithm', ], 'max' => 1, 'min' => 1, ], 'SourceAlgorithmSpecification' => [ 'type' => 'structure', 'required' => [ 'SourceAlgorithms', ], 'members' => [ 'SourceAlgorithms' => [ 'shape' => 'SourceAlgorithmList', ], ], ], 'SourceIpConfig' => [ 'type' => 'structure', 'required' => [ 'Cidrs', ], 'members' => [ 'Cidrs' => [ 'shape' => 'Cidrs', ], ], ], 'SourceType' => [ 'type' => 'string', 'max' => 128, ], 'SourceUri' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '.*', ], 'SpaceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/.*', ], 'SpaceCodeEditorAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'SpaceDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'Status' => [ 'shape' => 'SpaceStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'SpaceSettingsSummary' => [ 'shape' => 'SpaceSettingsSummary', ], 'SpaceSharingSettingsSummary' => [ 'shape' => 'SpaceSharingSettingsSummary', ], 'OwnershipSettingsSummary' => [ 'shape' => 'OwnershipSettingsSummary', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'SpaceEbsVolumeSizeInGb' => [ 'type' => 'integer', 'max' => 16384, 'min' => 5, ], 'SpaceJupyterLabAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], 'CodeRepositories' => [ 'shape' => 'CodeRepositories', ], ], ], 'SpaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SpaceDetails', ], ], 'SpaceName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'SpaceSettings' => [ 'type' => 'structure', 'members' => [ 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'CodeEditorAppSettings' => [ 'shape' => 'SpaceCodeEditorAppSettings', ], 'JupyterLabAppSettings' => [ 'shape' => 'SpaceJupyterLabAppSettings', ], 'AppType' => [ 'shape' => 'AppType', ], 'SpaceStorageSettings' => [ 'shape' => 'SpaceStorageSettings', ], 'CustomFileSystems' => [ 'shape' => 'CustomFileSystems', ], ], ], 'SpaceSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'AppType' => [ 'shape' => 'AppType', ], 'SpaceStorageSettings' => [ 'shape' => 'SpaceStorageSettings', ], ], ], 'SpaceSharingSettings' => [ 'type' => 'structure', 'required' => [ 'SharingType', ], 'members' => [ 'SharingType' => [ 'shape' => 'SharingType', ], ], ], 'SpaceSharingSettingsSummary' => [ 'type' => 'structure', 'members' => [ 'SharingType' => [ 'shape' => 'SharingType', ], ], ], 'SpaceSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'SpaceStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'SpaceStorageSettings' => [ 'type' => 'structure', 'members' => [ 'EbsStorageSettings' => [ 'shape' => 'EbsStorageSettings', ], ], ], 'SpawnRate' => [ 'type' => 'integer', 'min' => 0, ], 'SplitType' => [ 'type' => 'string', 'enum' => [ 'None', 'Line', 'RecordIO', 'TFRecord', ], ], 'StageStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'READYTODEPLOY', 'STARTING', 'INPROGRESS', 'DEPLOYED', 'FAILED', 'STOPPING', 'STOPPED', ], ], 'Stairs' => [ 'type' => 'structure', 'members' => [ 'DurationInSeconds' => [ 'shape' => 'TrafficDurationInSeconds', ], 'NumberOfSteps' => [ 'shape' => 'NumberOfSteps', ], 'UsersPerStep' => [ 'shape' => 'UsersPerStep', ], ], ], 'StartEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StartInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], ], ], 'StartInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StartMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StartNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StartPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', 'ClientRequestToken', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineNameOrArn', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'PipelineParameters' => [ 'shape' => 'ParameterList', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], 'SelectiveExecutionConfig' => [ 'shape' => 'SelectiveExecutionConfig', ], ], ], 'StartPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'Statistic' => [ 'type' => 'string', 'enum' => [ 'Average', 'Minimum', 'Maximum', 'SampleCount', 'Sum', ], ], 'StatusDetails' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'StatusMessage' => [ 'type' => 'string', ], 'StepDescription' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, 'pattern' => '.*', ], 'StepDisplayName' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '.*', ], 'StepName' => [ 'type' => 'string', 'max' => 64, 'pattern' => '^[A-Za-z0-9\\-_]*$', ], 'StepStatus' => [ 'type' => 'string', 'enum' => [ 'Starting', 'Executing', 'Stopping', 'Stopped', 'Failed', 'Succeeded', ], ], 'StopAutoMLJobRequest' => [ 'type' => 'structure', 'required' => [ 'AutoMLJobName', ], 'members' => [ 'AutoMLJobName' => [ 'shape' => 'AutoMLJobName', ], ], ], 'StopCompilationJobRequest' => [ 'type' => 'structure', 'required' => [ 'CompilationJobName', ], 'members' => [ 'CompilationJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgeDeploymentStageRequest' => [ 'type' => 'structure', 'required' => [ 'EdgeDeploymentPlanName', 'StageName', ], 'members' => [ 'EdgeDeploymentPlanName' => [ 'shape' => 'EntityName', ], 'StageName' => [ 'shape' => 'EntityName', ], ], ], 'StopEdgePackagingJobRequest' => [ 'type' => 'structure', 'required' => [ 'EdgePackagingJobName', ], 'members' => [ 'EdgePackagingJobName' => [ 'shape' => 'EntityName', ], ], ], 'StopHyperParameterTuningJobRequest' => [ 'type' => 'structure', 'required' => [ 'HyperParameterTuningJobName', ], 'members' => [ 'HyperParameterTuningJobName' => [ 'shape' => 'HyperParameterTuningJobName', ], ], ], 'StopInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'ModelVariantActions', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'ModelVariantActions' => [ 'shape' => 'ModelVariantActionMap', ], 'DesiredModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DesiredState' => [ 'shape' => 'InferenceExperimentStopDesiredState', ], 'Reason' => [ 'shape' => 'InferenceExperimentStatusReason', ], ], ], 'StopInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'StopInferenceRecommendationsJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobName', ], 'members' => [ 'JobName' => [ 'shape' => 'RecommendationJobName', ], ], ], 'StopLabelingJobRequest' => [ 'type' => 'structure', 'required' => [ 'LabelingJobName', ], 'members' => [ 'LabelingJobName' => [ 'shape' => 'LabelingJobName', ], ], ], 'StopMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], ], ], 'StopNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], ], ], 'StopPipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', 'ClientRequestToken', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'ClientRequestToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'StopPipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'StopProcessingJobRequest' => [ 'type' => 'structure', 'required' => [ 'ProcessingJobName', ], 'members' => [ 'ProcessingJobName' => [ 'shape' => 'ProcessingJobName', ], ], ], 'StopTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], ], ], 'StopTransformJobRequest' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], ], ], 'StoppingCondition' => [ 'type' => 'structure', 'members' => [ 'MaxRuntimeInSeconds' => [ 'shape' => 'MaxRuntimeInSeconds', ], 'MaxWaitTimeInSeconds' => [ 'shape' => 'MaxWaitTimeInSeconds', ], 'MaxPendingTimeInSeconds' => [ 'shape' => 'MaxPendingTimeInSeconds', ], ], ], 'StorageType' => [ 'type' => 'string', 'enum' => [ 'Standard', 'InMemory', ], ], 'String' => [ 'type' => 'string', ], 'String1024' => [ 'type' => 'string', 'max' => 1024, ], 'String128' => [ 'type' => 'string', 'max' => 128, ], 'String200' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '.+', ], 'String256' => [ 'type' => 'string', 'max' => 256, ], 'String3072' => [ 'type' => 'string', 'max' => 3072, ], 'String40' => [ 'type' => 'string', 'max' => 40, ], 'String64' => [ 'type' => 'string', 'max' => 64, ], 'String8192' => [ 'type' => 'string', 'max' => 8192, ], 'StringParameterValue' => [ 'type' => 'string', 'max' => 2500, 'pattern' => '.*', ], 'StudioLifecycleConfigAppType' => [ 'type' => 'string', 'enum' => [ 'JupyterServer', 'KernelGateway', 'VSCode', 'Savitur', 'CodeEditor', 'JupyterLab', ], ], 'StudioLifecycleConfigArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*', ], 'StudioLifecycleConfigContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'StudioLifecycleConfigDetails' => [ 'type' => 'structure', 'members' => [ 'StudioLifecycleConfigArn' => [ 'shape' => 'StudioLifecycleConfigArn', ], 'StudioLifecycleConfigName' => [ 'shape' => 'StudioLifecycleConfigName', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'StudioLifecycleConfigAppType' => [ 'shape' => 'StudioLifecycleConfigAppType', ], ], ], 'StudioLifecycleConfigName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'StudioLifecycleConfigSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', 'Name', ], ], 'StudioLifecycleConfigsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioLifecycleConfigDetails', ], ], 'StudioWebPortal' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'SubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'Subnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 16, 'min' => 1, ], 'SubscribedWorkteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamArn', ], 'members' => [ 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'MarketplaceTitle' => [ 'shape' => 'String200', ], 'SellerName' => [ 'shape' => 'String', ], 'MarketplaceDescription' => [ 'shape' => 'String200', ], 'ListingId' => [ 'shape' => 'String', ], ], ], 'SubscribedWorkteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubscribedWorkteam', ], ], 'Success' => [ 'type' => 'boolean', ], 'SuggestionQuery' => [ 'type' => 'structure', 'members' => [ 'PropertyNameQuery' => [ 'shape' => 'PropertyNameQuery', ], ], ], 'TableFormat' => [ 'type' => 'string', 'enum' => [ 'Default', 'Glue', 'Iceberg', ], ], 'TableName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*', ], 'TabularJobConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', ], 'members' => [ 'CandidateGenerationConfig' => [ 'shape' => 'CandidateGenerationConfig', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'Mode' => [ 'shape' => 'AutoMLMode', ], 'GenerateCandidateDefinitionsOnly' => [ 'shape' => 'GenerateCandidateDefinitionsOnly', ], 'ProblemType' => [ 'shape' => 'ProblemType', ], 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'SampleWeightAttributeName' => [ 'shape' => 'SampleWeightAttributeName', ], ], ], 'TabularResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'ProblemType' => [ 'shape' => 'ProblemType', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TargetAttributeName' => [ 'type' => 'string', 'min' => 1, ], 'TargetDevice' => [ 'type' => 'string', 'enum' => [ 'lambda', 'ml_m4', 'ml_m5', 'ml_m6g', 'ml_c4', 'ml_c5', 'ml_c6g', 'ml_p2', 'ml_p3', 'ml_g4dn', 'ml_inf1', 'ml_inf2', 'ml_trn1', 'ml_eia2', 'jetson_tx1', 'jetson_tx2', 'jetson_nano', 'jetson_xavier', 'rasp3b', 'rasp4b', 'imx8qm', 'deeplens', 'rk3399', 'rk3288', 'aisage', 'sbe_c', 'qcs605', 'qcs603', 'sitara_am57x', 'amba_cv2', 'amba_cv22', 'amba_cv25', 'x86_win32', 'x86_win64', 'coreml', 'jacinto_tda4vm', 'imx8mplus', ], ], 'TargetLabelColumn' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TargetObjectiveMetricValue' => [ 'type' => 'float', ], 'TargetPlatform' => [ 'type' => 'structure', 'required' => [ 'Os', 'Arch', ], 'members' => [ 'Os' => [ 'shape' => 'TargetPlatformOs', ], 'Arch' => [ 'shape' => 'TargetPlatformArch', ], 'Accelerator' => [ 'shape' => 'TargetPlatformAccelerator', ], ], ], 'TargetPlatformAccelerator' => [ 'type' => 'string', 'enum' => [ 'INTEL_GRAPHICS', 'MALI', 'NVIDIA', 'NNA', ], ], 'TargetPlatformArch' => [ 'type' => 'string', 'enum' => [ 'X86_64', 'X86', 'ARM64', 'ARM_EABI', 'ARM_EABIHF', ], ], 'TargetPlatformOs' => [ 'type' => 'string', 'enum' => [ 'ANDROID', 'LINUX', ], ], 'TargetTrackingScalingPolicyConfiguration' => [ 'type' => 'structure', 'members' => [ 'MetricSpecification' => [ 'shape' => 'MetricSpecification', ], 'TargetValue' => [ 'shape' => 'Double', ], ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'type' => 'integer', 'min' => 60, ], 'TaskCount' => [ 'type' => 'integer', 'min' => 0, ], 'TaskDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '.+', ], 'TaskInput' => [ 'type' => 'string', 'max' => 128000, 'min' => 2, 'pattern' => '[\\S\\s]+', ], 'TaskKeyword' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '^[A-Za-z0-9]+( [A-Za-z0-9]+)*$', ], 'TaskKeywords' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskKeyword', ], 'max' => 5, 'min' => 1, ], 'TaskTimeLimitInSeconds' => [ 'type' => 'integer', 'min' => 30, ], 'TaskTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$', ], 'TemplateContent' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'TemplateContentSha256' => [ 'type' => 'string', 'max' => 128000, 'min' => 1, ], 'TemplateUrl' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'TensorBoardAppSettings' => [ 'type' => 'structure', 'members' => [ 'DefaultResourceSpec' => [ 'shape' => 'ResourceSpec', ], ], ], 'TensorBoardOutputConfig' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'LocalPath' => [ 'shape' => 'DirectoryPath', ], 'S3OutputPath' => [ 'shape' => 'S3Uri', ], ], ], 'TenthFractionsOfACent' => [ 'type' => 'integer', 'max' => 9, 'min' => 0, ], 'TerminationWaitInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'TextClassificationJobConfig' => [ 'type' => 'structure', 'required' => [ 'ContentColumn', 'TargetLabelColumn', ], 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ContentColumn' => [ 'shape' => 'ContentColumn', ], 'TargetLabelColumn' => [ 'shape' => 'TargetLabelColumn', ], ], ], 'TextGenerationHyperParameterKey' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^[a-zA-Z0-9._-]+$', ], 'TextGenerationHyperParameterValue' => [ 'type' => 'string', 'max' => 16, 'pattern' => '^[a-zA-Z0-9._-]+$', ], 'TextGenerationHyperParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'TextGenerationHyperParameterKey', ], 'value' => [ 'shape' => 'TextGenerationHyperParameterValue', ], 'max' => 30, 'min' => 0, ], 'TextGenerationJobConfig' => [ 'type' => 'structure', 'members' => [ 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'BaseModelName' => [ 'shape' => 'BaseModelName', ], 'TextGenerationHyperParameters' => [ 'shape' => 'TextGenerationHyperParameters', ], 'ModelAccessConfig' => [ 'shape' => 'ModelAccessConfig', ], ], ], 'TextGenerationResolvedAttributes' => [ 'type' => 'structure', 'members' => [ 'BaseModelName' => [ 'shape' => 'BaseModelName', ], ], ], 'ThingName' => [ 'type' => 'string', 'max' => 128, 'pattern' => '[a-zA-Z0-9:_-]+', ], 'ThroughputConfig' => [ 'type' => 'structure', 'required' => [ 'ThroughputMode', ], 'members' => [ 'ThroughputMode' => [ 'shape' => 'ThroughputMode', ], 'ProvisionedReadCapacityUnits' => [ 'shape' => 'CapacityUnit', ], 'ProvisionedWriteCapacityUnits' => [ 'shape' => 'CapacityUnit', ], ], ], 'ThroughputConfigDescription' => [ 'type' => 'structure', 'required' => [ 'ThroughputMode', ], 'members' => [ 'ThroughputMode' => [ 'shape' => 'ThroughputMode', ], 'ProvisionedReadCapacityUnits' => [ 'shape' => 'CapacityUnit', ], 'ProvisionedWriteCapacityUnits' => [ 'shape' => 'CapacityUnit', ], ], ], 'ThroughputConfigUpdate' => [ 'type' => 'structure', 'members' => [ 'ThroughputMode' => [ 'shape' => 'ThroughputMode', ], 'ProvisionedReadCapacityUnits' => [ 'shape' => 'CapacityUnit', ], 'ProvisionedWriteCapacityUnits' => [ 'shape' => 'CapacityUnit', ], ], ], 'ThroughputMode' => [ 'type' => 'string', 'enum' => [ 'OnDemand', 'Provisioned', ], ], 'TimeSeriesConfig' => [ 'type' => 'structure', 'required' => [ 'TargetAttributeName', 'TimestampAttributeName', 'ItemIdentifierAttributeName', ], 'members' => [ 'TargetAttributeName' => [ 'shape' => 'TargetAttributeName', ], 'TimestampAttributeName' => [ 'shape' => 'TimestampAttributeName', ], 'ItemIdentifierAttributeName' => [ 'shape' => 'ItemIdentifierAttributeName', ], 'GroupingAttributeNames' => [ 'shape' => 'GroupingAttributeNames', ], ], ], 'TimeSeriesForecastingJobConfig' => [ 'type' => 'structure', 'required' => [ 'ForecastFrequency', 'ForecastHorizon', 'TimeSeriesConfig', ], 'members' => [ 'FeatureSpecificationS3Uri' => [ 'shape' => 'S3Uri', ], 'CompletionCriteria' => [ 'shape' => 'AutoMLJobCompletionCriteria', ], 'ForecastFrequency' => [ 'shape' => 'ForecastFrequency', ], 'ForecastHorizon' => [ 'shape' => 'ForecastHorizon', ], 'ForecastQuantiles' => [ 'shape' => 'ForecastQuantiles', ], 'Transformations' => [ 'shape' => 'TimeSeriesTransformations', ], 'TimeSeriesConfig' => [ 'shape' => 'TimeSeriesConfig', ], 'HolidayConfig' => [ 'shape' => 'HolidayConfig', ], ], ], 'TimeSeriesForecastingSettings' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'FeatureStatus', ], 'AmazonForecastRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'TimeSeriesTransformations' => [ 'type' => 'structure', 'members' => [ 'Filling' => [ 'shape' => 'FillingTransformations', ], 'Aggregation' => [ 'shape' => 'AggregationTransformations', ], ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TimestampAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'TrafficDurationInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TrafficPattern' => [ 'type' => 'structure', 'members' => [ 'TrafficType' => [ 'shape' => 'TrafficType', ], 'Phases' => [ 'shape' => 'Phases', ], 'Stairs' => [ 'shape' => 'Stairs', ], ], ], 'TrafficRoutingConfig' => [ 'type' => 'structure', 'required' => [ 'Type', 'WaitIntervalInSeconds', ], 'members' => [ 'Type' => [ 'shape' => 'TrafficRoutingConfigType', ], 'WaitIntervalInSeconds' => [ 'shape' => 'WaitIntervalInSeconds', ], 'CanarySize' => [ 'shape' => 'CapacitySize', ], 'LinearStepSize' => [ 'shape' => 'CapacitySize', ], ], ], 'TrafficRoutingConfigType' => [ 'type' => 'string', 'enum' => [ 'ALL_AT_ONCE', 'CANARY', 'LINEAR', ], ], 'TrafficType' => [ 'type' => 'string', 'enum' => [ 'PHASES', 'STAIRS', ], ], 'TrainingContainerArgument' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingContainerArguments' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerArgument', ], 'max' => 100, 'min' => 1, ], 'TrainingContainerEntrypoint' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingContainerEntrypointString', ], 'max' => 100, 'min' => 1, ], 'TrainingContainerEntrypointString' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrainingEnvironmentKey' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]*', ], 'TrainingEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrainingEnvironmentKey', ], 'value' => [ 'shape' => 'TrainingEnvironmentValue', ], 'max' => 100, ], 'TrainingEnvironmentValue' => [ 'type' => 'string', 'max' => 512, 'pattern' => '[\\S\\s]*', ], 'TrainingImageConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryAccessMode', ], 'members' => [ 'TrainingRepositoryAccessMode' => [ 'shape' => 'TrainingRepositoryAccessMode', ], 'TrainingRepositoryAuthConfig' => [ 'shape' => 'TrainingRepositoryAuthConfig', ], ], ], 'TrainingInputMode' => [ 'type' => 'string', 'enum' => [ 'Pipe', 'File', 'FastFile', ], ], 'TrainingInstanceCount' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.p3dn.24xlarge', 'ml.p4d.24xlarge', 'ml.p4de.24xlarge', 'ml.p5.48xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.c5n.xlarge', 'ml.c5n.2xlarge', 'ml.c5n.4xlarge', 'ml.c5n.9xlarge', 'ml.c5n.18xlarge', 'ml.g5.xlarge', 'ml.g5.2xlarge', 'ml.g5.4xlarge', 'ml.g5.8xlarge', 'ml.g5.16xlarge', 'ml.g5.12xlarge', 'ml.g5.24xlarge', 'ml.g5.48xlarge', 'ml.trn1.2xlarge', 'ml.trn1.32xlarge', 'ml.trn1n.32xlarge', 'ml.m6i.large', 'ml.m6i.xlarge', 'ml.m6i.2xlarge', 'ml.m6i.4xlarge', 'ml.m6i.8xlarge', 'ml.m6i.12xlarge', 'ml.m6i.16xlarge', 'ml.m6i.24xlarge', 'ml.m6i.32xlarge', 'ml.c6i.xlarge', 'ml.c6i.2xlarge', 'ml.c6i.8xlarge', 'ml.c6i.4xlarge', 'ml.c6i.12xlarge', 'ml.c6i.16xlarge', 'ml.c6i.24xlarge', 'ml.c6i.32xlarge', ], ], 'TrainingInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingInstanceType', ], ], 'TrainingJob' => [ 'type' => 'structure', 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'TuningJobArn' => [ 'shape' => 'HyperParameterTuningJobArn', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'ModelArtifacts' => [ 'shape' => 'ModelArtifacts', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'SecondaryStatus' => [ 'shape' => 'SecondaryStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'AlgorithmSpecification' => [ 'shape' => 'AlgorithmSpecification', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'VpcConfig' => [ 'shape' => 'VpcConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingStartTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'SecondaryStatusTransitions' => [ 'shape' => 'SecondaryStatusTransitions', ], 'FinalMetricDataList' => [ 'shape' => 'FinalMetricDataList', ], 'EnableNetworkIsolation' => [ 'shape' => 'Boolean', ], 'EnableInterContainerTrafficEncryption' => [ 'shape' => 'Boolean', ], 'EnableManagedSpotTraining' => [ 'shape' => 'Boolean', ], 'CheckpointConfig' => [ 'shape' => 'CheckpointConfig', ], 'TrainingTimeInSeconds' => [ 'shape' => 'TrainingTimeInSeconds', ], 'BillableTimeInSeconds' => [ 'shape' => 'BillableTimeInSeconds', ], 'DebugHookConfig' => [ 'shape' => 'DebugHookConfig', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'DebugRuleConfigurations' => [ 'shape' => 'DebugRuleConfigurations', ], 'TensorBoardOutputConfig' => [ 'shape' => 'TensorBoardOutputConfig', ], 'DebugRuleEvaluationStatuses' => [ 'shape' => 'DebugRuleEvaluationStatuses', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfig', ], 'Environment' => [ 'shape' => 'TrainingEnvironmentMap', ], 'RetryStrategy' => [ 'shape' => 'RetryStrategy', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TrainingJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/.*', ], 'TrainingJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TrainingInputMode', 'InputDataConfig', 'OutputDataConfig', 'ResourceConfig', 'StoppingCondition', ], 'members' => [ 'TrainingInputMode' => [ 'shape' => 'TrainingInputMode', ], 'HyperParameters' => [ 'shape' => 'HyperParameters', ], 'InputDataConfig' => [ 'shape' => 'InputDataConfig', ], 'OutputDataConfig' => [ 'shape' => 'OutputDataConfig', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfig', ], 'StoppingCondition' => [ 'shape' => 'StoppingCondition', ], ], ], 'TrainingJobEarlyStoppingType' => [ 'type' => 'string', 'enum' => [ 'Off', 'Auto', ], ], 'TrainingJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TrainingJobSortByOptions' => [ 'type' => 'string', 'enum' => [ 'Name', 'CreationTime', 'Status', 'FinalObjectiveMetricValue', ], ], 'TrainingJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrainingJobStatusCounter' => [ 'type' => 'integer', 'min' => 0, ], 'TrainingJobStatusCounters' => [ 'type' => 'structure', 'members' => [ 'Completed' => [ 'shape' => 'TrainingJobStatusCounter', ], 'InProgress' => [ 'shape' => 'TrainingJobStatusCounter', ], 'RetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'NonRetryableError' => [ 'shape' => 'TrainingJobStatusCounter', ], 'Stopped' => [ 'shape' => 'TrainingJobStatusCounter', ], ], ], 'TrainingJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'TrainingJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrainingJobSummary', ], ], 'TrainingJobSummary' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', 'TrainingJobArn', 'CreationTime', 'TrainingJobStatus', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TrainingEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TrainingJobStatus' => [ 'shape' => 'TrainingJobStatus', ], 'WarmPoolStatus' => [ 'shape' => 'WarmPoolStatus', ], ], ], 'TrainingRepositoryAccessMode' => [ 'type' => 'string', 'enum' => [ 'Platform', 'Vpc', ], ], 'TrainingRepositoryAuthConfig' => [ 'type' => 'structure', 'required' => [ 'TrainingRepositoryCredentialsProviderArn', ], 'members' => [ 'TrainingRepositoryCredentialsProviderArn' => [ 'shape' => 'TrainingRepositoryCredentialsProviderArn', ], ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:[\\p{Alnum}\\-]+:lambda:[\\p{Alnum}\\-]+:[0-9]{12}:function:.*', ], 'TrainingSpecification' => [ 'type' => 'structure', 'required' => [ 'TrainingImage', 'SupportedTrainingInstanceTypes', 'TrainingChannels', ], 'members' => [ 'TrainingImage' => [ 'shape' => 'ContainerImage', ], 'TrainingImageDigest' => [ 'shape' => 'ImageDigest', ], 'SupportedHyperParameters' => [ 'shape' => 'HyperParameterSpecifications', ], 'SupportedTrainingInstanceTypes' => [ 'shape' => 'TrainingInstanceTypes', ], 'SupportsDistributedTraining' => [ 'shape' => 'Boolean', ], 'MetricDefinitions' => [ 'shape' => 'MetricDefinitionList', ], 'TrainingChannels' => [ 'shape' => 'ChannelSpecifications', ], 'SupportedTuningJobObjectiveMetrics' => [ 'shape' => 'HyperParameterTuningJobObjectives', ], 'AdditionalS3DataSource' => [ 'shape' => 'AdditionalS3DataSource', ], ], ], 'TrainingTimeInSeconds' => [ 'type' => 'integer', 'min' => 1, ], 'TransformDataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataSource', ], 'members' => [ 'S3DataSource' => [ 'shape' => 'TransformS3DataSource', ], ], ], 'TransformEnvironmentKey' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '[a-zA-Z_][a-zA-Z0-9_]{0,1023}', ], 'TransformEnvironmentMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TransformEnvironmentKey', ], 'value' => [ 'shape' => 'TransformEnvironmentValue', ], 'max' => 16, ], 'TransformEnvironmentValue' => [ 'type' => 'string', 'max' => 10240, 'pattern' => '[\\S\\s]*', ], 'TransformInput' => [ 'type' => 'structure', 'required' => [ 'DataSource', ], 'members' => [ 'DataSource' => [ 'shape' => 'TransformDataSource', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'SplitType' => [ 'shape' => 'SplitType', ], ], ], 'TransformInstanceCount' => [ 'type' => 'integer', 'min' => 1, ], 'TransformInstanceType' => [ 'type' => 'string', 'enum' => [ 'ml.m4.xlarge', 'ml.m4.2xlarge', 'ml.m4.4xlarge', 'ml.m4.10xlarge', 'ml.m4.16xlarge', 'ml.c4.xlarge', 'ml.c4.2xlarge', 'ml.c4.4xlarge', 'ml.c4.8xlarge', 'ml.p2.xlarge', 'ml.p2.8xlarge', 'ml.p2.16xlarge', 'ml.p3.2xlarge', 'ml.p3.8xlarge', 'ml.p3.16xlarge', 'ml.c5.xlarge', 'ml.c5.2xlarge', 'ml.c5.4xlarge', 'ml.c5.9xlarge', 'ml.c5.18xlarge', 'ml.m5.large', 'ml.m5.xlarge', 'ml.m5.2xlarge', 'ml.m5.4xlarge', 'ml.m5.12xlarge', 'ml.m5.24xlarge', 'ml.g4dn.xlarge', 'ml.g4dn.2xlarge', 'ml.g4dn.4xlarge', 'ml.g4dn.8xlarge', 'ml.g4dn.12xlarge', 'ml.g4dn.16xlarge', ], ], 'TransformInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformInstanceType', ], 'min' => 1, ], 'TransformJob' => [ 'type' => 'structure', 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'ModelName' => [ 'shape' => 'ModelName', ], 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'ModelClientConfig' => [ 'shape' => 'ModelClientConfig', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'DataCaptureConfig' => [ 'shape' => 'BatchDataCaptureConfig', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformStartTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LabelingJobArn' => [ 'shape' => 'LabelingJobArn', ], 'AutoMLJobArn' => [ 'shape' => 'AutoMLJobArn', ], 'DataProcessing' => [ 'shape' => 'DataProcessing', ], 'ExperimentConfig' => [ 'shape' => 'ExperimentConfig', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TransformJobArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*', ], 'TransformJobDefinition' => [ 'type' => 'structure', 'required' => [ 'TransformInput', 'TransformOutput', 'TransformResources', ], 'members' => [ 'MaxConcurrentTransforms' => [ 'shape' => 'MaxConcurrentTransforms', ], 'MaxPayloadInMB' => [ 'shape' => 'MaxPayloadInMB', ], 'BatchStrategy' => [ 'shape' => 'BatchStrategy', ], 'Environment' => [ 'shape' => 'TransformEnvironmentMap', ], 'TransformInput' => [ 'shape' => 'TransformInput', ], 'TransformOutput' => [ 'shape' => 'TransformOutput', ], 'TransformResources' => [ 'shape' => 'TransformResources', ], ], ], 'TransformJobName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'TransformJobStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TransformJobStepMetadata' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'TransformJobArn', ], ], ], 'TransformJobSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransformJobSummary', ], ], 'TransformJobSummary' => [ 'type' => 'structure', 'required' => [ 'TransformJobName', 'TransformJobArn', 'CreationTime', 'TransformJobStatus', ], 'members' => [ 'TransformJobName' => [ 'shape' => 'TransformJobName', ], 'TransformJobArn' => [ 'shape' => 'TransformJobArn', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'TransformEndTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'TransformJobStatus' => [ 'shape' => 'TransformJobStatus', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], ], ], 'TransformOutput' => [ 'type' => 'structure', 'required' => [ 'S3OutputPath', ], 'members' => [ 'S3OutputPath' => [ 'shape' => 'S3Uri', ], 'Accept' => [ 'shape' => 'Accept', ], 'AssembleWith' => [ 'shape' => 'AssemblyType', ], 'KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformResources' => [ 'type' => 'structure', 'required' => [ 'InstanceType', 'InstanceCount', ], 'members' => [ 'InstanceType' => [ 'shape' => 'TransformInstanceType', ], 'InstanceCount' => [ 'shape' => 'TransformInstanceCount', ], 'VolumeKmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'TransformS3DataSource' => [ 'type' => 'structure', 'required' => [ 'S3DataType', 'S3Uri', ], 'members' => [ 'S3DataType' => [ 'shape' => 'S3DataType', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'TransformationAttributeName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Trial' => [ 'type' => 'structure', 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialArn' => [ 'shape' => 'TrialArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'Source' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'Tags' => [ 'shape' => 'TagList', ], 'TrialComponentSummaries' => [ 'shape' => 'TrialComponentSimpleSummaries', ], ], ], 'TrialArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/.*', ], 'TrialComponent' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'Source' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'Metrics' => [ 'shape' => 'TrialComponentMetricSummaries', ], 'MetadataProperties' => [ 'shape' => 'MetadataProperties', ], 'SourceDetail' => [ 'shape' => 'TrialComponentSourceDetail', ], 'LineageGroupArn' => [ 'shape' => 'LineageGroupArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'Parents' => [ 'shape' => 'Parents', ], 'RunName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'TrialComponentArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/.*', ], 'TrialComponentArtifact' => [ 'type' => 'structure', 'required' => [ 'Value', ], 'members' => [ 'MediaType' => [ 'shape' => 'MediaType', ], 'Value' => [ 'shape' => 'TrialComponentArtifactValue', ], ], ], 'TrialComponentArtifactValue' => [ 'type' => 'string', 'max' => 2048, 'pattern' => '.*', ], 'TrialComponentArtifacts' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey128', ], 'value' => [ 'shape' => 'TrialComponentArtifact', ], 'max' => 60, ], 'TrialComponentKey128' => [ 'type' => 'string', 'max' => 128, 'pattern' => '.*', ], 'TrialComponentKey256' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'TrialComponentKey320' => [ 'type' => 'string', 'max' => 320, 'pattern' => '.*', ], 'TrialComponentMetricSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentMetricSummary', ], ], 'TrialComponentMetricSummary' => [ 'type' => 'structure', 'members' => [ 'MetricName' => [ 'shape' => 'MetricName', ], 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TimeStamp' => [ 'shape' => 'Timestamp', ], 'Max' => [ 'shape' => 'OptionalDouble', ], 'Min' => [ 'shape' => 'OptionalDouble', ], 'Last' => [ 'shape' => 'OptionalDouble', ], 'Count' => [ 'shape' => 'OptionalInteger', ], 'Avg' => [ 'shape' => 'OptionalDouble', ], 'StdDev' => [ 'shape' => 'OptionalDouble', ], ], ], 'TrialComponentParameterValue' => [ 'type' => 'structure', 'members' => [ 'StringValue' => [ 'shape' => 'StringParameterValue', ], 'NumberValue' => [ 'shape' => 'DoubleParameterValue', ], ], ], 'TrialComponentParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'TrialComponentKey320', ], 'value' => [ 'shape' => 'TrialComponentParameterValue', ], 'max' => 300, ], 'TrialComponentPrimaryStatus' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Completed', 'Failed', 'Stopping', 'Stopped', ], ], 'TrialComponentSimpleSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSimpleSummary', ], ], 'TrialComponentSimpleSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialComponentSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialComponentSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialComponentSourceDetail' => [ 'type' => 'structure', 'members' => [ 'SourceArn' => [ 'shape' => 'TrialComponentSourceArn', ], 'TrainingJob' => [ 'shape' => 'TrainingJob', ], 'ProcessingJob' => [ 'shape' => 'ProcessingJob', ], 'TransformJob' => [ 'shape' => 'TransformJob', ], ], ], 'TrialComponentSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSource', ], ], 'TrialComponentStatus' => [ 'type' => 'structure', 'members' => [ 'PrimaryStatus' => [ 'shape' => 'TrialComponentPrimaryStatus', ], 'Message' => [ 'shape' => 'TrialComponentStatusMessage', ], ], ], 'TrialComponentStatusMessage' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '.*', ], 'TrialComponentSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialComponentSummary', ], ], 'TrialComponentSummary' => [ 'type' => 'structure', 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialComponentSource' => [ 'shape' => 'TrialComponentSource', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'UserContext', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'UserContext', ], ], ], 'TrialSource' => [ 'type' => 'structure', 'required' => [ 'SourceArn', ], 'members' => [ 'SourceArn' => [ 'shape' => 'TrialSourceArn', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'TrialSourceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*', ], 'TrialSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrialSummary', ], ], 'TrialSummary' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'TrialSource' => [ 'shape' => 'TrialSource', ], 'CreationTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'TtlDuration' => [ 'type' => 'structure', 'members' => [ 'Unit' => [ 'shape' => 'TtlDurationUnit', ], 'Value' => [ 'shape' => 'TtlDurationValue', ], ], ], 'TtlDurationUnit' => [ 'type' => 'string', 'enum' => [ 'Seconds', 'Minutes', 'Hours', 'Days', 'Weeks', ], ], 'TtlDurationValue' => [ 'type' => 'integer', 'min' => 1, ], 'TuningJobCompletionCriteria' => [ 'type' => 'structure', 'members' => [ 'TargetObjectiveMetricValue' => [ 'shape' => 'TargetObjectiveMetricValue', ], 'BestObjectiveNotImproving' => [ 'shape' => 'BestObjectiveNotImproving', ], 'ConvergenceDetected' => [ 'shape' => 'ConvergenceDetected', ], ], ], 'TuningJobStepMetaData' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'HyperParameterTuningJobArn', ], ], ], 'USD' => [ 'type' => 'structure', 'members' => [ 'Dollars' => [ 'shape' => 'Dollars', ], 'Cents' => [ 'shape' => 'Cents', ], 'TenthFractionsOfACent' => [ 'shape' => 'TenthFractionsOfACent', ], ], ], 'UiConfig' => [ 'type' => 'structure', 'members' => [ 'UiTemplateS3Uri' => [ 'shape' => 'S3Uri', ], 'HumanTaskUiArn' => [ 'shape' => 'HumanTaskUiArn', ], ], ], 'UiTemplate' => [ 'type' => 'structure', 'required' => [ 'Content', ], 'members' => [ 'Content' => [ 'shape' => 'TemplateContent', ], ], ], 'UiTemplateInfo' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'TemplateUrl', ], 'ContentSha256' => [ 'shape' => 'TemplateContentSha256', ], ], ], 'Uid' => [ 'type' => 'long', 'max' => 4000000, 'min' => 10000, ], 'UpdateActionRequest' => [ 'type' => 'structure', 'required' => [ 'ActionName', ], 'members' => [ 'ActionName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Status' => [ 'shape' => 'ActionStatus', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateActionResponse' => [ 'type' => 'structure', 'members' => [ 'ActionArn' => [ 'shape' => 'ActionArn', ], ], ], 'UpdateAppImageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'AppImageConfigName', ], 'members' => [ 'AppImageConfigName' => [ 'shape' => 'AppImageConfigName', ], 'KernelGatewayImageConfig' => [ 'shape' => 'KernelGatewayImageConfig', ], 'JupyterLabAppImageConfig' => [ 'shape' => 'JupyterLabAppImageConfig', ], ], ], 'UpdateAppImageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AppImageConfigArn' => [ 'shape' => 'AppImageConfigArn', ], ], ], 'UpdateArtifactRequest' => [ 'type' => 'structure', 'required' => [ 'ArtifactArn', ], 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], 'ArtifactName' => [ 'shape' => 'ExperimentEntityName', ], 'Properties' => [ 'shape' => 'ArtifactProperties', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateArtifactResponse' => [ 'type' => 'structure', 'members' => [ 'ArtifactArn' => [ 'shape' => 'ArtifactArn', ], ], ], 'UpdateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterName', 'InstanceGroups', ], 'members' => [ 'ClusterName' => [ 'shape' => 'ClusterNameOrArn', ], 'InstanceGroups' => [ 'shape' => 'ClusterInstanceGroupSpecifications', ], ], ], 'UpdateClusterResponse' => [ 'type' => 'structure', 'required' => [ 'ClusterArn', ], 'members' => [ 'ClusterArn' => [ 'shape' => 'ClusterArn', ], ], ], 'UpdateCodeRepositoryInput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryName', ], 'members' => [ 'CodeRepositoryName' => [ 'shape' => 'EntityName', ], 'GitConfig' => [ 'shape' => 'GitConfigForUpdate', ], ], ], 'UpdateCodeRepositoryOutput' => [ 'type' => 'structure', 'required' => [ 'CodeRepositoryArn', ], 'members' => [ 'CodeRepositoryArn' => [ 'shape' => 'CodeRepositoryArn', ], ], ], 'UpdateContextRequest' => [ 'type' => 'structure', 'required' => [ 'ContextName', ], 'members' => [ 'ContextName' => [ 'shape' => 'ContextName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], 'Properties' => [ 'shape' => 'LineageEntityParameters', ], 'PropertiesToRemove' => [ 'shape' => 'ListLineageEntityParameterKey', ], ], ], 'UpdateContextResponse' => [ 'type' => 'structure', 'members' => [ 'ContextArn' => [ 'shape' => 'ContextArn', ], ], ], 'UpdateDeviceFleetRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'OutputConfig', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'Description' => [ 'shape' => 'DeviceFleetDescription', ], 'OutputConfig' => [ 'shape' => 'EdgeOutputConfig', ], 'EnableIotRoleAlias' => [ 'shape' => 'EnableIotRoleAlias', ], ], ], 'UpdateDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'DeviceFleetName', 'Devices', ], 'members' => [ 'DeviceFleetName' => [ 'shape' => 'EntityName', ], 'Devices' => [ 'shape' => 'Devices', ], ], ], 'UpdateDomainRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'DefaultUserSettings' => [ 'shape' => 'UserSettings', ], 'DomainSettingsForUpdate' => [ 'shape' => 'DomainSettingsForUpdate', ], 'AppSecurityGroupManagement' => [ 'shape' => 'AppSecurityGroupManagement', ], 'DefaultSpaceSettings' => [ 'shape' => 'DefaultSpaceSettings', ], 'SubnetIds' => [ 'shape' => 'Subnets', ], 'AppNetworkAccessType' => [ 'shape' => 'AppNetworkAccessType', ], ], ], 'UpdateDomainResponse' => [ 'type' => 'structure', 'members' => [ 'DomainArn' => [ 'shape' => 'DomainArn', ], ], ], 'UpdateEndpointInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'EndpointConfigName', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'EndpointConfigName' => [ 'shape' => 'EndpointConfigName', ], 'RetainAllVariantProperties' => [ 'shape' => 'Boolean', ], 'ExcludeRetainedVariantProperties' => [ 'shape' => 'VariantPropertyList', ], 'DeploymentConfig' => [ 'shape' => 'DeploymentConfig', ], 'RetainDeploymentConfig' => [ 'shape' => 'Boolean', ], ], ], 'UpdateEndpointOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'type' => 'structure', 'required' => [ 'EndpointName', 'DesiredWeightsAndCapacities', ], 'members' => [ 'EndpointName' => [ 'shape' => 'EndpointName', ], 'DesiredWeightsAndCapacities' => [ 'shape' => 'DesiredWeightAndCapacityList', ], ], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'type' => 'structure', 'required' => [ 'EndpointArn', ], 'members' => [ 'EndpointArn' => [ 'shape' => 'EndpointArn', ], ], ], 'UpdateExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'ExperimentName', ], 'members' => [ 'ExperimentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Description' => [ 'shape' => 'ExperimentDescription', ], ], ], 'UpdateExperimentResponse' => [ 'type' => 'structure', 'members' => [ 'ExperimentArn' => [ 'shape' => 'ExperimentArn', ], ], ], 'UpdateFeatureGroupRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureAdditions' => [ 'shape' => 'FeatureAdditions', ], 'OnlineStoreConfig' => [ 'shape' => 'OnlineStoreConfigUpdate', ], 'ThroughputConfig' => [ 'shape' => 'ThroughputConfigUpdate', ], ], ], 'UpdateFeatureGroupResponse' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupArn', ], 'members' => [ 'FeatureGroupArn' => [ 'shape' => 'FeatureGroupArn', ], ], ], 'UpdateFeatureMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FeatureGroupName', 'FeatureName', ], 'members' => [ 'FeatureGroupName' => [ 'shape' => 'FeatureGroupNameOrArn', ], 'FeatureName' => [ 'shape' => 'FeatureName', ], 'Description' => [ 'shape' => 'FeatureDescription', ], 'ParameterAdditions' => [ 'shape' => 'FeatureParameterAdditions', ], 'ParameterRemovals' => [ 'shape' => 'FeatureParameterRemovals', ], ], ], 'UpdateHubRequest' => [ 'type' => 'structure', 'required' => [ 'HubName', ], 'members' => [ 'HubName' => [ 'shape' => 'HubName', ], 'HubDescription' => [ 'shape' => 'HubDescription', ], 'HubDisplayName' => [ 'shape' => 'HubDisplayName', ], 'HubSearchKeywords' => [ 'shape' => 'HubSearchKeywordList', ], ], ], 'UpdateHubResponse' => [ 'type' => 'structure', 'required' => [ 'HubArn', ], 'members' => [ 'HubArn' => [ 'shape' => 'HubArn', ], ], ], 'UpdateImageRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'DeleteProperties' => [ 'shape' => 'ImageDeletePropertyList', ], 'Description' => [ 'shape' => 'ImageDescription', ], 'DisplayName' => [ 'shape' => 'ImageDisplayName', ], 'ImageName' => [ 'shape' => 'ImageName', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'UpdateImageResponse' => [ 'type' => 'structure', 'members' => [ 'ImageArn' => [ 'shape' => 'ImageArn', ], ], ], 'UpdateImageVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ImageName', ], 'members' => [ 'ImageName' => [ 'shape' => 'ImageName', ], 'Alias' => [ 'shape' => 'SageMakerImageVersionAlias', ], 'Version' => [ 'shape' => 'ImageVersionNumber', ], 'AliasesToAdd' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'AliasesToDelete' => [ 'shape' => 'SageMakerImageVersionAliases', ], 'VendorGuidance' => [ 'shape' => 'VendorGuidance', ], 'JobType' => [ 'shape' => 'JobType', ], 'MLFramework' => [ 'shape' => 'MLFramework', ], 'ProgrammingLang' => [ 'shape' => 'ProgrammingLang', ], 'Processor' => [ 'shape' => 'Processor', ], 'Horovod' => [ 'shape' => 'Horovod', ], 'ReleaseNotes' => [ 'shape' => 'ReleaseNotes', ], ], ], 'UpdateImageVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ImageVersionArn' => [ 'shape' => 'ImageVersionArn', ], ], ], 'UpdateInferenceComponentInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'Specification' => [ 'shape' => 'InferenceComponentSpecification', ], 'RuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], ], ], 'UpdateInferenceComponentOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'UpdateInferenceComponentRuntimeConfigInput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentName', 'DesiredRuntimeConfig', ], 'members' => [ 'InferenceComponentName' => [ 'shape' => 'InferenceComponentName', ], 'DesiredRuntimeConfig' => [ 'shape' => 'InferenceComponentRuntimeConfig', ], ], ], 'UpdateInferenceComponentRuntimeConfigOutput' => [ 'type' => 'structure', 'required' => [ 'InferenceComponentArn', ], 'members' => [ 'InferenceComponentArn' => [ 'shape' => 'InferenceComponentArn', ], ], ], 'UpdateInferenceExperimentRequest' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'InferenceExperimentName', ], 'Schedule' => [ 'shape' => 'InferenceExperimentSchedule', ], 'Description' => [ 'shape' => 'InferenceExperimentDescription', ], 'ModelVariants' => [ 'shape' => 'ModelVariantConfigList', ], 'DataStorageConfig' => [ 'shape' => 'InferenceExperimentDataStorageConfig', ], 'ShadowModeConfig' => [ 'shape' => 'ShadowModeConfig', ], ], ], 'UpdateInferenceExperimentResponse' => [ 'type' => 'structure', 'required' => [ 'InferenceExperimentArn', ], 'members' => [ 'InferenceExperimentArn' => [ 'shape' => 'InferenceExperimentArn', ], ], ], 'UpdateModelCardRequest' => [ 'type' => 'structure', 'required' => [ 'ModelCardName', ], 'members' => [ 'ModelCardName' => [ 'shape' => 'ModelCardNameOrArn', ], 'Content' => [ 'shape' => 'ModelCardContent', ], 'ModelCardStatus' => [ 'shape' => 'ModelCardStatus', ], ], ], 'UpdateModelCardResponse' => [ 'type' => 'structure', 'required' => [ 'ModelCardArn', ], 'members' => [ 'ModelCardArn' => [ 'shape' => 'ModelCardArn', ], ], ], 'UpdateModelPackageInput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], 'ModelApprovalStatus' => [ 'shape' => 'ModelApprovalStatus', ], 'ApprovalDescription' => [ 'shape' => 'ApprovalDescription', ], 'CustomerMetadataProperties' => [ 'shape' => 'CustomerMetadataMap', ], 'CustomerMetadataPropertiesToRemove' => [ 'shape' => 'CustomerMetadataKeyList', ], 'AdditionalInferenceSpecificationsToAdd' => [ 'shape' => 'AdditionalInferenceSpecifications', ], ], ], 'UpdateModelPackageOutput' => [ 'type' => 'structure', 'required' => [ 'ModelPackageArn', ], 'members' => [ 'ModelPackageArn' => [ 'shape' => 'ModelPackageArn', ], ], ], 'UpdateMonitoringAlertRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringAlertName', 'DatapointsToAlert', 'EvaluationPeriod', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], 'DatapointsToAlert' => [ 'shape' => 'MonitoringDatapointsToAlert', ], 'EvaluationPeriod' => [ 'shape' => 'MonitoringEvaluationPeriod', ], ], ], 'UpdateMonitoringAlertResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], 'MonitoringAlertName' => [ 'shape' => 'MonitoringAlertName', ], ], ], 'UpdateMonitoringScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleName', 'MonitoringScheduleConfig', ], 'members' => [ 'MonitoringScheduleName' => [ 'shape' => 'MonitoringScheduleName', ], 'MonitoringScheduleConfig' => [ 'shape' => 'MonitoringScheduleConfig', ], ], ], 'UpdateMonitoringScheduleResponse' => [ 'type' => 'structure', 'required' => [ 'MonitoringScheduleArn', ], 'members' => [ 'MonitoringScheduleArn' => [ 'shape' => 'MonitoringScheduleArn', ], ], ], 'UpdateNotebookInstanceInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceName', ], 'members' => [ 'NotebookInstanceName' => [ 'shape' => 'NotebookInstanceName', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'DisassociateLifecycleConfig' => [ 'shape' => 'DisassociateNotebookInstanceLifecycleConfig', ], 'VolumeSizeInGB' => [ 'shape' => 'NotebookInstanceVolumeSizeInGB', ], 'DefaultCodeRepository' => [ 'shape' => 'CodeRepositoryNameOrUrl', ], 'AdditionalCodeRepositories' => [ 'shape' => 'AdditionalCodeRepositoryNamesOrUrls', ], 'AcceleratorTypes' => [ 'shape' => 'NotebookInstanceAcceleratorTypes', ], 'DisassociateAcceleratorTypes' => [ 'shape' => 'DisassociateNotebookInstanceAcceleratorTypes', ], 'DisassociateDefaultCodeRepository' => [ 'shape' => 'DisassociateDefaultCodeRepository', ], 'DisassociateAdditionalCodeRepositories' => [ 'shape' => 'DisassociateAdditionalCodeRepositories', ], 'RootAccess' => [ 'shape' => 'RootAccess', ], 'InstanceMetadataServiceConfiguration' => [ 'shape' => 'InstanceMetadataServiceConfiguration', ], ], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'type' => 'structure', 'required' => [ 'NotebookInstanceLifecycleConfigName', ], 'members' => [ 'NotebookInstanceLifecycleConfigName' => [ 'shape' => 'NotebookInstanceLifecycleConfigName', ], 'OnCreate' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], 'OnStart' => [ 'shape' => 'NotebookInstanceLifecycleConfigList', ], ], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdateNotebookInstanceOutput' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePipelineExecutionRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineExecutionArn', ], 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], 'PipelineExecutionDescription' => [ 'shape' => 'PipelineExecutionDescription', ], 'PipelineExecutionDisplayName' => [ 'shape' => 'PipelineExecutionName', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineExecutionResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineExecutionArn' => [ 'shape' => 'PipelineExecutionArn', ], ], ], 'UpdatePipelineRequest' => [ 'type' => 'structure', 'required' => [ 'PipelineName', ], 'members' => [ 'PipelineName' => [ 'shape' => 'PipelineName', ], 'PipelineDisplayName' => [ 'shape' => 'PipelineName', ], 'PipelineDefinition' => [ 'shape' => 'PipelineDefinition', ], 'PipelineDefinitionS3Location' => [ 'shape' => 'PipelineDefinitionS3Location', ], 'PipelineDescription' => [ 'shape' => 'PipelineDescription', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'UpdatePipelineResponse' => [ 'type' => 'structure', 'members' => [ 'PipelineArn' => [ 'shape' => 'PipelineArn', ], ], ], 'UpdateProjectInput' => [ 'type' => 'structure', 'required' => [ 'ProjectName', ], 'members' => [ 'ProjectName' => [ 'shape' => 'ProjectEntityName', ], 'ProjectDescription' => [ 'shape' => 'EntityDescription', ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'shape' => 'ServiceCatalogProvisioningUpdateDetails', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'UpdateProjectOutput' => [ 'type' => 'structure', 'required' => [ 'ProjectArn', ], 'members' => [ 'ProjectArn' => [ 'shape' => 'ProjectArn', ], ], ], 'UpdateSpaceRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'SpaceName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'SpaceName' => [ 'shape' => 'SpaceName', ], 'SpaceSettings' => [ 'shape' => 'SpaceSettings', ], 'SpaceDisplayName' => [ 'shape' => 'NonEmptyString64', ], ], ], 'UpdateSpaceResponse' => [ 'type' => 'structure', 'members' => [ 'SpaceArn' => [ 'shape' => 'SpaceArn', ], ], ], 'UpdateTrainingJobRequest' => [ 'type' => 'structure', 'required' => [ 'TrainingJobName', ], 'members' => [ 'TrainingJobName' => [ 'shape' => 'TrainingJobName', ], 'ProfilerConfig' => [ 'shape' => 'ProfilerConfigForUpdate', ], 'ProfilerRuleConfigurations' => [ 'shape' => 'ProfilerRuleConfigurations', ], 'ResourceConfig' => [ 'shape' => 'ResourceConfigForUpdate', ], 'RemoteDebugConfig' => [ 'shape' => 'RemoteDebugConfigForUpdate', ], ], ], 'UpdateTrainingJobResponse' => [ 'type' => 'structure', 'required' => [ 'TrainingJobArn', ], 'members' => [ 'TrainingJobArn' => [ 'shape' => 'TrainingJobArn', ], ], ], 'UpdateTrialComponentRequest' => [ 'type' => 'structure', 'required' => [ 'TrialComponentName', ], 'members' => [ 'TrialComponentName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], 'Status' => [ 'shape' => 'TrialComponentStatus', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Parameters' => [ 'shape' => 'TrialComponentParameters', ], 'ParametersToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'InputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'InputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], 'OutputArtifacts' => [ 'shape' => 'TrialComponentArtifacts', ], 'OutputArtifactsToRemove' => [ 'shape' => 'ListTrialComponentKey256', ], ], ], 'UpdateTrialComponentResponse' => [ 'type' => 'structure', 'members' => [ 'TrialComponentArn' => [ 'shape' => 'TrialComponentArn', ], ], ], 'UpdateTrialRequest' => [ 'type' => 'structure', 'required' => [ 'TrialName', ], 'members' => [ 'TrialName' => [ 'shape' => 'ExperimentEntityName', ], 'DisplayName' => [ 'shape' => 'ExperimentEntityName', ], ], ], 'UpdateTrialResponse' => [ 'type' => 'structure', 'members' => [ 'TrialArn' => [ 'shape' => 'TrialArn', ], ], ], 'UpdateUserProfileRequest' => [ 'type' => 'structure', 'required' => [ 'DomainId', 'UserProfileName', ], 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'UserSettings' => [ 'shape' => 'UserSettings', ], ], ], 'UpdateUserProfileResponse' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'UserProfileArn', ], ], ], 'UpdateWorkforceRequest' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfig', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigRequest', ], ], ], 'UpdateWorkforceResponse' => [ 'type' => 'structure', 'required' => [ 'Workforce', ], 'members' => [ 'Workforce' => [ 'shape' => 'Workforce', ], ], ], 'UpdateWorkteamRequest' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'Description' => [ 'shape' => 'String200', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'UpdateWorkteamResponse' => [ 'type' => 'structure', 'required' => [ 'Workteam', ], 'members' => [ 'Workteam' => [ 'shape' => 'Workteam', ], ], ], 'Url' => [ 'type' => 'string', 'max' => 1024, 'pattern' => '^(https|s3)://([^/]+)/?(.*)$', ], 'UserContext' => [ 'type' => 'structure', 'members' => [ 'UserProfileArn' => [ 'shape' => 'String', ], 'UserProfileName' => [ 'shape' => 'String', ], 'DomainId' => [ 'shape' => 'String', ], 'IamIdentity' => [ 'shape' => 'IamIdentity', ], ], ], 'UserProfileArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/.*', ], 'UserProfileDetails' => [ 'type' => 'structure', 'members' => [ 'DomainId' => [ 'shape' => 'DomainId', ], 'UserProfileName' => [ 'shape' => 'UserProfileName', ], 'Status' => [ 'shape' => 'UserProfileStatus', ], 'CreationTime' => [ 'shape' => 'CreationTime', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], ], ], 'UserProfileList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserProfileDetails', ], ], 'UserProfileName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'UserProfileSortKey' => [ 'type' => 'string', 'enum' => [ 'CreationTime', 'LastModifiedTime', ], ], 'UserProfileStatus' => [ 'type' => 'string', 'enum' => [ 'Deleting', 'Failed', 'InService', 'Pending', 'Updating', 'Update_Failed', 'Delete_Failed', ], ], 'UserSettings' => [ 'type' => 'structure', 'members' => [ 'ExecutionRole' => [ 'shape' => 'RoleArn', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupIds', ], 'SharingSettings' => [ 'shape' => 'SharingSettings', ], 'JupyterServerAppSettings' => [ 'shape' => 'JupyterServerAppSettings', ], 'KernelGatewayAppSettings' => [ 'shape' => 'KernelGatewayAppSettings', ], 'TensorBoardAppSettings' => [ 'shape' => 'TensorBoardAppSettings', ], 'RStudioServerProAppSettings' => [ 'shape' => 'RStudioServerProAppSettings', ], 'RSessionAppSettings' => [ 'shape' => 'RSessionAppSettings', ], 'CanvasAppSettings' => [ 'shape' => 'CanvasAppSettings', ], 'CodeEditorAppSettings' => [ 'shape' => 'CodeEditorAppSettings', ], 'JupyterLabAppSettings' => [ 'shape' => 'JupyterLabAppSettings', ], 'SpaceStorageSettings' => [ 'shape' => 'DefaultSpaceStorageSettings', ], 'DefaultLandingUri' => [ 'shape' => 'LandingUri', ], 'StudioWebPortal' => [ 'shape' => 'StudioWebPortal', ], 'CustomPosixUserConfig' => [ 'shape' => 'CustomPosixUserConfig', ], 'CustomFileSystemConfigs' => [ 'shape' => 'CustomFileSystemConfigs', ], ], ], 'UsersPerStep' => [ 'type' => 'integer', 'max' => 3, 'min' => 1, ], 'UtilizationMetric' => [ 'type' => 'float', 'min' => 0.0, ], 'UtilizationPercentagePerCore' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ValidationFraction' => [ 'type' => 'float', 'max' => 1, 'min' => 0, ], 'VariantName' => [ 'type' => 'string', 'max' => 63, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'VariantProperty' => [ 'type' => 'structure', 'required' => [ 'VariantPropertyType', ], 'members' => [ 'VariantPropertyType' => [ 'shape' => 'VariantPropertyType', ], ], ], 'VariantPropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VariantProperty', ], 'max' => 3, 'min' => 0, ], 'VariantPropertyType' => [ 'type' => 'string', 'enum' => [ 'DesiredInstanceCount', 'DesiredWeight', 'DataCaptureConfig', ], ], 'VariantStatus' => [ 'type' => 'string', 'enum' => [ 'Creating', 'Updating', 'Deleting', 'ActivatingTraffic', 'Baking', ], ], 'VariantStatusMessage' => [ 'type' => 'string', 'max' => 1024, ], 'VariantWeight' => [ 'type' => 'float', 'min' => 0, ], 'VectorConfig' => [ 'type' => 'structure', 'required' => [ 'Dimension', ], 'members' => [ 'Dimension' => [ 'shape' => 'Dimension', ], ], ], 'VendorGuidance' => [ 'type' => 'string', 'enum' => [ 'NOT_PROVIDED', 'STABLE', 'TO_BE_ARCHIVED', 'ARCHIVED', ], ], 'VersionId' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'VersionedArnOrName' => [ 'type' => 'string', 'max' => 176, 'min' => 1, 'pattern' => '(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'AssociationEntityArn', ], 'Type' => [ 'shape' => 'String40', ], 'LineageType' => [ 'shape' => 'LineageType', ], ], ], 'Vertices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Vertex', ], ], 'VisibilityConditions' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'VisibilityConditionsKey', ], 'Value' => [ 'shape' => 'VisibilityConditionsValue', ], ], ], 'VisibilityConditionsKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'VisibilityConditionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VisibilityConditions', ], 'max' => 5, 'min' => 1, ], 'VisibilityConditionsValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'VolumeSizeInGB' => [ 'type' => 'integer', 'min' => 1, ], 'VpcConfig' => [ 'type' => 'structure', 'required' => [ 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'SecurityGroupIds' => [ 'shape' => 'VpcSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'Subnets', ], ], ], 'VpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '[-0-9a-zA-Z]+', ], 'VpcOnlyTrustedAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], ], 'VpcSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WaitIntervalInSeconds' => [ 'type' => 'integer', 'max' => 3600, 'min' => 0, ], 'WarmPoolResourceStatus' => [ 'type' => 'string', 'enum' => [ 'Available', 'Terminated', 'Reused', 'InUse', ], ], 'WarmPoolStatus' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'WarmPoolResourceStatus', ], 'ResourceRetainedBillableTimeInSeconds' => [ 'shape' => 'ResourceRetainedBillableTimeInSeconds', ], 'ReusedByJob' => [ 'shape' => 'TrainingJobName', ], ], ], 'Workforce' => [ 'type' => 'structure', 'required' => [ 'WorkforceName', 'WorkforceArn', ], 'members' => [ 'WorkforceName' => [ 'shape' => 'WorkforceName', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'SourceIpConfig' => [ 'shape' => 'SourceIpConfig', ], 'SubDomain' => [ 'shape' => 'String', ], 'CognitoConfig' => [ 'shape' => 'CognitoConfig', ], 'OidcConfig' => [ 'shape' => 'OidcConfigForResponse', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'WorkforceVpcConfig' => [ 'shape' => 'WorkforceVpcConfigResponse', ], 'Status' => [ 'shape' => 'WorkforceStatus', ], 'FailureReason' => [ 'shape' => 'WorkforceFailureReason', ], ], ], 'WorkforceArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/.*', ], 'WorkforceFailureReason' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '.+', ], 'WorkforceName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}$', ], 'WorkforceSecurityGroupId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^sg-[0-9a-z]*$', ], 'WorkforceSecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'WorkforceStatus' => [ 'type' => 'string', 'enum' => [ 'Initializing', 'Updating', 'Deleting', 'Failed', 'Active', ], ], 'WorkforceSubnetId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^subnet-[0-9a-z]*$', ], 'WorkforceSubnets' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkforceSubnetId', ], 'max' => 16, 'min' => 1, ], 'WorkforceVpcConfigRequest' => [ 'type' => 'structure', 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], ], ], 'WorkforceVpcConfigResponse' => [ 'type' => 'structure', 'required' => [ 'VpcId', 'SecurityGroupIds', 'Subnets', ], 'members' => [ 'VpcId' => [ 'shape' => 'WorkforceVpcId', ], 'SecurityGroupIds' => [ 'shape' => 'WorkforceSecurityGroupIds', ], 'Subnets' => [ 'shape' => 'WorkforceSubnets', ], 'VpcEndpointId' => [ 'shape' => 'WorkforceVpcEndpointId', ], ], ], 'WorkforceVpcEndpointId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^vpce-[0-9a-z]*$', ], 'WorkforceVpcId' => [ 'type' => 'string', 'max' => 32, 'pattern' => '^vpc-[0-9a-z]*$', ], 'Workforces' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workforce', ], ], 'WorkspaceSettings' => [ 'type' => 'structure', 'members' => [ 'S3ArtifactPath' => [ 'shape' => 'S3Uri', ], 'S3KmsKeyId' => [ 'shape' => 'KmsKeyId', ], ], ], 'Workteam' => [ 'type' => 'structure', 'required' => [ 'WorkteamName', 'MemberDefinitions', 'WorkteamArn', 'Description', ], 'members' => [ 'WorkteamName' => [ 'shape' => 'WorkteamName', ], 'MemberDefinitions' => [ 'shape' => 'MemberDefinitions', ], 'WorkteamArn' => [ 'shape' => 'WorkteamArn', ], 'WorkforceArn' => [ 'shape' => 'WorkforceArn', ], 'ProductListingIds' => [ 'shape' => 'ProductListings', ], 'Description' => [ 'shape' => 'String200', ], 'SubDomain' => [ 'shape' => 'String', ], 'CreateDate' => [ 'shape' => 'Timestamp', ], 'LastUpdatedDate' => [ 'shape' => 'Timestamp', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], ], ], 'WorkteamArn' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/.*', ], 'WorkteamName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}', ], 'Workteams' => [ 'type' => 'list', 'member' => [ 'shape' => 'Workteam', ], ], ],]; diff --git a/src/data/sagemaker/2017-07-24/docs-2.json b/src/data/sagemaker/2017-07-24/docs-2.json index 5b78083e8b..b4d2b71859 100644 --- a/src/data/sagemaker/2017-07-24/docs-2.json +++ b/src/data/sagemaker/2017-07-24/docs-2.json @@ -1640,6 +1640,17 @@ "CapacitySize$Value": "

Defines the capacity size, either as a number of instances or a capacity percentage.

" } }, + "CapacityUnit": { + "base": null, + "refs": { + "ThroughputConfig$ProvisionedReadCapacityUnits": "

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

", + "ThroughputConfig$ProvisionedWriteCapacityUnits": "

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

", + "ThroughputConfigDescription$ProvisionedReadCapacityUnits": "

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

", + "ThroughputConfigDescription$ProvisionedWriteCapacityUnits": "

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

", + "ThroughputConfigUpdate$ProvisionedReadCapacityUnits": "

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

", + "ThroughputConfigUpdate$ProvisionedWriteCapacityUnits": "

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

" + } + }, "CaptureContentTypeHeader": { "base": "

Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker will by default base64 encode when capturing the data.

", "refs": { @@ -14555,6 +14566,32 @@ "DeviceSummary$IotThingName": "

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

" } }, + "ThroughputConfig": { + "base": "

Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

", + "refs": { + "CreateFeatureGroupRequest$ThroughputConfig": null + } + }, + "ThroughputConfigDescription": { + "base": "

Active throughput configuration of the feature group. Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

", + "refs": { + "DescribeFeatureGroupResponse$ThroughputConfig": null + } + }, + "ThroughputConfigUpdate": { + "base": "

The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period.

", + "refs": { + "UpdateFeatureGroupRequest$ThroughputConfig": null + } + }, + "ThroughputMode": { + "base": null, + "refs": { + "ThroughputConfig$ThroughputMode": "

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

", + "ThroughputConfigDescription$ThroughputMode": "

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

", + "ThroughputConfigUpdate$ThroughputMode": "

Target throughput mode of the feature group. Throughput update is an asynchronous operation, and the outcome should be monitored by polling LastUpdateStatus field in DescribeFeatureGroup response. You cannot update a feature group's throughput while another update is in progress.

" + } + }, "TimeSeriesConfig": { "base": "

The collection of components that defines the time-series.

", "refs": { diff --git a/src/data/sagemaker/2017-07-24/docs-2.json.php b/src/data/sagemaker/2017-07-24/docs-2.json.php index d9f1895d83..35482808e4 100644 --- a/src/data/sagemaker/2017-07-24/docs-2.json.php +++ b/src/data/sagemaker/2017-07-24/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Provides APIs for creating and managing SageMaker resources.

Other Resources:

', 'operations' => [ 'AddAssociation' => '

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'AddTags' => '

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

', 'AssociateTrialComponent' => '

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

', 'BatchDescribeModelPackage' => '

This action batch describes a list of versioned model packages

', 'CreateAction' => '

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateAlgorithm' => '

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

', 'CreateApp' => '

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

', 'CreateAppImageConfig' => '

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.

', 'CreateArtifact' => '

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateAutoMLJob' => '

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.

', 'CreateAutoMLJobV2' => '

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.

You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

', 'CreateCluster' => '

Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

', 'CreateCodeRepository' => '

Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

', 'CreateCompilationJob' => '

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

  • A name for the compilation job

  • Information about the input model artifacts

  • The output location for the compiled model and the device (target) that the model runs on

  • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.

You can also provide a Tag to track the model compilation job\'s resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

', 'CreateContext' => '

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateDataQualityJobDefinition' => '

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'CreateDeviceFleet' => '

Creates a device fleet.

', 'CreateDomain' => '

Creates a Domain. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All traffic between the domain and the EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.

  • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

    When internet access is disabled, you won\'t be able to run a Amazon SageMaker Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully.

For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.

', 'CreateEdgeDeploymentPlan' => '

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

', 'CreateEdgeDeploymentStage' => '

Creates a new stage in an existing edge deployment plan.

', 'CreateEdgePackagingJob' => '

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

', 'CreateEndpoint' => '

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

  • Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.

  • Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:

    "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"]

    "Resource": [

    "arn:aws:sagemaker:region:account-id:endpoint/endpointName"

    "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"

    ]

    For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.

', 'CreateEndpointConfig' => '

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

Use this API if you want to use SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

', 'CreateExperiment' => '

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment\'s properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

', 'CreateFeatureGroup' => '

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

', 'CreateFlowDefinition' => '

Creates a flow definition.

', 'CreateHub' => '

Create a hub.

Hub APIs are only callable through SageMaker Studio.

', 'CreateHumanTaskUi' => '

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

', 'CreateHyperParameterTuningJob' => '

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.

Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

', 'CreateImage' => '

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image.

', 'CreateImageVersion' => '

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.

', 'CreateInferenceComponent' => '

Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

', 'CreateInferenceExperiment' => '

Creates an inference experiment using the configurations specified in the request.

Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.

Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint\'s model variants based on your specified configuration.

While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.

', 'CreateInferenceRecommendationsJob' => '

Starts a recommendation job. You can create either an instance recommendation or load test job.

', 'CreateLabelingJob' => '

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

  • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

  • One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.

  • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

', 'CreateModel' => '

Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

For an example that calls this method when deploying a model to SageMaker hosting services, see Create a Model (Amazon Web Services SDK for Python (Boto 3)).

To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

', 'CreateModelBiasJobDefinition' => '

Creates the definition for a model bias job.

', 'CreateModelCard' => '

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card.

', 'CreateModelCardExportJob' => '

Creates an Amazon SageMaker Model Card export job.

', 'CreateModelExplainabilityJobDefinition' => '

Creates the definition for a model explainability job.

', 'CreateModelPackage' => '

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

  • Versioned - a model that is part of a model group in the model registry.

  • Unversioned - a model package that is not part of a model group.

', 'CreateModelPackageGroup' => '

Creates a model group. A model group contains a group of model versions.

', 'CreateModelQualityJobDefinition' => '

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'CreateMonitoringSchedule' => '

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.

', 'CreateNotebookInstance' => '

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, SageMaker does the following:

  1. Creates a network interface in the SageMaker VPC.

  2. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

  3. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can\'t change the name of a notebook instance after you create it.

After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models.

For more information, see How It Works.

', 'CreateNotebookInstanceLifecycleConfig' => '

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'CreatePipeline' => '

Creates a pipeline using a JSON pipeline definition.

', 'CreatePresignedDomainUrl' => '

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain\'s Amazon Elastic File System (EFS) volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

', 'CreatePresignedNotebookInstanceUrl' => '

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

', 'CreateProcessingJob' => '

Creates a processing job.

', 'CreateProject' => '

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

', 'CreateSpace' => '

Creates a space used for real time collaboration in a Domain.

', 'CreateStudioLifecycleConfig' => '

Creates a new Amazon SageMaker Studio Lifecycle Configuration.

', 'CreateTrainingJob' => '

Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.

In the request body, you provide the following:

  • AlgorithmSpecification - Identifies the training algorithm to use.

  • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

    Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

  • InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.

  • OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.

  • ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.

  • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.

  • RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.

  • StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.

  • Environment - The environment variables to set in the Docker container.

  • RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.

For more information about SageMaker, see How It Works.

', 'CreateTransformJob' => '

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

  • TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

  • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.

  • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

  • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

  • TransformResources - Identifies the ML compute instances for the transform job.

For more information about how batch transformation works, see Batch Transform.

', 'CreateTrial' => '

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial\'s properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

', 'CreateTrialComponent' => '

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

', 'CreateUserProfile' => '

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user\'s private Amazon Elastic File System (EFS) home directory.

', 'CreateWorkforce' => '

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

', 'CreateWorkteam' => '

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

', 'DeleteAction' => '

Deletes an action.

', 'DeleteAlgorithm' => '

Removes the specified algorithm from your account.

', 'DeleteApp' => '

Used to stop and delete an app.

', 'DeleteAppImageConfig' => '

Deletes an AppImageConfig.

', 'DeleteArtifact' => '

Deletes an artifact. Either ArtifactArn or Source must be specified.

', 'DeleteAssociation' => '

Deletes an association.

', 'DeleteCluster' => '

Delete a SageMaker HyperPod cluster.

', 'DeleteCodeRepository' => '

Deletes the specified Git repository from your account.

', 'DeleteCompilationJob' => '

Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker. It doesn\'t delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.

You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomes STOPPED.

', 'DeleteContext' => '

Deletes an context.

', 'DeleteDataQualityJobDefinition' => '

Deletes a data quality monitoring job definition.

', 'DeleteDeviceFleet' => '

Deletes a fleet.

', 'DeleteDomain' => '

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

', 'DeleteEdgeDeploymentPlan' => '

Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

', 'DeleteEdgeDeploymentStage' => '

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

', 'DeleteEndpoint' => '

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don\'t need to use the RevokeGrant API call.

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.

', 'DeleteEndpointConfig' => '

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

', 'DeleteExperiment' => '

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

', 'DeleteFeatureGroup' => '

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.

', 'DeleteFlowDefinition' => '

Deletes the specified flow definition.

', 'DeleteHub' => '

Delete a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DeleteHubContent' => '

Delete the contents of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DeleteHumanTaskUi' => '

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

', 'DeleteImage' => '

Deletes a SageMaker image and all versions of the image. The container images aren\'t deleted.

', 'DeleteImageVersion' => '

Deletes a version of a SageMaker image. The container image the version represents isn\'t deleted.

', 'DeleteInferenceComponent' => '

Deletes an inference component.

', 'DeleteInferenceExperiment' => '

Deletes an inference experiment.

This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.

', 'DeleteModel' => '

Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

', 'DeleteModelBiasJobDefinition' => '

Deletes an Amazon SageMaker model bias job definition.

', 'DeleteModelCard' => '

Deletes an Amazon SageMaker Model Card.

', 'DeleteModelExplainabilityJobDefinition' => '

Deletes an Amazon SageMaker model explainability job definition.

', 'DeleteModelPackage' => '

Deletes a model package.

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

', 'DeleteModelPackageGroup' => '

Deletes the specified model group.

', 'DeleteModelPackageGroupPolicy' => '

Deletes a model group resource policy.

', 'DeleteModelQualityJobDefinition' => '

Deletes the secified model quality monitoring job definition.

', 'DeleteMonitoringSchedule' => '

Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

', 'DeleteNotebookInstance' => '

Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

', 'DeleteNotebookInstanceLifecycleConfig' => '

Deletes a notebook instance lifecycle configuration.

', 'DeletePipeline' => '

Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.

', 'DeleteProject' => '

Delete the specified project.

', 'DeleteSpace' => '

Used to delete a space.

', 'DeleteStudioLifecycleConfig' => '

Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

', 'DeleteTags' => '

Deletes the specified tags from an SageMaker resource.

To list a resource\'s tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.

', 'DeleteTrial' => '

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

', 'DeleteTrialComponent' => '

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

', 'DeleteUserProfile' => '

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

', 'DeleteWorkforce' => '

Use this operation to delete a workforce.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.

', 'DeleteWorkteam' => '

Deletes an existing work team. This operation can\'t be undone.

', 'DeregisterDevices' => '

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

', 'DescribeAction' => '

Describes an action.

', 'DescribeAlgorithm' => '

Returns a description of the specified algorithm that is in your account.

', 'DescribeApp' => '

Describes the app.

', 'DescribeAppImageConfig' => '

Describes an AppImageConfig.

', 'DescribeArtifact' => '

Describes an artifact.

', 'DescribeAutoMLJob' => '

Returns information about an AutoML job created by calling CreateAutoMLJob.

AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.

', 'DescribeAutoMLJobV2' => '

Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.

', 'DescribeCluster' => '

Retrieves information of a SageMaker HyperPod cluster.

', 'DescribeClusterNode' => '

Retrieves information of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

', 'DescribeCodeRepository' => '

Gets details about the specified Git repository.

', 'DescribeCompilationJob' => '

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

', 'DescribeContext' => '

Describes a context.

', 'DescribeDataQualityJobDefinition' => '

Gets the details of a data quality monitoring job definition.

', 'DescribeDevice' => '

Describes the device.

', 'DescribeDeviceFleet' => '

A description of the fleet the device belongs to.

', 'DescribeDomain' => '

The description of the domain.

', 'DescribeEdgeDeploymentPlan' => '

Describes an edge deployment plan with deployment status per stage.

', 'DescribeEdgePackagingJob' => '

A description of edge packaging jobs.

', 'DescribeEndpoint' => '

Returns the description of an endpoint.

', 'DescribeEndpointConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', 'DescribeExperiment' => '

Provides a list of an experiment\'s properties.

', 'DescribeFeatureGroup' => '

Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

', 'DescribeFeatureMetadata' => '

Shows the metadata for a feature within a feature group.

', 'DescribeFlowDefinition' => '

Returns information about the specified flow definition.

', 'DescribeHub' => '

Describe a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DescribeHubContent' => '

Describe the content of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DescribeHumanTaskUi' => '

Returns information about the requested human task user interface (worker task template).

', 'DescribeHyperParameterTuningJob' => '

Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.

', 'DescribeImage' => '

Describes a SageMaker image.

', 'DescribeImageVersion' => '

Describes a version of a SageMaker image.

', 'DescribeInferenceComponent' => '

Returns information about an inference component.

', 'DescribeInferenceExperiment' => '

Returns details about an inference experiment.

', 'DescribeInferenceRecommendationsJob' => '

Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

', 'DescribeLabelingJob' => '

Gets information about a labeling job.

', 'DescribeLineageGroup' => '

Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

', 'DescribeModel' => '

Describes a model that you created using the CreateModel API.

', 'DescribeModelBiasJobDefinition' => '

Returns a description of a model bias job definition.

', 'DescribeModelCard' => '

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

', 'DescribeModelCardExportJob' => '

Describes an Amazon SageMaker Model Card export job.

', 'DescribeModelExplainabilityJobDefinition' => '

Returns a description of a model explainability job definition.

', 'DescribeModelPackage' => '

Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

', 'DescribeModelPackageGroup' => '

Gets a description for the specified model group.

', 'DescribeModelQualityJobDefinition' => '

Returns a description of a model quality job definition.

', 'DescribeMonitoringSchedule' => '

Describes the schedule for a monitoring job.

', 'DescribeNotebookInstance' => '

Returns information about a notebook instance.

', 'DescribeNotebookInstanceLifecycleConfig' => '

Returns a description of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'DescribePipeline' => '

Describes the details of a pipeline.

', 'DescribePipelineDefinitionForExecution' => '

Describes the details of an execution\'s pipeline definition.

', 'DescribePipelineExecution' => '

Describes the details of a pipeline execution.

', 'DescribeProcessingJob' => '

Returns a description of a processing job.

', 'DescribeProject' => '

Describes the details of a project.

', 'DescribeSpace' => '

Describes the space.

', 'DescribeStudioLifecycleConfig' => '

Describes the Amazon SageMaker Studio Lifecycle Configuration.

', 'DescribeSubscribedWorkteam' => '

Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.

', 'DescribeTrainingJob' => '

Returns information about a training job.

Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.

', 'DescribeTransformJob' => '

Returns information about a transform job.

', 'DescribeTrial' => '

Provides a list of a trial\'s properties.

', 'DescribeTrialComponent' => '

Provides a list of a trials component\'s properties.

', 'DescribeUserProfile' => '

Describes a user profile. For more information, see CreateUserProfile.

', 'DescribeWorkforce' => '

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

', 'DescribeWorkteam' => '

Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team\'s Amazon Resource Name (ARN).

', 'DisableSagemakerServicecatalogPortfolio' => '

Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'DisassociateTrialComponent' => '

Disassociates a trial component from a trial. This doesn\'t effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

', 'EnableSagemakerServicecatalogPortfolio' => '

Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'GetDeviceFleetReport' => '

Describes a fleet.

', 'GetLineageGroupPolicy' => '

The resource policy for the lineage group.

', 'GetModelPackageGroupPolicy' => '

Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

', 'GetSagemakerServicecatalogPortfolioStatus' => '

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'GetScalingConfigurationRecommendation' => '

Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.

', 'GetSearchSuggestions' => '

An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

', 'ImportHubContent' => '

Import hub content.

Hub APIs are only callable through SageMaker Studio.

', 'ListActions' => '

Lists the actions in your account and their properties.

', 'ListAlgorithms' => '

Lists the machine learning algorithms that have been created.

', 'ListAliases' => '

Lists the aliases of a specified image or image version.

', 'ListAppImageConfigs' => '

Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

', 'ListApps' => '

Lists apps.

', 'ListArtifacts' => '

Lists the artifacts in your account and their properties.

', 'ListAssociations' => '

Lists the associations in your account and their properties.

', 'ListAutoMLJobs' => '

Request a list of jobs.

', 'ListCandidatesForAutoMLJob' => '

List the candidates created for the job.

', 'ListClusterNodes' => '

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

', 'ListClusters' => '

Retrieves the list of SageMaker HyperPod clusters.

', 'ListCodeRepositories' => '

Gets a list of the Git repositories in your account.

', 'ListCompilationJobs' => '

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

', 'ListContexts' => '

Lists the contexts in your account and their properties.

', 'ListDataQualityJobDefinitions' => '

Lists the data quality job definitions in your account.

', 'ListDeviceFleets' => '

Returns a list of devices in the fleet.

', 'ListDevices' => '

A list of devices.

', 'ListDomains' => '

Lists the domains.

', 'ListEdgeDeploymentPlans' => '

Lists all edge deployment plans.

', 'ListEdgePackagingJobs' => '

Returns a list of edge packaging jobs.

', 'ListEndpointConfigs' => '

Lists endpoint configurations.

', 'ListEndpoints' => '

Lists endpoints.

', 'ListExperiments' => '

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

', 'ListFeatureGroups' => '

List FeatureGroups based on given filter and order.

', 'ListFlowDefinitions' => '

Returns information about the flow definitions in your account.

', 'ListHubContentVersions' => '

List hub content versions.

Hub APIs are only callable through SageMaker Studio.

', 'ListHubContents' => '

List the contents of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'ListHubs' => '

List all existing hubs.

Hub APIs are only callable through SageMaker Studio.

', 'ListHumanTaskUis' => '

Returns information about the human task user interfaces in your account.

', 'ListHyperParameterTuningJobs' => '

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

', 'ListImageVersions' => '

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

', 'ListImages' => '

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

', 'ListInferenceComponents' => '

Lists the inference components in your account and their properties.

', 'ListInferenceExperiments' => '

Returns the list of all inference experiments.

', 'ListInferenceRecommendationsJobSteps' => '

Returns a list of the subtasks for an Inference Recommender job.

The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

', 'ListInferenceRecommendationsJobs' => '

Lists recommendation jobs that satisfy various filters.

', 'ListLabelingJobs' => '

Gets a list of labeling jobs.

', 'ListLabelingJobsForWorkteam' => '

Gets a list of labeling jobs assigned to a specified work team.

', 'ListLineageGroups' => '

A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

', 'ListModelBiasJobDefinitions' => '

Lists model bias jobs definitions that satisfy various filters.

', 'ListModelCardExportJobs' => '

List the export jobs for the Amazon SageMaker Model Card.

', 'ListModelCardVersions' => '

List existing versions of an Amazon SageMaker Model Card.

', 'ListModelCards' => '

List existing model cards.

', 'ListModelExplainabilityJobDefinitions' => '

Lists model explainability job definitions that satisfy various filters.

', 'ListModelMetadata' => '

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

', 'ListModelPackageGroups' => '

Gets a list of the model groups in your Amazon Web Services account.

', 'ListModelPackages' => '

Lists the model packages that have been created.

', 'ListModelQualityJobDefinitions' => '

Gets a list of model quality monitoring job definitions in your account.

', 'ListModels' => '

Lists models created with the CreateModel API.

', 'ListMonitoringAlertHistory' => '

Gets a list of past alerts in a model monitoring schedule.

', 'ListMonitoringAlerts' => '

Gets the alerts for a single monitoring schedule.

', 'ListMonitoringExecutions' => '

Returns list of all monitoring job executions.

', 'ListMonitoringSchedules' => '

Returns list of all monitoring schedules.

', 'ListNotebookInstanceLifecycleConfigs' => '

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

', 'ListNotebookInstances' => '

Returns a list of the SageMaker notebook instances in the requester\'s account in an Amazon Web Services Region.

', 'ListPipelineExecutionSteps' => '

Gets a list of PipeLineExecutionStep objects.

', 'ListPipelineExecutions' => '

Gets a list of the pipeline executions.

', 'ListPipelineParametersForExecution' => '

Gets a list of parameters for a pipeline execution.

', 'ListPipelines' => '

Gets a list of pipelines.

', 'ListProcessingJobs' => '

Lists processing jobs that satisfy various filters.

', 'ListProjects' => '

Gets a list of the projects in an Amazon Web Services account.

', 'ListResourceCatalogs' => '

Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.

', 'ListSpaces' => '

Lists spaces.

', 'ListStageDevices' => '

Lists devices allocated to the stage, containing detailed device information and deployment status.

', 'ListStudioLifecycleConfigs' => '

Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

', 'ListSubscribedWorkteams' => '

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

', 'ListTags' => '

Returns the tags for the specified SageMaker resource.

', 'ListTrainingJobs' => '

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

', 'ListTrainingJobsForHyperParameterTuningJob' => '

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

', 'ListTransformJobs' => '

Lists transform jobs.

', 'ListTrialComponents' => '

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

  • ExperimentName

  • SourceArn

  • TrialName

', 'ListTrials' => '

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

', 'ListUserProfiles' => '

Lists user profiles.

', 'ListWorkforces' => '

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

', 'ListWorkteams' => '

Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

', 'PutModelPackageGroupPolicy' => '

Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

', 'QueryLineage' => '

Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.

', 'RegisterDevices' => '

Register devices.

', 'RenderUiTemplate' => '

Renders the UI template so that you can preview the worker\'s experience.

', 'RetryPipelineExecution' => '

Retry the execution of the pipeline.

', 'Search' => '

Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numeric, text, Boolean, and timestamp.

The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.

', 'SendPipelineExecutionStepFailure' => '

Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

', 'SendPipelineExecutionStepSuccess' => '

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step\'s output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

', 'StartEdgeDeploymentStage' => '

Starts a stage in an edge deployment plan.

', 'StartInferenceExperiment' => '

Starts an inference experiment.

', 'StartMonitoringSchedule' => '

Starts a previously stopped monitoring schedule.

By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.

', 'StartNotebookInstance' => '

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance\'s status must be InService before you can connect to your Jupyter notebook.

', 'StartPipelineExecution' => '

Starts a pipeline execution.

', 'StopAutoMLJob' => '

A method for forcing a running job to shut down.

', 'StopCompilationJob' => '

Stops a model compilation job.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn\'t stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.

', 'StopEdgeDeploymentStage' => '

Stops a stage in an edge deployment plan.

', 'StopEdgePackagingJob' => '

Request to stop an edge packaging job.

', 'StopHyperParameterTuningJob' => '

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

', 'StopInferenceExperiment' => '

Stops an inference experiment.

', 'StopInferenceRecommendationsJob' => '

Stops an Inference Recommender job.

', 'StopLabelingJob' => '

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

', 'StopMonitoringSchedule' => '

Stops a previously started monitoring schedule.

', 'StopNotebookInstance' => '

Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

', 'StopPipelineExecution' => '

Stops a pipeline execution.

Callback Step

A pipeline execution won\'t stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping".

You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

Lambda Step

A pipeline execution can\'t be stopped while a lambda step is running because the Lambda function invoked by the lambda step can\'t be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.

', 'StopProcessingJob' => '

Stops a processing job.

', 'StopTrainingJob' => '

Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.

', 'StopTransformJob' => '

Stops a batch transform job.

When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn\'t store the job\'s output in Amazon S3.

', 'UpdateAction' => '

Updates an action.

', 'UpdateAppImageConfig' => '

Updates the properties of an AppImageConfig.

', 'UpdateArtifact' => '

Updates an artifact.

', 'UpdateCluster' => '

Update a SageMaker HyperPod cluster.

', 'UpdateCodeRepository' => '

Updates the specified Git repository with the specified values.

', 'UpdateContext' => '

Updates a context.

', 'UpdateDeviceFleet' => '

Updates a fleet of devices.

', 'UpdateDevices' => '

Updates one or more devices in a fleet.

', 'UpdateDomain' => '

Updates the default settings for new user profiles in the domain.

', 'UpdateEndpoint' => '

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

', 'UpdateEndpointWeightsAndCapacities' => '

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

', 'UpdateExperiment' => '

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

', 'UpdateFeatureGroup' => '

Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API.

You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.

You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration.

', 'UpdateFeatureMetadata' => '

Updates the description and parameters of the feature group.

', 'UpdateHub' => '

Update a hub.

Hub APIs are only callable through SageMaker Studio.

', 'UpdateImage' => '

Updates the properties of a SageMaker image. To change the image\'s tags, use the AddTags and DeleteTags APIs.

', 'UpdateImageVersion' => '

Updates the properties of a SageMaker image version.

', 'UpdateInferenceComponent' => '

Updates an inference component.

', 'UpdateInferenceComponentRuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceExperiment' => '

Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.

', 'UpdateModelCard' => '

Update an Amazon SageMaker Model Card.

You cannot update both model card content and model card status in a single call.

', 'UpdateModelPackage' => '

Updates a versioned model.

', 'UpdateMonitoringAlert' => '

Update the parameters of a model monitor alert.

', 'UpdateMonitoringSchedule' => '

Updates a previously created schedule.

', 'UpdateNotebookInstance' => '

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

', 'UpdateNotebookInstanceLifecycleConfig' => '

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

', 'UpdatePipeline' => '

Updates a pipeline.

', 'UpdatePipelineExecution' => '

Updates a pipeline execution.

', 'UpdateProject' => '

Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.

', 'UpdateSpace' => '

Updates the settings of a space.

', 'UpdateTrainingJob' => '

Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.

', 'UpdateTrial' => '

Updates the display name of a trial.

', 'UpdateTrialComponent' => '

Updates one or more properties of a trial component.

', 'UpdateUserProfile' => '

Updates a user profile.

', 'UpdateWorkforce' => '

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

The worker portal is now supported in VPC and public internet.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn\'t restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as "10.0.0.0/16".

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

This operation only applies to private workforces.

', 'UpdateWorkteam' => '

Updates an existing work team with new member definitions or description.

', ], 'shapes' => [ 'Accept' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$Accept' => '

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

', ], ], 'AcceptEula' => [ 'base' => NULL, 'refs' => [ 'ModelAccessConfig$AcceptEula' => '

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'LabelingJobForWorkteamSummary$WorkRequesterAccountId' => '

The Amazon Web Services account ID of the account used to start the labeling job.

', 'VpcOnlyTrustedAccounts$member' => NULL, ], ], 'ActionArn' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'CreateActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'DeleteActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'DescribeActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'UpdateActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', ], ], 'ActionSource' => [ 'base' => '

A structure describing the source of an action.

', 'refs' => [ 'ActionSummary$Source' => '

The source of the action.

', 'CreateActionRequest$Source' => '

The source type, ID, and URI.

', 'DescribeActionResponse$Source' => '

The source of the action.

', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$Status' => '

The status of the action.

', 'CreateActionRequest$Status' => '

The status of the action.

', 'DescribeActionResponse$Status' => '

The status of the action.

', 'UpdateActionRequest$Status' => '

The new status for the action.

', ], ], 'ActionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListActionsResponse$ActionSummaries' => '

A list of actions and their properties.

', ], ], 'ActionSummary' => [ 'base' => '

Lists the properties of an action. An action represents an action or activity. Some examples are a workflow step and a model deployment. Generally, an action involves at least one input artifact or output artifact.

', 'refs' => [ 'ActionSummaries$member' => NULL, ], ], 'AddAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$AdditionalCodeRepositories' => '

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'DescribeNotebookInstanceOutput$AdditionalCodeRepositories' => '

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'NotebookInstanceSummary$AdditionalCodeRepositories' => '

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'UpdateNotebookInstanceInput$AdditionalCodeRepositories' => '

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', ], ], 'AdditionalInferenceSpecificationDefinition' => [ 'base' => '

A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package

', 'refs' => [ 'AdditionalInferenceSpecifications$member' => NULL, ], ], 'AdditionalInferenceSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', 'DescribeModelPackageOutput$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', 'ModelPackage$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects.

', 'UpdateModelPackageInput$AdditionalInferenceSpecificationsToAdd' => '

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', ], ], 'AdditionalS3DataSource' => [ 'base' => '

A data source used for training or inference that is in addition to the input dataset or model data.

', 'refs' => [ 'ModelPackageContainerDefinition$AdditionalS3DataSource' => '

The additional data source that is used during inference in the Docker container for your model package.

', 'TrainingSpecification$AdditionalS3DataSource' => '

The additional data source used during the training job.

', ], ], 'AdditionalS3DataSourceDataType' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$S3DataType' => '

The data type of the additional data source that you specify for use in inference or training.

', ], ], 'AgentVersion' => [ 'base' => '

Edge Manager agent version.

', 'refs' => [ 'AgentVersions$member' => NULL, ], ], 'AgentVersions' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$AgentVersions' => '

The versions of Edge Manager agent deployed on the fleet.

', ], ], 'AggregationTransformationValue' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$value' => NULL, ], ], 'AggregationTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Aggregation' => '

A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.

The supported aggregation methods are sum (default), avg, first, min, max.

Aggregation is only supported for the target column.

', ], ], 'Alarm' => [ 'base' => '

An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.

', 'refs' => [ 'AlarmList$member' => NULL, ], ], 'AlarmList' => [ 'base' => NULL, 'refs' => [ 'AutoRollbackConfig$Alarms' => '

List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.

', ], ], 'AlarmName' => [ 'base' => NULL, 'refs' => [ 'Alarm$AlarmName' => '

The name of a CloudWatch alarm in your account.

', ], ], 'AlgorithmArn' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm.

', 'CreateAlgorithmOutput$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the new algorithm.

', 'DescribeAlgorithmOutput$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm.

', ], ], 'AlgorithmImage' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$TrainingImage' => '

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

For more information, see the note in the AlgorithmName parameter description.

', 'DebugRuleConfiguration$RuleEvaluatorImage' => '

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

', 'HyperParameterAlgorithmSpecification$TrainingImage' => '

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

', 'ProfilerRuleConfiguration$RuleEvaluatorImage' => '

The Amazon Elastic Container Registry Image for the managed rule evaluation.

', ], ], 'AlgorithmSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'AlgorithmSpecification' => [ 'base' => '

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

', 'refs' => [ 'CreateTrainingJobRequest$AlgorithmSpecification' => '

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

', 'DescribeTrainingJobResponse$AlgorithmSpecification' => '

Information about the algorithm used for training, and algorithm metadata.

', 'TrainingJob$AlgorithmSpecification' => '

Information about the algorithm used for training, and algorithm metadata.

', ], ], 'AlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmStatus' => '

The overall status of the algorithm.

', 'DescribeAlgorithmOutput$AlgorithmStatus' => '

The current status of the algorithm.

', ], ], 'AlgorithmStatusDetails' => [ 'base' => '

Specifies the validation and image scan statuses of the algorithm.

', 'refs' => [ 'DescribeAlgorithmOutput$AlgorithmStatusDetails' => '

Details about the current status of the algorithm.

', ], ], 'AlgorithmStatusItem' => [ 'base' => '

Represents the overall status of an algorithm.

', 'refs' => [ 'AlgorithmStatusItemList$member' => NULL, ], ], 'AlgorithmStatusItemList' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusDetails$ValidationStatuses' => '

The status of algorithm validation.

', 'AlgorithmStatusDetails$ImageScanStatuses' => '

The status of the scan of the algorithm\'s Docker image container.

', ], ], 'AlgorithmSummary' => [ 'base' => '

Provides summary information about an algorithm.

', 'refs' => [ 'AlgorithmSummaryList$member' => NULL, ], ], 'AlgorithmSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsOutput$AlgorithmSummaryList' => '

>An array of AlgorithmSummary objects, each of which lists an algorithm.

', ], ], 'AlgorithmValidationProfile' => [ 'base' => '

Defines a training job and a batch transform job that SageMaker runs to validate your algorithm.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

', 'refs' => [ 'AlgorithmValidationProfiles$member' => NULL, ], ], 'AlgorithmValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'AlgorithmValidationSpecification$ValidationProfiles' => '

An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.

', ], ], 'AlgorithmValidationSpecification' => [ 'base' => '

Specifies configurations for one or more training jobs that SageMaker runs to test the algorithm.

', 'refs' => [ 'CreateAlgorithmInput$ValidationSpecification' => '

Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm\'s training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm\'s inference code.

', 'DescribeAlgorithmOutput$ValidationSpecification' => '

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

', ], ], 'AnnotationConsolidationConfig' => [ 'base' => '

Configures how labels are consolidated across human workers and processes output data.

', 'refs' => [ 'HumanTaskConfig$AnnotationConsolidationConfig' => '

Configures how labels are consolidated across human workers.

', ], ], 'AppArn' => [ 'base' => NULL, 'refs' => [ 'CreateAppResponse$AppArn' => '

The Amazon Resource Name (ARN) of the app.

', 'DescribeAppResponse$AppArn' => '

The Amazon Resource Name (ARN) of the app.

', ], ], 'AppDetails' => [ 'base' => '

Details about an Amazon SageMaker app.

', 'refs' => [ 'AppList$member' => NULL, ], ], 'AppImageConfigArn' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigArn' => '

The Amazon Resource Name (ARN) of the AppImageConfig.

', 'CreateAppImageConfigResponse$AppImageConfigArn' => '

The Amazon Resource Name (ARN) of the AppImageConfig.

', 'DescribeAppImageConfigResponse$AppImageConfigArn' => '

The Amazon Resource Name (ARN) of the AppImageConfig.

', 'UpdateAppImageConfigResponse$AppImageConfigArn' => '

The Amazon Resource Name (ARN) for the AppImageConfig.

', ], ], 'AppImageConfigDetails' => [ 'base' => '

The configuration for running a SageMaker image as a KernelGateway app.

', 'refs' => [ 'AppImageConfigList$member' => NULL, ], ], 'AppImageConfigList' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsResponse$AppImageConfigs' => '

A list of AppImageConfigs and their properties.

', ], ], 'AppImageConfigName' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigName' => '

The name of the AppImageConfig. Must be unique to your account.

', 'CreateAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig. Must be unique to your account.

', 'CustomImage$AppImageConfigName' => '

The name of the AppImageConfig.

', 'DeleteAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to delete.

', 'DescribeAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to describe.

', 'DescribeAppImageConfigResponse$AppImageConfigName' => '

The name of the AppImageConfig.

', 'ListAppImageConfigsRequest$NameContains' => '

A filter that returns only AppImageConfigs whose name contains the specified string.

', 'UpdateAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to update.

', ], ], 'AppImageConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'AppInstanceType' => [ 'base' => NULL, 'refs' => [ 'ResourceSpec$InstanceType' => '

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

', ], ], 'AppList' => [ 'base' => NULL, 'refs' => [ 'ListAppsResponse$Apps' => '

The list of apps.

', ], ], 'AppManaged' => [ 'base' => NULL, 'refs' => [ 'ProcessingInput$AppManaged' => '

When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.

', 'ProcessingOutput$AppManaged' => '

When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.

', ], ], 'AppName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$AppName' => '

The name of the app.

', 'CreateAppRequest$AppName' => '

The name of the app.

', 'DeleteAppRequest$AppName' => '

The name of the app.

', 'DescribeAppRequest$AppName' => '

The name of the app.

', 'DescribeAppResponse$AppName' => '

The name of the app.

', ], ], 'AppNetworkAccessType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

', 'DescribeDomainResponse$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

', 'UpdateDomainRequest$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access.

  • VpcOnly - All Studio traffic is through the specified VPC and subnets.

This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

', ], ], 'AppSecurityGroupManagement' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

', 'DescribeDomainResponse$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

', 'UpdateDomainRequest$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

', ], ], 'AppSortKey' => [ 'base' => NULL, 'refs' => [ 'ListAppsRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'AppSpecification' => [ 'base' => '

Configuration to run a processing job in a specified container image.

', 'refs' => [ 'CreateProcessingJobRequest$AppSpecification' => '

Configures the processing job to run a specified Docker container image.

', 'DescribeProcessingJobResponse$AppSpecification' => '

Configures the processing job to run a specified container image.

', 'ProcessingJob$AppSpecification' => NULL, ], ], 'AppStatus' => [ 'base' => NULL, 'refs' => [ 'AppDetails$Status' => '

The status.

', 'DescribeAppResponse$Status' => '

The status.

', ], ], 'AppType' => [ 'base' => NULL, 'refs' => [ 'AppDetails$AppType' => '

The type of app.

', 'CreateAppRequest$AppType' => '

The type of app.

', 'DeleteAppRequest$AppType' => '

The type of app.

', 'DescribeAppRequest$AppType' => '

The type of app.

', 'DescribeAppResponse$AppType' => '

The type of app.

', 'SpaceSettings$AppType' => '

The type of app created within the space.

', 'SpaceSettingsSummary$AppType' => '

The type of app created within the space.

', ], ], 'ApprovalDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeModelPackageOutput$ApprovalDescription' => '

A description provided for the model approval.

', 'ModelPackage$ApprovalDescription' => '

A description provided when the model approval is set.

', 'UpdateModelPackageInput$ApprovalDescription' => '

A description for the approval status of the model.

', ], ], 'ArnOrName' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$AlgorithmName' => '

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can\'t specify a value for TrainingImage, and vice versa.

If you specify values for both parameters, the training job might break; if you don\'t specify any value for both parameters, the training job might raise a null error.

', 'CreateModelPackageInput$ModelPackageGroupName' => '

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

', 'DeleteModelPackageGroupInput$ModelPackageGroupName' => '

The name of the model group to delete.

', 'DescribeAlgorithmInput$AlgorithmName' => '

The name of the algorithm to describe.

', 'DescribeModelPackageGroupInput$ModelPackageGroupName' => '

The name of gthe model group to describe.

', 'HyperParameterAlgorithmSpecification$AlgorithmName' => '

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

', 'ListModelPackagesInput$ModelPackageGroupName' => '

A filter that returns only model versions that belong to the specified model group.

', 'SourceAlgorithm$AlgorithmName' => '

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

', ], ], 'ArtifactArn' => [ 'base' => NULL, 'refs' => [ 'ArtifactSummary$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'CreateArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'DeleteArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to delete.

', 'DeleteArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'DescribeArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to describe.

', 'DescribeArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'UpdateArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to update.

', 'UpdateArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', ], ], 'ArtifactDigest' => [ 'base' => NULL, 'refs' => [ 'ModelDigests$ArtifactDigest' => '

Provides a hash value that uniquely identifies the stored model artifacts.

', ], ], 'ArtifactProperties' => [ 'base' => NULL, 'refs' => [ 'CreateArtifactRequest$Properties' => '

A list of properties to add to the artifact.

', 'UpdateArtifactRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', ], ], 'ArtifactPropertyValue' => [ 'base' => NULL, 'refs' => [ 'ArtifactProperties$value' => NULL, ], ], 'ArtifactSource' => [ 'base' => '

A structure describing the source of an artifact.

', 'refs' => [ 'ArtifactSummary$Source' => '

The source of the artifact.

', 'CreateArtifactRequest$Source' => '

The ID, ID type, and URI of the source.

', 'DeleteArtifactRequest$Source' => '

The URI of the source.

', 'DescribeArtifactResponse$Source' => '

The source of the artifact.

', ], ], 'ArtifactSourceIdType' => [ 'base' => NULL, 'refs' => [ 'ArtifactSourceType$SourceIdType' => '

The type of ID.

', ], ], 'ArtifactSourceType' => [ 'base' => '

The ID and ID type of an artifact source.

', 'refs' => [ 'ArtifactSourceTypes$member' => NULL, ], ], 'ArtifactSourceTypes' => [ 'base' => NULL, 'refs' => [ 'ArtifactSource$SourceTypes' => '

A list of source types.

', ], ], 'ArtifactSummaries' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsResponse$ArtifactSummaries' => '

A list of artifacts and their properties.

', ], ], 'ArtifactSummary' => [ 'base' => '

Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.

', 'refs' => [ 'ArtifactSummaries$member' => NULL, ], ], 'AssemblyType' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$AssembleWith' => '

Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

', ], ], 'AssociateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociationEdgeType' => [ 'base' => NULL, 'refs' => [ 'AddAssociationRequest$AssociationType' => '

The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.

  • ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.

  • AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.

  • DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.

  • Produced - The source generated the destination. For example, a training job produced a model artifact.

', 'AssociationSummary$AssociationType' => '

The type of the association.

', 'Edge$AssociationType' => '

The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.

', 'ListAssociationsRequest$AssociationType' => '

A filter that returns only associations of the specified type.

', ], ], 'AssociationEntityArn' => [ 'base' => NULL, 'refs' => [ 'AddAssociationRequest$SourceArn' => '

The ARN of the source.

', 'AddAssociationRequest$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'AddAssociationResponse$SourceArn' => '

The ARN of the source.

', 'AddAssociationResponse$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'AssociationSummary$SourceArn' => '

The ARN of the source.

', 'AssociationSummary$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'DeleteAssociationRequest$SourceArn' => '

The ARN of the source.

', 'DeleteAssociationRequest$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'DeleteAssociationResponse$SourceArn' => '

The ARN of the source.

', 'DeleteAssociationResponse$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'Edge$SourceArn' => '

The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

', 'Edge$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

', 'ListAssociationsRequest$SourceArn' => '

A filter that returns only associations with the specified source ARN.

', 'ListAssociationsRequest$DestinationArn' => '

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

', 'QueryLineageStartArns$member' => NULL, 'Vertex$Arn' => '

The Amazon Resource Name (ARN) of the lineage entity resource.

', ], ], 'AssociationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAssociationsResponse$AssociationSummaries' => '

A list of associations and their properties.

', ], ], 'AssociationSummary' => [ 'base' => '

Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.

', 'refs' => [ 'AssociationSummaries$member' => NULL, ], ], 'AsyncInferenceClientConfig' => [ 'base' => '

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

', 'refs' => [ 'AsyncInferenceConfig$ClientConfig' => '

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

', ], ], 'AsyncInferenceConfig' => [ 'base' => '

Specifies configuration for how an endpoint performs asynchronous inference.

', 'refs' => [ 'CreateEndpointConfigInput$AsyncInferenceConfig' => '

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

', 'DescribeEndpointConfigOutput$AsyncInferenceConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', 'DescribeEndpointOutput$AsyncInferenceConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', ], ], 'AsyncInferenceNotificationConfig' => [ 'base' => '

Specifies the configuration for notifications of inference results for asynchronous inference.

', 'refs' => [ 'AsyncInferenceOutputConfig$NotificationConfig' => '

Specifies the configuration for notifications of inference results for asynchronous inference.

', ], ], 'AsyncInferenceOutputConfig' => [ 'base' => '

Specifies the configuration for asynchronous inference invocation outputs.

', 'refs' => [ 'AsyncInferenceConfig$OutputConfig' => '

Specifies the configuration for asynchronous inference invocation outputs.

', ], ], 'AsyncNotificationTopicTypeList' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$IncludeInferenceResponseIn' => '

The Amazon SNS topics where you want the inference response to be included.

The inference response is included only if the response size is less than or equal to 128 KB.

', ], ], 'AsyncNotificationTopicTypes' => [ 'base' => NULL, 'refs' => [ 'AsyncNotificationTopicTypeList$member' => NULL, ], ], 'AthenaCatalog' => [ 'base' => '

The name of the data catalog used in Athena query execution.

', 'refs' => [ 'AthenaDatasetDefinition$Catalog' => NULL, ], ], 'AthenaDatabase' => [ 'base' => '

The name of the database used in the Athena query execution.

', 'refs' => [ 'AthenaDatasetDefinition$Database' => NULL, ], ], 'AthenaDatasetDefinition' => [ 'base' => '

Configuration for Athena Dataset Definition input.

', 'refs' => [ 'DatasetDefinition$AthenaDatasetDefinition' => NULL, ], ], 'AthenaQueryString' => [ 'base' => '

The SQL query statements, to be executed.

', 'refs' => [ 'AthenaDatasetDefinition$QueryString' => NULL, ], ], 'AthenaResultCompressionType' => [ 'base' => '

The compression used for Athena query results.

', 'refs' => [ 'AthenaDatasetDefinition$OutputCompression' => NULL, ], ], 'AthenaResultFormat' => [ 'base' => '

The data storage format for Athena query results.

', 'refs' => [ 'AthenaDatasetDefinition$OutputFormat' => NULL, ], ], 'AthenaWorkGroup' => [ 'base' => '

The name of the workgroup in which the Athena query is being started.

', 'refs' => [ 'AthenaDatasetDefinition$WorkGroup' => NULL, ], ], 'AttributeName' => [ 'base' => NULL, 'refs' => [ 'AttributeNames$member' => NULL, ], ], 'AttributeNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$AttributeNames' => '

A list of one or more attribute names to use that are found in a specified augmented manifest file.

', ], ], 'AuthMode' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AuthMode' => '

The mode of authentication that members use to access the domain.

', 'DescribeDomainResponse$AuthMode' => '

The domain\'s authentication mode.

', ], ], 'AutoGenerateEndpointName' => [ 'base' => NULL, 'refs' => [ 'ModelDeployConfig$AutoGenerateEndpointName' => '

Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.

If you set AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a 400 error is thrown.

', ], ], 'AutoMLAlgorithm' => [ 'base' => NULL, 'refs' => [ 'AutoMLAlgorithms$member' => NULL, ], ], 'AutoMLAlgorithmConfig' => [ 'base' => '

The collection of algorithms run on a dataset for training the model candidates of an Autopilot job.

', 'refs' => [ 'AutoMLAlgorithmsConfig$member' => NULL, ], ], 'AutoMLAlgorithms' => [ 'base' => NULL, 'refs' => [ 'AutoMLAlgorithmConfig$AutoMLAlgorithms' => '

The selection of algorithms run on a dataset to train the model candidates of an Autopilot job.

Selected algorithms must belong to the list corresponding to the training mode set in AutoMLJobConfig.Mode (ENSEMBLING or HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.

  • In ENSEMBLING mode:

    • "catboost"

    • "extra-trees"

    • "fastai"

    • "lightgbm"

    • "linear-learner"

    • "nn-torch"

    • "randomforest"

    • "xgboost"

  • In HYPERPARAMETER_TUNING mode:

    • "linear-learner"

    • "mlp"

    • "xgboost"

', ], ], 'AutoMLAlgorithmsConfig' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateGenerationConfig$AlgorithmsConfig' => '

Stores the configuration information for the selection of algorithms used to train the model candidates.

The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .

  • AlgorithmsConfig should not be set in AUTO training mode.

  • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

    If the list of algorithms provided as values for AutoMLAlgorithms is empty, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.

  • When AlgorithmsConfig is not provided, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.

For the list of all algorithms per training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

', 'CandidateGenerationConfig$AlgorithmsConfig' => '

Stores the configuration information for the selection of algorithms used to train model candidates on tabular data.

The list of available algorithms to choose from depends on the training mode set in TabularJobConfig.Mode .

  • AlgorithmsConfig should not be set in AUTO training mode.

  • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

    If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

  • When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

For the list of all algorithms per problem type and training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

', ], ], 'AutoMLCandidate' => [ 'base' => '

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

', 'refs' => [ 'AutoMLCandidates$member' => NULL, 'DescribeAutoMLJobResponse$BestCandidate' => '

The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

', 'DescribeAutoMLJobV2Response$BestCandidate' => '

Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.

', ], ], 'AutoMLCandidateGenerationConfig' => [ 'base' => '

Stores the configuration information for how a candidate is generated (optional).

', 'refs' => [ 'AutoMLJobConfig$CandidateGenerationConfig' => '

The configuration for generating a candidate for an AutoML job (optional).

', ], ], 'AutoMLCandidateStep' => [ 'base' => '

Information about the steps for a candidate and what step it is working on.

', 'refs' => [ 'CandidateSteps$member' => NULL, ], ], 'AutoMLCandidates' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobResponse$Candidates' => '

Summaries about the AutoMLCandidates.

', ], ], 'AutoMLChannel' => [ 'base' => '

A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see Channel.

A validation dataset must contain the same headers as the training dataset.

', 'refs' => [ 'AutoMLInputDataConfig$member' => NULL, ], ], 'AutoMLChannelType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$ChannelType' => '

The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName. For information on specifying training and validation channel types, see How to specify training and validation datasets.

', 'AutoMLJobChannel$ChannelType' => '

The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType

The type of channel defaults to training for the time-series forecasting problem type.

', ], ], 'AutoMLContainerDefinition' => [ 'base' => '

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.

', 'refs' => [ 'AutoMLContainerDefinitions$member' => NULL, ], ], 'AutoMLContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$InferenceContainers' => '

Information about the recommended inference container definitions.

', 'AutoMLInferenceContainerDefinitions$value' => '

Information about the recommended inference container definitions.

', ], ], 'AutoMLDataSource' => [ 'base' => '

The data source for the Autopilot job.

', 'refs' => [ 'AutoMLChannel$DataSource' => '

The data source for an AutoML channel.

', 'AutoMLJobChannel$DataSource' => '

The data source for an AutoML channel (Required).

', ], ], 'AutoMLDataSplitConfig' => [ 'base' => '

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

', 'refs' => [ 'AutoMLJobConfig$DataSplitConfig' => '

The configuration for splitting the input training dataset.

Type: AutoMLDataSplitConfig

', 'CreateAutoMLJobV2Request$DataSplitConfig' => '

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

This attribute must not be set for the time-series forecasting problem type, as Autopilot automatically splits the input dataset into training and validation sets.

', 'DescribeAutoMLJobV2Response$DataSplitConfig' => '

Returns the configuration settings of how the data are split into train and validation datasets.

', ], ], 'AutoMLFailureReason' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$FailureReason' => '

The failure reason.

', 'AutoMLJobSummary$FailureReason' => '

The failure reason of an AutoML job.

', 'AutoMLPartialFailureReason$PartialFailureMessage' => '

The message containing the reason for a partial failure of an AutoML job.

', 'DescribeAutoMLJobResponse$FailureReason' => '

Returns the failure reason for an AutoML job, when applicable.

', 'DescribeAutoMLJobV2Response$FailureReason' => '

Returns the reason for the failure of the AutoML job V2, when applicable.

', ], ], 'AutoMLInferenceContainerDefinitions' => [ 'base' => '

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the V2 API only (for example, for jobs created by calling CreateAutoMLJobV2).

', 'refs' => [ 'AutoMLCandidate$InferenceContainerDefinitions' => '

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling CreateAutoMLJobV2) related to image or text classification problem types only.

', ], ], 'AutoMLInputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$InputDataConfig' => '

An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

', 'DescribeAutoMLJobResponse$InputDataConfig' => '

Returns the input data configuration for the AutoML job.

', ], ], 'AutoMLJobArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the AutoML job.

', 'AutoMLJobSummary$AutoMLJobArn' => '

The ARN of the AutoML job.

', 'CreateAutoMLJobResponse$AutoMLJobArn' => '

The unique ARN assigned to the AutoML job when it is created.

', 'CreateAutoMLJobV2Response$AutoMLJobArn' => '

The unique ARN assigned to the AutoMLJob when it is created.

', 'DescribeAutoMLJobResponse$AutoMLJobArn' => '

Returns the ARN of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobArn' => '

Returns the Amazon Resource Name (ARN) of the AutoML job V2.

', 'DescribeProcessingJobResponse$AutoMLJobArn' => '

The ARN of an AutoML job associated with this processing job.

', 'DescribeTrainingJobResponse$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of an AutoML job.

', 'DescribeTransformJobResponse$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML transform job.

', 'ProcessingJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

', 'TrainingJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'TransformJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML job that created the transform job.

', ], ], 'AutoMLJobArtifacts' => [ 'base' => '

The artifacts that are generated during an AutoML job.

', 'refs' => [ 'DescribeAutoMLJobResponse$AutoMLJobArtifacts' => '

Returns information on the job\'s artifacts found in AutoMLJobArtifacts.

', 'DescribeAutoMLJobV2Response$AutoMLJobArtifacts' => NULL, ], ], 'AutoMLJobChannel' => [ 'base' => '

A channel is a named input source that training algorithms can consume. This channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).

', 'refs' => [ 'AutoMLJobInputDataConfig$member' => NULL, ], ], 'AutoMLJobCompletionCriteria' => [ 'base' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'refs' => [ 'AutoMLJobConfig$CompletionCriteria' => '

How long an AutoML job is allowed to run, or how many candidates a job is allowed to generate.

', 'AutoMLResolvedAttributes$CompletionCriteria' => NULL, 'ImageClassificationJobConfig$CompletionCriteria' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'ResolvedAttributes$CompletionCriteria' => NULL, 'TabularJobConfig$CompletionCriteria' => NULL, 'TextClassificationJobConfig$CompletionCriteria' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'TextGenerationJobConfig$CompletionCriteria' => '

How long a fine-tuning job is allowed to run. For TextGenerationJobConfig problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h (259200s).

', 'TimeSeriesForecastingJobConfig$CompletionCriteria' => NULL, ], ], 'AutoMLJobConfig' => [ 'base' => '

A collection of settings used for an AutoML job.

', 'refs' => [ 'CreateAutoMLJobRequest$AutoMLJobConfig' => '

A collection of settings used to configure an AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobConfig' => '

Returns the configuration for the AutoML job.

', ], ], 'AutoMLJobInputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLJobInputDataConfig' => '

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters. The supported formats depend on the problem type:

  • For tabular problem types: S3Prefix, ManifestFile.

  • For image classification: S3Prefix, ManifestFile, AugmentedManifestFile.

  • For text classification: S3Prefix.

  • For time-series forecasting: S3Prefix.

  • For text generation (LLMs fine-tuning): S3Prefix.

', 'DescribeAutoMLJobV2Response$AutoMLJobInputDataConfig' => '

Returns an array of channel objects describing the input data and their location.

', ], ], 'AutoMLJobName' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobName' => '

The name of the AutoML job you are requesting.

', 'CreateAutoMLJobRequest$AutoMLJobName' => '

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

', 'CreateAutoMLJobV2Request$AutoMLJobName' => '

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

', 'DescribeAutoMLJobRequest$AutoMLJobName' => '

Requests information about an AutoML job using its unique name.

', 'DescribeAutoMLJobResponse$AutoMLJobName' => '

Returns the name of the AutoML job.

', 'DescribeAutoMLJobV2Request$AutoMLJobName' => '

Requests information about an AutoML job V2 using its unique name.

', 'DescribeAutoMLJobV2Response$AutoMLJobName' => '

Returns the name of the AutoML job V2.

', 'ListCandidatesForAutoMLJobRequest$AutoMLJobName' => '

List the candidates created for the job by providing the job\'s name.

', 'StopAutoMLJobRequest$AutoMLJobName' => '

The name of the object you are requesting.

', ], ], 'AutoMLJobObjective' => [ 'base' => '

Specifies a metric to minimize or maximize as the objective of an AutoML job.

', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLJobObjective' => NULL, 'CreateAutoMLJobRequest$AutoMLJobObjective' => '

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.

', 'CreateAutoMLJobV2Request$AutoMLJobObjective' => '

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. For the list of default values per problem type, see AutoMLJobObjective.

  • For tabular problem types: You must either provide both the AutoMLJobObjective and indicate the type of supervised learning problem in AutoMLProblemTypeConfig (TabularJobConfig.ProblemType), or none at all.

  • For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.

', 'DescribeAutoMLJobResponse$AutoMLJobObjective' => '

Returns the job\'s objective.

', 'DescribeAutoMLJobV2Response$AutoMLJobObjective' => '

Returns the job\'s objective.

', 'ResolvedAttributes$AutoMLJobObjective' => NULL, ], ], 'AutoMLJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Type' => '

The type of metric with the best result.

', ], ], 'AutoMLJobSecondaryStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobSecondaryStatus' => '

The secondary status of the AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobSecondaryStatus' => '

Returns the secondary status of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobSecondaryStatus' => '

Returns the secondary status of the AutoML job V2.

', ], ], 'AutoMLJobStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobStatus' => '

The status of the AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobStatus' => '

Returns the status of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobStatus' => '

Returns the status of the AutoML job V2.

', 'ListAutoMLJobsRequest$StatusEquals' => '

Request a list of jobs, using a filter for status.

', ], ], 'AutoMLJobStepMetadata' => [ 'base' => '

Metadata for an AutoML job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$AutoMLJob' => '

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

', ], ], 'AutoMLJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsResponse$AutoMLJobSummaries' => '

Returns a summary list of jobs.

', ], ], 'AutoMLJobSummary' => [ 'base' => '

Provides a summary about an AutoML job.

', 'refs' => [ 'AutoMLJobSummaries$member' => NULL, ], ], 'AutoMLMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$MaxResults' => '

Request a list of jobs up to a specified limit.

', ], ], 'AutoMLMaxResultsForTrials' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobRequest$MaxResults' => '

List the job\'s candidates up to a specified limit.

', ], ], 'AutoMLMetricEnum' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobObjective$MetricName' => '

The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model\'s parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.

The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.

  • For tabular problem types:

    • List of available metrics:

      • Regression: InferenceLatency, MAE, MSE, R2, RMSE

      • Binary classification: Accuracy, AUC, BalancedAccuracy, F1, InferenceLatency, LogLoss, Precision, Recall

      • Multiclass classification: Accuracy, BalancedAccuracy, F1macro, InferenceLatency, LogLoss, PrecisionMacro, RecallMacro

      For a description of each metric, see Autopilot metrics for classification and regression.

    • Default objective metrics:

      • Regression: MSE.

      • Binary classification: F1.

      • Multiclass classification: Accuracy.

  • For image or text classification problem types:

  • For time-series forecasting problem types:

  • For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.

', 'FinalAutoMLJobObjectiveMetric$MetricName' => '

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.

', 'FinalAutoMLJobObjectiveMetric$StandardMetricName' => '

The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.

', 'MetricDatum$MetricName' => '

The name of the metric.

', ], ], 'AutoMLMetricExtendedEnum' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$StandardMetricName' => '

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

', ], ], 'AutoMLMode' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobConfig$Mode' => '

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

', 'TabularJobConfig$Mode' => '

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

', ], ], 'AutoMLNameContains' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$NameContains' => '

Request a list of jobs, using a search filter for name.

', ], ], 'AutoMLOutputDataConfig' => [ 'base' => '

The output data configuration.

', 'refs' => [ 'CreateAutoMLJobRequest$OutputDataConfig' => '

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.

', 'CreateAutoMLJobV2Request$OutputDataConfig' => '

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.

', 'DescribeAutoMLJobResponse$OutputDataConfig' => '

Returns the job\'s output data config.

', 'DescribeAutoMLJobV2Response$OutputDataConfig' => '

Returns the job\'s output data config.

', ], ], 'AutoMLPartialFailureReason' => [ 'base' => '

The reason for a partial failure of an AutoML job.

', 'refs' => [ 'AutoMLPartialFailureReasons$member' => NULL, ], ], 'AutoMLPartialFailureReasons' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$PartialFailureReasons' => '

The list of reasons for partial failures within an AutoML job.

', 'DescribeAutoMLJobResponse$PartialFailureReasons' => '

Returns a list of reasons for partial failures within an AutoML job.

', 'DescribeAutoMLJobV2Response$PartialFailureReasons' => '

Returns a list of reasons for partial failures within an AutoML job V2.

', ], ], 'AutoMLProblemTypeConfig' => [ 'base' => '

A collection of settings specific to the problem type used to configure an AutoML job V2. There must be one and only one config of the following type.

', 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLProblemTypeConfig' => '

Defines the configuration settings of one of the supported problem types.

', 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfig' => '

Returns the configuration settings of the problem type set for the AutoML job V2.

', ], ], 'AutoMLProblemTypeConfigName' => [ 'base' => NULL, 'refs' => [ 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfigName' => '

Returns the name of the problem type configuration set for the AutoML job V2.

', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'base' => '

Stores resolved attributes specific to the problem type of an AutoML job V2.

', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLProblemTypeResolvedAttributes' => '

Defines the resolved attributes specific to a problem type.

', ], ], 'AutoMLProcessingUnit' => [ 'base' => NULL, 'refs' => [ 'AutoMLInferenceContainerDefinitions$key' => '

Processing unit for an inference container. Currently Autopilot only supports CPU or GPU.

', ], ], 'AutoMLResolvedAttributes' => [ 'base' => '

The resolved attributes used to configure an AutoML job V2.

', 'refs' => [ 'DescribeAutoMLJobV2Response$ResolvedAttributes' => '

Returns the resolved attributes used by the AutoML job V2.

', ], ], 'AutoMLS3DataSource' => [ 'base' => '

Describes the Amazon S3 data source.

', 'refs' => [ 'AutoMLDataSource$S3DataSource' => '

The Amazon S3 location of the input data.

', ], ], 'AutoMLS3DataType' => [ 'base' => NULL, 'refs' => [ 'AutoMLS3DataSource$S3DataType' => '

The data type.

  • If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

    The S3Prefix should have the following format:

    s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE

  • If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

    A ManifestFile should have the format shown below:

    [ {"prefix": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/"},

    "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1",

    "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2",

    ... "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N" ]

  • If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile is available for V2 API jobs only (for example, for jobs created by calling CreateAutoMLJobV2).

    Here is a minimal, single-record example of an AugmentedManifestFile:

    {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",

    "label-metadata": {"class-name": "cat" }

    For more information on AugmentedManifestFile, see Provide Dataset Metadata to Training Jobs with an Augmented Manifest File.

', ], ], 'AutoMLSecurityConfig' => [ 'base' => '

Security options.

', 'refs' => [ 'AutoMLJobConfig$SecurityConfig' => '

The security configuration for traffic encryption or Amazon VPC settings.

', 'CreateAutoMLJobV2Request$SecurityConfig' => '

The security configuration for traffic encryption or Amazon VPC settings.

', 'DescribeAutoMLJobV2Response$SecurityConfig' => '

Returns the security configuration for traffic encryption or Amazon VPC settings.

', ], ], 'AutoMLSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$SortBy' => '

The parameter by which to sort the results. The default is Name.

', ], ], 'AutoMLSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$SortOrder' => '

The sort order for the results. The default is Descending.

', 'ListCandidatesForAutoMLJobRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', ], ], 'AutoParameter' => [ 'base' => '

The name and an example value of the hyperparameter that you want to use in Autotune. If Automatic model tuning (AMT) determines that your hyperparameter is eligible for Autotune, an optimal hyperparameter range is selected for you.

', 'refs' => [ 'AutoParameters$member' => NULL, ], ], 'AutoParameters' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$AutoParameters' => '

A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.

', ], ], 'AutoRollbackConfig' => [ 'base' => '

Automatic rollback configuration for handling endpoint deployment failures and recovery.

', 'refs' => [ 'DeploymentConfig$AutoRollbackConfiguration' => '

Automatic rollback configuration for handling endpoint deployment failures and recovery.

', ], ], 'Autotune' => [ 'base' => '

A flag to indicate if you want to use Autotune to automatically find optimal values for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$Autotune' => '

Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

', 'DescribeHyperParameterTuningJobResponse$Autotune' => '

A flag to indicate if autotune is enabled for the hyperparameter tuning job.

', ], ], 'AutotuneMode' => [ 'base' => NULL, 'refs' => [ 'Autotune$Mode' => '

Set Mode to Enabled if you want to use Autotune.

', ], ], 'AwsManagedHumanLoopRequestSource' => [ 'base' => NULL, 'refs' => [ 'HumanLoopRequestSource$AwsManagedHumanLoopRequestSource' => '

Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:

', ], ], 'BacktestResultsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$BacktestResults' => '

The Amazon S3 prefix to the accuracy metrics and the inference results observed over the testing window. Available only for the time-series forecasting problem type.

', ], ], 'BaseModelName' => [ 'base' => NULL, 'refs' => [ 'TextGenerationJobConfig$BaseModelName' => '

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no BaseModelName is provided, the default model used is Falcon7BInstruct.

', 'TextGenerationResolvedAttributes$BaseModelName' => '

The name of the base model to fine-tune.

', ], ], 'BatchDataCaptureConfig' => [ 'base' => '

Configuration to control how SageMaker captures inference data for batch transform jobs.

', 'refs' => [ 'CreateTransformJobRequest$DataCaptureConfig' => '

Configuration to control how SageMaker captures inference data.

', 'DescribeTransformJobResponse$DataCaptureConfig' => '

Configuration to control how SageMaker captures inference data.

', 'TransformJob$DataCaptureConfig' => NULL, ], ], 'BatchDescribeModelPackageError' => [ 'base' => '

The error code and error description associated with the resource.

', 'refs' => [ 'BatchDescribeModelPackageErrorMap$value' => NULL, ], ], 'BatchDescribeModelPackageErrorMap' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$BatchDescribeModelPackageErrorMap' => '

A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.

', ], ], 'BatchDescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageSummary' => [ 'base' => '

Provides summary information about the model package.

', 'refs' => [ 'ModelPackageSummaries$value' => NULL, ], ], 'BatchStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

', 'DescribeTransformJobResponse$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

', 'TransformJob$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

', 'TransformJobDefinition$BatchStrategy' => '

A string that determines the number of records included in a single mini-batch.

SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

', ], ], 'BatchTransformInput' => [ 'base' => '

Input object for the batch transform job.

', 'refs' => [ 'DataQualityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelBiasJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelDashboardMonitoringSchedule$BatchTransformInput' => NULL, 'ModelExplainabilityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelQualityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'MonitoringInput$BatchTransformInput' => '

Input object for the batch transform job.

', ], ], 'BestObjectiveNotImproving' => [ 'base' => '

A structure that keeps track of which training jobs launched by your hyperparameter tuning job are not improving model performance as evaluated against an objective function.

', 'refs' => [ 'TuningJobCompletionCriteria$BestObjectiveNotImproving' => '

A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.

', ], ], 'Bias' => [ 'base' => '

Contains bias metrics for a model.

', 'refs' => [ 'ModelMetrics$Bias' => '

Metrics that measure bais in a model.

', ], ], 'BillableTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$BillableTimeInSeconds' => '

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

', 'TrainingJob$BillableTimeInSeconds' => '

The billable time in seconds.

', ], ], 'BlockedReason' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreStatus$BlockedReason' => '

The justification for why the OfflineStoreStatus is Blocked (if applicable).

', ], ], 'BlueGreenUpdatePolicy' => [ 'base' => '

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

', 'refs' => [ 'DeploymentConfig$BlueGreenUpdatePolicy' => '

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$EnableSageMakerMetricsTimeSeries' => '

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren\'t generated except in the following cases:

', 'AutoMLSecurityConfig$EnableInterContainerTrafficEncryption' => '

Whether to use traffic encryption between the container layers.

', 'BatchDataCaptureConfig$GenerateInferenceId' => '

Flag that indicates whether to append inference id to the output.

', 'ChannelSpecification$IsRequired' => '

Indicates whether the channel is required by the algorithm.

', 'ClarifyCheckStepMetadata$SkipCheck' => '

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

', 'ClarifyCheckStepMetadata$RegisterNewBaseline' => '

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

', 'CreateEndpointConfigInput$EnableNetworkIsolation' => '

Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

', 'CreateModelInput$EnableNetworkIsolation' => '

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

', 'CreateTrainingJobRequest$EnableNetworkIsolation' => '

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'CreateTrainingJobRequest$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

', 'CreateTrainingJobRequest$EnableManagedSpotTraining' => '

To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

', 'DescribeEndpointConfigOutput$EnableNetworkIsolation' => '

Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

', 'DescribeModelOutput$EnableNetworkIsolation' => '

If True, no inbound or outbound network calls can be made to or from the model container.

', 'DescribeTrainingJobResponse$EnableNetworkIsolation' => '

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'DescribeTrainingJobResponse$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

', 'DescribeTrainingJobResponse$EnableManagedSpotTraining' => '

A Boolean indicating whether managed spot training is enabled (True) or not (False).

', 'HyperParameterSpecification$IsTunable' => '

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

', 'HyperParameterSpecification$IsRequired' => '

Indicates whether this hyperparameter is required.

', 'HyperParameterTrainingJobDefinition$EnableNetworkIsolation' => '

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'HyperParameterTrainingJobDefinition$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

', 'HyperParameterTrainingJobDefinition$EnableManagedSpotTraining' => '

A Boolean indicating whether managed spot training is enabled (True) or not (False).

', 'ListStageDevicesRequest$ExcludeDevicesDeployedInOtherStage' => '

Toggle for excluding devices deployed in other stages.

', 'Model$EnableNetworkIsolation' => '

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

', 'ModelDashboardIndicatorAction$Enabled' => '

Indicates whether the alert action is turned on.

', 'MonitoringCsvDatasetFormat$Header' => '

Indicates if the CSV data has a header.

', 'MonitoringJsonDatasetFormat$Line' => '

Indicates if the file should be read as a JSON object per line.

', 'MonitoringNetworkConfig$EnableInterContainerTrafficEncryption' => '

Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.

', 'MonitoringNetworkConfig$EnableNetworkIsolation' => '

Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.

', 'NetworkConfig$EnableInterContainerTrafficEncryption' => '

Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

', 'NetworkConfig$EnableNetworkIsolation' => '

Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

', 'OfflineStoreConfig$DisableGlueTableCreation' => '

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena\'s naming recommendations.

The default value is False.

', 'OnlineStoreConfig$EnableOnlineStore' => '

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False.

', 'QualityCheckStepMetadata$SkipCheck' => '

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

', 'QualityCheckStepMetadata$RegisterNewBaseline' => '

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.

', 'QueryLineageRequest$IncludeEdges' => '

Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

', 'TrainingJob$EnableNetworkIsolation' => '

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can\'t communicate beyond the VPC they run in.

', 'TrainingJob$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

', 'TrainingJob$EnableManagedSpotTraining' => '

When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

', 'TrainingSpecification$SupportsDistributedTraining' => '

Indicates whether the algorithm supports distributed training. If set to false, buyers can\'t request more than one instance during training.

', 'UpdateEndpointInput$RetainAllVariantProperties' => '

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.

', 'UpdateEndpointInput$RetainDeploymentConfig' => '

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

', ], ], 'BooleanOperator' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$Operator' => '

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

', ], ], 'Branch' => [ 'base' => NULL, 'refs' => [ 'GitConfig$Branch' => '

The default branch for the Git repository.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$Bucket' => '

Name of the S3 bucket.

', ], ], 'CacheHitResult' => [ 'base' => '

Details on the cache hit of a pipeline execution step.

', 'refs' => [ 'PipelineExecutionStep$CacheHitResult' => '

If this pipeline execution step was cached, details on the cache hit.

', ], ], 'CallbackStepMetadata' => [ 'base' => '

Metadata about a callback step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Callback' => '

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

', ], ], 'CallbackToken' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', 'SendPipelineExecutionStepFailureRequest$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', 'SendPipelineExecutionStepSuccessRequest$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', ], ], 'CandidateArtifactLocations' => [ 'base' => '

The location of artifacts for an AutoML candidate job.

', 'refs' => [ 'CandidateProperties$CandidateArtifactLocations' => '

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

', ], ], 'CandidateDefinitionNotebookLocation' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobArtifacts$CandidateDefinitionNotebookLocation' => '

The URL of the notebook location.

', ], ], 'CandidateGenerationConfig' => [ 'base' => '

Stores the configuration information for how model candidates are generated using an AutoML job V2.

', 'refs' => [ 'TabularJobConfig$CandidateGenerationConfig' => '

The configuration information of how model candidates are generated.

', ], ], 'CandidateName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateName' => '

The name of the candidate.

', 'ListCandidatesForAutoMLJobRequest$CandidateNameEquals' => '

List the candidates for the job and filter by candidate name.

', ], ], 'CandidateProperties' => [ 'base' => '

The properties of an AutoML candidate job.

', 'refs' => [ 'AutoMLCandidate$CandidateProperties' => '

The properties of an AutoML candidate job.

', ], ], 'CandidateSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobRequest$SortBy' => '

The parameter by which to sort the results. The default is Descending.

', ], ], 'CandidateStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateStatus' => '

The candidate\'s status.

', 'ListCandidatesForAutoMLJobRequest$StatusEquals' => '

List the candidates for the job and filter by status.

', ], ], 'CandidateStepArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepArn' => '

The ARN for the candidate\'s step.

', ], ], 'CandidateStepName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepName' => '

The name for the candidate\'s step.

', ], ], 'CandidateStepType' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepType' => '

Whether the candidate is at the transform, training, or processing step.

', ], ], 'CandidateSteps' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateSteps' => '

Information about the candidate\'s steps.

', ], ], 'CanvasAppSettings' => [ 'base' => '

The SageMaker Canvas application settings.

', 'refs' => [ 'UserSettings$CanvasAppSettings' => '

The Canvas app settings.

', ], ], 'CapacitySize' => [ 'base' => '

Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your fleet.

For a rollback strategy, if you don\'t specify the fields in this object, or if you set the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

', 'refs' => [ 'RollingUpdatePolicy$MaximumBatchSize' => '

Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between 5% to 50% of the variant\'s total instance count.

', 'RollingUpdatePolicy$RollbackMaximumBatchSize' => '

Batch size for rollback to the old endpoint fleet. Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.

', 'TrafficRoutingConfig$CanarySize' => '

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant\'s total instance count.

', 'TrafficRoutingConfig$LinearStepSize' => '

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant\'s total instance count.

', ], ], 'CapacitySizeType' => [ 'base' => NULL, 'refs' => [ 'CapacitySize$Type' => '

Specifies the endpoint capacity type.

  • INSTANCE_COUNT: The endpoint activates based on the number of instances.

  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.

', ], ], 'CapacitySizeValue' => [ 'base' => NULL, 'refs' => [ 'CapacitySize$Value' => '

Defines the capacity size, either as a number of instances or a capacity percentage.

', ], ], 'CaptureContentTypeHeader' => [ 'base' => '

Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker will by default base64 encode when capturing the data.

', 'refs' => [ 'DataCaptureConfig$CaptureContentTypeHeader' => '

Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

', 'InferenceExperimentDataStorageConfig$ContentType' => NULL, ], ], 'CaptureMode' => [ 'base' => NULL, 'refs' => [ 'CaptureOption$CaptureMode' => '

Specify the boundary of data to capture.

', ], ], 'CaptureOption' => [ 'base' => '

Specifies data Model Monitor will capture.

', 'refs' => [ 'CaptureOptionList$member' => NULL, ], ], 'CaptureOptionList' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$CaptureOptions' => '

Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

', ], ], 'CaptureStatus' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfigSummary$CaptureStatus' => '

Whether data capture is currently functional.

', ], ], 'Catalog' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Catalog' => '

The name of the Glue table catalog.

', ], ], 'CategoricalParameter' => [ 'base' => '

Environment parameters you want to benchmark your load test against.

', 'refs' => [ 'CategoricalParameters$member' => NULL, ], ], 'CategoricalParameterRange' => [ 'base' => '

A list of categorical hyperparameters to tune.

', 'refs' => [ 'CategoricalParameterRanges$member' => NULL, ], ], 'CategoricalParameterRangeSpecification' => [ 'base' => '

Defines the possible values for a categorical hyperparameter.

', 'refs' => [ 'ParameterRange$CategoricalParameterRangeSpecification' => '

A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

', ], ], 'CategoricalParameterRangeValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameter$Value' => '

The list of values you can pass.

', ], ], 'CategoricalParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$CategoricalParameterRanges' => '

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

', ], ], 'CategoricalParameters' => [ 'base' => NULL, 'refs' => [ 'EnvironmentParameterRanges$CategoricalParameterRanges' => '

Specified a list of parameters for each category.

', ], ], 'Cents' => [ 'base' => NULL, 'refs' => [ 'USD$Cents' => '

The fractional portion, in cents, of the amount.

', ], ], 'CertifyForMarketplace' => [ 'base' => NULL, 'refs' => [ 'CreateAlgorithmInput$CertifyForMarketplace' => '

Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

', 'CreateModelPackageInput$CertifyForMarketplace' => '

Whether to certify the model package for listing on Amazon Web Services Marketplace.

This parameter is optional for unversioned models, and does not apply to versioned models.

', 'DescribeAlgorithmOutput$CertifyForMarketplace' => '

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

', 'DescribeModelPackageOutput$CertifyForMarketplace' => '

Whether the model package is certified for listing on Amazon Web Services Marketplace.

', 'ModelPackage$CertifyForMarketplace' => '

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

', ], ], 'Channel' => [ 'base' => '

A channel is a named input source that training algorithms can consume.

', 'refs' => [ 'InputDataConfig$member' => NULL, ], ], 'ChannelName' => [ 'base' => NULL, 'refs' => [ 'Channel$ChannelName' => '

The name of the channel.

', 'ChannelSpecification$Name' => '

The name of the channel.

', ], ], 'ChannelSpecification' => [ 'base' => '

Defines a named input source, called a channel, to be used by an algorithm.

', 'refs' => [ 'ChannelSpecifications$member' => NULL, ], ], 'ChannelSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$TrainingChannels' => '

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

', ], ], 'CheckpointConfig' => [ 'base' => '

Contains information about the output location for managed spot training checkpoint data.

', 'refs' => [ 'CreateTrainingJobRequest$CheckpointConfig' => '

Contains information about the output location for managed spot training checkpoint data.

', 'DescribeTrainingJobResponse$CheckpointConfig' => NULL, 'HyperParameterTrainingJobDefinition$CheckpointConfig' => NULL, 'TrainingJob$CheckpointConfig' => NULL, ], ], 'Cidr' => [ 'base' => NULL, 'refs' => [ 'Cidrs$member' => NULL, ], ], 'Cidrs' => [ 'base' => NULL, 'refs' => [ 'SourceIpConfig$Cidrs' => '

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

Maximum: Ten CIDR values

The following Length Constraints apply to individual CIDR values in the CIDR value list.

', ], ], 'ClarifyCheckStepMetadata' => [ 'base' => '

The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'PipelineExecutionStepMetadata$ClarifyCheck' => '

Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted,

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

', ], ], 'ClarifyContentTemplate' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ContentTemplate' => '

A template string used to format a JSON record into an acceptable model container input. For example, a ContentTemplate string \'{"myfeatures":$features}\' will format a list of features [1,2,3] into the record string \'{"myfeatures":[1,2,3]}\'. Required only when the model container input is in JSON Lines format.

', ], ], 'ClarifyEnableExplanations' => [ 'base' => NULL, 'refs' => [ 'ClarifyExplainerConfig$EnableExplanations' => '

A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.

', ], ], 'ClarifyExplainerConfig' => [ 'base' => '

The configuration parameters for the SageMaker Clarify explainer.

', 'refs' => [ 'ExplainerConfig$ClarifyExplainerConfig' => '

A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.

', ], ], 'ClarifyFeatureHeaders' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeatureHeaders' => '

The names of the features. If provided, these are included in the endpoint response payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint in the Developer Guide for more information.

', ], ], 'ClarifyFeatureType' => [ 'base' => NULL, 'refs' => [ 'ClarifyFeatureTypes$member' => NULL, ], ], 'ClarifyFeatureTypes' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeatureTypes' => '

A list of data types of the features (optional). Applicable only to NLP explainability. If provided, FeatureTypes must have at least one \'text\' string (for example, [\'text\']). If FeatureTypes is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the response section under Invoke the endpoint in the Developer Guide for more information.

', ], ], 'ClarifyFeaturesAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeaturesAttribute' => '

Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if FeaturesAttribute is the JMESPath expression \'myfeatures\', it extracts a list of features [1,2,3] from request data \'{"myfeatures":[1,2,3]}\'.

', ], ], 'ClarifyHeader' => [ 'base' => NULL, 'refs' => [ 'ClarifyFeatureHeaders$member' => NULL, 'ClarifyLabelHeaders$member' => NULL, ], ], 'ClarifyInferenceConfig' => [ 'base' => '

The inference configuration parameter for the model container.

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

The inference configuration parameter for the model container.

', ], ], 'ClarifyLabelAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelAttribute' => '

A JMESPath expression used to locate the list of label headers in the model container output.

Example: If the model container output of a batch request is \'{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}\', then set LabelAttribute to \'labels\' to extract the list of label headers ["cat","dog","fish"]

', ], ], 'ClarifyLabelHeaders' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelHeaders' => '

For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the InvokeEndpoint API. See the response section under Invoke the endpoint in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.

', ], ], 'ClarifyLabelIndex' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelIndex' => '

A zero-based index used to extract a label header or list of label headers from model container output in CSV format.

Example for a multiclass model: If the model container output consists of label headers followed by probabilities: \'"[\\\'cat\\\',\\\'dog\\\',\\\'fish\\\']","[0.1,0.6,0.3]"\', set LabelIndex to 0 to select the label headers [\'cat\',\'dog\',\'fish\'].

', ], ], 'ClarifyMaxPayloadInMB' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$MaxPayloadInMB' => '

The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.

', ], ], 'ClarifyMaxRecordCount' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$MaxRecordCount' => '

The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If MaxRecordCount is 1, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container\'s capacity at runtime.

', ], ], 'ClarifyMimeType' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapBaselineConfig$MimeType' => '

The MIME type of the baseline data. Choose from \'text/csv\' or \'application/jsonlines\'. Defaults to \'text/csv\'.

', ], ], 'ClarifyProbabilityAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ProbabilityAttribute' => '

A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.

Example: If the model container output of a single request is \'{"predicted_label":1,"probability":0.6}\', then set ProbabilityAttribute to \'probability\'.

', ], ], 'ClarifyProbabilityIndex' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ProbabilityIndex' => '

A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.

Example for a single class model: If the model container output consists of a string-formatted prediction label followed by its probability: \'1,0.6\', set ProbabilityIndex to 1 to select the probability value 0.6.

Example for a multiclass model: If the model container output consists of a string-formatted prediction label followed by its probability: \'"[\\\'cat\\\',\\\'dog\\\',\\\'fish\\\']","[0.1,0.6,0.3]"\', set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3].

', ], ], 'ClarifyShapBaseline' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapBaselineConfig$ShapBaseline' => '

The inline SHAP baseline data in string format. ShapBaseline can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the Granularity of the TextConfig parameter. The size limit for ShapBasline is 4 KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB of baseline data.

', ], ], 'ClarifyShapBaselineConfig' => [ 'base' => '

The configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.

  • The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

  • ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.

', 'refs' => [ 'ClarifyShapConfig$ShapBaselineConfig' => '

The configuration for the SHAP baseline of the Kernal SHAP algorithm.

', ], ], 'ClarifyShapConfig' => [ 'base' => '

The configuration for SHAP analysis using SageMaker Clarify Explainer.

', 'refs' => [ 'ClarifyExplainerConfig$ShapConfig' => '

The configuration for SHAP analysis.

', ], ], 'ClarifyShapNumberOfSamples' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$NumberOfSamples' => '

The number of samples to be used for analysis by the Kernal SHAP algorithm.

The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

', ], ], 'ClarifyShapSeed' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$Seed' => '

The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.

', ], ], 'ClarifyShapUseLogit' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$UseLogit' => '

A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.

', ], ], 'ClarifyTextConfig' => [ 'base' => '

A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text. Required only for natural language processing (NLP) explainability.

', 'refs' => [ 'ClarifyShapConfig$TextConfig' => '

A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. Required for natural language processing (NLP) explainability only.

', ], ], 'ClarifyTextGranularity' => [ 'base' => NULL, 'refs' => [ 'ClarifyTextConfig$Granularity' => '

The unit of granularity for the analysis of text features. For example, if the unit is \'token\', then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.

', ], ], 'ClarifyTextLanguage' => [ 'base' => NULL, 'refs' => [ 'ClarifyTextConfig$Language' => '

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

For a mix of multiple languages, use code \'xx\'.

', ], ], 'ClientId' => [ 'base' => NULL, 'refs' => [ 'CognitoConfig$ClientId' => '

The client ID for your Amazon Cognito user pool.

', 'CognitoMemberDefinition$ClientId' => '

An identifier for an application client. You must create the app client ID using Amazon Cognito.

', 'OidcConfig$ClientId' => '

The OIDC IdP client ID used to configure your private workforce.

', 'OidcConfigForResponse$ClientId' => '

The OIDC IdP client ID used to configure your private workforce.

', ], ], 'ClientSecret' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$ClientSecret' => '

The OIDC IdP client secret used to configure your private workforce.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ClientToken' => '

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

', 'CreateModelPackageInput$ClientToken' => '

A unique token that guarantees that the call to this API is idempotent.

', ], ], 'ClusterArn' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'CreateClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the cluster.

', 'DeleteClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

', 'DescribeClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'UpdateClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$TargetCount' => '

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceCount' => '

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceGroupDetails' => [ 'base' => '

Details of an instance group in a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterInstanceGroupDetailsList$member' => NULL, ], ], 'ClusterInstanceGroupDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribeClusterResponse$InstanceGroups' => '

The instance groups of the SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceGroupName' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$InstanceGroupName' => '

The name of the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceGroupName' => '

Specifies the name of the instance group.

', 'ClusterNodeDetails$InstanceGroupName' => '

The instance group name in which the instance is.

', 'ClusterNodeSummary$InstanceGroupName' => '

The name of the instance group in which the instance is.

', 'ListClusterNodesRequest$InstanceGroupNameContains' => '

A filter that returns the instance groups whose name contain a specified string.

', ], ], 'ClusterInstanceGroupSpecification' => [ 'base' => '

The specifications of an instance group that you need to define.

', 'refs' => [ 'ClusterInstanceGroupSpecifications$member' => NULL, ], ], 'ClusterInstanceGroupSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateClusterRequest$InstanceGroups' => '

The instance groups to be created in the SageMaker HyperPod cluster.

', 'UpdateClusterRequest$InstanceGroups' => '

Specify the instance groups to update.

', ], ], 'ClusterInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceStatusDetails$Status' => '

The status of an instance in a SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceStatusDetails' => [ 'base' => '

Details of an instance in a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterNodeDetails$InstanceStatus' => '

The status of the instance.

', 'ClusterNodeSummary$InstanceStatus' => '

The status of the instance.

', ], ], 'ClusterInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$InstanceType' => '

The instance type of the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceType' => '

Specifies the instance type of the instance group.

', 'ClusterNodeDetails$InstanceType' => '

The type of the instance.

', 'ClusterNodeSummary$InstanceType' => '

The type of the instance.

', ], ], 'ClusterLifeCycleConfig' => [ 'base' => '

The LifeCycle configuration for a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterInstanceGroupDetails$LifeCycleConfig' => '

Details of LifeCycle configuration for the instance group.

', 'ClusterInstanceGroupSpecification$LifeCycleConfig' => '

Specifies the LifeCycle configuration for the instance group.

', 'ClusterNodeDetails$LifeCycleConfig' => '

The LifeCycle configuration applied to the instance.

', ], ], 'ClusterLifeCycleConfigFileName' => [ 'base' => NULL, 'refs' => [ 'ClusterLifeCycleConfig$OnCreate' => '

The directory of the LifeCycle script under SourceS3Uri. This LifeCycle script runs during cluster creation.

', ], ], 'ClusterName' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterName' => '

The name of the SageMaker HyperPod cluster.

', 'CreateClusterRequest$ClusterName' => '

The name for the new SageMaker HyperPod cluster.

', 'DescribeClusterResponse$ClusterName' => '

The name of the SageMaker HyperPod cluster.

', ], ], 'ClusterNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteClusterRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

', 'DescribeClusterNodeRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the instance is.

', 'DescribeClusterRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'ListClusterNodesRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

', 'UpdateClusterRequest$ClusterName' => '

Specify the name of the SageMaker HyperPod cluster you want to update.

', ], ], 'ClusterNodeDetails' => [ 'base' => '

Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

', 'refs' => [ 'DescribeClusterNodeResponse$NodeDetails' => '

The details of the instance.

', ], ], 'ClusterNodeId' => [ 'base' => NULL, 'refs' => [ 'DescribeClusterNodeRequest$NodeId' => '

The ID of the instance.

', ], ], 'ClusterNodeSummaries' => [ 'base' => NULL, 'refs' => [ 'ListClusterNodesResponse$ClusterNodeSummaries' => '

The summaries of listed instances in a SageMaker HyperPod cluster

', ], ], 'ClusterNodeSummary' => [ 'base' => '

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterNodeSummaries$member' => NULL, ], ], 'ClusterNonNegativeInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$CurrentCount' => '

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

', ], ], 'ClusterSortBy' => [ 'base' => NULL, 'refs' => [ 'ListClusterNodesRequest$SortBy' => '

The field by which to sort results. The default value is CREATION_TIME.

', 'ListClustersRequest$SortBy' => '

The field by which to sort results. The default value is CREATION_TIME.

', ], ], 'ClusterStatus' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterStatus' => '

The status of the SageMaker HyperPod cluster.

', 'DescribeClusterResponse$ClusterStatus' => '

The status of the SageMaker HyperPod cluster.

', ], ], 'ClusterSummaries' => [ 'base' => NULL, 'refs' => [ 'ListClustersResponse$ClusterSummaries' => '

The summaries of listed SageMaker HyperPod clusters.

', ], ], 'ClusterSummary' => [ 'base' => '

Lists a summary of the properties of a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterSummaries$member' => NULL, ], ], 'ClusterThreadsPerCore' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$ThreadsPerCore' => '

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

', 'ClusterInstanceGroupSpecification$ThreadsPerCore' => '

Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn\'t support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

', 'ClusterNodeDetails$ThreadsPerCore' => '

The number of threads per CPU core you specified under CreateCluster.

', ], ], 'CodeEditorAppSettings' => [ 'base' => '

The Code Editor application settings.

For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.

', 'refs' => [ 'UserSettings$CodeEditorAppSettings' => '

The Code Editor application settings.

', ], ], 'CodeRepositories' => [ 'base' => NULL, 'refs' => [ 'JupyterLabAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

', 'JupyterServerAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.

', 'SpaceJupyterLabAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

', ], ], 'CodeRepository' => [ 'base' => '

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

', 'refs' => [ 'CodeRepositories$member' => NULL, ], ], 'CodeRepositoryArn' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the Git repository.

', 'CreateCodeRepositoryOutput$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the new repository.

', 'DescribeCodeRepositoryOutput$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the Git repository.

', 'UpdateCodeRepositoryOutput$CodeRepositoryArn' => '

The ARN of the Git repository.

', ], ], 'CodeRepositoryContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$DefaultCodeRepositoryContains' => '

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

', ], ], 'CodeRepositoryNameContains' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$NameContains' => '

A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.

', ], ], 'CodeRepositoryNameOrUrl' => [ 'base' => NULL, 'refs' => [ 'AdditionalCodeRepositoryNamesOrUrls$member' => NULL, 'CreateNotebookInstanceInput$DefaultCodeRepository' => '

A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'DescribeNotebookInstanceOutput$DefaultCodeRepository' => '

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'ListNotebookInstancesInput$AdditionalCodeRepositoryEquals' => '

A filter that returns only notebook instances with associated with the specified git repository.

', 'NotebookInstanceSummary$DefaultCodeRepository' => '

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'UpdateNotebookInstanceInput$DefaultCodeRepository' => '

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', ], ], 'CodeRepositorySortBy' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'CodeRepositorySortOrder' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'CodeRepositorySummary' => [ 'base' => '

Specifies summary information about a Git repository.

', 'refs' => [ 'CodeRepositorySummaryList$member' => NULL, ], ], 'CodeRepositorySummaryList' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesOutput$CodeRepositorySummaryList' => '

Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:

  • Name

  • Amazon Resource Name (ARN)

  • Creation time

  • Last modified time

  • Configuration information, including the URL location of the repository and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', ], ], 'CognitoConfig' => [ 'base' => '

Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

', 'refs' => [ 'CreateWorkforceRequest$CognitoConfig' => '

Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

', 'Workforce$CognitoConfig' => '

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

', ], ], 'CognitoMemberDefinition' => [ 'base' => '

Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.

', 'refs' => [ 'MemberDefinition$CognitoMemberDefinition' => '

The Amazon Cognito user group that is part of the work team.

', ], ], 'CognitoUserGroup' => [ 'base' => NULL, 'refs' => [ 'CognitoMemberDefinition$UserGroup' => '

An identifier for a user group.

', ], ], 'CognitoUserPool' => [ 'base' => NULL, 'refs' => [ 'CognitoConfig$UserPool' => '

A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.

', 'CognitoMemberDefinition$UserPool' => '

An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

', ], ], 'CollectionConfig' => [ 'base' => '

Configuration for your collection.

', 'refs' => [ 'FeatureDefinition$CollectionConfig' => '

Configuration for your collection.

', ], ], 'CollectionConfiguration' => [ 'base' => '

Configuration information for the Amazon SageMaker Debugger output tensor collections.

', 'refs' => [ 'CollectionConfigurations$member' => NULL, ], ], 'CollectionConfigurations' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$CollectionConfigurations' => '

Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', ], ], 'CollectionName' => [ 'base' => NULL, 'refs' => [ 'CollectionConfiguration$CollectionName' => '

The name of the tensor collection. The name must be unique relative to other rule configuration names.

', ], ], 'CollectionParameters' => [ 'base' => NULL, 'refs' => [ 'CollectionConfiguration$CollectionParameters' => '

Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".

', ], ], 'CollectionType' => [ 'base' => NULL, 'refs' => [ 'FeatureDefinition$CollectionType' => '

A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).

  • List: An ordered collection of elements.

  • Set: An unordered collection of unique elements.

  • Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

', ], ], 'CompilationJobArn' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationJobArn' => '

The Amazon Resource Name (ARN) of the model compilation job.

', 'CreateCompilationJobResponse$CompilationJobArn' => '

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:

  • CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.

', 'DescribeCompilationJobResponse$CompilationJobArn' => '

The Amazon Resource Name (ARN) of the model compilation job.

', ], ], 'CompilationJobStatus' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationJobStatus' => '

The status of the model compilation job.

', 'DescribeCompilationJobResponse$CompilationJobStatus' => '

The status of the model compilation job.

', 'ListCompilationJobsRequest$StatusEquals' => '

A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.

', ], ], 'CompilationJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListCompilationJobsResponse$CompilationJobSummaries' => '

An array of CompilationJobSummary objects, each describing a model compilation job.

', ], ], 'CompilationJobSummary' => [ 'base' => '

A summary of a model compilation job.

', 'refs' => [ 'CompilationJobSummaries$member' => NULL, ], ], 'CompilerOptions' => [ 'base' => NULL, 'refs' => [ 'OutputConfig$CompilerOptions' => '

Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.

  • DTYPE: Specifies the data type for the input. When compiling for ml_* (except for ml_inf) instances using PyTorch framework, provide the data type (dtype) of the model\'s input. "float32" is used if "DTYPE" is not specified. Options for data type are:

    • float32: Use either "float" or "float32".

    • int64: Use either "int64" or "long".

    For example, {"dtype" : "float32"}.

  • CPU: Compilation for CPU supports the following compiler options.

    • mcpu: CPU micro-architecture. For example, {\'mcpu\': \'skylake-avx512\'}

    • mattr: CPU flags. For example, {\'mattr\': [\'+neon\', \'+vfpv4\']}

  • ARM: Details of ARM CPU compilations.

    • NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.

      For example, add {\'mattr\': [\'+neon\']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.

  • NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.

    • gpu_code: Specifies the targeted architecture.

    • trt-ver: Specifies the TensorRT versions in x.y.z. format.

    • cuda-ver: Specifies the CUDA version in x.y format.

    For example, {\'gpu-code\': \'sm_72\', \'trt-ver\': \'6.0.1\', \'cuda-ver\': \'10.1\'}

  • ANDROID: Compilation for the Android OS supports the following compiler options:

    • ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {\'ANDROID_PLATFORM\': 28}.

    • mattr: Add {\'mattr\': [\'+neon\']} to compiler options if compiling for ARM 32-bit platform with NEON support.

  • INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, "CompilerOptions": "\\"--verbose 1 --num-neuroncores 2 -O2\\"".

    For information about supported compiler options, see Neuron Compiler CLI Reference Guide.

  • CoreML: Compilation for the CoreML OutputConfig TargetDevice supports the following compiler options:

    • class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {"class_labels": "imagenet_labels_1000.txt"}. Labels inside the txt file should be separated by newlines.

  • EIA: Compilation for the Elastic Inference Accelerator supports the following compiler options:

    • precision_mode: Specifies the precision of compiled artifacts. Supported values are "FP16" and "FP32". Default is "FP32".

    • signature_def_key: Specifies the signature to use for models in SavedModel format. Defaults is TensorFlow\'s default signature def key.

    • output_names: Specifies a list of output tensor names for models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.

    For example: {"precision_mode": "FP32", "output_names": ["output:0"]}

', ], ], 'CompleteOnConvergence' => [ 'base' => NULL, 'refs' => [ 'ConvergenceDetected$CompleteOnConvergence' => '

A flag to stop a tuning job once AMT has detected that the job has converged.

', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$CompressionType' => '

The type of compression used for an additional data source used in inference or training. Specify None if your additional data source is not compressed.

', 'AutoMLChannel$CompressionType' => '

You can use Gzip or None. The default value is None.

', 'AutoMLJobChannel$CompressionType' => '

The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default to None.

', 'Channel$CompressionType' => '

If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

', 'CompressionTypes$member' => NULL, 'TransformInput$CompressionType' => '

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

', ], ], 'CompressionTypes' => [ 'base' => NULL, 'refs' => [ 'ChannelSpecification$SupportedCompressionTypes' => '

The allowed compression types, if data compression is used.

', ], ], 'ConditionOutcome' => [ 'base' => NULL, 'refs' => [ 'ConditionStepMetadata$Outcome' => '

The outcome of the Condition step evaluation.

', ], ], 'ConditionStepMetadata' => [ 'base' => '

Metadata for a Condition step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Condition' => '

The outcome of the condition evaluation that was run by this step execution.

', ], ], 'ConfigKey' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$key' => NULL, 'HookParameters$key' => NULL, 'ProfilingParameters$key' => NULL, 'RuleParameters$key' => NULL, ], ], 'ConfigValue' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$value' => NULL, 'HookParameters$value' => NULL, 'ProfilingParameters$value' => NULL, 'RuleParameters$value' => NULL, ], ], 'ConflictException' => [ 'base' => '

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

', 'refs' => [], ], 'ContainerArgument' => [ 'base' => NULL, 'refs' => [ 'ContainerArguments$member' => NULL, 'MonitoringContainerArguments$member' => NULL, ], ], 'ContainerArguments' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ContainerArguments' => '

The arguments for a container used to run a processing job.

', ], ], 'ContainerConfig' => [ 'base' => '

The configuration used to run the application image container.

', 'refs' => [ 'JupyterLabAppImageConfig$ContainerConfig' => NULL, ], ], 'ContainerDefinition' => [ 'base' => '

Describes the container, as part of model definition.

', 'refs' => [ 'ContainerDefinitionList$member' => NULL, 'CreateModelInput$PrimaryContainer' => '

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

', 'DescribeModelOutput$PrimaryContainer' => '

The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

', 'Model$PrimaryContainer' => NULL, ], ], 'ContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$Containers' => '

Specifies the containers in the inference pipeline.

', 'DescribeModelOutput$Containers' => '

The containers in the inference pipeline.

', 'Model$Containers' => '

The containers in the inference pipeline.

', ], ], 'ContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ContainerEntrypoint' => '

The entrypoint for a container used to run a processing job.

', 'DataQualityAppSpecification$ContainerEntrypoint' => '

The entrypoint for a container used to run a monitoring job.

', 'ModelQualityAppSpecification$ContainerEntrypoint' => '

Specifies the entrypoint for a container that the monitoring job runs.

', 'MonitoringAppSpecification$ContainerEntrypoint' => '

Specifies the entrypoint for a container used to run the monitoring job.

', ], ], 'ContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'ContainerEntrypoint$member' => NULL, ], ], 'ContainerHostname' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ContainerHostname' => '

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don\'t specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

', 'ModelPackageContainerDefinition$ContainerHostname' => '

The DNS host name for the Docker container.

', ], ], 'ContainerImage' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Image' => '

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.

', 'ContainerDefinition$Image' => '

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

', 'DeployedImage$SpecifiedImage' => '

The image path you specified when you created the model.

', 'DeployedImage$ResolvedImage' => '

The specific digest path of the image hosted in this ProductionVariant.

', 'InferenceComponentContainerSpecification$Image' => '

The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

', 'ModelPackageContainerDefinition$Image' => '

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

', 'TrainingSpecification$TrainingImage' => '

The Amazon ECR registry path of the Docker image that contains the training algorithm.

', ], ], 'ContainerMode' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$Mode' => '

Whether the container hosts a single model or multiple models.

', ], ], 'ContentClassifier' => [ 'base' => NULL, 'refs' => [ 'ContentClassifiers$member' => NULL, ], ], 'ContentClassifiers' => [ 'base' => NULL, 'refs' => [ 'LabelingJobDataAttributes$ContentClassifiers' => '

Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

', ], ], 'ContentColumn' => [ 'base' => NULL, 'refs' => [ 'TextClassificationJobConfig$ContentColumn' => '

The name of the column used to provide the sentences to be classified. It should not be the same as the target column.

', ], ], 'ContentDigest' => [ 'base' => NULL, 'refs' => [ 'FileSource$ContentDigest' => '

The digest of the file source.

', 'MetricsSource$ContentDigest' => '

The hash key used for the metrics source.

', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$ContentType' => '

The content type of the data from the input source. You can use text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

', 'AutoMLJobChannel$ContentType' => '

The content type of the data from the input source. The following are the allowed content types for different problems:

  • For tabular problem types: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For image classification: image/png, image/jpeg, or image/*. The default value is image/*.

  • For text classification: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For time-series forecasting: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For text generation (LLMs fine-tuning): text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

', 'Channel$ContentType' => '

The MIME type of the data.

', 'ContentTypes$member' => NULL, 'FileSource$ContentType' => '

The type of content stored in the file source.

', 'MetricsSource$ContentType' => '

The metric source content type.

', 'TransformInput$ContentType' => '

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

', ], ], 'ContentTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedContentTypes' => '

The supported MIME types for the input data.

', 'ChannelSpecification$SupportedContentTypes' => '

The supported MIME types for the data.

', 'InferenceSpecification$SupportedContentTypes' => '

The supported MIME types for the input data.

', ], ], 'ContextArn' => [ 'base' => NULL, 'refs' => [ 'ContextSummary$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'CreateContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'DeleteContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'DescribeContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'UpdateContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', ], ], 'ContextName' => [ 'base' => NULL, 'refs' => [ 'ContextSummary$ContextName' => '

The name of the context.

', 'CreateContextRequest$ContextName' => '

The name of the context. Must be unique to your account in an Amazon Web Services Region.

', 'DeleteContextRequest$ContextName' => '

The name of the context to delete.

', 'DescribeContextResponse$ContextName' => '

The name of the context.

', 'UpdateContextRequest$ContextName' => '

The name of the context to update.

', ], ], 'ContextNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeContextRequest$ContextName' => '

The name of the context to describe.

', ], ], 'ContextSource' => [ 'base' => '

A structure describing the source of a context.

', 'refs' => [ 'ContextSummary$Source' => '

The source of the context.

', 'CreateContextRequest$Source' => '

The source type, ID, and URI.

', 'DescribeContextResponse$Source' => '

The source of the context.

', ], ], 'ContextSummaries' => [ 'base' => NULL, 'refs' => [ 'ListContextsResponse$ContextSummaries' => '

A list of contexts and their properties.

', ], ], 'ContextSummary' => [ 'base' => '

Lists a summary of the properties of a context. A context provides a logical grouping of other entities.

', 'refs' => [ 'ContextSummaries$member' => NULL, ], ], 'ContinuousParameterRange' => [ 'base' => '

A list of continuous hyperparameters to tune.

', 'refs' => [ 'ContinuousParameterRanges$member' => NULL, ], ], 'ContinuousParameterRangeSpecification' => [ 'base' => '

Defines the possible values for a continuous hyperparameter.

', 'refs' => [ 'ParameterRange$ContinuousParameterRangeSpecification' => '

A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

', ], ], 'ContinuousParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$ContinuousParameterRanges' => '

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

', ], ], 'ConvergenceDetected' => [ 'base' => '

A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.

', 'refs' => [ 'TuningJobCompletionCriteria$ConvergenceDetected' => '

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.

', ], ], 'CountryCode' => [ 'base' => NULL, 'refs' => [ 'HolidayConfigAttributes$CountryCode' => '

The country code for the holiday calendar.

For the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your choice.

', ], ], 'CreateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$CreationTime' => '

A timestamp that shows when the algorithm was created.

', 'AppDetails$CreationTime' => '

The creation time.

', 'BatchDescribeModelPackageSummary$CreationTime' => '

The creation time of the mortgage package summary.

', 'CodeRepositorySummary$CreationTime' => '

The date and time that the Git repository was created.

', 'CompilationJobSummary$CreationTime' => '

The time when the model compilation job was created.

', 'DescribeAlgorithmOutput$CreationTime' => '

A timestamp specifying when the algorithm was created.

', 'DescribeCodeRepositoryOutput$CreationTime' => '

The date and time that the repository was created.

', 'DescribeCompilationJobResponse$CreationTime' => '

The time that the model compilation job was created.

', 'DescribeDomainResponse$CreationTime' => '

The creation time.

', 'DescribeFeatureGroupResponse$CreationTime' => '

A timestamp indicating when SageMaker created the FeatureGroup.

', 'DescribeFeatureMetadataResponse$CreationTime' => '

A timestamp indicating when the feature was created.

', 'DescribeInferenceRecommendationsJobResponse$CreationTime' => '

A timestamp that shows when the job was created.

', 'DescribeModelPackageGroupOutput$CreationTime' => '

The time that the model group was created.

', 'DescribeModelPackageOutput$CreationTime' => '

A timestamp specifying when the model package was created.

', 'DescribeNotebookInstanceLifecycleConfigOutput$CreationTime' => '

A timestamp that tells when the lifecycle configuration was created.

', 'DescribeNotebookInstanceOutput$CreationTime' => '

A timestamp. Use this parameter to return the time when the notebook instance was created

', 'DescribeSpaceResponse$CreationTime' => '

The creation time.

', 'DescribeUserProfileResponse$CreationTime' => '

The creation time.

', 'DomainDetails$CreationTime' => '

The creation time.

', 'FeatureGroup$CreationTime' => '

The time a FeatureGroup was created.

', 'FeatureMetadata$CreationTime' => '

A timestamp indicating when the feature was created.

', 'InferenceRecommendationsJob$CreationTime' => '

A timestamp that shows when the job was created.

', 'ListAlgorithmsInput$CreationTimeAfter' => '

A filter that returns only algorithms created after the specified time (timestamp).

', 'ListAlgorithmsInput$CreationTimeBefore' => '

A filter that returns only algorithms created before the specified time (timestamp).

', 'ListCodeRepositoriesInput$CreationTimeAfter' => '

A filter that returns only Git repositories that were created after the specified time.

', 'ListCodeRepositoriesInput$CreationTimeBefore' => '

A filter that returns only Git repositories that were created before the specified time.

', 'ListCompilationJobsRequest$CreationTimeAfter' => '

A filter that returns the model compilation jobs that were created after a specified time.

', 'ListCompilationJobsRequest$CreationTimeBefore' => '

A filter that returns the model compilation jobs that were created before a specified time.

', 'ListFeatureGroupsRequest$CreationTimeAfter' => '

Use this parameter to search for FeatureGroupss created after a specific date and time.

', 'ListFeatureGroupsRequest$CreationTimeBefore' => '

Use this parameter to search for FeatureGroupss created before a specific date and time.

', 'ListInferenceRecommendationsJobsRequest$CreationTimeAfter' => '

A filter that returns only jobs created after the specified time (timestamp).

', 'ListInferenceRecommendationsJobsRequest$CreationTimeBefore' => '

A filter that returns only jobs created before the specified time (timestamp).

', 'ListModelPackageGroupsInput$CreationTimeAfter' => '

A filter that returns only model groups created after the specified time.

', 'ListModelPackageGroupsInput$CreationTimeBefore' => '

A filter that returns only model groups created before the specified time.

', 'ListModelPackagesInput$CreationTimeAfter' => '

A filter that returns only model packages created after the specified time (timestamp).

', 'ListModelPackagesInput$CreationTimeBefore' => '

A filter that returns only model packages created before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeBefore' => '

A filter that returns only lifecycle configurations that were created before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeAfter' => '

A filter that returns only lifecycle configurations that were created after the specified time (timestamp).

', 'ListNotebookInstancesInput$CreationTimeBefore' => '

A filter that returns only notebook instances that were created before the specified time (timestamp).

', 'ListNotebookInstancesInput$CreationTimeAfter' => '

A filter that returns only notebook instances that were created after the specified time (timestamp).

', 'ModelPackage$CreationTime' => '

The time that the model package was created.

', 'ModelPackageGroup$CreationTime' => '

The time that the model group was created.

', 'ModelPackageGroupSummary$CreationTime' => '

The time that the model group was created.

', 'ModelPackageSummary$CreationTime' => '

A timestamp that shows when the model package was created.

', 'NotebookInstanceLifecycleConfigSummary$CreationTime' => '

A timestamp that tells when the lifecycle configuration was created.

', 'NotebookInstanceSummary$CreationTime' => '

A timestamp that shows when the notebook instance was created.

', 'SpaceDetails$CreationTime' => '

The creation time.

', 'UserProfileDetails$CreationTime' => '

The creation time.

', ], ], 'CrossAccountFilterOption' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$CrossAccountFilterOption' => '

A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

', ], ], 'CsvContentType' => [ 'base' => NULL, 'refs' => [ 'CsvContentTypes$member' => NULL, ], ], 'CsvContentTypes' => [ 'base' => NULL, 'refs' => [ 'CaptureContentTypeHeader$CsvContentTypes' => '

The list of all content type headers that Amazon SageMaker will treat as CSV and capture accordingly.

', ], ], 'CustomFileSystem' => [ 'base' => '

A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystems$member' => NULL, ], ], 'CustomFileSystemConfig' => [ 'base' => '

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystemConfigs$member' => NULL, ], ], 'CustomFileSystemConfigs' => [ 'base' => NULL, 'refs' => [ 'UserSettings$CustomFileSystemConfigs' => '

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

', ], ], 'CustomFileSystems' => [ 'base' => NULL, 'refs' => [ 'SpaceSettings$CustomFileSystems' => '

A file system, created by you, that you assign to a space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', ], ], 'CustomImage' => [ 'base' => '

A custom SageMaker image. For more information, see Bring your own SageMaker image.

', 'refs' => [ 'CustomImages$member' => NULL, ], ], 'CustomImageContainerArguments' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerArguments' => '

The arguments for the container when you\'re running the application.

', ], ], 'CustomImageContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerEntrypoint' => '

The entrypoint used to run the application in the container.

', ], ], 'CustomImageContainerEnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerEnvironmentVariables' => '

The environment variables to set in the container

', ], ], 'CustomImages' => [ 'base' => NULL, 'refs' => [ 'JupyterLabAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a JupyterLab app.

', 'KernelGatewayAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a KernelGateway app.

', 'RSessionAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a RSession app.

', ], ], 'CustomPosixUserConfig' => [ 'base' => '

Details about the POSIX identity that is used for file system operations.

', 'refs' => [ 'UserSettings$CustomPosixUserConfig' => '

Details about the POSIX identity that is used for file system operations.

', ], ], 'CustomerMetadataKey' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataKeyList$member' => NULL, 'CustomerMetadataMap$key' => NULL, ], ], 'CustomerMetadataKeyList' => [ 'base' => NULL, 'refs' => [ 'UpdateModelPackageInput$CustomerMetadataPropertiesToRemove' => '

The metadata properties associated with the model package versions to remove.

', ], ], 'CustomerMetadataMap' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', 'DescribeModelPackageOutput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', 'ModelPackage$CustomerMetadataProperties' => '

The metadata properties for the model package.

', 'UpdateModelPackageInput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', ], ], 'CustomerMetadataValue' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataMap$value' => NULL, ], ], 'CustomizedMetricSpecification' => [ 'base' => '

A customized metric.

', 'refs' => [ 'MetricSpecification$Customized' => '

Information about a customized metric.

', ], ], 'DataCaptureConfig' => [ 'base' => '

Configuration to control how SageMaker captures inference data.

', 'refs' => [ 'CreateEndpointConfigInput$DataCaptureConfig' => NULL, 'DescribeEndpointConfigOutput$DataCaptureConfig' => NULL, ], ], 'DataCaptureConfigSummary' => [ 'base' => '

The currently active data capture configuration used by your Endpoint.

', 'refs' => [ 'DescribeEndpointOutput$DataCaptureConfig' => NULL, 'Endpoint$DataCaptureConfig' => NULL, ], ], 'DataCatalogConfig' => [ 'base' => '

The meta data of the Glue table which serves as data catalog for the OfflineStore.

', 'refs' => [ 'OfflineStoreConfig$DataCatalogConfig' => '

The meta data of the Glue table that is autogenerated when an OfflineStore is created.

', ], ], 'DataDistributionType' => [ 'base' => NULL, 'refs' => [ 'DatasetDefinition$DataDistributionType' => '

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

', ], ], 'DataExplorationNotebookLocation' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobArtifacts$DataExplorationNotebookLocation' => '

The URL of the notebook location.

', ], ], 'DataInputConfig' => [ 'base' => NULL, 'refs' => [ 'DerivedInformation$DerivedDataInputConfig' => '

The data input configuration that SageMaker Neo automatically derived for the model. When SageMaker Neo derives this information, you don\'t need to specify the data input configuration when you create a compilation job.

', 'InputConfig$DataInputConfig' => '

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are Framework specific.

  • TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"input":[1,1024,1024,3]}

      • If using the CLI, {\\"input\\":[1,1024,1024,3]}

    • Examples for two inputs:

      • If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}

      • If using the CLI, {\\"data1\\": [1,28,28,1], \\"data2\\":[1,28,28,1]}

  • KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"input_1":[1,3,224,224]}

      • If using the CLI, {\\"input_1\\":[1,3,224,224]}

    • Examples for two inputs:

      • If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]}

      • If using the CLI, {\\"input_1\\": [1,3,224,224], \\"input_2\\":[1,3,224,224]}

  • MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"data":[1,3,1024,1024]}

      • If using the CLI, {\\"data\\":[1,3,1024,1024]}

    • Examples for two inputs:

      • If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}

      • If using the CLI, {\\"var1\\": [1,1,28,28], \\"var2\\":[1,1,28,28]}

  • PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

    • Examples for one input in dictionary format:

      • If using the console, {"input0":[1,3,224,224]}

      • If using the CLI, {\\"input0\\":[1,3,224,224]}

    • Example for one input in list format: [[1,3,224,224]]

    • Examples for two inputs in dictionary format:

      • If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}

      • If using the CLI, {\\"input0\\":[1,3,224,224], \\"input1\\":[1,3,224,224]}

    • Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

  • XGBOOST: input data name and shape are not needed.

DataInputConfig supports the following parameters for CoreML TargetDevice (ML Model format):

  • shape: Input shape, for example {"input_1": {"shape": [1,224,224,3]}}. In addition to static input shapes, CoreML converter supports Flexible input shapes:

    • Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {"input_1": {"shape": ["1..10", 224, 224, 3]}}

    • Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}}

  • default_shape: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, 3]}}

  • type: Input type. Allowed values: Image and Tensor. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale.

  • bias: If the input type is an Image, you need to provide the bias vector.

  • scale: If the input type is an Image, you need to provide a scale factor.

CoreML ClassifierConfig parameters can be specified using OutputConfig CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

  • Tensor type input:

    • "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3]}}

  • Tensor type input without input name (PyTorch):

    • "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224]}]

  • Image type input:

    • "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}}

    • "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

  • Image type input without input name (PyTorch):

    • "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}]

    • "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

  • For TensorFlow models saved in the SavedModel format, specify the input names from signature_def_key and the input model shapes for DataInputConfig. Specify the signature_def_key in OutputConfig:CompilerOptions if the model does not use TensorFlow\'s default signature def key. For example:

    • "DataInputConfig": {"inputs": [1, 224, 224, 3]}

    • "CompilerOptions": {"signature_def_key": "serving_custom"}

  • For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes in DataInputConfig and the output tensor names for output_names in OutputConfig:CompilerOptions . For example:

    • "DataInputConfig": {"input_tensor:0": [1, 224, 224, 3]}

    • "CompilerOptions": {"output_names": ["output_tensor:0"]}

', 'ModelInput$DataInputConfig' => '

The input configuration object for the model.

', ], ], 'DataProcessing' => [ 'base' => '

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

', 'refs' => [ 'CreateTransformJobRequest$DataProcessing' => '

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

', 'DescribeTransformJobResponse$DataProcessing' => NULL, 'TransformJob$DataProcessing' => NULL, ], ], 'DataQualityAppSpecification' => [ 'base' => '

Information about the container that a data quality monitoring job runs.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityAppSpecification' => '

Specifies the container that runs the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityAppSpecification' => '

Information about the container that runs the data quality monitoring job.

', ], ], 'DataQualityBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityBaselineConfig' => '

Configures the constraints and baselines for the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityBaselineConfig' => '

The constraints and baselines for the data quality monitoring job definition.

', ], ], 'DataQualityJobInput' => [ 'base' => '

The input for the data quality monitoring job. Currently endpoints are supported for input.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobInput' => '

A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityJobInput' => '

The list of inputs for the data quality monitoring job. Currently endpoints are supported.

', ], ], 'DataSource' => [ 'base' => '

Describes the location of the channel data.

', 'refs' => [ 'Channel$DataSource' => '

The location of the channel data.

', ], ], 'DataSourceName' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderOAuthSetting$DataSourceName' => '

The name of the data source that you\'re connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

', ], ], 'Database' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Database' => '

The name of the Glue table database.

', ], ], 'DatasetDefinition' => [ 'base' => '

Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

', 'refs' => [ 'ProcessingInput$DatasetDefinition' => '

Configuration for a Dataset Definition input.

', ], ], 'DebugHookConfig' => [ 'base' => '

Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'refs' => [ 'CreateTrainingJobRequest$DebugHookConfig' => NULL, 'DescribeTrainingJobResponse$DebugHookConfig' => NULL, 'TrainingJob$DebugHookConfig' => NULL, ], ], 'DebugRuleConfiguration' => [ 'base' => '

Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'refs' => [ 'DebugRuleConfigurations$member' => NULL, ], ], 'DebugRuleConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$DebugRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

', 'DescribeTrainingJobResponse$DebugRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

', 'TrainingJob$DebugRuleConfigurations' => '

Information about the debug rule configuration.

', ], ], 'DebugRuleEvaluationStatus' => [ 'base' => '

Information about the status of the rule evaluation.

', 'refs' => [ 'DebugRuleEvaluationStatuses$member' => NULL, ], ], 'DebugRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$DebugRuleEvaluationStatuses' => '

Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

', 'TrainingJob$DebugRuleEvaluationStatuses' => '

Information about the evaluation status of the rules for the training job.

', ], ], 'DefaultEbsStorageSettings' => [ 'base' => '

A collection of default EBS storage settings that applies to private spaces created within a domain or user profile.

', 'refs' => [ 'DefaultSpaceStorageSettings$DefaultEbsStorageSettings' => '

The default EBS storage settings for a private space.

', ], ], 'DefaultGid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultGid' => '

The default POSIX group ID (GID). If not specified, defaults to 100.

', ], ], 'DefaultSpaceSettings' => [ 'base' => '

A collection of settings that apply to spaces created in the Domain.

', 'refs' => [ 'CreateDomainRequest$DefaultSpaceSettings' => '

The default settings used to create a space.

', 'DescribeDomainResponse$DefaultSpaceSettings' => '

The default settings used to create a space.

', 'UpdateDomainRequest$DefaultSpaceSettings' => '

The default settings used to create a space within the Domain.

', ], ], 'DefaultSpaceStorageSettings' => [ 'base' => '

The default storage settings for a private space.

', 'refs' => [ 'UserSettings$SpaceStorageSettings' => '

The storage settings for a private space.

', ], ], 'DefaultUid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultUid' => '

The default POSIX user ID (UID). If not specified, defaults to 1000.

', ], ], 'DeleteActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'DependencyCopyPath' => [ 'base' => NULL, 'refs' => [ 'HubContentDependency$DependencyCopyPath' => '

The hub content dependency copy path.

', ], ], 'DependencyOriginPath' => [ 'base' => NULL, 'refs' => [ 'HubContentDependency$DependencyOriginPath' => '

The hub content dependency origin path.

', ], ], 'DeployedImage' => [ 'base' => '

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

', 'refs' => [ 'DeployedImages$member' => NULL, 'InferenceComponentContainerSpecificationSummary$DeployedImage' => NULL, ], ], 'DeployedImages' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$DeployedImages' => '

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

', 'ProductionVariantSummary$DeployedImages' => '

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

', ], ], 'DeploymentConfig' => [ 'base' => '

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

', 'refs' => [ 'CreateEndpointInput$DeploymentConfig' => NULL, 'DescribeEndpointOutput$LastDeploymentConfig' => '

The most recent deployment configuration for the endpoint.

', 'UpdateEndpointInput$DeploymentConfig' => '

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

', ], ], 'DeploymentRecommendation' => [ 'base' => '

A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.

', 'refs' => [ 'DescribeModelOutput$DeploymentRecommendation' => '

A set of recommended deployment configurations for the model.

', 'Model$DeploymentRecommendation' => '

A set of recommended deployment configurations for the model.

', ], ], 'DeploymentStage' => [ 'base' => '

Contains information about a stage in an edge deployment plan.

', 'refs' => [ 'DeploymentStages$member' => NULL, ], ], 'DeploymentStageMaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanRequest$MaxResults' => '

The maximum number of results to select (50 by default).

', ], ], 'DeploymentStageStatusSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanResponse$Stages' => '

List of stages in the edge deployment plan.

', ], ], 'DeploymentStageStatusSummary' => [ 'base' => '

Contains information summarizing the deployment stage results.

', 'refs' => [ 'DeploymentStageStatusSummaries$member' => NULL, ], ], 'DeploymentStages' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$Stages' => '

List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.

', 'CreateEdgeDeploymentStageRequest$Stages' => '

List of stages to be added to the edge deployment plan.

', ], ], 'DeregisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DerivedInformation' => [ 'base' => '

Information that SageMaker Neo automatically derived about the model.

', 'refs' => [ 'DescribeCompilationJobResponse$DerivedInformation' => '

Information that SageMaker Neo automatically derived about the model.

', ], ], 'DescribeActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterNodeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterNodeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$Description' => '

A free-form description of a FeatureGroup.

', 'DescribeFeatureGroupResponse$Description' => '

A free form description of the feature group.

', 'FeatureGroup$Description' => '

A free form description of a FeatureGroup.

', ], ], 'DesiredWeightAndCapacity' => [ 'base' => '

Specifies weight and capacity values for a production variant.

', 'refs' => [ 'DesiredWeightAndCapacityList$member' => NULL, ], ], 'DesiredWeightAndCapacityList' => [ 'base' => NULL, 'refs' => [ 'UpdateEndpointWeightsAndCapacitiesInput$DesiredWeightsAndCapacities' => '

An object that provides new capacity and weight values for a variant.

', ], ], 'DestinationS3Uri' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$S3OutputPath' => '

The Amazon S3 location to upload inference responses to.

', 'AsyncInferenceOutputConfig$S3FailurePath' => '

The Amazon S3 location to upload failure inference responses to.

', 'BatchTransformInput$DataCapturedDestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'DataCaptureConfig$DestinationS3Uri' => '

The Amazon S3 location used to capture the data.

', 'DataCaptureConfigSummary$DestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'InferenceExperimentDataStorageConfig$Destination' => '

The Amazon S3 bucket where the inference request and response data is stored.

', 'ProductionVariantCoreDumpConfig$DestinationS3Uri' => '

The Amazon S3 bucket to send the core dump to.

', ], ], 'DetailedAlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$Status' => '

The current status.

', ], ], 'DetailedModelPackageStatus' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusItem$Status' => '

The current status.

', ], ], 'Device' => [ 'base' => '

Information of a particular device.

', 'refs' => [ 'Devices$member' => NULL, ], ], 'DeviceArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$DeviceArn' => '

The Amazon Resource Name (ARN) of the device.

', 'DeviceDeploymentSummary$DeviceArn' => '

The ARN of the device.

', 'DeviceSummary$DeviceArn' => '

Amazon Resource Name (ARN) of the device.

', ], ], 'DeviceDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'DeviceDeploymentSummary$DeviceDeploymentStatus' => '

The deployment status of the device.

', ], ], 'DeviceDeploymentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStageDevicesResponse$DeviceDeploymentSummaries' => '

List of summaries of devices allocated to the stage.

', ], ], 'DeviceDeploymentSummary' => [ 'base' => '

Contains information summarizing device details and deployment status.

', 'refs' => [ 'DeviceDeploymentSummaries$member' => NULL, ], ], 'DeviceDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Description' => '

A description of the device.

', 'Device$Description' => '

Description of the device.

', 'DeviceDeploymentSummary$Description' => '

The description of the device.

', 'DeviceSummary$Description' => '

A description of the device.

', ], ], 'DeviceFleetArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$DeviceFleetArn' => '

The The Amazon Resource Name (ARN) of the fleet.

', 'DeviceFleetSummary$DeviceFleetArn' => '

Amazon Resource Name (ARN) of the device fleet.

', 'GetDeviceFleetReportResponse$DeviceFleetArn' => '

The Amazon Resource Name (ARN) of the device.

', ], ], 'DeviceFleetDescription' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$Description' => '

A description of the fleet.

', 'DescribeDeviceFleetResponse$Description' => '

A description of the fleet.

', 'GetDeviceFleetReportResponse$Description' => '

Description of the fleet.

', 'UpdateDeviceFleetRequest$Description' => '

Description of the fleet.

', ], ], 'DeviceFleetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsResponse$DeviceFleetSummaries' => '

Summary of the device fleet.

', ], ], 'DeviceFleetSummary' => [ 'base' => '

Summary of the device fleet.

', 'refs' => [ 'DeviceFleetSummaries$member' => NULL, ], ], 'DeviceName' => [ 'base' => NULL, 'refs' => [ 'Device$DeviceName' => '

The name of the device.

', 'DeviceDeploymentSummary$DeviceName' => '

The name of the device.

', 'DeviceNames$member' => NULL, 'DeviceSelectionConfig$DeviceNameContains' => '

A filter to select devices with names containing this name.

', ], ], 'DeviceNames' => [ 'base' => NULL, 'refs' => [ 'DeregisterDevicesRequest$DeviceNames' => '

The unique IDs of the devices.

', 'DeviceSelectionConfig$DeviceNames' => '

List of devices chosen to deploy.

', ], ], 'DeviceSelectionConfig' => [ 'base' => '

Contains information about the configurations of selected devices.

', 'refs' => [ 'DeploymentStage$DeviceSelectionConfig' => '

Configuration of the devices in the stage.

', 'DeploymentStageStatusSummary$DeviceSelectionConfig' => '

Configuration of the devices in the stage.

', ], ], 'DeviceStats' => [ 'base' => '

Status of devices.

', 'refs' => [ 'GetDeviceFleetReportResponse$DeviceStats' => '

Status of devices.

', ], ], 'DeviceSubsetType' => [ 'base' => NULL, 'refs' => [ 'DeviceSelectionConfig$DeviceSubsetType' => '

Type of device subsets to deploy to the current stage.

', ], ], 'DeviceSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDevicesResponse$DeviceSummaries' => '

Summary of devices.

', ], ], 'DeviceSummary' => [ 'base' => '

Summary of the device.

', 'refs' => [ 'DeviceSummaries$member' => NULL, ], ], 'Devices' => [ 'base' => NULL, 'refs' => [ 'RegisterDevicesRequest$Devices' => '

A list of devices to register with SageMaker Edge Manager.

', 'UpdateDevicesRequest$Devices' => '

List of devices to register with Edge Manager agent.

', ], ], 'Dimension' => [ 'base' => NULL, 'refs' => [ 'VectorConfig$Dimension' => '

The number of elements in your vector.

', ], ], 'DirectDeploySettings' => [ 'base' => '

The model deployment settings for the SageMaker Canvas application.

In order to enable model deployment for Canvas, the SageMaker Domain\'s or user profile\'s Amazon Web Services IAM execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also turn on model deployment permissions through the SageMaker Domain\'s or user profile\'s settings in the SageMaker console.

', 'refs' => [ 'CanvasAppSettings$DirectDeploySettings' => '

The model deployment settings for the SageMaker Canvas application.

', ], ], 'DirectInternetAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$DirectInternetAccess' => '

Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC.

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

', 'DescribeNotebookInstanceOutput$DirectInternetAccess' => '

Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

', ], ], 'Direction' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$Direction' => '

Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.

', ], ], 'DirectoryPath' => [ 'base' => NULL, 'refs' => [ 'CheckpointConfig$LocalPath' => '

(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

', 'DebugHookConfig$LocalPath' => '

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

', 'DebugRuleConfiguration$LocalPath' => '

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

', 'FileSystemDataSource$DirectoryPath' => '

The full path to the directory to associate with the channel.

', 'ProfilerRuleConfiguration$LocalPath' => '

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

', 'TensorBoardOutputConfig$LocalPath' => '

Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.

', ], ], 'DisableProfiler' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$DisableProfiler' => '

Configuration to turn off Amazon SageMaker Debugger\'s system monitoring and profiling functionality. To turn it off, set to True.

', 'ProfilerConfigForUpdate$DisableProfiler' => '

To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.

', ], ], 'DisableSagemakerServicecatalogPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DisableSagemakerServicecatalogPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateAdditionalCodeRepositories' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateAdditionalCodeRepositories' => '

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateDefaultCodeRepository' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateDefaultCodeRepository' => '

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateAcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateLifecycleConfig' => '

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DockerSettings' => [ 'base' => '

A collection of settings that configure the domain\'s Docker interaction.

', 'refs' => [ 'DomainSettings$DockerSettings' => '

A collection of settings that configure the domain\'s Docker interaction.

', 'DomainSettingsForUpdate$DockerSettings' => '

A collection of settings that configure the domain\'s Docker interaction.

', ], ], 'DocumentSchemaVersion' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$DocumentSchemaVersion' => '

The document schema version for the hub content.

', 'HubContentInfo$DocumentSchemaVersion' => '

The version of the hub content document schema.

', 'ImportHubContentRequest$DocumentSchemaVersion' => '

The version of the hub content schema to import.

', 'ListHubContentVersionsRequest$MaxSchemaVersion' => '

The upper bound of the hub content schema version.

', 'ListHubContentsRequest$MaxSchemaVersion' => '

The upper bound of the hub content schema verion.

', ], ], 'Dollars' => [ 'base' => NULL, 'refs' => [ 'USD$Dollars' => '

The whole number of dollars in the amount.

', ], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateDomainResponse$DomainArn' => '

The Amazon Resource Name (ARN) of the created domain.

', 'DescribeDomainResponse$DomainArn' => '

The domain\'s Amazon Resource Name (ARN).

', 'DomainDetails$DomainArn' => '

The domain\'s Amazon Resource Name (ARN).

', 'UpdateDomainResponse$DomainArn' => '

The Amazon Resource Name (ARN) of the domain.

', ], ], 'DomainDetails' => [ 'base' => '

The domain\'s details.

', 'refs' => [ 'DomainList$member' => NULL, ], ], 'DomainId' => [ 'base' => NULL, 'refs' => [ 'AppDetails$DomainId' => '

The domain ID.

', 'CreateAppRequest$DomainId' => '

The domain ID.

', 'CreatePresignedDomainUrlRequest$DomainId' => '

The domain ID.

', 'CreateSpaceRequest$DomainId' => '

The ID of the associated Domain.

', 'CreateUserProfileRequest$DomainId' => '

The ID of the associated Domain.

', 'DeleteAppRequest$DomainId' => '

The domain ID.

', 'DeleteDomainRequest$DomainId' => '

The domain ID.

', 'DeleteSpaceRequest$DomainId' => '

The ID of the associated Domain.

', 'DeleteUserProfileRequest$DomainId' => '

The domain ID.

', 'DescribeAppRequest$DomainId' => '

The domain ID.

', 'DescribeAppResponse$DomainId' => '

The domain ID.

', 'DescribeDomainRequest$DomainId' => '

The domain ID.

', 'DescribeDomainResponse$DomainId' => '

The domain ID.

', 'DescribeSpaceRequest$DomainId' => '

The ID of the associated Domain.

', 'DescribeSpaceResponse$DomainId' => '

The ID of the associated Domain.

', 'DescribeUserProfileRequest$DomainId' => '

The domain ID.

', 'DescribeUserProfileResponse$DomainId' => '

The ID of the domain that contains the profile.

', 'DomainDetails$DomainId' => '

The domain ID.

', 'ListAppsRequest$DomainIdEquals' => '

A parameter to search for the domain ID.

', 'ListSpacesRequest$DomainIdEquals' => '

A parameter to search for the Domain ID.

', 'ListUserProfilesRequest$DomainIdEquals' => '

A parameter by which to filter the results.

', 'SpaceDetails$DomainId' => '

The ID of the associated Domain.

', 'UpdateDomainRequest$DomainId' => '

The ID of the domain to be updated.

', 'UpdateSpaceRequest$DomainId' => '

The ID of the associated Domain.

', 'UpdateUserProfileRequest$DomainId' => '

The domain ID.

', 'UserProfileDetails$DomainId' => '

The domain ID.

', ], ], 'DomainList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsResponse$Domains' => '

The list of domains.

', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$DomainName' => '

A name for the domain.

', 'DescribeDomainResponse$DomainName' => '

The domain name.

', 'DomainDetails$DomainName' => '

The domain name.

', ], ], 'DomainSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$SecurityGroupIds' => '

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

', 'DomainSettingsForUpdate$SecurityGroupIds' => '

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

', ], ], 'DomainSettings' => [ 'base' => '

A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.

', 'refs' => [ 'CreateDomainRequest$DomainSettings' => '

A collection of Domain settings.

', 'DescribeDomainResponse$DomainSettings' => '

A collection of Domain settings.

', ], ], 'DomainSettingsForUpdate' => [ 'base' => '

A collection of Domain configuration settings to update.

', 'refs' => [ 'UpdateDomainRequest$DomainSettingsForUpdate' => '

A collection of DomainSettings configuration values to update.

', ], ], 'DomainStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$Status' => '

The status.

', 'DomainDetails$Status' => '

The status.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'TargetTrackingScalingPolicyConfiguration$TargetValue' => '

The recommended target value to specify for the metric when creating a scaling policy.

', ], ], 'DoubleParameterValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentParameterValue$NumberValue' => '

The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can\'t specify the StringValue parameter.

', ], ], 'DriftCheckBaselines' => [ 'base' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'CreateModelPackageInput$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

', 'DescribeModelPackageOutput$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

', 'ModelPackage$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckBias' => [ 'base' => '

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$Bias' => '

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckExplainability' => [ 'base' => '

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$Explainability' => '

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckModelDataQuality' => [ 'base' => '

Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$ModelDataQuality' => '

Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckModelQuality' => [ 'base' => '

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$ModelQuality' => '

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

', ], ], 'DynamicScalingConfiguration' => [ 'base' => '

An object with the recommended values for you to specify when creating an autoscaling policy.

', 'refs' => [ 'GetScalingConfigurationRecommendationResponse$DynamicScalingConfiguration' => '

An object with the recommended values for you to specify when creating an autoscaling policy.

', ], ], 'EFSFileSystem' => [ 'base' => '

A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystem$EFSFileSystem' => '

A custom file system in Amazon EFS.

', ], ], 'EFSFileSystemConfig' => [ 'base' => '

The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker Domain.

', 'refs' => [ 'CustomFileSystemConfig$EFSFileSystemConfig' => '

The settings for a custom Amazon EFS file system.

', ], ], 'EMRStepMetadata' => [ 'base' => '

The configurations and outcomes of an Amazon EMR step execution.

', 'refs' => [ 'PipelineExecutionStepMetadata$EMR' => '

The configurations and outcomes of an Amazon EMR step execution.

', ], ], 'EbsStorageSettings' => [ 'base' => '

A collection of EBS storage settings that applies to private spaces.

', 'refs' => [ 'SpaceStorageSettings$EbsStorageSettings' => '

A collection of EBS storage settings for a private space.

', ], ], 'Edge' => [ 'base' => '

A directed edge connecting two lineage entities.

', 'refs' => [ 'Edges$member' => NULL, ], ], 'EdgeDeploymentConfig' => [ 'base' => '

Contains information about the configuration of a deployment.

', 'refs' => [ 'DeploymentStage$DeploymentConfig' => '

Configuration of the deployment details.

', 'DeploymentStageStatusSummary$DeploymentConfig' => '

Configuration of the deployment details.

', ], ], 'EdgeDeploymentModelConfig' => [ 'base' => '

Contains information about the configuration of a model in a deployment.

', 'refs' => [ 'EdgeDeploymentModelConfigs$member' => NULL, ], ], 'EdgeDeploymentModelConfigs' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$ModelConfigs' => '

List of models associated with the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$ModelConfigs' => '

List of models associated with the edge deployment plan.

', ], ], 'EdgeDeploymentPlanArn' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => '

The ARN of edge deployment plan.

', 'DeviceDeploymentSummary$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', ], ], 'EdgeDeploymentPlanSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansResponse$EdgeDeploymentPlanSummaries' => '

List of summaries of edge deployment plans.

', ], ], 'EdgeDeploymentPlanSummary' => [ 'base' => '

Contains information summarizing an edge deployment plan.

', 'refs' => [ 'EdgeDeploymentPlanSummaries$member' => NULL, ], ], 'EdgeDeploymentStatus' => [ 'base' => '

Contains information summarizing the deployment stage results.

', 'refs' => [ 'DeploymentStageStatusSummary$DeploymentStatus' => '

General status of the current state.

', ], ], 'EdgeModel' => [ 'base' => '

The model on the edge device.

', 'refs' => [ 'EdgeModels$member' => NULL, ], ], 'EdgeModelStat' => [ 'base' => '

Status of edge devices with this model.

', 'refs' => [ 'EdgeModelStats$member' => NULL, ], ], 'EdgeModelStats' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$ModelStats' => '

Status of model on device.

', ], ], 'EdgeModelSummaries' => [ 'base' => NULL, 'refs' => [ 'DeviceSummary$Models' => '

Models on the device.

', ], ], 'EdgeModelSummary' => [ 'base' => '

Summary of model on edge device.

', 'refs' => [ 'EdgeModelSummaries$member' => NULL, ], ], 'EdgeModels' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Models' => '

Models on the device.

', ], ], 'EdgeOutputConfig' => [ 'base' => '

The output configuration.

', 'refs' => [ 'CreateDeviceFleetRequest$OutputConfig' => '

The output configuration for storing sample data collected by the fleet.

', 'CreateEdgePackagingJobRequest$OutputConfig' => '

Provides information about the output location for the packaged model.

', 'DescribeDeviceFleetResponse$OutputConfig' => '

The output configuration for storing sampled data.

', 'DescribeEdgePackagingJobResponse$OutputConfig' => '

The output configuration for the edge packaging job.

', 'GetDeviceFleetReportResponse$OutputConfig' => '

The output configuration for storing sample data collected by the fleet.

', 'UpdateDeviceFleetRequest$OutputConfig' => '

Output configuration for storing sample data collected by the fleet.

', ], ], 'EdgePackagingJobArn' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobArn' => '

The Amazon Resource Name (ARN) of the edge packaging job.

', 'EdgePackagingJobSummary$EdgePackagingJobArn' => '

The Amazon Resource Name (ARN) of the edge packaging job.

', ], ], 'EdgePackagingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatus' => '

The current status of the packaging job.

', 'EdgePackagingJobSummary$EdgePackagingJobStatus' => '

The status of the edge packaging job.

', 'ListEdgePackagingJobsRequest$StatusEquals' => '

The job status to filter for.

', ], ], 'EdgePackagingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgePackagingJobsResponse$EdgePackagingJobSummaries' => '

Summaries of edge packaging jobs.

', ], ], 'EdgePackagingJobSummary' => [ 'base' => '

Summary of edge packaging job.

', 'refs' => [ 'EdgePackagingJobSummaries$member' => NULL, ], ], 'EdgePresetDeploymentArtifact' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Artifact' => '

The Amazon Resource Name (ARN) of the generated deployable resource.

', ], ], 'EdgePresetDeploymentOutput' => [ 'base' => '

The output of a SageMaker Edge Manager deployable resource.

', 'refs' => [ 'DescribeEdgePackagingJobResponse$PresetDeploymentOutput' => '

The output of a SageMaker Edge Manager deployable resource.

', ], ], 'EdgePresetDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Status' => '

The status of the deployable resource.

', ], ], 'EdgePresetDeploymentType' => [ 'base' => NULL, 'refs' => [ 'EdgeOutputConfig$PresetDeploymentType' => '

The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

', 'EdgePresetDeploymentOutput$Type' => '

The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

', ], ], 'EdgeVersion' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$Version' => '

Version of the agent.

', 'CreateEdgePackagingJobRequest$ModelVersion' => '

The version of the model.

', 'DescribeDeviceResponse$AgentVersion' => '

Edge Manager agent version.

', 'DescribeEdgePackagingJobResponse$ModelVersion' => '

The version of the model.

', 'DeviceSummary$AgentVersion' => '

Edge Manager agent version.

', 'EdgeModel$ModelVersion' => '

The model version.

', 'EdgeModelStat$ModelVersion' => '

The model version.

', 'EdgeModelSummary$ModelVersion' => '

The version model.

', 'EdgePackagingJobSummary$ModelVersion' => '

The version of the model.

', ], ], 'Edges' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Edges' => '

A list of edges that connect vertices in the response.

', ], ], 'EfsUid' => [ 'base' => NULL, 'refs' => [ 'DescribeSpaceResponse$HomeEfsFileSystemUid' => '

The ID of the space\'s profile in the Amazon Elastic File System volume.

', 'DescribeUserProfileResponse$HomeEfsFileSystemUid' => '

The ID of the user\'s profile in the Amazon Elastic File System (EFS) volume.

', ], ], 'EnableCapture' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$EnableCapture' => '

Whether data capture should be enabled or disabled (defaults to enabled).

', 'DataCaptureConfigSummary$EnableCapture' => '

Whether data capture is enabled or disabled.

', ], ], 'EnableInfraCheck' => [ 'base' => NULL, 'refs' => [ 'InfraCheckConfig$EnableInfraCheck' => '

Enables an infrastructure health check.

', ], ], 'EnableIotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$EnableIotRoleAlias' => '

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

', 'UpdateDeviceFleetRequest$EnableIotRoleAlias' => '

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

', ], ], 'EnableRemoteDebug' => [ 'base' => NULL, 'refs' => [ 'RemoteDebugConfig$EnableRemoteDebug' => '

If set to True, enables remote debugging.

', 'RemoteDebugConfigForUpdate$EnableRemoteDebug' => '

If set to True, enables remote debugging.

', ], ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'Endpoint' => [ 'base' => '

A hosted endpoint for real-time inference.

', 'refs' => [ 'SearchRecord$Endpoint' => NULL, ], ], 'EndpointArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'DescribeEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'DescribeInferenceComponentOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

', 'Endpoint$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'EndpointSummary$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'InferenceComponentSummary$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

', 'ModelDashboardEndpoint$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'UpdateEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'UpdateEndpointWeightsAndCapacitiesOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the updated endpoint.

', ], ], 'EndpointConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigOutput$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', 'DescribeEndpointConfigOutput$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', 'EndpointConfigSummary$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', ], ], 'EndpointConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

', 'CreateEndpointInput$EndpointConfigName' => '

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

', 'DeleteEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration that you want to delete.

', 'DescribeEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration.

', 'DescribeEndpointConfigOutput$EndpointConfigName' => '

Name of the SageMaker endpoint configuration.

', 'DescribeEndpointOutput$EndpointConfigName' => '

The name of the endpoint configuration associated with this endpoint.

', 'Endpoint$EndpointConfigName' => '

The endpoint configuration associated with the endpoint.

', 'EndpointConfigSummary$EndpointConfigName' => '

The name of the endpoint configuration.

', 'EndpointMetadata$EndpointConfigName' => '

The name of the endpoint configuration.

', 'PendingDeploymentSummary$EndpointConfigName' => '

The name of the endpoint configuration used in the deployment.

', 'UpdateEndpointInput$EndpointConfigName' => '

The name of the new endpoint configuration.

', ], ], 'EndpointConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NameContains' => '

A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.

', ], ], 'EndpointConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'EndpointConfigSummary' => [ 'base' => '

Provides summary information for an endpoint configuration.

', 'refs' => [ 'EndpointConfigSummaryList$member' => NULL, ], ], 'EndpointConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsOutput$EndpointConfigs' => '

An array of endpoint configurations.

', ], ], 'EndpointInfo' => [ 'base' => '

Details about a customer endpoint that was compared in an Inference Recommender job.

', 'refs' => [ 'EndpointPerformance$EndpointInfo' => NULL, 'Endpoints$member' => NULL, ], ], 'EndpointInput' => [ 'base' => '

Input object for the endpoint

', 'refs' => [ 'DataQualityJobInput$EndpointInput' => NULL, 'ModelBiasJobInput$EndpointInput' => NULL, 'ModelExplainabilityJobInput$EndpointInput' => NULL, 'ModelQualityJobInput$EndpointInput' => NULL, 'MonitoringInput$EndpointInput' => '

The endpoint for a monitoring job.

', ], ], 'EndpointInputConfiguration' => [ 'base' => '

The endpoint configuration for the load test.

', 'refs' => [ 'EndpointInputConfigurations$member' => NULL, ], ], 'EndpointInputConfigurations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$EndpointConfigurations' => '

Specifies the endpoint configuration to use for a job.

', ], ], 'EndpointMetadata' => [ 'base' => '

The metadata of the endpoint.

', 'refs' => [ 'DescribeInferenceExperimentResponse$EndpointMetadata' => '

The metadata of the endpoint on which the inference experiment ran.

', ], ], 'EndpointName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointInput$EndpointName' => '

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.

', 'CreateInferenceComponentInput$EndpointName' => '

The name of an existing endpoint where you host the inference component.

', 'CreateInferenceExperimentRequest$EndpointName' => '

The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.

', 'DeleteEndpointInput$EndpointName' => '

The name of the endpoint that you want to delete.

', 'DescribeEndpointInput$EndpointName' => '

The name of the endpoint.

', 'DescribeEndpointOutput$EndpointName' => '

Name of the endpoint.

', 'DescribeInferenceComponentOutput$EndpointName' => '

The name of the endpoint that hosts the inference component.

', 'DescribeMonitoringScheduleResponse$EndpointName' => '

The name of the endpoint for the monitoring job.

', 'Endpoint$EndpointName' => '

The name of the endpoint.

', 'EndpointInfo$EndpointName' => '

The name of a customer\'s endpoint.

', 'EndpointInput$EndpointName' => '

An endpoint in customer\'s account which has enabled DataCaptureConfig enabled.

', 'EndpointMetadata$EndpointName' => '

The name of the endpoint.

', 'EndpointSummary$EndpointName' => '

The name of the endpoint.

', 'GetScalingConfigurationRecommendationRequest$EndpointName' => '

The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the RecommendationId field.

', 'GetScalingConfigurationRecommendationResponse$EndpointName' => '

The name of an endpoint benchmarked during a previously completed Inference Recommender job.

', 'InferenceComponentSummary$EndpointName' => '

The name of the endpoint that hosts the inference component.

', 'ListDataQualityJobDefinitionsRequest$EndpointName' => '

A filter that lists the data quality job definitions associated with the specified endpoint.

', 'ListInferenceComponentsInput$EndpointNameEquals' => '

An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

', 'ListModelBiasJobDefinitionsRequest$EndpointName' => '

Name of the endpoint to monitor for model bias.

', 'ListModelExplainabilityJobDefinitionsRequest$EndpointName' => '

Name of the endpoint to monitor for model explainability.

', 'ListModelQualityJobDefinitionsRequest$EndpointName' => '

A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.

', 'ListMonitoringExecutionsRequest$EndpointName' => '

Name of a specific endpoint to fetch jobs for.

', 'ListMonitoringSchedulesRequest$EndpointName' => '

Name of a specific endpoint to fetch schedules for.

', 'ModelDashboardEndpoint$EndpointName' => '

The endpoint name.

', 'ModelDashboardMonitoringSchedule$EndpointName' => '

The endpoint which is monitored.

', 'ModelDeployConfig$EndpointName' => '

Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.

Specify the EndpointName if and only if you set AutoGenerateEndpointName to False; otherwise a 400 error is thrown.

', 'ModelDeployResult$EndpointName' => '

The name of the endpoint to which the model has been deployed.

If model deployment fails, this field is omitted from the response.

', 'MonitoringExecutionSummary$EndpointName' => '

The name of the endpoint used to run the monitoring job.

', 'MonitoringJobDefinitionSummary$EndpointName' => '

The name of the endpoint that the job monitors.

', 'MonitoringSchedule$EndpointName' => '

The endpoint that hosts the model being monitored.

', 'MonitoringScheduleSummary$EndpointName' => '

The name of the endpoint using the monitoring schedule.

', 'UpdateEndpointInput$EndpointName' => '

The name of the endpoint whose configuration you want to update.

', 'UpdateEndpointWeightsAndCapacitiesInput$EndpointName' => '

The name of an existing SageMaker endpoint.

', ], ], 'EndpointNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$NameContains' => '

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

', ], ], 'EndpointOutputConfiguration' => [ 'base' => '

The endpoint configuration made by Inference Recommender during a recommendation job.

', 'refs' => [ 'InferenceRecommendation$EndpointConfiguration' => '

Defines the endpoint configuration parameters.

', 'RecommendationJobInferenceBenchmark$EndpointConfiguration' => NULL, ], ], 'EndpointPerformance' => [ 'base' => '

The performance results from running an Inference Recommender job on an existing endpoint.

', 'refs' => [ 'EndpointPerformances$member' => NULL, ], ], 'EndpointPerformances' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$EndpointPerformances' => '

The performance results from running an Inference Recommender job on an existing endpoint.

', ], ], 'EndpointSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'EndpointStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeEndpointOutput$EndpointStatus' => '

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

  • UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint\'s status to InService, see Rolling Deployments.

', 'Endpoint$EndpointStatus' => '

The status of the endpoint.

', 'EndpointMetadata$EndpointStatus' => '

The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.

', 'EndpointSummary$EndpointStatus' => '

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints.

', 'ListEndpointsInput$StatusEquals' => '

A filter that returns only endpoints with the specified status.

', 'ModelDashboardEndpoint$EndpointStatus' => '

The endpoint status.

', ], ], 'EndpointSummary' => [ 'base' => '

Provides summary information for an endpoint.

', 'refs' => [ 'EndpointSummaryList$member' => NULL, ], ], 'EndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsOutput$Endpoints' => '

An array or endpoint objects.

', ], ], 'Endpoints' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$Endpoints' => '

Existing customer endpoints on which to run an Inference Recommender job.

', ], ], 'EntityDescription' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Description' => '

A description of the additional Inference specification

', 'AlgorithmSummary$AlgorithmDescription' => '

A brief description of the algorithm.

', 'BatchDescribeModelPackageSummary$ModelPackageDescription' => '

The description of the model package.

', 'ChannelSpecification$Description' => '

A brief description of the channel.

', 'CreateAlgorithmInput$AlgorithmDescription' => '

A description of the algorithm.

', 'CreateModelPackageGroupInput$ModelPackageGroupDescription' => '

A description for the model group.

', 'CreateModelPackageInput$ModelPackageDescription' => '

A description of the model package.

', 'CreateProjectInput$ProjectDescription' => '

A description for the project.

', 'DescribeAlgorithmOutput$AlgorithmDescription' => '

A brief summary about the algorithm.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupDescription' => '

A description of the model group.

', 'DescribeModelPackageOutput$ModelPackageDescription' => '

A brief summary of the model package.

', 'DescribeProjectOutput$ProjectDescription' => '

The description of the project.

', 'HyperParameterSpecification$Description' => '

A brief description of the hyperparameter.

', 'ModelPackage$ModelPackageDescription' => '

The description of the model package.

', 'ModelPackageGroup$ModelPackageGroupDescription' => '

The description for the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupDescription' => '

A description of the model group.

', 'ModelPackageSummary$ModelPackageDescription' => '

A brief description of the model package.

', 'Project$ProjectDescription' => '

The description of the project.

', 'ProjectSummary$ProjectDescription' => '

The description of the project.

', 'UpdateProjectInput$ProjectDescription' => '

The description for the project.

', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Name' => '

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

', 'AlgorithmStatusItem$Name' => '

The name of the algorithm for which the overall status is being reported.

', 'AlgorithmSummary$AlgorithmName' => '

The name of the algorithm that is described by the summary.

', 'AlgorithmValidationProfile$ProfileName' => '

The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'BatchDescribeModelPackageSummary$ModelPackageGroupName' => '

The group name for the model package

', 'CodeRepositorySummary$CodeRepositoryName' => '

The name of the Git repository.

', 'CompilationJobSummary$CompilationJobName' => '

The name of the model compilation job that you want a summary for.

', 'CreateAlgorithmInput$AlgorithmName' => '

The name of the algorithm.

', 'CreateCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'CreateCompilationJobRequest$CompilationJobName' => '

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

', 'CreateDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet that the device belongs to.

', 'CreateEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'CreateEdgeDeploymentPlanRequest$DeviceFleetName' => '

The device fleet used for this edge deployment plan.

', 'CreateEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'CreateEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'CreateEdgePackagingJobRequest$CompilationJobName' => '

The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.

', 'CreateEdgePackagingJobRequest$ModelName' => '

The name of the model.

', 'CreateModelCardExportJobRequest$ModelCardExportJobName' => '

The name of the model card export job.

', 'CreateModelCardRequest$ModelCardName' => '

The unique name of the model card.

', 'CreateModelPackageGroupInput$ModelPackageGroupName' => '

The name of the model group.

', 'CreateModelPackageInput$ModelPackageName' => '

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

This parameter is required for unversioned models. It is not applicable to versioned models.

', 'DeleteAlgorithmInput$AlgorithmName' => '

The name of the algorithm to delete.

', 'DeleteCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to delete.

', 'DeleteCompilationJobRequest$CompilationJobName' => '

The name of the compilation job to delete.

', 'DeleteDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet to delete.

', 'DeleteEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to delete.

', 'DeleteEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan from which the stage will be deleted.

', 'DeleteEdgeDeploymentStageRequest$StageName' => '

The name of the stage.

', 'DeleteModelCardRequest$ModelCardName' => '

The name of the model card to delete.

', 'DeleteModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group for which to delete the policy.

', 'DeploymentStage$StageName' => '

The name of the stage.

', 'DeploymentStageStatusSummary$StageName' => '

The name of the stage.

', 'DeregisterDevicesRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', 'DescribeAlgorithmOutput$AlgorithmName' => '

The name of the algorithm being described.

', 'DescribeCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to describe.

', 'DescribeCodeRepositoryOutput$CodeRepositoryName' => '

The name of the Git repository.

', 'DescribeCompilationJobRequest$CompilationJobName' => '

The name of the model compilation job that you want information about.

', 'DescribeCompilationJobResponse$CompilationJobName' => '

The name of the model compilation job.

', 'DescribeDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet.

', 'DescribeDeviceFleetResponse$DeviceFleetName' => '

The name of the fleet.

', 'DescribeDeviceRequest$DeviceName' => '

The unique ID of the device.

', 'DescribeDeviceRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', 'DescribeDeviceResponse$DeviceName' => '

The unique identifier of the device.

', 'DescribeDeviceResponse$DeviceFleetName' => '

The name of the fleet the device belongs to.

', 'DescribeEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the deployment plan to describe.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$DeviceFleetName' => '

The device fleet used for this edge deployment plan.

', 'DescribeEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'DescribeEdgePackagingJobResponse$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'DescribeEdgePackagingJobResponse$CompilationJobName' => '

The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

', 'DescribeEdgePackagingJobResponse$ModelName' => '

The name of the model.

', 'DescribeModelCardExportJobResponse$ModelCardExportJobName' => '

The name of the model card export job to describe.

', 'DescribeModelCardExportJobResponse$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card that the model export job exports.

', 'DescribeModelCardResponse$ModelCardName' => '

The name of the model card.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupName' => '

The name of the model group.

', 'DescribeModelPackageOutput$ModelPackageName' => '

The name of the model package being described.

', 'DescribeModelPackageOutput$ModelPackageGroupName' => '

If the model is a versioned model, the name of the model group that the versioned model belongs to.

', 'DeviceDeploymentSummary$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'DeviceDeploymentSummary$StageName' => '

The name of the stage in the edge deployment plan.

', 'DeviceDeploymentSummary$DeployedStageName' => '

The name of the deployed stage.

', 'DeviceDeploymentSummary$DeviceFleetName' => '

The name of the fleet to which the device belongs to.

', 'DeviceFleetSummary$DeviceFleetName' => '

Name of the device fleet.

', 'DeviceSummary$DeviceName' => '

The unique identifier of the device.

', 'DeviceSummary$DeviceFleetName' => '

The name of the fleet the device belongs to.

', 'EdgeDeploymentModelConfig$ModelHandle' => '

The name the device application uses to reference this model.

', 'EdgeDeploymentModelConfig$EdgePackagingJobName' => '

The edge packaging job associated with this deployment.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'EdgeDeploymentPlanSummary$DeviceFleetName' => '

The name of the device fleet used for the deployment.

', 'EdgeModel$ModelName' => '

The name of the model.

', 'EdgeModelStat$ModelName' => '

The name of the model.

', 'EdgeModelSummary$ModelName' => '

The name of the model.

', 'EdgePackagingJobSummary$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'EdgePackagingJobSummary$CompilationJobName' => '

The name of the SageMaker Neo compilation job.

', 'EdgePackagingJobSummary$ModelName' => '

The name of the model.

', 'GetDeviceFleetReportRequest$DeviceFleetName' => '

The name of the fleet.

', 'GetDeviceFleetReportResponse$DeviceFleetName' => '

The name of the fleet.

', 'GetModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group for which to get the resource policy.

', 'ListDevicesRequest$ModelName' => '

A filter that searches devices that contains this name in any of their models.

', 'ListDevicesRequest$DeviceFleetName' => '

Filter for fleets containing this name in their device fleet name.

', 'ListModelCardExportJobsRequest$ModelCardName' => '

List export jobs for the model card with the specified name.

', 'ListModelCardExportJobsRequest$ModelCardExportJobNameContains' => '

Only list model card export jobs with names that contain the specified string.

', 'ListModelCardsRequest$NameContains' => '

Only list model cards with names that contain the specified string.

', 'ListStageDevicesRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'ListStageDevicesRequest$StageName' => '

The name of the stage in the deployment.

', 'ModelCard$ModelCardName' => '

The unique name of the model card.

', 'ModelCardExportJobSummary$ModelCardExportJobName' => '

The name of the model card export job.

', 'ModelCardExportJobSummary$ModelCardName' => '

The name of the model card that the export job exports.

', 'ModelCardSummary$ModelCardName' => '

The name of the model card.

', 'ModelCardVersionSummary$ModelCardName' => '

The name of the model card.

', 'ModelDashboardModelCard$ModelCardName' => '

The name of a model card.

', 'ModelPackage$ModelPackageName' => '

The name of the model.

', 'ModelPackage$ModelPackageGroupName' => '

The model group to which the model belongs.

', 'ModelPackageGroup$ModelPackageGroupName' => '

The name of the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupName' => '

The name of the model group.

', 'ModelPackageStatusItem$Name' => '

The name of the model package for which the overall status is being reported.

', 'ModelPackageSummary$ModelPackageName' => '

The name of the model package.

', 'ModelPackageSummary$ModelPackageGroupName' => '

If the model package is a versioned model, the model group that the versioned model belongs to.

', 'ModelPackageValidationProfile$ProfileName' => '

The name of the profile for the model package.

', 'PutModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group to add a resource policy to.

', 'RegisterDevicesRequest$DeviceFleetName' => '

The name of the fleet.

', 'StartEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to start.

', 'StartEdgeDeploymentStageRequest$StageName' => '

The name of the stage to start.

', 'StopCompilationJobRequest$CompilationJobName' => '

The name of the model compilation job to stop.

', 'StopEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to stop.

', 'StopEdgeDeploymentStageRequest$StageName' => '

The name of the stage to stop.

', 'StopEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'UpdateCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to update.

', 'UpdateDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet.

', 'UpdateDevicesRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', ], ], 'EnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$key' => NULL, ], ], 'EnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Environment' => '

The environment variables to set in the container. For more information, see ContainerDefinition.

', 'ContainerDefinition$Environment' => '

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

', 'InferenceComponentContainerSpecification$Environment' => '

The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.

', 'InferenceComponentContainerSpecificationSummary$Environment' => '

The environment variables to set in the Docker container.

', 'ModelPackageContainerDefinition$Environment' => '

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

', 'RealTimeInferenceRecommendation$Environment' => '

The recommended environment variables to set in the model container for Real-Time Inference.

', ], ], 'EnvironmentParameter' => [ 'base' => '

A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

', 'refs' => [ 'EnvironmentParameters$member' => NULL, ], ], 'EnvironmentParameterRanges' => [ 'base' => '

Specifies the range of environment parameters

', 'refs' => [ 'EndpointInputConfiguration$EnvironmentParameterRanges' => '

The parameter you want to benchmark against.

', ], ], 'EnvironmentParameters' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$EnvironmentParameters' => '

Defines the environment parameters that includes key, value types, and values.

', ], ], 'EnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$value' => NULL, ], ], 'ExcludeFeaturesAttribute' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$ExcludeFeaturesAttribute' => '

The attributes of the input data to exclude from the analysis.

', 'EndpointInput$ExcludeFeaturesAttribute' => '

The attributes of the input data to exclude from the analysis.

', ], ], 'ExecutionRoleIdentityConfig' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$ExecutionRoleIdentityConfig' => '

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

', 'DomainSettingsForUpdate$ExecutionRoleIdentityConfig' => '

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

', ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsRequest$StatusEquals' => '

A filter that retrieves only jobs with a specific status.

', 'MonitoringExecutionSummary$MonitoringExecutionStatus' => '

The status of the monitoring job.

', ], ], 'ExitMessage' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ExitMessage' => '

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', 'ProcessingJob$ExitMessage' => '

A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', 'ProcessingJobSummary$ExitMessage' => '

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', ], ], 'Experiment' => [ 'base' => '

The properties of an experiment as returned by the Search API.

', 'refs' => [ 'SearchRecord$Experiment' => '

The properties of an experiment.

', ], ], 'ExperimentArn' => [ 'base' => NULL, 'refs' => [ 'CreateExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'DeleteExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment that is being deleted.

', 'DescribeExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'Experiment$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'ExperimentSummary$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'UpdateExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', ], ], 'ExperimentConfig' => [ 'base' => '

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

', 'refs' => [ 'CreateProcessingJobRequest$ExperimentConfig' => NULL, 'CreateTrainingJobRequest$ExperimentConfig' => NULL, 'CreateTransformJobRequest$ExperimentConfig' => NULL, 'DescribeProcessingJobResponse$ExperimentConfig' => '

The configuration information used to create an experiment.

', 'DescribeTrainingJobResponse$ExperimentConfig' => NULL, 'DescribeTransformJobResponse$ExperimentConfig' => NULL, 'ProcessingJob$ExperimentConfig' => NULL, 'TrainingJob$ExperimentConfig' => NULL, 'TransformJob$ExperimentConfig' => NULL, ], ], 'ExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateActionRequest$Description' => '

The description of the action.

', 'CreateContextRequest$Description' => '

The description of the context.

', 'CreateExperimentRequest$Description' => '

The description of the experiment.

', 'DescribeActionResponse$Description' => '

The description of the action.

', 'DescribeContextResponse$Description' => '

The description of the context.

', 'DescribeExperimentResponse$Description' => '

The description of the experiment.

', 'DescribeLineageGroupResponse$Description' => '

The description of the lineage group.

', 'Experiment$Description' => '

The description of the experiment.

', 'UpdateActionRequest$Description' => '

The new description for the action.

', 'UpdateContextRequest$Description' => '

The new description for the context.

', 'UpdateExperimentRequest$Description' => '

The description of the experiment.

', ], ], 'ExperimentEntityName' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionName' => '

The name of the action.

', 'ArtifactSummary$ArtifactName' => '

The name of the artifact.

', 'AssociateTrialComponentRequest$TrialComponentName' => '

The name of the component to associated with the trial.

', 'AssociateTrialComponentRequest$TrialName' => '

The name of the trial to associate with.

', 'AssociationSummary$SourceName' => '

The name of the source.

', 'AssociationSummary$DestinationName' => '

The name of the destination.

', 'CreateActionRequest$ActionName' => '

The name of the action. Must be unique to your account in an Amazon Web Services Region.

', 'CreateArtifactRequest$ArtifactName' => '

The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

', 'CreateExperimentRequest$ExperimentName' => '

The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateExperimentRequest$DisplayName' => '

The name of the experiment as displayed. The name doesn\'t need to be unique. If you don\'t specify DisplayName, the value in ExperimentName is displayed.

', 'CreateTrialComponentRequest$TrialComponentName' => '

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateTrialComponentRequest$DisplayName' => '

The name of the component as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'CreateTrialRequest$TrialName' => '

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateTrialRequest$DisplayName' => '

The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.

', 'CreateTrialRequest$ExperimentName' => '

The name of the experiment to associate the trial with.

', 'DeleteActionRequest$ActionName' => '

The name of the action to delete.

', 'DeleteExperimentRequest$ExperimentName' => '

The name of the experiment to delete.

', 'DeleteTrialComponentRequest$TrialComponentName' => '

The name of the component to delete.

', 'DeleteTrialRequest$TrialName' => '

The name of the trial to delete.

', 'DescribeExperimentRequest$ExperimentName' => '

The name of the experiment to describe.

', 'DescribeExperimentResponse$ExperimentName' => '

The name of the experiment.

', 'DescribeExperimentResponse$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'DescribeLineageGroupRequest$LineageGroupName' => '

The name of the lineage group.

', 'DescribeLineageGroupResponse$LineageGroupName' => '

The name of the lineage group.

', 'DescribeLineageGroupResponse$DisplayName' => '

The display name of the lineage group.

', 'DescribeTrialComponentResponse$TrialComponentName' => '

The name of the trial component.

', 'DescribeTrialComponentResponse$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'DescribeTrialRequest$TrialName' => '

The name of the trial to describe.

', 'DescribeTrialResponse$TrialName' => '

The name of the trial.

', 'DescribeTrialResponse$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'DescribeTrialResponse$ExperimentName' => '

The name of the experiment the trial is part of.

', 'DisassociateTrialComponentRequest$TrialComponentName' => '

The name of the component to disassociate from the trial.

', 'DisassociateTrialComponentRequest$TrialName' => '

The name of the trial to disassociate from.

', 'Experiment$ExperimentName' => '

The name of the experiment.

', 'Experiment$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'ExperimentConfig$ExperimentName' => '

The name of an existing experiment to associate with the trial component.

', 'ExperimentConfig$TrialName' => '

The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

', 'ExperimentConfig$TrialComponentDisplayName' => '

The display name for the trial component. If this key isn\'t specified, the display name is the trial component name.

', 'ExperimentConfig$RunName' => '

The name of the experiment run to associate with the trial component.

', 'ExperimentSummary$ExperimentName' => '

The name of the experiment.

', 'ExperimentSummary$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'LineageGroupSummary$LineageGroupName' => '

The name or Amazon Resource Name (ARN) of the lineage group.

', 'LineageGroupSummary$DisplayName' => '

The display name of the lineage group summary.

', 'ListTrialComponentsRequest$ExperimentName' => '

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can\'t filter by SourceArn or TrialName.

', 'ListTrialComponentsRequest$TrialName' => '

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can\'t filter by ExperimentName or SourceArn.

', 'ListTrialsRequest$ExperimentName' => '

A filter that returns only trials that are part of the specified experiment.

', 'ListTrialsRequest$TrialComponentName' => '

A filter that returns only trials that are associated with the specified trial component.

', 'Parent$TrialName' => '

The name of the trial.

', 'Parent$ExperimentName' => '

The name of the experiment.

', 'PipelineExperimentConfig$ExperimentName' => '

The name of the experiment.

', 'PipelineExperimentConfig$TrialName' => '

The name of the trial.

', 'Trial$TrialName' => '

The name of the trial.

', 'Trial$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'Trial$ExperimentName' => '

The name of the experiment the trial is part of.

', 'TrialComponent$TrialComponentName' => '

The name of the trial component.

', 'TrialComponent$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'TrialComponent$RunName' => '

The name of the experiment run.

', 'TrialComponentSimpleSummary$TrialComponentName' => '

The name of the trial component.

', 'TrialComponentSummary$TrialComponentName' => '

The name of the trial component.

', 'TrialComponentSummary$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'TrialSummary$TrialName' => '

The name of the trial.

', 'TrialSummary$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'UpdateActionRequest$ActionName' => '

The name of the action to update.

', 'UpdateArtifactRequest$ArtifactName' => '

The new name for the artifact.

', 'UpdateExperimentRequest$ExperimentName' => '

The name of the experiment to update.

', 'UpdateExperimentRequest$DisplayName' => '

The name of the experiment as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'UpdateTrialComponentRequest$TrialComponentName' => '

The name of the component to update.

', 'UpdateTrialComponentRequest$DisplayName' => '

The name of the component as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'UpdateTrialRequest$TrialName' => '

The name of the trial to update.

', 'UpdateTrialRequest$DisplayName' => '

The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.

', ], ], 'ExperimentEntityNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeActionRequest$ActionName' => '

The name of the action to describe.

', 'DescribeActionResponse$ActionName' => '

The name of the action.

', 'DescribeArtifactResponse$ArtifactName' => '

The name of the artifact.

', 'DescribeTrialComponentRequest$TrialComponentName' => '

The name of the trial component to describe.

', ], ], 'ExperimentSource' => [ 'base' => '

The source of the experiment.

', 'refs' => [ 'DescribeExperimentResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the type.

', 'Experiment$Source' => NULL, 'ExperimentSummary$ExperimentSource' => NULL, ], ], 'ExperimentSourceArn' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'ExperimentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListExperimentsResponse$ExperimentSummaries' => '

A list of the summaries of your experiments.

', ], ], 'ExperimentSummary' => [ 'base' => '

A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.

', 'refs' => [ 'ExperimentSummaries$member' => NULL, ], ], 'ExpiresInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$ExpiresInSeconds' => '

The number of seconds until the pre-signed URL expires. This value defaults to 300.

', ], ], 'Explainability' => [ 'base' => '

Contains explainability metrics for a model.

', 'refs' => [ 'ModelMetrics$Explainability' => '

Metrics that help explain a model.

', ], ], 'ExplainabilityLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$Explainability' => '

The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.

', ], ], 'ExplainerConfig' => [ 'base' => '

A parameter to activate explainers.

', 'refs' => [ 'CreateEndpointConfigInput$ExplainerConfig' => '

A member of CreateEndpointConfig that enables explainers.

', 'DescribeEndpointConfigOutput$ExplainerConfig' => '

The configuration parameters for an explainer.

', 'DescribeEndpointOutput$ExplainerConfig' => '

The configuration parameters for an explainer.

', ], ], 'FailStepMetadata' => [ 'base' => '

The container for the metadata for Fail step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Fail' => '

The configurations and outcomes of a Fail step execution.

', ], ], 'FailureHandlingPolicy' => [ 'base' => NULL, 'refs' => [ 'EdgeDeploymentConfig$FailureHandlingPolicy' => '

Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.

', ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Message' => NULL, 'DescribeAppResponse$FailureReason' => '

The failure reason.

', 'DescribeCompilationJobResponse$FailureReason' => '

If a model compilation job failed, the reason it failed.

', 'DescribeDomainResponse$FailureReason' => '

The failure reason.

', 'DescribeEndpointOutput$FailureReason' => '

If the status of the endpoint is Failed, the reason why it failed.

', 'DescribeFeatureGroupResponse$FailureReason' => '

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:

  • The FeatureGroup could not be created in the OfflineStore.

  • The FeatureGroup could not be deleted from the OfflineStore.

', 'DescribeFlowDefinitionResponse$FailureReason' => '

The reason your flow definition failed.

', 'DescribeHubContentResponse$FailureReason' => '

The failure reason if importing hub content failed.

', 'DescribeHubResponse$FailureReason' => '

The failure reason if importing hub content failed.

', 'DescribeHyperParameterTuningJobResponse$FailureReason' => '

If the tuning job failed, the reason it failed.

', 'DescribeImageResponse$FailureReason' => '

When a create, update, or delete operation fails, the reason for the failure.

', 'DescribeImageVersionResponse$FailureReason' => '

When a create or delete operation fails, the reason for the failure.

', 'DescribeInferenceComponentOutput$FailureReason' => '

If the inference component status is Failed, the reason for the failure.

', 'DescribeInferenceRecommendationsJobResponse$FailureReason' => '

If the job fails, provides information why the job failed.

', 'DescribeLabelingJobResponse$FailureReason' => '

If the job failed, the reason that it failed.

', 'DescribeModelCardExportJobResponse$FailureReason' => '

The failure reason if the model export job fails.

', 'DescribeMonitoringScheduleResponse$FailureReason' => '

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

', 'DescribeNotebookInstanceOutput$FailureReason' => '

If status is Failed, the reason it failed.

', 'DescribeProcessingJobResponse$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'DescribeSpaceResponse$FailureReason' => '

The failure reason.

', 'DescribeTrainingJobResponse$FailureReason' => '

If the training job failed, the reason it failed.

', 'DescribeTransformJobResponse$FailureReason' => '

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

', 'DescribeUserProfileResponse$FailureReason' => '

The failure reason.

', 'Endpoint$FailureReason' => '

If the endpoint failed, the reason it failed.

', 'EndpointMetadata$FailureReason' => '

If the status of the endpoint is Failed, or the status is InService but update operation fails, this provides the reason why it failed.

', 'FeatureGroup$FailureReason' => '

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

', 'FlowDefinitionSummary$FailureReason' => '

The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

', 'HyperParameterTrainingJobSummary$FailureReason' => '

The reason that the training job failed.

', 'HyperParameterTuningJobSearchEntity$FailureReason' => '

The error that was created when a hyperparameter tuning job failed.

', 'Image$FailureReason' => '

When a create, update, or delete operation fails, the reason for the failure.

', 'ImageVersion$FailureReason' => '

When a create or delete operation fails, the reason for the failure.

', 'InferenceRecommendationsJob$FailureReason' => '

If the job fails, provides information why the job failed.

', 'LabelingJobSummary$FailureReason' => '

If the LabelingJobStatus field is Failed, this field contains a description of the error.

', 'LastUpdateStatus$FailureReason' => '

If the update wasn\'t successful, indicates the reason why it failed.

', 'ModelDashboardMonitoringSchedule$FailureReason' => '

If a monitoring job failed, provides the reason.

', 'MonitoringExecutionSummary$FailureReason' => '

Contains the reason a monitoring job failed, if it failed.

', 'MonitoringSchedule$FailureReason' => '

If the monitoring schedule failed, the reason it failed.

', 'PipelineExecutionStep$FailureReason' => '

The reason why the step failed execution. This is only returned if the step failed its execution.

', 'ProcessingJob$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'ProcessingJobSummary$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'ResourceInUse$Message' => NULL, 'ResourceLimitExceeded$Message' => NULL, 'ResourceNotFound$Message' => NULL, 'TrainingJob$FailureReason' => '

If the training job failed, the reason it failed.

', 'TransformJob$FailureReason' => '

If the transform job failed, the reason it failed.

', 'TransformJobSummary$FailureReason' => '

If the transform job failed, the reason it failed.

', ], ], 'FeatureAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureGroupRequest$FeatureAdditions' => '

Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you\'ve made a valid request. It takes some time after you\'ve made a valid request for Feature Store to update the feature group.

', ], ], 'FeatureDefinition' => [ 'base' => '

A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.

', 'refs' => [ 'FeatureAdditions$member' => NULL, 'FeatureDefinitions$member' => NULL, ], ], 'FeatureDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$FeatureDefinitions' => '

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

', 'DescribeFeatureGroupResponse$FeatureDefinitions' => '

A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

', 'FeatureGroup$FeatureDefinitions' => '

A list of Features. Each Feature must include a FeatureName and a FeatureType.

Valid FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

', ], ], 'FeatureDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$Description' => '

The description you added to describe the feature.

', 'FeatureMetadata$Description' => '

An optional description that you specify to better describe the feature.

', 'UpdateFeatureMetadataRequest$Description' => '

A description that you can write to better describe the feature.

', ], ], 'FeatureGroup' => [ 'base' => '

Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.

', 'refs' => [ 'SearchRecord$FeatureGroup' => NULL, ], ], 'FeatureGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.

', 'DescribeFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of the FeatureGroup.

', 'DescribeFeatureMetadataResponse$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group that contains the feature.

', 'FeatureGroup$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of a FeatureGroup.

', 'FeatureGroupSummary$FeatureGroupArn' => '

Unique identifier for the FeatureGroup.

', 'FeatureMetadata$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group.

', 'UpdateFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group that you\'re updating.

', ], ], 'FeatureGroupMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$MaxResults' => '

The maximum number of results returned by ListFeatureGroups.

', ], ], 'FeatureGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$FeatureGroupName' => '

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. The name:

  • Must start and end with an alphanumeric character.

  • Can only contain alphanumeric character and hyphens. Spaces are not allowed.

', 'DeleteFeatureGroupRequest$FeatureGroupName' => '

The name of the FeatureGroup you want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeFeatureGroupResponse$FeatureGroupName' => '

he name of the FeatureGroup.

', 'DescribeFeatureMetadataResponse$FeatureGroupName' => '

The name of the feature group that you\'ve specified.

', 'FeatureGroup$FeatureGroupName' => '

The name of the FeatureGroup.

', 'FeatureGroupSummary$FeatureGroupName' => '

The name of FeatureGroup.

', 'FeatureMetadata$FeatureGroupName' => '

The name of the feature group containing the feature.

', 'ProcessingFeatureStoreOutput$FeatureGroupName' => '

The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.

', ], ], 'FeatureGroupNameContains' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$NameContains' => '

A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.

', ], ], 'FeatureGroupNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.

', 'DescribeFeatureMetadataRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group containing the feature.

', 'UpdateFeatureGroupRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group that you\'re updating.

', 'UpdateFeatureMetadataRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group containing the feature that you\'re updating.

', ], ], 'FeatureGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortBy' => '

The value on which the feature group list is sorted.

', ], ], 'FeatureGroupSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortOrder' => '

The order in which feature groups are listed.

', ], ], 'FeatureGroupStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupResponse$FeatureGroupStatus' => '

The status of the feature group.

', 'FeatureGroup$FeatureGroupStatus' => '

A FeatureGroup status.

', 'FeatureGroupSummary$FeatureGroupStatus' => '

The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.

', 'ListFeatureGroupsRequest$FeatureGroupStatusEquals' => '

A FeatureGroup status. Filters by FeatureGroup status.

', ], ], 'FeatureGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsResponse$FeatureGroupSummaries' => '

A summary of feature groups.

', ], ], 'FeatureGroupSummary' => [ 'base' => '

The name, ARN, CreationTime, FeatureGroup values, LastUpdatedTime and EnableOnlineStorage status of a FeatureGroup.

', 'refs' => [ 'FeatureGroupSummaries$member' => NULL, ], ], 'FeatureMetadata' => [ 'base' => '

The metadata for a feature. It can either be metadata that you specify, or metadata that is updated automatically.

', 'refs' => [ 'SearchRecord$FeatureMetadata' => '

The feature metadata used to search through the features.

', ], ], 'FeatureName' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$RecordIdentifierFeatureName' => '

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions\' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

  • Must start and end with an alphanumeric character.

  • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

', 'CreateFeatureGroupRequest$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

An EventTime can be a String or Fractional.

  • Fractional: EventTime feature values must be a Unix timestamp in seconds.

  • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd\'T\'HH:mm:ssZ and yyyy-MM-dd\'T\'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. \'T\' and Z are constants.

', 'DescribeFeatureGroupResponse$RecordIdentifierFeatureName' => '

The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

', 'DescribeFeatureGroupResponse$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.

', 'DescribeFeatureMetadataRequest$FeatureName' => '

The name of the feature.

', 'DescribeFeatureMetadataResponse$FeatureName' => '

The name of the feature that you\'ve specified.

', 'FeatureDefinition$FeatureName' => '

The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

', 'FeatureGroup$RecordIdentifierFeatureName' => '

The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

', 'FeatureGroup$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

', 'FeatureMetadata$FeatureName' => '

The name of feature.

', 'UpdateFeatureMetadataRequest$FeatureName' => '

The name of the feature that you\'re updating.

', ], ], 'FeatureParameter' => [ 'base' => '

A key-value pair that you specify to describe the feature.

', 'refs' => [ 'FeatureParameterAdditions$member' => NULL, 'FeatureParameters$member' => NULL, ], ], 'FeatureParameterAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterAdditions' => '

A list of key-value pairs that you can add to better describe the feature.

', ], ], 'FeatureParameterKey' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Key' => '

A key that must contain a value to describe the feature.

', 'FeatureParameterRemovals$member' => NULL, ], ], 'FeatureParameterRemovals' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterRemovals' => '

A list of parameter keys that you can specify to remove parameters that describe your feature.

', ], ], 'FeatureParameterValue' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Value' => '

The value that belongs to a key.

', ], ], 'FeatureParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$Parameters' => '

The key-value pairs that you added to describe the feature.

', 'FeatureMetadata$Parameters' => '

Optional key-value pairs that you specify to better describe the feature.

', ], ], 'FeatureStatus' => [ 'base' => NULL, 'refs' => [ 'DirectDeploySettings$Status' => '

Describes whether model deployment permissions are enabled or disabled in the Canvas application.

', 'DockerSettings$EnableDockerAccess' => '

Indicates whether the domain can access Docker.

', 'IdentityProviderOAuthSetting$Status' => '

Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

', 'KendraSettings$Status' => '

Describes whether the document querying feature is enabled or disabled in the Canvas application.

', 'ModelRegisterSettings$Status' => '

Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

', 'TimeSeriesForecastingSettings$Status' => '

Describes whether time series forecasting is enabled or disabled in the Canvas application.

', ], ], 'FeatureType' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$FeatureType' => '

The data type of the feature.

', 'FeatureDefinition$FeatureType' => '

The value type of a feature. Valid values are Integral, Fractional, or String.

', 'FeatureMetadata$FeatureType' => '

The data type of the feature.

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

Contains details regarding the file source.

', 'refs' => [ 'DriftCheckBias$ConfigFile' => '

The bias config file for a model.

', 'DriftCheckExplainability$ConfigFile' => '

The explainability config file for the model.

', ], ], 'FileSystemAccessMode' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemAccessMode' => '

The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

', ], ], 'FileSystemConfig' => [ 'base' => '

The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

', 'refs' => [ 'JupyterLabAppImageConfig$FileSystemConfig' => NULL, 'KernelGatewayImageConfig$FileSystemConfig' => '

The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

', ], ], 'FileSystemDataSource' => [ 'base' => '

Specifies a file system data source for a channel.

', 'refs' => [ 'DataSource$FileSystemDataSource' => '

The file system that is associated with a channel.

', ], ], 'FileSystemId' => [ 'base' => NULL, 'refs' => [ 'EFSFileSystem$FileSystemId' => '

The ID of your Amazon EFS file system.

', 'EFSFileSystemConfig$FileSystemId' => '

The ID of your Amazon EFS file system.

', 'FileSystemDataSource$FileSystemId' => '

The file system id.

', ], ], 'FileSystemPath' => [ 'base' => NULL, 'refs' => [ 'EFSFileSystemConfig$FileSystemPath' => '

The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

', ], ], 'FileSystemType' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemType' => '

The file system type.

', ], ], 'FillingTransformationMap' => [ 'base' => NULL, 'refs' => [ 'FillingTransformations$value' => NULL, ], ], 'FillingTransformationValue' => [ 'base' => NULL, 'refs' => [ 'FillingTransformationMap$value' => NULL, ], ], 'FillingTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Filling' => '

A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.

The supported filling methods and their corresponding options are:

  • frontfill: none (Supported only for target column)

  • middlefill: zero, value, median, mean, min, max

  • backfill: zero, value, median, mean, min, max

  • futurefill: zero, value, median, mean, min, max

To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example "backfill" : "value"), and define the filling value in an additional parameter prefixed with "_value". For example, to set backfill to a value of 2, you must include two parameters: "backfill": "value" and "backfill_value":"2".

', ], ], 'FillingType' => [ 'base' => NULL, 'refs' => [ 'FillingTransformationMap$key' => NULL, ], ], 'Filter' => [ 'base' => '

A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.

If you specify a Value, but not an Operator, SageMaker uses the equals operator.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form "Metrics.<name>", where <name> is a metric name. For example, the following filter searches for training jobs with an "accuracy" metric greater than "0.9":

{

"Name": "Metrics.accuracy",

"Operator": "GreaterThan",

"Value": "0.9"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form "HyperParameters.<name>". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a "learning_rate" hyperparameter that is less than "0.5":

{

"Name": "HyperParameters.learning_rate",

"Operator": "LessThan",

"Value": "0.5"

}

Tags

To define a tag filter, enter a value with the form Tags.<key>.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'NestedFilters$Filters' => '

A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

', 'SearchExpression$Filters' => '

A list of filter objects.

', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'Filter$Value' => '

A value used with Name and Operator to determine which resources satisfy the filter\'s condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd\'T\'HH:MM:SS.

', ], ], 'FinalAutoMLJobObjectiveMetric' => [ 'base' => '

The best candidate result from an AutoML training job.

', 'refs' => [ 'AutoMLCandidate$FinalAutoMLJobObjectiveMetric' => NULL, ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'base' => '

Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

', 'refs' => [ 'HyperParameterTrainingJobSummary$FinalHyperParameterTuningJobObjectiveMetric' => '

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

', ], ], 'FinalMetricDataList' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$FinalMetricDataList' => '

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

', 'TrainingJob$FinalMetricDataList' => '

A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

', ], ], 'FlatInvocations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$FlatInvocations' => '

Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.

', ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'MetricData$Value' => '

The value of the metric.

', 'MetricDatum$Value' => '

The value of the metric.

', 'RecommendationMetrics$CostPerHour' => '

Defines the cost per hour for the instance.

', 'RecommendationMetrics$CostPerInference' => '

Defines the cost per inference for the instance .

', ], ], 'FlowDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionResponse$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow definition you create.

', 'DescribeFlowDefinitionResponse$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow defintion.

', 'FlowDefinitionSummary$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow definition.

', ], ], 'FlowDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionRequest$FlowDefinitionName' => '

The name of your flow definition.

', 'DeleteFlowDefinitionRequest$FlowDefinitionName' => '

The name of the flow definition you are deleting.

', 'DescribeFlowDefinitionRequest$FlowDefinitionName' => '

The name of the flow definition.

', 'DescribeFlowDefinitionResponse$FlowDefinitionName' => '

The Amazon Resource Name (ARN) of the flow definition.

', 'FlowDefinitionSummary$FlowDefinitionName' => '

The name of the flow definition.

', ], ], 'FlowDefinitionOutputConfig' => [ 'base' => '

Contains information about where human output will be stored.

', 'refs' => [ 'CreateFlowDefinitionRequest$OutputConfig' => '

An object containing information about where the human review results will be uploaded.

', 'DescribeFlowDefinitionResponse$OutputConfig' => '

An object containing information about the output file.

', ], ], 'FlowDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowDefinitionResponse$FlowDefinitionStatus' => '

The status of the flow definition. Valid values are listed below.

', 'FlowDefinitionSummary$FlowDefinitionStatus' => '

The status of the flow definition. Valid values:

', ], ], 'FlowDefinitionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListFlowDefinitionsResponse$FlowDefinitionSummaries' => '

An array of objects describing the flow definitions.

', ], ], 'FlowDefinitionSummary' => [ 'base' => '

Contains summary information about the flow definition.

', 'refs' => [ 'FlowDefinitionSummaries$member' => NULL, ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskAvailabilityLifetimeInSeconds' => '

The length of time that a task remains available for review by human workers.

', ], ], 'FlowDefinitionTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskCount' => '

The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

', ], ], 'FlowDefinitionTaskDescription' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskDescription' => '

A description for the human worker task.

', ], ], 'FlowDefinitionTaskKeyword' => [ 'base' => NULL, 'refs' => [ 'FlowDefinitionTaskKeywords$member' => NULL, ], ], 'FlowDefinitionTaskKeywords' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskKeywords' => '

Keywords used to describe the task so that workers can discover the task.

', ], ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTimeLimitInSeconds' => '

The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

', ], ], 'FlowDefinitionTaskTitle' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTitle' => '

A title for the human worker task.

', ], ], 'ForecastFrequency' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastFrequency' => '

The frequency of predictions in a forecast.

Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, 1D indicates every day and 15min indicates every 15 minutes. The value of a frequency must not overlap with the next larger frequency. For example, you must use a frequency of 1H instead of 60min.

The valid values for each frequency are the following:

  • Minute - 1-59

  • Hour - 1-23

  • Day - 1-6

  • Week - 1-4

  • Month - 1-11

  • Year - 1

', ], ], 'ForecastHorizon' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastHorizon' => '

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.

', ], ], 'ForecastQuantile' => [ 'base' => NULL, 'refs' => [ 'ForecastQuantiles$member' => NULL, ], ], 'ForecastQuantiles' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastQuantiles' => '

The quantiles used to train the model for forecasts at a specified quantile. You can specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of 0.01 or higher. Up to five forecast quantiles can be specified. When ForecastQuantiles is not provided, the AutoML job uses the quantiles p10, p50, and p90 as default.

', ], ], 'Framework' => [ 'base' => NULL, 'refs' => [ 'InputConfig$Framework' => '

Identifies the framework in which the model was trained. For example: TENSORFLOW.

', ], ], 'FrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'InputConfig$FrameworkVersion' => '

Specifies the framework version to use. This API field is only supported for the MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.

For information about framework versions supported for cloud targets and edge devices, see Cloud Supported Instance Types and Frameworks and Edge Supported Frameworks.

', ], ], 'GenerateCandidateDefinitionsOnly' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$GenerateCandidateDefinitionsOnly' => '

Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

', 'DescribeAutoMLJobResponse$GenerateCandidateDefinitionsOnly' => '

Indicates whether the output for an AutoML job generates candidate definitions only.

', 'TabularJobConfig$GenerateCandidateDefinitionsOnly' => '

Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

', ], ], 'GetDeviceFleetReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDeviceFleetReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetScalingConfigurationRecommendationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetScalingConfigurationRecommendationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Gid' => [ 'base' => NULL, 'refs' => [ 'CustomPosixUserConfig$Gid' => '

The POSIX group ID.

', ], ], 'GitConfig' => [ 'base' => '

Specifies configuration details for a Git repository in your Amazon Web Services account.

', 'refs' => [ 'CodeRepositorySummary$GitConfig' => '

Configuration details for the Git repository, including the URL where it is located and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', 'CreateCodeRepositoryInput$GitConfig' => '

Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.

', 'DescribeCodeRepositoryOutput$GitConfig' => '

Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', ], ], 'GitConfigForUpdate' => [ 'base' => '

Specifies configuration details for a Git repository when the repository is updated.

', 'refs' => [ 'UpdateCodeRepositoryInput$GitConfig' => '

The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', ], ], 'GitConfigUrl' => [ 'base' => NULL, 'refs' => [ 'GitConfig$RepositoryUrl' => '

The URL where the Git repository is located.

', ], ], 'Group' => [ 'base' => NULL, 'refs' => [ 'Groups$member' => NULL, ], ], 'GroupingAttributeName' => [ 'base' => NULL, 'refs' => [ 'GroupingAttributeNames$member' => NULL, ], ], 'GroupingAttributeNames' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$GroupingAttributeNames' => '

A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.

', ], ], 'Groups' => [ 'base' => NULL, 'refs' => [ 'OidcMemberDefinition$Groups' => '

A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.

', ], ], 'HolidayConfig' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$HolidayConfig' => '

The collection of holiday featurization attributes used to incorporate national holiday information into your forecasting model.

', ], ], 'HolidayConfigAttributes' => [ 'base' => '

Stores the holiday featurization attributes applicable to each item of time-series datasets during the training of a forecasting model. This allows the model to identify patterns associated with specific holidays.

', 'refs' => [ 'HolidayConfig$member' => NULL, ], ], 'HookParameters' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$HookParameters' => '

Configuration information for the Amazon SageMaker Debugger hook parameters.

', ], ], 'Horovod' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Horovod' => '

Indicates Horovod compatibility.

', 'DescribeImageVersionResponse$Horovod' => '

Indicates Horovod compatibility.

', 'UpdateImageVersionRequest$Horovod' => '

Indicates Horovod compatibility.

', ], ], 'HubArn' => [ 'base' => NULL, 'refs' => [ 'CreateHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'DescribeHubContentResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub that contains the content.

', 'DescribeHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'HubInfo$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'ImportHubContentResponse$HubArn' => '

The ARN of the hub that the content was imported into.

', 'UpdateHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the updated hub.

', ], ], 'HubContentArn' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentArn' => '

The Amazon Resource Name (ARN) of the hub content.

', 'HubContentInfo$HubContentArn' => '

The Amazon Resource Name (ARN) of the hub content.

', 'ImportHubContentResponse$HubContentArn' => '

The ARN of the hub content that was imported.

', ], ], 'HubContentDependency' => [ 'base' => '

Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

', 'refs' => [ 'HubContentDependencyList$member' => NULL, ], ], 'HubContentDependencyList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDependencies' => '

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

', ], ], 'HubContentDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDescription' => '

A description of the hub content.

', 'HubContentInfo$HubContentDescription' => '

A description of the hub content.

', 'ImportHubContentRequest$HubContentDescription' => '

A description of the hub content to import.

', ], ], 'HubContentDisplayName' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDisplayName' => '

The display name of the hub content.

', 'HubContentInfo$HubContentDisplayName' => '

The display name of the hub content.

', 'ImportHubContentRequest$HubContentDisplayName' => '

The display name of the hub content to import.

', ], ], 'HubContentDocument' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDocument' => '

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

', 'ImportHubContentRequest$HubContentDocument' => '

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

', ], ], 'HubContentInfo' => [ 'base' => '

Information about hub content.

', 'refs' => [ 'HubContentInfoList$member' => NULL, ], ], 'HubContentInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsResponse$HubContentSummaries' => '

The summaries of the listed hub content versions.

', 'ListHubContentsResponse$HubContentSummaries' => '

The summaries of the listed hub content.

', ], ], 'HubContentMarkdown' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentMarkdown' => '

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

', 'ImportHubContentRequest$HubContentMarkdown' => '

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

', ], ], 'HubContentName' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentName' => '

The name of the content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentName' => '

The name of the content to describe.

', 'DescribeHubContentResponse$HubContentName' => '

The name of the hub content.

', 'HubContentInfo$HubContentName' => '

The name of the hub content.

', 'ImportHubContentRequest$HubContentName' => '

The name of the hub content to import.

', 'ListHubContentVersionsRequest$HubContentName' => '

The name of the hub content.

', ], ], 'HubContentSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentSearchKeywords' => '

The searchable keywords for the hub content.

', 'HubContentInfo$HubContentSearchKeywords' => '

The searchable keywords for the hub content.

', 'ImportHubContentRequest$HubContentSearchKeywords' => '

The searchable keywords of the hub content.

', ], ], 'HubContentSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsRequest$SortBy' => '

Sort hub content versions by either name or creation time.

', 'ListHubContentsRequest$SortBy' => '

Sort hub content versions by either name or creation time.

', ], ], 'HubContentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentStatus' => '

The status of the hub content.

', 'HubContentInfo$HubContentStatus' => '

The status of the hub content.

', ], ], 'HubContentType' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentType' => '

The type of content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentType' => '

The type of content in the hub.

', 'DescribeHubContentResponse$HubContentType' => '

The type of hub content.

', 'HubContentInfo$HubContentType' => '

The type of hub content.

', 'ImportHubContentRequest$HubContentType' => '

The type of hub content to import.

', 'ListHubContentVersionsRequest$HubContentType' => '

The type of hub content to list versions of.

', 'ListHubContentsRequest$HubContentType' => '

The type of hub content to list.

', ], ], 'HubContentVersion' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentVersion' => '

The version of the content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentVersion' => '

The version of the content to describe.

', 'DescribeHubContentResponse$HubContentVersion' => '

The version of the hub content.

', 'HubContentInfo$HubContentVersion' => '

The version of the hub content.

', 'ImportHubContentRequest$HubContentVersion' => '

The version of the hub content to import.

', 'ListHubContentVersionsRequest$MinVersion' => '

The lower bound of the hub content versions to list.

', ], ], 'HubDescription' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDescription' => '

A description of the hub.

', 'DescribeHubResponse$HubDescription' => '

A description of the hub.

', 'HubInfo$HubDescription' => '

A description of the hub.

', 'UpdateHubRequest$HubDescription' => '

A description of the updated hub.

', ], ], 'HubDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDisplayName' => '

The display name of the hub.

', 'DescribeHubResponse$HubDisplayName' => '

The display name of the hub.

', 'HubInfo$HubDisplayName' => '

The display name of the hub.

', 'UpdateHubRequest$HubDisplayName' => '

The display name of the hub.

', ], ], 'HubInfo' => [ 'base' => '

Information about a hub.

', 'refs' => [ 'HubInfoList$member' => NULL, ], ], 'HubInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubsResponse$HubSummaries' => '

The summaries of the listed hubs.

', ], ], 'HubName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubName' => '

The name of the hub to create.

', 'DeleteHubContentRequest$HubName' => '

The name of the hub that you want to delete content in.

', 'DeleteHubRequest$HubName' => '

The name of the hub to delete.

', 'DescribeHubContentRequest$HubName' => '

The name of the hub that contains the content to describe.

', 'DescribeHubContentResponse$HubName' => '

The name of the hub that contains the content.

', 'DescribeHubRequest$HubName' => '

The name of the hub to describe.

', 'DescribeHubResponse$HubName' => '

The name of the hub.

', 'HubInfo$HubName' => '

The name of the hub.

', 'ImportHubContentRequest$HubName' => '

The name of the hub to import content into.

', 'ListHubContentVersionsRequest$HubName' => '

The name of the hub to list the content versions of.

', 'ListHubContentsRequest$HubName' => '

The name of the hub to list the contents of.

', 'UpdateHubRequest$HubName' => '

The name of the hub to update.

', ], ], 'HubS3StorageConfig' => [ 'base' => '

The Amazon S3 storage configuration of a hub.

', 'refs' => [ 'CreateHubRequest$S3StorageConfig' => '

The Amazon S3 storage configuration for the hub.

', 'DescribeHubResponse$S3StorageConfig' => '

The Amazon S3 storage configuration for the hub.

', ], ], 'HubSearchKeyword' => [ 'base' => NULL, 'refs' => [ 'HubContentSearchKeywordList$member' => NULL, 'HubSearchKeywordList$member' => NULL, ], ], 'HubSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'DescribeHubResponse$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'HubInfo$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'UpdateHubRequest$HubSearchKeywords' => '

The searchable keywords for the hub.

', ], ], 'HubSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubsRequest$SortBy' => '

Sort hubs by either name or creation time.

', ], ], 'HubStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubResponse$HubStatus' => '

The status of the hub.

', 'HubInfo$HubStatus' => '

The status of the hub.

', ], ], 'HumanLoopActivationConditions' => [ 'base' => NULL, 'refs' => [ 'HumanLoopActivationConditionsConfig$HumanLoopActivationConditions' => '

JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.

', ], ], 'HumanLoopActivationConditionsConfig' => [ 'base' => '

Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.

', 'refs' => [ 'HumanLoopActivationConfig$HumanLoopActivationConditionsConfig' => '

Container structure for defining under what conditions SageMaker creates a human loop.

', ], ], 'HumanLoopActivationConfig' => [ 'base' => '

Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopActivationConfig' => '

An object containing information about the events that trigger a human workflow.

', 'DescribeFlowDefinitionResponse$HumanLoopActivationConfig' => '

An object containing information about what triggers a human review workflow.

', ], ], 'HumanLoopConfig' => [ 'base' => '

Describes the work to be performed by human workers.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopConfig' => '

An object containing information about the tasks the human reviewers will perform.

', 'DescribeFlowDefinitionResponse$HumanLoopConfig' => '

An object containing information about who works on the task, the workforce task price, and other task details.

', ], ], 'HumanLoopRequestSource' => [ 'base' => '

Container for configuring the source of human task requests.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopRequestSource' => '

Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

', 'DescribeFlowDefinitionResponse$HumanLoopRequestSource' => '

Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

', ], ], 'HumanTaskConfig' => [ 'base' => '

Information required for human workers to complete a labeling task.

', 'refs' => [ 'CreateLabelingJobRequest$HumanTaskConfig' => '

Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

', 'DescribeLabelingJobResponse$HumanTaskConfig' => '

Configuration information required for human workers to complete a labeling task.

', ], ], 'HumanTaskUiArn' => [ 'base' => NULL, 'refs' => [ 'CreateHumanTaskUiResponse$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human review workflow user interface you create.

', 'DescribeHumanTaskUiResponse$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

', 'HumanLoopConfig$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface.

You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

To learn how to create a custom HTML template, see Create Custom Worker Task Template.

To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

', 'HumanTaskUiSummary$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface.

', 'RenderUiTemplateRequest$HumanTaskUiArn' => '

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

', 'UiConfig$HumanTaskUiArn' => '

The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).

Named Entity Recognition

Use the following HumanTaskUiArn for named entity recognition labeling jobs:

arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition

3D Point Cloud HumanTaskUiArns

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation

Video Frame HumanTaskUiArns

Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.

  • arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection

Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking

', ], ], 'HumanTaskUiName' => [ 'base' => NULL, 'refs' => [ 'CreateHumanTaskUiRequest$HumanTaskUiName' => '

The name of the user interface you are creating.

', 'DeleteHumanTaskUiRequest$HumanTaskUiName' => '

The name of the human task user interface (work task template) you want to delete.

', 'DescribeHumanTaskUiRequest$HumanTaskUiName' => '

The name of the human task user interface (worker task template) you want information about.

', 'DescribeHumanTaskUiResponse$HumanTaskUiName' => '

The name of the human task user interface (worker task template).

', 'HumanTaskUiSummary$HumanTaskUiName' => '

The name of the human task user interface.

', ], ], 'HumanTaskUiStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHumanTaskUiResponse$HumanTaskUiStatus' => '

The status of the human task user interface (worker task template). Valid values are listed below.

', ], ], 'HumanTaskUiSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHumanTaskUisResponse$HumanTaskUiSummaries' => '

An array of objects describing the human task user interfaces.

', ], ], 'HumanTaskUiSummary' => [ 'base' => '

Container for human task user interface information.

', 'refs' => [ 'HumanTaskUiSummaries$member' => NULL, ], ], 'HyperParameterAlgorithmSpecification' => [ 'base' => '

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$AlgorithmSpecification' => '

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

', ], ], 'HyperParameterKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameters$key' => NULL, ], ], 'HyperParameterScalingType' => [ 'base' => NULL, 'refs' => [ 'ContinuousParameterRange$ScalingType' => '

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

', 'IntegerParameterRange$ScalingType' => '

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

', ], ], 'HyperParameterSpecification' => [ 'base' => '

Defines a hyperparameter to be used by an algorithm.

', 'refs' => [ 'HyperParameterSpecifications$member' => NULL, ], ], 'HyperParameterSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedHyperParameters' => '

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

', ], ], 'HyperParameterTrainingJobDefinition' => [ 'base' => '

Defines the training jobs launched by a hyperparameter tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinition' => '

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinition' => '

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

', 'HyperParameterTrainingJobDefinitions$member' => NULL, 'HyperParameterTuningJobSearchEntity$TrainingJobDefinition' => NULL, ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$DefinitionName' => '

The job definition name.

', 'HyperParameterTrainingJobSummary$TrainingJobDefinitionName' => '

The training job definition name.

', ], ], 'HyperParameterTrainingJobDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinitions' => '

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions' => '

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

', 'HyperParameterTuningJobSearchEntity$TrainingJobDefinitions' => '

The job definitions included in a hyperparameter tuning job.

', ], ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobEnvironmentMap$key' => NULL, ], ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$Environment' => '

An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.

The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can\'t exceed the maximum number specified.

', ], ], 'HyperParameterTrainingJobEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobEnvironmentMap$value' => NULL, ], ], 'HyperParameterTrainingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsForHyperParameterTuningJobResponse$TrainingJobSummaries' => '

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

', ], ], 'HyperParameterTrainingJobSummary' => [ 'base' => '

The container for the summary information about a training job.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$BestTrainingJob' => '

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

', 'DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob' => '

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

', 'HyperParameterTrainingJobSummaries$member' => NULL, 'HyperParameterTuningJobSearchEntity$BestTrainingJob' => NULL, 'HyperParameterTuningJobSearchEntity$OverallBestTrainingJob' => NULL, ], ], 'HyperParameterTuningAllocationStrategy' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningResourceConfig$AllocationStrategy' => '

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

', ], ], 'HyperParameterTuningInstanceConfig' => [ 'base' => '

The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).

', 'refs' => [ 'HyperParameterTuningInstanceConfigs$member' => NULL, ], ], 'HyperParameterTuningInstanceConfigs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningResourceConfig$InstanceConfigs' => '

A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.

If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.

', ], ], 'HyperParameterTuningJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobResponse$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job.

', 'DescribeTrainingJobResponse$TuningJobArn' => '

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job.

', 'TrainingJob$TuningJobArn' => '

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

', 'TuningJobStepMetaData$Arn' => '

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

', ], ], 'HyperParameterTuningJobCompletionDetails' => [ 'base' => '

A structure that contains runtime information about both current and completed hyperparameter tuning jobs.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TuningJobCompletionDetails' => '

Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

', 'HyperParameterTuningJobSearchEntity$TuningJobCompletionDetails' => '

Information about either a current or completed hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobConfig' => [ 'base' => '

Configures a hyperparameter tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobConfig' => '

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig' => '

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobConfig' => NULL, ], ], 'HyperParameterTuningJobConsumedResources' => [ 'base' => '

The total resources consumed by your hyperparameter tuning job.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ConsumedResources' => NULL, 'HyperParameterTuningJobSearchEntity$ConsumedResources' => '

The total amount of resources consumed by a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobName' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

', 'DescribeHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobName' => '

The name of the hyperparameter tuning job.

', 'HyperParameterTrainingJobSummary$TuningJobName' => '

The HyperParameter tuning job that launched the training job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobName' => '

The name of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobName' => '

The name of the tuning job.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job whose training jobs you want to list.

', 'ParentHyperParameterTuningJob$HyperParameterTuningJobName' => '

The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

', 'StopHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job to stop.

', ], ], 'HyperParameterTuningJobObjective' => [ 'base' => '

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$TuningObjective' => NULL, 'HyperParameterTuningJobConfig$HyperParameterTuningJobObjective' => '

The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.

', 'HyperParameterTuningJobObjectives$member' => NULL, ], ], 'HyperParameterTuningJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalHyperParameterTuningJobObjectiveMetric$Type' => '

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

', 'HyperParameterTuningJobObjective$Type' => '

Whether to minimize or maximize the objective metric.

', ], ], 'HyperParameterTuningJobObjectives' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedTuningJobObjectiveMetrics' => '

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'base' => '

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

', 'refs' => [ 'SearchRecord$HyperParameterTuningJob' => '

The properties of a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsRequest$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'HyperParameterTuningJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobStatus' => '

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobStatus' => '

The status of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobStatus' => '

The status of the tuning job.

', 'ListHyperParameterTuningJobsRequest$StatusEquals' => '

A filter that returns only tuning jobs with the specified status.

', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'base' => '

The configuration for a training job launched by a hyperparameter tuning job. Choose Bayesian for Bayesian optimization, and Random for random search optimization. For more advanced use cases, use Hyperband, which evaluates objective metrics for training jobs after every epoch. For more information about strategies, see How Hyperparameter Tuning Works.

', 'refs' => [ 'HyperParameterTuningJobConfig$StrategyConfig' => '

The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.

', ], ], 'HyperParameterTuningJobStrategyType' => [ 'base' => '

The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model.

', 'refs' => [ 'HyperParameterTuningJobConfig$Strategy' => '

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

', 'HyperParameterTuningJobSummary$Strategy' => '

Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

', ], ], 'HyperParameterTuningJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsResponse$HyperParameterTuningJobSummaries' => '

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

', ], ], 'HyperParameterTuningJobSummary' => [ 'base' => '

Provides summary information about a hyperparameter tuning job.

', 'refs' => [ 'HyperParameterTuningJobSummaries$member' => NULL, ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'base' => '

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$WarmStartConfig' => '

Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

', 'DescribeHyperParameterTuningJobResponse$WarmStartConfig' => '

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

', 'HyperParameterTuningJobSearchEntity$WarmStartConfig' => NULL, ], ], 'HyperParameterTuningJobWarmStartType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$WarmStartType' => '

Specifies one of the following:

IDENTICAL_DATA_AND_ALGORITHM

The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

TRANSFER_LEARNING

The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

', ], ], 'HyperParameterTuningMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxRuntimeInSeconds' => '

The maximum time in seconds that a hyperparameter tuning job can run.

', ], ], 'HyperParameterTuningResourceConfig' => [ 'base' => '

The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. HyperParameterTuningResourceConfig is similar to ResourceConfig, but has the additional InstanceConfigs and AllocationStrategy fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.

HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig with the exception of KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$HyperParameterTuningResourceConfig' => '

The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).

', ], ], 'HyperParameterValue' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$DefaultValue' => '

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

', 'HyperParameters$value' => NULL, ], ], 'HyperParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$HyperParameters' => '

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

', 'DescribeTrainingJobResponse$HyperParameters' => '

Algorithm-specific parameters.

', 'HyperParameterTrainingJobDefinition$StaticHyperParameters' => '

Specifies the values of hyperparameters that do not change for the tuning job.

', 'HyperParameterTrainingJobSummary$TunedHyperParameters' => '

A list of the hyperparameters for which you specified ranges to search.

', 'TrainingJob$HyperParameters' => '

Algorithm-specific parameters.

', 'TrainingJobDefinition$HyperParameters' => '

The hyperparameters used for the training job.

', ], ], 'HyperbandStrategyConfig' => [ 'base' => '

The configuration for Hyperband, a multi-fidelity based hyperparameter tuning strategy. Hyperband uses the final and intermediate results of a training job to dynamically allocate resources to utilized hyperparameter configurations while automatically stopping under-performing configurations. This parameter should be provided only if Hyperband is selected as the StrategyConfig under the HyperParameterTuningJobConfig API.

', 'refs' => [ 'HyperParameterTuningJobStrategyConfig$HyperbandStrategyConfig' => '

The configuration for the object that specifies the Hyperband strategy. This parameter is only supported for the Hyperband selection for Strategy within the HyperParameterTuningJobConfig API.

', ], ], 'HyperbandStrategyMaxResource' => [ 'base' => NULL, 'refs' => [ 'HyperbandStrategyConfig$MaxResource' => '

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTrainingJ attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:

  • epochs

  • numepochs

  • n-epochs

  • n_epochs

  • num_epochs

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributive training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

', ], ], 'HyperbandStrategyMinResource' => [ 'base' => NULL, 'refs' => [ 'HyperbandStrategyConfig$MinResource' => '

The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job is not stopped by Hyperband.

', ], ], 'IamIdentity' => [ 'base' => '

The IAM Identity details associated with the user. These details are associated with model package groups, model packages and project entities only.

', 'refs' => [ 'UserContext$IamIdentity' => '

The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

', ], ], 'IdempotencyToken' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'DeletePipelineRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'RetryPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', 'SendPipelineExecutionStepFailureRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'SendPipelineExecutionStepSuccessRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'StartPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', 'StopPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', ], ], 'IdentityProviderOAuthSetting' => [ 'base' => '

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

', 'refs' => [ 'IdentityProviderOAuthSettings$member' => NULL, ], ], 'IdentityProviderOAuthSettings' => [ 'base' => NULL, 'refs' => [ 'CanvasAppSettings$IdentityProviderOAuthSettings' => '

The settings for connecting to an external data source with OAuth.

', ], ], 'Image' => [ 'base' => '

A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.

', 'refs' => [ 'Images$member' => NULL, ], ], 'ImageArn' => [ 'base' => NULL, 'refs' => [ 'CreateImageResponse$ImageArn' => '

The ARN of the image.

', 'DescribeImageResponse$ImageArn' => '

The ARN of the image.

', 'DescribeImageVersionResponse$ImageArn' => '

The ARN of the image the version is based on.

', 'Image$ImageArn' => '

The ARN of the image.

', 'ImageVersion$ImageArn' => '

The ARN of the image the version is based on.

', 'ResourceSpec$SageMakerImageArn' => '

The ARN of the SageMaker image that the image version belongs to.

', 'UpdateImageResponse$ImageArn' => '

The ARN of the image.

', ], ], 'ImageBaseImage' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$BaseImage' => '

The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

', 'DescribeImageVersionResponse$BaseImage' => '

The registry path of the container image on which this image version is based.

', ], ], 'ImageClassificationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the image classification problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$ImageClassificationJobConfig' => '

Settings used to configure an AutoML job V2 for the image classification problem type.

', ], ], 'ImageConfig' => [ 'base' => '

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).

', 'refs' => [ 'ContainerDefinition$ImageConfig' => '

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

', ], ], 'ImageContainerImage' => [ 'base' => NULL, 'refs' => [ 'DescribeImageVersionResponse$ContainerImage' => '

The registry path of the container image that contains this image version.

', ], ], 'ImageDeleteProperty' => [ 'base' => NULL, 'refs' => [ 'ImageDeletePropertyList$member' => NULL, ], ], 'ImageDeletePropertyList' => [ 'base' => NULL, 'refs' => [ 'UpdateImageRequest$DeleteProperties' => '

A list of properties to delete. Only the Description and DisplayName properties can be deleted.

', ], ], 'ImageDescription' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$Description' => '

The description of the image.

', 'DescribeImageResponse$Description' => '

The description of the image.

', 'Image$Description' => '

The description of the image.

', 'UpdateImageRequest$Description' => '

The new description for the image.

', ], ], 'ImageDigest' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$ImageDigest' => '

An MD5 hash of the training algorithm that identifies the Docker image used for training.

', 'TrainingSpecification$TrainingImageDigest' => '

An MD5 hash of the training algorithm that identifies the Docker image used for training.

', ], ], 'ImageDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$DisplayName' => '

The display name of the image. If not provided, ImageName is displayed.

', 'DescribeImageResponse$DisplayName' => '

The name of the image as displayed.

', 'Image$DisplayName' => '

The name of the image as displayed.

', 'UpdateImageRequest$DisplayName' => '

The new display name for the image.

', ], ], 'ImageName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$ImageName' => '

The name of the image. Must be unique to your account.

', 'CreateImageVersionRequest$ImageName' => '

The ImageName of the Image to create a version of.

', 'CustomImage$ImageName' => '

The name of the CustomImage. Must be unique to your account.

', 'DeleteImageRequest$ImageName' => '

The name of the image to delete.

', 'DeleteImageVersionRequest$ImageName' => '

The name of the image to delete.

', 'DescribeImageRequest$ImageName' => '

The name of the image to describe.

', 'DescribeImageResponse$ImageName' => '

The name of the image.

', 'DescribeImageVersionRequest$ImageName' => '

The name of the image.

', 'Image$ImageName' => '

The name of the image.

', 'ListAliasesRequest$ImageName' => '

The name of the image.

', 'ListImageVersionsRequest$ImageName' => '

The name of the image to list the versions of.

', 'UpdateImageRequest$ImageName' => '

The name of the image to update.

', 'UpdateImageVersionRequest$ImageName' => '

The name of the image.

', ], ], 'ImageNameContains' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$NameContains' => '

A filter that returns only images whose name contains the specified string.

', ], ], 'ImageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$SortBy' => '

The property used to sort results. The default value is CREATION_TIME.

', ], ], 'ImageSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$SortOrder' => '

The sort order. The default value is DESCENDING.

', ], ], 'ImageStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeImageResponse$ImageStatus' => '

The status of the image.

', 'Image$ImageStatus' => '

The status of the image.

', ], ], 'ImageUri' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ImageUri' => '

The container image to be run by the processing job.

', 'DataQualityAppSpecification$ImageUri' => '

The container image that the data quality monitoring job runs.

', 'ModelBiasAppSpecification$ImageUri' => '

The container image to be run by the model bias job.

', 'ModelExplainabilityAppSpecification$ImageUri' => '

The container image to be run by the model explainability job.

', 'ModelQualityAppSpecification$ImageUri' => '

The address of the container image that the monitoring job runs.

', 'MonitoringAppSpecification$ImageUri' => '

The container image to be run by the monitoring job.

', ], ], 'ImageVersion' => [ 'base' => '

A version of a SageMaker Image. A version represents an existing container image.

', 'refs' => [ 'ImageVersions$member' => NULL, ], ], 'ImageVersionAlias' => [ 'base' => NULL, 'refs' => [ 'ResourceSpec$SageMakerImageVersionAlias' => '

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

', ], ], 'ImageVersionArn' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionResponse$ImageVersionArn' => '

The ARN of the image version.

', 'DescribeImageVersionResponse$ImageVersionArn' => '

The ARN of the version.

', 'ImageVersion$ImageVersionArn' => '

The ARN of the version.

', 'ResourceSpec$SageMakerImageVersionArn' => '

The ARN of the image version created on the instance.

', 'UpdateImageVersionResponse$ImageVersionArn' => '

The ARN of the image version.

', ], ], 'ImageVersionNumber' => [ 'base' => NULL, 'refs' => [ 'CustomImage$ImageVersionNumber' => '

The version number of the CustomImage.

', 'DeleteImageVersionRequest$Version' => '

The version to delete.

', 'DescribeImageVersionRequest$Version' => '

The version of the image. If not specified, the latest version is described.

', 'DescribeImageVersionResponse$Version' => '

The version number.

', 'ImageVersion$Version' => '

The version number.

', 'ListAliasesRequest$Version' => '

The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

', 'UpdateImageVersionRequest$Version' => '

The version of the image.

', ], ], 'ImageVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsRequest$SortBy' => '

The property used to sort results. The default value is CREATION_TIME.

', ], ], 'ImageVersionSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsRequest$SortOrder' => '

The sort order. The default value is DESCENDING.

', ], ], 'ImageVersionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeImageVersionResponse$ImageVersionStatus' => '

The status of the version.

', 'ImageVersion$ImageVersionStatus' => '

The status of the version.

', ], ], 'ImageVersions' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsResponse$ImageVersions' => '

A list of versions and their properties.

', ], ], 'Images' => [ 'base' => NULL, 'refs' => [ 'ListImagesResponse$Images' => '

A list of images and their properties.

', ], ], 'ImportHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'InferenceComponentArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'DescribeInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'InferenceComponentSummary$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'UpdateInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'UpdateInferenceComponentRuntimeConfigOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', ], ], 'InferenceComponentComputeResourceRequirements' => [ 'base' => '

Defines the compute resources to allocate to run a model that you assign to an inference component. These resources include CPU cores, accelerators, and memory.

', 'refs' => [ 'InferenceComponentSpecification$ComputeResourceRequirements' => '

The compute resources allocated to run the model assigned to the inference component.

', 'InferenceComponentSpecificationSummary$ComputeResourceRequirements' => '

The compute resources allocated to run the model assigned to the inference component.

', ], ], 'InferenceComponentContainerSpecification' => [ 'base' => '

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

', 'refs' => [ 'InferenceComponentSpecification$Container' => '

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

', ], ], 'InferenceComponentContainerSpecificationSummary' => [ 'base' => '

Details about the resources that are deployed with this inference component.

', 'refs' => [ 'InferenceComponentSpecificationSummary$Container' => '

Details about the container that provides the runtime environment for the model that is deployed with the inference component.

', ], ], 'InferenceComponentCopyCount' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentRuntimeConfig$CopyCount' => '

The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.

', 'InferenceComponentRuntimeConfigSummary$DesiredCopyCount' => '

The number of runtime copies of the model container that you requested to deploy with the inference component.

', 'InferenceComponentRuntimeConfigSummary$CurrentCopyCount' => '

The number of runtime copies of the model container that are currently deployed.

', ], ], 'InferenceComponentName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentInput$InferenceComponentName' => '

A unique name to assign to the inference component.

', 'DeleteInferenceComponentInput$InferenceComponentName' => '

The name of the inference component to delete.

', 'DescribeInferenceComponentInput$InferenceComponentName' => '

The name of the inference component.

', 'DescribeInferenceComponentOutput$InferenceComponentName' => '

The name of the inference component.

', 'InferenceComponentSummary$InferenceComponentName' => '

The name of the inference component.

', 'UpdateInferenceComponentInput$InferenceComponentName' => '

The name of the inference component.

', 'UpdateInferenceComponentRuntimeConfigInput$InferenceComponentName' => '

The name of the inference component to update.

', ], ], 'InferenceComponentNameContains' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsInput$NameContains' => '

Filters the results to only those inference components with a name that contains the specified string.

', ], ], 'InferenceComponentRuntimeConfig' => [ 'base' => '

Runtime settings for a model that is deployed with an inference component.

', 'refs' => [ 'CreateInferenceComponentInput$RuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceComponentInput$RuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceComponentRuntimeConfigInput$DesiredRuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', ], ], 'InferenceComponentRuntimeConfigSummary' => [ 'base' => '

Details about the runtime settings for the model that is deployed with the inference component.

', 'refs' => [ 'DescribeInferenceComponentOutput$RuntimeConfig' => '

Details about the runtime settings for the model that is deployed with the inference component.

', ], ], 'InferenceComponentSortKey' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsInput$SortBy' => '

The field by which to sort the inference components in the response. The default is CreationTime.

', ], ], 'InferenceComponentSpecification' => [ 'base' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', 'refs' => [ 'CreateInferenceComponentInput$Specification' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', 'UpdateInferenceComponentInput$Specification' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', ], ], 'InferenceComponentSpecificationSummary' => [ 'base' => '

Details about the resources that are deployed with this inference component.

', 'refs' => [ 'DescribeInferenceComponentOutput$Specification' => '

Details about the resources that are deployed with this inference component.

', ], ], 'InferenceComponentStartupParameters' => [ 'base' => '

Settings that take effect while the model container starts up.

', 'refs' => [ 'InferenceComponentSpecification$StartupParameters' => '

Settings that take effect while the model container starts up.

', 'InferenceComponentSpecificationSummary$StartupParameters' => '

Settings that take effect while the model container starts up.

', ], ], 'InferenceComponentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceComponentOutput$InferenceComponentStatus' => '

The status of the inference component.

', 'InferenceComponentSummary$InferenceComponentStatus' => '

The status of the inference component.

', 'ListInferenceComponentsInput$StatusEquals' => '

Filters the results to only those inference components with the specified status.

', ], ], 'InferenceComponentSummary' => [ 'base' => '

A summary of the properties of an inference component.

', 'refs' => [ 'InferenceComponentSummaryList$member' => NULL, ], ], 'InferenceComponentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsOutput$InferenceComponents' => '

A list of inference components and their properties that matches any of the filters you specified in the request.

', ], ], 'InferenceExecutionConfig' => [ 'base' => '

Specifies details about how containers in a multi-container endpoint are run.

', 'refs' => [ 'CreateModelInput$InferenceExecutionConfig' => '

Specifies details of how containers in a multi-container endpoint are called.

', 'DescribeModelOutput$InferenceExecutionConfig' => '

Specifies details of how containers in a multi-container endpoint are called.

', 'Model$InferenceExecutionConfig' => NULL, ], ], 'InferenceExecutionMode' => [ 'base' => NULL, 'refs' => [ 'InferenceExecutionConfig$Mode' => '

How containers in a multi-container are run. The following values are valid.

  • SERIAL - Containers run as a serial pipeline.

  • DIRECT - Only the individual container that you specify is run.

', ], ], 'InferenceExperimentArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN for your inference experiment.

', 'DeleteInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the deleted inference experiment.

', 'DescribeInferenceExperimentResponse$Arn' => '

The ARN of the inference experiment being described.

', 'StartInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the started inference experiment to start.

', 'StopInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the stopped inference experiment.

', 'UpdateInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the updated inference experiment.

', ], ], 'InferenceExperimentDataStorageConfig' => [ 'base' => '

The Amazon S3 location and configuration for storing inference request and response data.

', 'refs' => [ 'CreateInferenceExperimentRequest$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

This is an optional parameter that you can use for data capture. For more information, see Capture data.

', 'DescribeInferenceExperimentResponse$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

', 'UpdateInferenceExperimentRequest$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

', ], ], 'InferenceExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Description' => '

A description for the inference experiment.

', 'DescribeInferenceExperimentResponse$Description' => '

The description of the inference experiment.

', 'InferenceExperimentSummary$Description' => '

The description of the inference experiment.

', 'UpdateInferenceExperimentRequest$Description' => '

The description of the inference experiment.

', ], ], 'InferenceExperimentList' => [ 'base' => NULL, 'refs' => [ 'ListInferenceExperimentsResponse$InferenceExperiments' => '

List of inference experiments.

', ], ], 'InferenceExperimentName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Name' => '

The name for the inference experiment.

', 'DeleteInferenceExperimentRequest$Name' => '

The name of the inference experiment you want to delete.

', 'DescribeInferenceExperimentRequest$Name' => '

The name of the inference experiment to describe.

', 'DescribeInferenceExperimentResponse$Name' => '

The name of the inference experiment.

', 'InferenceExperimentSummary$Name' => '

The name of the inference experiment.

', 'StartInferenceExperimentRequest$Name' => '

The name of the inference experiment to start.

', 'StopInferenceExperimentRequest$Name' => '

The name of the inference experiment to stop.

', 'UpdateInferenceExperimentRequest$Name' => '

The name of the inference experiment to be updated.

', ], ], 'InferenceExperimentSchedule' => [ 'base' => '

The start and end times of an inference experiment.

The maximum duration that you can set for an inference experiment is 30 days.

', 'refs' => [ 'CreateInferenceExperimentRequest$Schedule' => '

The duration for which you want the inference experiment to run. If you don\'t specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.

', 'DescribeInferenceExperimentResponse$Schedule' => '

The duration for which the inference experiment ran or will run.

', 'InferenceExperimentSummary$Schedule' => '

The duration for which the inference experiment ran or will run.

The maximum duration that you can set for an inference experiment is 30 days.

', 'UpdateInferenceExperimentRequest$Schedule' => '

The duration for which the inference experiment will run. If the status of the inference experiment is Created, then you can update both the start and end dates. If the status of the inference experiment is Running, then you can update only the end date.

', ], ], 'InferenceExperimentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$Status' => '

The status of the inference experiment. The following are the possible statuses for an inference experiment:

  • Creating - Amazon SageMaker is creating your experiment.

  • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

  • Updating - When you make changes to your experiment, your experiment shows as updating.

  • Starting - Amazon SageMaker is beginning your experiment.

  • Running - Your experiment is in progress.

  • Stopping - Amazon SageMaker is stopping your experiment.

  • Completed - Your experiment has completed.

  • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

', 'InferenceExperimentSummary$Status' => '

The status of the inference experiment.

', 'ListInferenceExperimentsRequest$StatusEquals' => '

Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.

', ], ], 'InferenceExperimentStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$StatusReason' => '

The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

', 'InferenceExperimentSummary$StatusReason' => '

The error message for the inference experiment status result.

', 'StopInferenceExperimentRequest$Reason' => '

The reason for stopping the experiment.

', ], ], 'InferenceExperimentStopDesiredState' => [ 'base' => NULL, 'refs' => [ 'StopInferenceExperimentRequest$DesiredState' => '

The desired state of the experiment after stopping. The possible states are the following:

  • Completed: The experiment completed successfully

  • Cancelled: The experiment was canceled

', ], ], 'InferenceExperimentSummary' => [ 'base' => '

Lists a summary of properties of an inference experiment.

', 'refs' => [ 'InferenceExperimentList$member' => NULL, ], ], 'InferenceExperimentType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Type' => '

The type of the inference experiment that you want to run. The following types of experiments are possible:

  • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

', 'DescribeInferenceExperimentResponse$Type' => '

The type of the inference experiment.

', 'InferenceExperimentSummary$Type' => '

The type of the inference experiment.

', 'ListInferenceExperimentsRequest$Type' => '

Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.

', ], ], 'InferenceImage' => [ 'base' => NULL, 'refs' => [ 'DescribeCompilationJobResponse$InferenceImage' => '

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

', ], ], 'InferenceMetrics' => [ 'base' => '

The metrics for an existing endpoint compared in an Inference Recommender job.

', 'refs' => [ 'EndpointPerformance$Metrics' => '

The metrics for an existing endpoint.

', 'RecommendationJobInferenceBenchmark$EndpointMetrics' => NULL, ], ], 'InferenceRecommendation' => [ 'base' => '

A list of recommendations made by Amazon SageMaker Inference Recommender.

', 'refs' => [ 'InferenceRecommendations$member' => NULL, ], ], 'InferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$InferenceRecommendations' => '

The recommendations made by Inference Recommender.

', ], ], 'InferenceRecommendationsJob' => [ 'base' => '

A structure that contains a list of recommendation jobs.

', 'refs' => [ 'InferenceRecommendationsJobs$member' => NULL, ], ], 'InferenceRecommendationsJobStep' => [ 'base' => '

A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.

', 'refs' => [ 'InferenceRecommendationsJobSteps$member' => NULL, ], ], 'InferenceRecommendationsJobSteps' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobStepsResponse$Steps' => '

A list of all subtask details in Inference Recommender.

', ], ], 'InferenceRecommendationsJobs' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsResponse$InferenceRecommendationsJobs' => '

The recommendations created from the Amazon SageMaker Inference Recommender job.

', ], ], 'InferenceSpecification' => [ 'base' => '

Defines how to perform inference generation after a training job is run.

', 'refs' => [ 'BatchDescribeModelPackageSummary$InferenceSpecification' => NULL, 'CreateAlgorithmInput$InferenceSpecification' => '

Specifies details about inference jobs that the algorithm runs, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the algorithm supports for inference.

', 'CreateModelPackageInput$InferenceSpecification' => '

Specifies details about inference jobs that can be run with models based on this model package, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

', 'DescribeAlgorithmOutput$InferenceSpecification' => '

Details about inference jobs that the algorithm runs.

', 'DescribeModelPackageOutput$InferenceSpecification' => '

Details about inference jobs that can be run with models based on this model package.

', 'ModelPackage$InferenceSpecification' => '

Defines how to perform inference generation after a training job is run.

', ], ], 'InferenceSpecificationName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$InferenceSpecificationName' => '

The inference specification name in the model package version.

', 'EndpointInputConfiguration$InferenceSpecificationName' => '

The inference specification name in the model package version.

', 'ModelConfiguration$InferenceSpecificationName' => '

The inference specification name in the model package version.

', ], ], 'InfraCheckConfig' => [ 'base' => '

Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network connectivity.

', 'refs' => [ 'CreateTrainingJobRequest$InfraCheckConfig' => '

Contains information about the infrastructure health check configuration for the training job.

', 'DescribeTrainingJobResponse$InfraCheckConfig' => '

Contains information about the infrastructure health check configuration for the training job.

', ], ], 'InitialInstanceCount' => [ 'base' => NULL, 'refs' => [ 'EndpointOutputConfiguration$InitialInstanceCount' => '

The number of instances recommended to launch initially.

', ], ], 'InitialNumberOfUsers' => [ 'base' => NULL, 'refs' => [ 'Phase$InitialNumberOfUsers' => '

Specifies how many concurrent users to start with. The value should be between 1 and 3.

', ], ], 'InitialTaskCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$InitialInstanceCount' => '

Number of instances to launch initially.

', ], ], 'InputConfig' => [ 'base' => '

Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', 'refs' => [ 'CreateCompilationJobRequest$InputConfig' => '

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', 'DescribeCompilationJobResponse$InputConfig' => '

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', ], ], 'InputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$InputDataConfig' => '

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.

Your input must be in the same Amazon Web Services region as your training job.

', 'DescribeTrainingJobResponse$InputDataConfig' => '

An array of Channel objects that describes each data input channel.

', 'HyperParameterTrainingJobDefinition$InputDataConfig' => '

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

', 'TrainingJob$InputDataConfig' => '

An array of Channel objects that describes each data input channel.

Your input must be in the same Amazon Web Services region as your training job.

', 'TrainingJobDefinition$InputDataConfig' => '

An array of Channel objects, each of which specifies an input source.

', ], ], 'InputMode' => [ 'base' => NULL, 'refs' => [ 'DatasetDefinition$InputMode' => '

Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

', ], ], 'InputModes' => [ 'base' => NULL, 'refs' => [ 'ChannelSpecification$SupportedInputModes' => '

The allowed input mode, either FILE or PIPE.

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

', ], ], 'InstanceGroup' => [ 'base' => '

Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .

', 'refs' => [ 'InstanceGroups$member' => NULL, ], ], 'InstanceGroupName' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$InstanceGroupName' => '

Specifies the name of the instance group.

', 'InstanceGroupNames$member' => NULL, ], ], 'InstanceGroupNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$InstanceGroupNames' => '

A list of names of instance groups that get data from the S3 data source.

', ], ], 'InstanceGroups' => [ 'base' => NULL, 'refs' => [ 'ResourceConfig$InstanceGroups' => '

The configuration of a heterogeneous cluster in JSON format.

', ], ], 'InstanceMetadataServiceConfiguration' => [ 'base' => '

Information on the IMDS configuration of the notebook instance

', 'refs' => [ 'CreateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', 'DescribeNotebookInstanceOutput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', 'UpdateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$InstanceType' => '

The type of ML compute instance to launch for the notebook instance.

', 'DescribeNotebookInstanceOutput$InstanceType' => '

The type of ML compute instance running on the notebook instance.

', 'NotebookInstanceSummary$InstanceType' => '

The type of ML compute instance that the notebook instance is running on.

', 'RealTimeInferenceConfig$InstanceType' => '

The instance type the model is deployed to.

', 'UpdateNotebookInstanceInput$InstanceType' => '

The Amazon ML compute instance type.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobRequest$ModelCardVersion' => '

The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

', 'DescribeDeviceResponse$MaxModels' => '

The maximum number of models.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentSuccess' => '

The number of edge devices with the successful deployment.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPending' => '

The number of edge devices yet to pick up deployment, or in progress.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentFailed' => '

The number of edge devices that failed the deployment.

', 'DescribeModelCardExportJobResponse$ModelCardVersion' => '

The version of the model card that the model export job exports.

', 'DescribeModelCardRequest$ModelCardVersion' => '

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

', 'DescribeModelCardResponse$ModelCardVersion' => '

The version of the model card.

', 'DynamicScalingConfiguration$MinCapacity' => '

The recommended minimum capacity to specify for your autoscaling policy.

', 'DynamicScalingConfiguration$MaxCapacity' => '

The recommended maximum capacity to specify for your autoscaling policy.

', 'DynamicScalingConfiguration$ScaleInCooldown' => '

The recommended scale in cooldown time for your autoscaling policy.

', 'DynamicScalingConfiguration$ScaleOutCooldown' => '

The recommended scale out cooldown time for your autoscaling policy.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentSuccess' => '

The number of edge devices with the successful deployment.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPending' => '

The number of edge devices yet to pick up the deployment, or in progress.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentFailed' => '

The number of edge devices that failed the deployment.

', 'EdgeDeploymentStatus$EdgeDeploymentSuccessInStage' => '

The number of edge devices with the successful deployment in the current stage.

', 'EdgeDeploymentStatus$EdgeDeploymentPendingInStage' => '

The number of edge devices yet to pick up the deployment in current stage, or in progress.

', 'EdgeDeploymentStatus$EdgeDeploymentFailedInStage' => '

The number of edge devices that failed the deployment in current stage.

', 'HyperParameterTuningJobCompletionDetails$NumberOfTrainingJobsObjectiveNotImproving' => '

The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.

', 'HyperParameterTuningJobConsumedResources$RuntimeInSeconds' => '

The wall clock runtime in seconds used by your hyperparameter tuning job.

', 'InferenceMetrics$MaxInvocations' => '

The expected maximum number of requests per minute for the instance.

', 'InferenceMetrics$ModelLatency' => '

The expected model latency at maximum invocations per minute for the instance.

', 'ListModelCardExportJobsRequest$ModelCardVersion' => '

List export jobs for the model card with the specified version.

', 'ModelCard$ModelCardVersion' => '

The version of the model card.

', 'ModelCardExportJobSummary$ModelCardVersion' => '

The version of the model card that the export job exports.

', 'ModelCardVersionSummary$ModelCardVersion' => '

A version of the model card.

', 'ModelDashboardModelCard$ModelCardVersion' => '

The model card version.

', 'ModelLatencyThreshold$ValueInMilliseconds' => '

The model latency percentile value in milliseconds.

', 'PipelineExecutionStep$AttemptCount' => '

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

', 'RecommendationJobStoppingConditions$MaxInvocations' => '

The maximum number of requests per minute expected for the endpoint.

', 'RecommendationMetrics$MaxInvocations' => '

The expected maximum number of requests per minute for the instance.

', 'RecommendationMetrics$ModelLatency' => '

The expected model latency at maximum invocation per minute for the instance.

', 'ScalingPolicyMetric$InvocationsPerInstance' => '

The number of invocations sent to a model, normalized by InstanceCount in each ProductionVariant. 1/numberOfInstances is sent as the value on each request, where numberOfInstances is the number of active instances for the ProductionVariant behind the endpoint at the time of the request.

', 'ScalingPolicyMetric$ModelLatency' => '

The interval of time taken by a model to respond as viewed from SageMaker. This interval includes the local communication times taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

', 'ScalingPolicyObjective$MinInvocationsPerMinute' => '

The minimum number of expected requests to your endpoint per minute.

', 'ScalingPolicyObjective$MaxInvocationsPerMinute' => '

The maximum number of expected requests to your endpoint per minute.

', ], ], 'IntegerParameterRange' => [ 'base' => '

For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.

', 'refs' => [ 'IntegerParameterRanges$member' => NULL, ], ], 'IntegerParameterRangeSpecification' => [ 'base' => '

Defines the possible values for an integer hyperparameter.

', 'refs' => [ 'ParameterRange$IntegerParameterRangeSpecification' => '

A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

', ], ], 'IntegerParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$IntegerParameterRanges' => '

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

', ], ], 'InvocationEndTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationEndTime' => '

A timestamp that shows when the benchmark completed.

', 'RecommendationJobInferenceBenchmark$InvocationEndTime' => '

A timestamp that shows when the benchmark completed.

', ], ], 'InvocationStartTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationStartTime' => '

A timestamp that shows when the benchmark started.

', 'RecommendationJobInferenceBenchmark$InvocationStartTime' => '

A timestamp that shows when the benchmark started.

', ], ], 'InvocationsMaxRetries' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsMaxRetries' => '

The maximum number of retries when invocation requests are failing. The default value is 3.

', ], ], 'InvocationsTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsTimeoutInSeconds' => '

The timeout value in seconds for an invocation request. The default value is 600.

', ], ], 'IotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$IotRoleAlias' => '

The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

', ], ], 'ItemIdentifierAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$ItemIdentifierAttributeName' => '

The name of the column that represents the set of item identifiers for which you want to predict the target value.

', ], ], 'JobDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$JobDurationInSeconds' => '

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

', ], ], 'JobReferenceCode' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$JobReferenceCode' => '

A unique identifier for work done as part of a labeling job.

', 'LabelingJobForWorkteamSummary$JobReferenceCode' => '

A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

', ], ], 'JobReferenceCodeContains' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$JobReferenceCodeContains' => '

A filter the limits jobs to only the ones whose job reference code contains the specified string.

', ], ], 'JobType' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', 'DescribeImageVersionResponse$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', 'UpdateImageVersionRequest$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', ], ], 'JoinSource' => [ 'base' => NULL, 'refs' => [ 'DataProcessing$JoinSource' => '

Specifies the source of the data to join with the transformed data. The valid values are None and Input. The default value is None, which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input. You can specify OutputFilter as an additional filter to select a portion of the joined dataset and store it in the output file.

For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with the input by appending each transformed row to the end of the input. The joined data has the original input data followed by the transformed data and the output is a CSV file.

For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

', ], ], 'JsonContentType' => [ 'base' => NULL, 'refs' => [ 'JsonContentTypes$member' => NULL, ], ], 'JsonContentTypes' => [ 'base' => NULL, 'refs' => [ 'CaptureContentTypeHeader$JsonContentTypes' => '

The list of all content type headers that SageMaker will treat as JSON and capture accordingly.

', ], ], 'JsonPath' => [ 'base' => NULL, 'refs' => [ 'DataProcessing$InputFilter' => '

A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

Examples: "$", "$[1:]", "$.features"

', 'DataProcessing$OutputFilter' => '

A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren\'t within the dimension size of the joined dataset, you get an error.

Examples: "$", "$[0,5:]", "$[\'id\',\'SageMakerOutput\']"

', ], ], 'JupyterLabAppImageConfig' => [ 'base' => '

The configuration for the file system and kernels in a SageMaker image running as a JupyterLab app.

', 'refs' => [ 'AppImageConfigDetails$JupyterLabAppImageConfig' => '

The configuration for the file system and the runtime, such as the environment variables and entry point.

', 'CreateAppImageConfigRequest$JupyterLabAppImageConfig' => '

The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.

', 'DescribeAppImageConfigResponse$JupyterLabAppImageConfig' => '

The configuration of the JupyterLab app.

', 'UpdateAppImageConfigRequest$JupyterLabAppImageConfig' => '

The JupyterLab app running on the image.

', ], ], 'JupyterLabAppSettings' => [ 'base' => '

The settings for the JupyterLab application.

', 'refs' => [ 'UserSettings$JupyterLabAppSettings' => '

The settings for the JupyterLab application.

', ], ], 'JupyterServerAppSettings' => [ 'base' => '

The JupyterServer app settings.

', 'refs' => [ 'DefaultSpaceSettings$JupyterServerAppSettings' => NULL, 'SpaceSettings$JupyterServerAppSettings' => NULL, 'UserSettings$JupyterServerAppSettings' => '

The Jupyter server\'s app settings.

', ], ], 'KeepAlivePeriodInSeconds' => [ 'base' => 'Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.', 'refs' => [ 'ResourceConfig$KeepAlivePeriodInSeconds' => '

The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.

', 'ResourceConfigForUpdate$KeepAlivePeriodInSeconds' => '

The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.

', ], ], 'KendraSettings' => [ 'base' => '

The Amazon SageMaker Canvas application setting where you configure document querying.

', 'refs' => [ 'CanvasAppSettings$KendraSettings' => '

The settings for document querying.

', ], ], 'KernelDisplayName' => [ 'base' => NULL, 'refs' => [ 'KernelSpec$DisplayName' => '

The display name of the kernel.

', ], ], 'KernelGatewayAppSettings' => [ 'base' => '

The KernelGateway app settings.

', 'refs' => [ 'DefaultSpaceSettings$KernelGatewayAppSettings' => NULL, 'SpaceSettings$KernelGatewayAppSettings' => NULL, 'UserSettings$KernelGatewayAppSettings' => '

The kernel gateway app settings.

', ], ], 'KernelGatewayImageConfig' => [ 'base' => '

The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.

', 'refs' => [ 'AppImageConfigDetails$KernelGatewayImageConfig' => '

The configuration for the file system and kernels in the SageMaker image.

', 'CreateAppImageConfigRequest$KernelGatewayImageConfig' => '

The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.

', 'DescribeAppImageConfigResponse$KernelGatewayImageConfig' => '

The configuration of a KernelGateway app.

', 'UpdateAppImageConfigRequest$KernelGatewayImageConfig' => '

The new KernelGateway app to run on the image.

', ], ], 'KernelName' => [ 'base' => NULL, 'refs' => [ 'KernelSpec$Name' => '

The name of the Jupyter kernel in the image. This value is case sensitive.

', ], ], 'KernelSpec' => [ 'base' => '

The specification of a Jupyter kernel.

', 'refs' => [ 'KernelSpecs$member' => NULL, ], ], 'KernelSpecs' => [ 'base' => NULL, 'refs' => [ 'KernelGatewayImageConfig$KernelSpecs' => '

The specification of the Jupyter kernels in the image.

', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$ObjectKey' => '

The object key (or key name) uniquely identifies the object in an S3 bucket.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

', 'AthenaDatasetDefinition$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

', 'AutoMLOutputDataConfig$KmsKeyId' => '

The Key Management Service (KMS) encryption key ID.

', 'AutoMLSecurityConfig$VolumeKmsKeyId' => '

The key used to encrypt stored data.

', 'BatchDataCaptureConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'CreateDomainRequest$HomeEfsFileSystemKmsKeyId' => '

Use KmsKeyId.

', 'CreateDomainRequest$KmsKeyId' => '

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

', 'CreateEdgePackagingJobRequest$ResourceKey' => '

The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.

', 'CreateEndpointConfigInput$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

', 'CreateInferenceExperimentRequest$KmsKey' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:

  • KMS key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS key Alias

    "alias/ExampleAlias"

  • Amazon Resource Name (ARN) of a KMS key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'CreateNotebookInstanceInput$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.

', 'DataCaptureConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'DataCaptureConfigSummary$KmsKeyId' => '

The KMS key being used to encrypt the data in Amazon S3.

', 'DescribeDomainResponse$HomeEfsFileSystemKmsKeyId' => '

Use KmsKeyId.

', 'DescribeDomainResponse$KmsKeyId' => '

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

', 'DescribeEdgePackagingJobResponse$ResourceKey' => '

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

', 'DescribeEndpointConfigOutput$KmsKeyId' => '

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

', 'DescribeInferenceExperimentResponse$KmsKey' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.

', 'DescribeNotebookInstanceOutput$KmsKeyId' => '

The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

', 'EdgeOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account.

', 'FlowDefinitionOutputConfig$KmsKeyId' => '

The Amazon Key Management Service (KMS) key ID for server-side encryption.

', 'HyperParameterTuningResourceConfig$VolumeKmsKeyId' => '

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.

KMS Key ID:

"1234abcd-12ab-34cd-56ef-1234567890ab"

Amazon Resource Name (ARN) of a KMS key:

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.

', 'InferenceExperimentDataStorageConfig$KmsKey' => '

The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.

', 'LabelingJobOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don\'t provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role\'s account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

', 'LabelingJobResourceConfig$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling.

You can only specify a VolumeKmsKeyId when you create a labeling job with automated data labeling enabled using the API operation CreateLabelingJob. You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see Output Data and Storage Volume Encryption.

The VolumeKmsKeyId can be any of the following formats:

  • KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

', 'ModelCardSecurityConfig$KmsKeyId' => '

A Key Management Service key ID to use for encrypting a model card.

', 'MonitoringClusterConfig$VolumeKmsKeyId' => '

The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

', 'MonitoringOutputConfig$KmsKeyId' => '

The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

', 'OnlineStoreSecurityConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:

  • "kms:Encrypt"

  • "kms:Decrypt"

  • "kms:DescribeKey"

  • "kms:CreateGrant"

  • "kms:RetireGrant"

  • "kms:ReEncryptFrom"

  • "kms:ReEncryptTo"

  • "kms:GenerateDataKey"

  • "kms:ListAliases"

  • "kms:ListGrants"

  • "kms:RevokeGrant"

The caller (either user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:

  • "kms:Decrypt"

', 'OutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'OutputDataConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'ProcessingClusterConfig$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

', 'ProcessingOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.

', 'ProductionVariantCoreDumpConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role\'s account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'RecommendationJobInputConfig$VolumeKmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

', 'RecommendationJobOutputConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

', 'RedshiftDatasetDefinition$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.

', 'ResourceConfig$VolumeKmsKeyId' => '

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be in any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

', 'S3StorageConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:

  • "kms:GenerateDataKey"

', 'SharingSettings$S3KmsKeyId' => '

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

', 'TransformOutput$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'TransformResources$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'WorkspaceSettings$S3KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

', ], ], 'LabelAttributeName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelAttributeName' => '

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.

  • The name can\'t end with "-metadata".

  • If you are using one of the following built-in task types, the attribute name must end with "-ref". If the task type you are using is not listed below, the attribute name must not end with "-ref".

    • Image semantic segmentation (SemanticSegmentation), and adjustment (AdjustmentSemanticSegmentation) and verification (VerificationSemanticSegmentation) labeling jobs for this task type.

    • Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.

    • Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.

    • 3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.

    • 3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.

If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.

', 'DescribeLabelingJobResponse$LabelAttributeName' => '

The attribute used as the label in the output manifest file.

', ], ], 'LabelCounter' => [ 'base' => NULL, 'refs' => [ 'LabelCounters$TotalLabeled' => '

The total number of objects labeled.

', 'LabelCounters$HumanLabeled' => '

The total number of objects labeled by a human worker.

', 'LabelCounters$MachineLabeled' => '

The total number of objects labeled by automated data labeling.

', 'LabelCounters$FailedNonRetryableError' => '

The total number of objects that could not be labeled due to an error.

', 'LabelCounters$Unlabeled' => '

The total number of objects not yet labeled.

', 'LabelCountersForWorkteam$HumanLabeled' => '

The total number of data objects labeled by a human worker.

', 'LabelCountersForWorkteam$PendingHuman' => '

The total number of data objects that need to be labeled by a human worker.

', 'LabelCountersForWorkteam$Total' => '

The total number of tasks in the labeling job.

', ], ], 'LabelCounters' => [ 'base' => '

Provides a breakdown of the number of objects labeled.

', 'refs' => [ 'DescribeLabelingJobResponse$LabelCounters' => '

Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn\'t be labeled, and the total number of objects labeled.

', 'LabelingJobSummary$LabelCounters' => '

Counts showing the progress of the labeling job.

', ], ], 'LabelCountersForWorkteam' => [ 'base' => '

Provides counts for human-labeled tasks in the labeling job.

', 'refs' => [ 'LabelingJobForWorkteamSummary$LabelCounters' => '

Provides information about the progress of a labeling job.

', ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'base' => NULL, 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobAlgorithmSpecificationArn' => '

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

  • Image classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

  • Text classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

  • Object detection

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

  • Semantic Segmentation

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

', ], ], 'LabelingJobAlgorithmsConfig' => [ 'base' => '

Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.

', 'refs' => [ 'CreateLabelingJobRequest$LabelingJobAlgorithmsConfig' => '

Configures the information required to perform automated data labeling.

', 'DescribeLabelingJobResponse$LabelingJobAlgorithmsConfig' => '

Configuration information for automated data labeling.

', ], ], 'LabelingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

', 'DescribeLabelingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job.

', 'DescribeTrainingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.

', 'DescribeTransformJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

', 'LabelingJobSummary$LabelingJobArn' => '

The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

', 'TrainingJob$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job.

', 'TransformJob$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job that created the transform job.

', ], ], 'LabelingJobDataAttributes' => [ 'base' => '

Attributes of the data specified by the customer. Use these to describe the data to be labeled.

', 'refs' => [ 'LabelingJobInputConfig$DataAttributes' => '

Attributes of the data specified by the customer.

', ], ], 'LabelingJobDataSource' => [ 'base' => '

Provides information about the location of input data.

You must specify at least one of the following: S3DataSource or SnsDataSource.

Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job.

Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

', 'refs' => [ 'LabelingJobInputConfig$DataSource' => '

The location of the input data.

', ], ], 'LabelingJobForWorkteamSummary' => [ 'base' => '

Provides summary information for a work team.

', 'refs' => [ 'LabelingJobForWorkteamSummaryList$member' => NULL, ], ], 'LabelingJobForWorkteamSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamResponse$LabelingJobSummaryList' => '

An array of LabelingJobSummary objects, each describing a labeling job.

', ], ], 'LabelingJobInputConfig' => [ 'base' => '

Input configuration information for a labeling job.

', 'refs' => [ 'CreateLabelingJobRequest$InputConfig' => '

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

You must specify at least one of the following: S3DataSource or SnsDataSource.

  • Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.

  • Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use ContentClassifiers to specify that your data is free of personally identifiable information and adult content.

', 'DescribeLabelingJobResponse$InputConfig' => '

Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

', 'LabelingJobSummary$InputConfig' => '

Input configuration for the labeling job.

', ], ], 'LabelingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelingJobName' => '

The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. LabelingJobName is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.

', 'DescribeLabelingJobRequest$LabelingJobName' => '

The name of the labeling job to return information for.

', 'DescribeLabelingJobResponse$LabelingJobName' => '

The name assigned to the labeling job when it was created.

', 'LabelingJobForWorkteamSummary$LabelingJobName' => '

The name of the labeling job that the work team is assigned to.

', 'LabelingJobSummary$LabelingJobName' => '

The name of the labeling job.

', 'StopLabelingJobRequest$LabelingJobName' => '

The name of the labeling job to stop.

', ], ], 'LabelingJobOutput' => [ 'base' => '

Specifies the location of the output produced by the labeling job.

', 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobOutput' => '

The location of the output produced by the labeling job.

', 'LabelingJobSummary$LabelingJobOutput' => '

The location of the output produced by the labeling job.

', ], ], 'LabelingJobOutputConfig' => [ 'base' => '

Output configuration information for a labeling job.

', 'refs' => [ 'CreateLabelingJobRequest$OutputConfig' => '

The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

', 'DescribeLabelingJobResponse$OutputConfig' => '

The location of the job\'s output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

', ], ], 'LabelingJobResourceConfig' => [ 'base' => '

Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.

', 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobResourceConfig' => '

Provides configuration information for a labeling job.

', ], ], 'LabelingJobS3DataSource' => [ 'base' => '

The Amazon S3 location of the input data objects.

', 'refs' => [ 'LabelingJobDataSource$S3DataSource' => '

The Amazon S3 location of the input data objects.

', ], ], 'LabelingJobSnsDataSource' => [ 'base' => '

An Amazon SNS data source used for streaming labeling jobs.

', 'refs' => [ 'LabelingJobDataSource$SnsDataSource' => '

An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.

', ], ], 'LabelingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobStatus' => '

The processing status of the labeling job.

', 'LabelingJobSummary$LabelingJobStatus' => '

The current status of the labeling job.

', 'ListLabelingJobsRequest$StatusEquals' => '

A filter that retrieves only labeling jobs with a specific status.

', ], ], 'LabelingJobStoppingConditions' => [ 'base' => '

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Labeling jobs fail after 30 days with an appropriate client error message.

', 'refs' => [ 'CreateLabelingJobRequest$StoppingConditions' => '

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

', 'DescribeLabelingJobResponse$StoppingConditions' => '

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

', ], ], 'LabelingJobSummary' => [ 'base' => '

Provides summary information about a labeling job.

', 'refs' => [ 'LabelingJobSummaryList$member' => NULL, ], ], 'LabelingJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsResponse$LabelingJobSummaryList' => '

An array of LabelingJobSummary objects, each describing a labeling job.

', ], ], 'LambdaFunctionArn' => [ 'base' => NULL, 'refs' => [ 'AnnotationConsolidationConfig$AnnotationConsolidationLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

This parameter is required for all labeling jobs. For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Semantic Segmentation Adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

Semantic Segmentation Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding Box Adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

Bounding Box Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking

3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection

3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation

', 'HumanTaskConfig$PreHumanTaskLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking

3D Point Cloud Modalities

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking

3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation

', 'LabelingJobSummary$PreHumanTaskLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.

', 'LabelingJobSummary$AnnotationConsolidationLambdaArn' => '

The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.

', ], ], 'LambdaStepMetadata' => [ 'base' => '

Metadata for a Lambda step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Lambda' => '

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

', ], ], 'LandingUri' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$LandingUri' => '

The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

  • studio::relative/path: Directs users to the relative path in Studio.

  • app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

  • app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

  • app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

  • app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

  • app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

', 'UserSettings$DefaultLandingUri' => '

The default experience that the user is directed to when accessing the domain. The supported values are:

  • studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

  • app:JupyterServer:: Indicates that Studio Classic is the default experience.

', ], ], 'LastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$LastModifiedTime' => '

The date and time that the Git repository was last modified.

', 'CompilationJobSummary$LastModifiedTime' => '

The time when the model compilation job was last modified.

', 'DescribeCodeRepositoryOutput$LastModifiedTime' => '

The date and time that the repository was last changed.

', 'DescribeCompilationJobResponse$LastModifiedTime' => '

The time that the status of the model compilation job was last modified.

', 'DescribeDomainResponse$LastModifiedTime' => '

The last modified time.

', 'DescribeFeatureGroupResponse$LastModifiedTime' => '

A timestamp indicating when the feature group was last updated.

', 'DescribeFeatureMetadataResponse$LastModifiedTime' => '

A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you

', 'DescribeInferenceRecommendationsJobResponse$LastModifiedTime' => '

A timestamp that shows when the job was last modified.

', 'DescribeNotebookInstanceLifecycleConfigOutput$LastModifiedTime' => '

A timestamp that tells when the lifecycle configuration was last modified.

', 'DescribeNotebookInstanceOutput$LastModifiedTime' => '

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

', 'DescribeSpaceResponse$LastModifiedTime' => '

The last modified time.

', 'DescribeUserProfileResponse$LastModifiedTime' => '

The last modified time.

', 'DomainDetails$LastModifiedTime' => '

The last modified time.

', 'FeatureGroup$LastModifiedTime' => '

A timestamp indicating the last time you updated the feature group.

', 'FeatureMetadata$LastModifiedTime' => '

A timestamp indicating when the feature was last modified.

', 'InferenceRecommendationsJob$LastModifiedTime' => '

A timestamp that shows when the job was last modified.

', 'ListCompilationJobsRequest$LastModifiedTimeAfter' => '

A filter that returns the model compilation jobs that were modified after a specified time.

', 'ListCompilationJobsRequest$LastModifiedTimeBefore' => '

A filter that returns the model compilation jobs that were modified before a specified time.

', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only jobs that were last modified after the specified time (timestamp).

', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only jobs that were last modified before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeBefore' => '

A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeAfter' => '

A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

', 'ListNotebookInstancesInput$LastModifiedTimeBefore' => '

A filter that returns only notebook instances that were modified before the specified time (timestamp).

', 'ListNotebookInstancesInput$LastModifiedTimeAfter' => '

A filter that returns only notebook instances that were modified after the specified time (timestamp).

', 'NotebookInstanceLifecycleConfigSummary$LastModifiedTime' => '

A timestamp that tells when the lifecycle configuration was last modified.

', 'NotebookInstanceSummary$LastModifiedTime' => '

A timestamp that shows when the notebook instance was last modified.

', 'SpaceDetails$LastModifiedTime' => '

The last modified time.

', 'UserProfileDetails$LastModifiedTime' => '

The last modified time.

', ], ], 'LastUpdateStatus' => [ 'base' => '

A value that indicates whether the update was successful.

', 'refs' => [ 'DescribeFeatureGroupResponse$LastUpdateStatus' => '

A value indicating whether the update made to the feature group was successful.

', 'FeatureGroup$LastUpdateStatus' => '

A value that indicates whether the feature group was updated successfully.

', ], ], 'LastUpdateStatusValue' => [ 'base' => NULL, 'refs' => [ 'LastUpdateStatus$Status' => '

A value that indicates whether the update was made successful.

', ], ], 'LifecycleConfigArns' => [ 'base' => NULL, 'refs' => [ 'CodeEditorAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

', 'JupyterLabAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

', 'JupyterServerAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

', 'KernelGatewayAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

', ], ], 'LineageEntityParameters' => [ 'base' => NULL, 'refs' => [ 'CreateActionRequest$Properties' => '

A list of properties to add to the action.

', 'CreateContextRequest$Properties' => '

A list of properties to add to the context.

', 'DescribeActionResponse$Properties' => '

A list of the action\'s properties.

', 'DescribeArtifactResponse$Properties' => '

A list of the artifact\'s properties.

', 'DescribeContextResponse$Properties' => '

A list of the context\'s properties.

', 'UpdateActionRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', 'UpdateContextRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', ], ], 'LineageGroupArn' => [ 'base' => NULL, 'refs' => [ 'DescribeActionResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeArtifactResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeContextResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeLineageGroupResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeTrialComponentResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'GetLineageGroupPolicyResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'LineageGroupSummary$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group resource.

', 'TrialComponent$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group resource.

', ], ], 'LineageGroupNameOrArn' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyRequest$LineageGroupName' => '

The name or Amazon Resource Name (ARN) of the lineage group.

', ], ], 'LineageGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsResponse$LineageGroupSummaries' => '

A list of lineage groups and their properties.

', ], ], 'LineageGroupSummary' => [ 'base' => '

Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.

', 'refs' => [ 'LineageGroupSummaries$member' => NULL, ], ], 'LineageType' => [ 'base' => NULL, 'refs' => [ 'QueryLineageTypes$member' => NULL, 'Vertex$LineageType' => '

The type of resource of the lineage entity.

', ], ], 'ListActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListActionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClusterNodesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClusterNodesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCompilationJobsRequest$SortBy' => '

The field by which to sort results. The default is CreationTime.

', ], ], 'ListContextsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContextsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsRequest$SortBy' => '

The column to sort by.

', ], ], 'ListDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansSortBy' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansRequest$SortBy' => '

The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.

', ], ], 'ListEdgePackagingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgePackagingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgePackagingJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListEdgePackagingJobsRequest$SortBy' => '

Use to specify what column to sort by.

', ], ], 'ListEndpointConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceComponentsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceComponentsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsRequest$SortBy' => '

The parameter by which to sort the results.

', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'ListLabelingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLineageEntityParameterKey' => [ 'base' => NULL, 'refs' => [ 'UpdateActionRequest$PropertiesToRemove' => '

A list of properties to remove.

', 'UpdateArtifactRequest$PropertiesToRemove' => '

A list of properties to remove.

', 'UpdateContextRequest$PropertiesToRemove' => '

A list of properties to remove.

', ], ], 'ListLineageGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLineageGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsRequest$MaxResults' => '

The maximum number of results to select.

', 'ListDevicesRequest$MaxResults' => '

Maximum number of results to select.

', 'ListEdgeDeploymentPlansRequest$MaxResults' => '

The maximum number of results to select (50 by default).

', 'ListEdgePackagingJobsRequest$MaxResults' => '

Maximum number of results to select.

', 'ListStageDevicesRequest$MaxResults' => '

The maximum number of requests to select.

', ], ], 'ListModelBiasJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelBiasJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListTagsInput$MaxResults' => '

Maximum number of tags to return.

', ], ], 'ListTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'UpdateTrialComponentRequest$ParametersToRemove' => '

The hyperparameters to remove from the component.

', 'UpdateTrialComponentRequest$InputArtifactsToRemove' => '

The input artifacts to remove from the component.

', 'UpdateTrialComponentRequest$OutputArtifactsToRemove' => '

The output artifacts to remove from the component.

', ], ], 'ListTrialComponentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesRequest$SortBy' => '

Sort workforces using the workforce name or creation date.

', ], ], 'ListWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$AgentCount' => '

The number of Edge Manager agents.

', 'DeviceStats$ConnectedDeviceCount' => '

The number of devices connected with a heartbeat.

', 'DeviceStats$RegisteredDeviceCount' => '

The number of registered devices.

', 'EdgeModelStat$OfflineDeviceCount' => '

The number of devices that have this model version and do not have a heart beat.

', 'EdgeModelStat$ConnectedDeviceCount' => '

The number of devices that have this model version and have a heart beat.

', 'EdgeModelStat$ActiveDeviceCount' => '

The number of devices that have this model version, a heart beat, and are currently running.

', 'EdgeModelStat$SamplingDeviceCount' => '

The number of devices with this model version and are producing sample data.

', ], ], 'MLFramework' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$MLFramework' => '

The machine learning framework vended in the image version.

', 'DescribeImageVersionResponse$MLFramework' => '

The machine learning framework vended in the image version.

', 'UpdateImageVersionRequest$MLFramework' => '

The machine learning framework vended in the image version.

', ], ], 'ManagedInstanceScalingMaxInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$MaxInstanceCount' => '

The maximum number of instances that the endpoint can provision when it scales up to accommodate an increase in traffic.

', ], ], 'ManagedInstanceScalingMinInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$MinInstanceCount' => '

The minimum number of instances that the endpoint must retain when it scales down to accommodate a decrease in traffic.

', ], ], 'ManagedInstanceScalingStatus' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$Status' => '

Indicates whether managed instance scaling is enabled.

', ], ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxAutoMLJobRuntimeInSeconds' => '

The maximum runtime, in seconds, an AutoML job has to complete.

If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.

', ], ], 'MaxCandidates' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxCandidates' => '

The maximum number of times a training job is allowed to run.

For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.

', ], ], 'MaxConcurrentInvocationsPerInstance' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceClientConfig$MaxConcurrentInvocationsPerInstance' => '

The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.

', ], ], 'MaxConcurrentTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$MaxConcurrentTaskCount' => '

Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.

', ], ], 'MaxConcurrentTransforms' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don\'t need to set a value for MaxConcurrentTransforms.

', 'DescribeTransformJobResponse$MaxConcurrentTransforms' => '

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

', 'TransformJob$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don\'t need to set a value for MaxConcurrentTransforms.

', 'TransformJobDefinition$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

', ], ], 'MaxHumanLabeledObjectCount' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxHumanLabeledObjectCount' => '

The maximum number of objects that can be labeled by human workers.

', ], ], 'MaxNumberOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxNumberOfTests' => '

Defines the maximum number of load tests.

', ], ], 'MaxNumberOfTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxNumberOfTrainingJobs' => '

The maximum number of training jobs that a hyperparameter tuning job can launch.

', ], ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'base' => NULL, 'refs' => [ 'BestObjectiveNotImproving$MaxNumberOfTrainingJobsNotImproving' => '

The number of training jobs that have failed to improve model performance by 1% or greater over prior training jobs as evaluated against an objective function.

', ], ], 'MaxParallelExecutionSteps' => [ 'base' => NULL, 'refs' => [ 'ParallelismConfiguration$MaxParallelExecutionSteps' => '

The max number of steps that can be executed in parallel.

', ], ], 'MaxParallelOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxParallelOfTests' => '

Defines the maximum number of parallel load tests.

', ], ], 'MaxParallelTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxParallelTrainingJobs' => '

The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

', ], ], 'MaxPayloadInMB' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$MaxPayloadInMB' => '

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

', 'DescribeTransformJobResponse$MaxPayloadInMB' => '

The maximum payload size, in MB, used in the transform job.

', 'TransformJob$MaxPayloadInMB' => '

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.

', 'TransformJobDefinition$MaxPayloadInMB' => '

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

', ], ], 'MaxPendingTimeInSeconds' => [ 'base' => 'Maximum job scheduler pending time in seconds.', 'refs' => [ 'StoppingCondition$MaxPendingTimeInSeconds' => '

The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.

', ], ], 'MaxPercentageOfInputDatasetLabeled' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxPercentageOfInputDatasetLabeled' => '

The maximum number of input data objects that should be labeled.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$MaxResults' => '

The maximum number of actions to return in the response. The default value is 10.

', 'ListAlgorithmsInput$MaxResults' => '

The maximum number of algorithms to return in the response.

', 'ListAliasesRequest$MaxResults' => '

The maximum number of aliases to return.

', 'ListAppImageConfigsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListAppsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListArtifactsRequest$MaxResults' => '

The maximum number of artifacts to return in the response. The default value is 10.

', 'ListAssociationsRequest$MaxResults' => '

The maximum number of associations to return in the response. The default value is 10.

', 'ListClusterNodesRequest$MaxResults' => '

The maximum number of nodes to return in the response.

', 'ListClustersRequest$MaxResults' => '

Set the maximum number of SageMaker HyperPod clusters to list.

', 'ListCodeRepositoriesInput$MaxResults' => '

The maximum number of Git repositories to return in the response.

', 'ListCompilationJobsRequest$MaxResults' => '

The maximum number of model compilation jobs to return in the response.

', 'ListContextsRequest$MaxResults' => '

The maximum number of contexts to return in the response. The default value is 10.

', 'ListDataQualityJobDefinitionsRequest$MaxResults' => '

The maximum number of data quality monitoring job definitions to return in the response.

', 'ListDomainsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListEndpointConfigsInput$MaxResults' => '

The maximum number of training jobs to return in the response.

', 'ListEndpointsInput$MaxResults' => '

The maximum number of endpoints to return in the response. This value defaults to 10.

', 'ListExperimentsRequest$MaxResults' => '

The maximum number of experiments to return in the response. The default value is 10.

', 'ListFlowDefinitionsRequest$MaxResults' => '

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

', 'ListHubContentVersionsRequest$MaxResults' => '

The maximum number of hub content versions to list.

', 'ListHubContentsRequest$MaxResults' => '

The maximum amount of hub content to list.

', 'ListHubsRequest$MaxResults' => '

The maximum number of hubs to list.

', 'ListHumanTaskUisRequest$MaxResults' => '

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

', 'ListHyperParameterTuningJobsRequest$MaxResults' => '

The maximum number of tuning jobs to return. The default value is 10.

', 'ListImageVersionsRequest$MaxResults' => '

The maximum number of versions to return in the response. The default value is 10.

', 'ListImagesRequest$MaxResults' => '

The maximum number of images to return in the response. The default value is 10.

', 'ListInferenceComponentsInput$MaxResults' => '

The maximum number of inference components to return in the response. This value defaults to 10.

', 'ListInferenceExperimentsRequest$MaxResults' => '

The maximum number of results to select.

', 'ListInferenceRecommendationsJobStepsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListInferenceRecommendationsJobsRequest$MaxResults' => '

The maximum number of recommendations to return in the response.

', 'ListLabelingJobsForWorkteamRequest$MaxResults' => '

The maximum number of labeling jobs to return in each page of the response.

', 'ListLabelingJobsRequest$MaxResults' => '

The maximum number of labeling jobs to return in each page of the response.

', 'ListLineageGroupsRequest$MaxResults' => '

The maximum number of endpoints to return in the response. This value defaults to 10.

', 'ListModelBiasJobDefinitionsRequest$MaxResults' => '

The maximum number of model bias jobs to return in the response. The default value is 10.

', 'ListModelCardExportJobsRequest$MaxResults' => '

The maximum number of model card export jobs to list.

', 'ListModelCardVersionsRequest$MaxResults' => '

The maximum number of model card versions to list.

', 'ListModelCardsRequest$MaxResults' => '

The maximum number of model cards to list.

', 'ListModelExplainabilityJobDefinitionsRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListModelMetadataRequest$MaxResults' => '

The maximum number of models to return in the response.

', 'ListModelPackageGroupsInput$MaxResults' => '

The maximum number of results to return in the response.

', 'ListModelPackagesInput$MaxResults' => '

The maximum number of model packages to return in the response.

', 'ListModelQualityJobDefinitionsRequest$MaxResults' => '

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

', 'ListModelsInput$MaxResults' => '

The maximum number of models to return in the response.

', 'ListMonitoringAlertHistoryRequest$MaxResults' => '

The maximum number of results to display. The default is 100.

', 'ListMonitoringAlertsRequest$MaxResults' => '

The maximum number of results to display. The default is 100.

', 'ListMonitoringExecutionsRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListMonitoringSchedulesRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListNotebookInstanceLifecycleConfigsInput$MaxResults' => '

The maximum number of lifecycle configurations to return in the response.

', 'ListNotebookInstancesInput$MaxResults' => '

The maximum number of notebook instances to return.

', 'ListPipelineExecutionStepsRequest$MaxResults' => '

The maximum number of pipeline execution steps to return in the response.

', 'ListPipelineExecutionsRequest$MaxResults' => '

The maximum number of pipeline executions to return in the response.

', 'ListPipelineParametersForExecutionRequest$MaxResults' => '

The maximum number of parameters to return in the response.

', 'ListPipelinesRequest$MaxResults' => '

The maximum number of pipelines to return in the response.

', 'ListProcessingJobsRequest$MaxResults' => '

The maximum number of processing jobs to return in the response.

', 'ListProjectsInput$MaxResults' => '

The maximum number of projects to return in the response.

', 'ListResourceCatalogsRequest$MaxResults' => '

The maximum number of results returned by ListResourceCatalogs.

', 'ListSpacesRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListStudioLifecycleConfigsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListSubscribedWorkteamsRequest$MaxResults' => '

The maximum number of work teams to return in each page of the response.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$MaxResults' => '

The maximum number of training jobs to return. The default value is 10.

', 'ListTrainingJobsRequest$MaxResults' => '

The maximum number of training jobs to return in the response.

', 'ListTransformJobsRequest$MaxResults' => '

The maximum number of transform jobs to return in the response. The default value is 10.

', 'ListTrialComponentsRequest$MaxResults' => '

The maximum number of components to return in the response. The default value is 10.

', 'ListTrialsRequest$MaxResults' => '

The maximum number of trials to return in the response. The default value is 10.

', 'ListUserProfilesRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListWorkforcesRequest$MaxResults' => '

The maximum number of workforces returned in the response.

', 'ListWorkteamsRequest$MaxResults' => '

The maximum number of work teams to return in each page of the response.

', 'SearchRequest$MaxResults' => '

The maximum number of results to return.

', ], ], 'MaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'StoppingCondition$MaxRuntimeInSeconds' => '

The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.

For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.

', ], ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxRuntimePerTrainingJobInSeconds' => '

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).

', ], ], 'MaxWaitTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'StoppingCondition$MaxWaitTimeInSeconds' => '

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

', ], ], 'MaximumExecutionTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'BlueGreenUpdatePolicy$MaximumExecutionTimeoutInSeconds' => '

Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

', 'RollingUpdatePolicy$MaximumExecutionTimeoutInSeconds' => '

The time limit for the total deployment. Exceeding this limit causes a timeout.

', ], ], 'MaximumRetryAttempts' => [ 'base' => NULL, 'refs' => [ 'RetryStrategy$MaximumRetryAttempts' => '

The number of times to retry the job. When the job is retried, it\'s SecondaryStatus is changed to STARTING.

', ], ], 'MediaType' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifact$MediaType' => '

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

', ], ], 'MemberDefinition' => [ 'base' => '

Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

', 'refs' => [ 'MemberDefinitions$member' => NULL, ], ], 'MemberDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

', 'UpdateWorkteamRequest$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

', 'Workteam$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.

', ], ], 'MemoryInMb' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$MinMemoryRequiredInMb' => '

The minimum MB of memory to allocate to run a model that you assign to an inference component.

', 'InferenceComponentComputeResourceRequirements$MaxMemoryRequiredInMb' => '

The maximum MB of memory to allocate to run a model that you assign to an inference component.

', ], ], 'MetadataProperties' => [ 'base' => '

Metadata properties of the tracking entity, trial, or trial component.

', 'refs' => [ 'CreateActionRequest$MetadataProperties' => NULL, 'CreateArtifactRequest$MetadataProperties' => NULL, 'CreateModelPackageInput$MetadataProperties' => NULL, 'CreateTrialComponentRequest$MetadataProperties' => NULL, 'CreateTrialRequest$MetadataProperties' => NULL, 'DescribeActionResponse$MetadataProperties' => NULL, 'DescribeArtifactResponse$MetadataProperties' => NULL, 'DescribeModelPackageOutput$MetadataProperties' => NULL, 'DescribeTrialComponentResponse$MetadataProperties' => NULL, 'DescribeTrialResponse$MetadataProperties' => NULL, 'ModelPackage$MetadataProperties' => '

Metadata properties of the tracking entity, trial, or trial component.

', 'Trial$MetadataProperties' => NULL, 'TrialComponent$MetadataProperties' => NULL, ], ], 'MetadataPropertyValue' => [ 'base' => NULL, 'refs' => [ 'MetadataProperties$CommitId' => '

The commit ID.

', 'MetadataProperties$Repository' => '

The repository.

', 'MetadataProperties$GeneratedBy' => '

The entity this entity was generated by.

', 'MetadataProperties$ProjectId' => '

The project ID.

', ], ], 'MetricData' => [ 'base' => '

The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

', 'refs' => [ 'FinalMetricDataList$member' => NULL, ], ], 'MetricDataList' => [ 'base' => NULL, 'refs' => [ 'CandidateProperties$CandidateMetrics' => '

Information about the candidate metrics for an AutoML job.

', ], ], 'MetricDatum' => [ 'base' => '

Information about the metric for a candidate produced by an AutoML job.

', 'refs' => [ 'MetricDataList$member' => NULL, ], ], 'MetricDefinition' => [ 'base' => '

Specifies a metric that the training algorithm writes to stderr or stdout. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in the HyperParameterTrainingJobDefinition API to evaluate job performance during hyperparameter tuning.

', 'refs' => [ 'MetricDefinitionList$member' => NULL, ], ], 'MetricDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$MetricDefinitions' => '

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

', 'HyperParameterAlgorithmSpecification$MetricDefinitions' => '

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

', 'TrainingSpecification$MetricDefinitions' => '

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'FinalHyperParameterTuningJobObjectiveMetric$MetricName' => '

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

', 'HyperParameterTuningJobObjective$MetricName' => '

The name of the metric to use for the objective metric.

', 'MetricData$MetricName' => '

The name of the metric.

', 'MetricDefinition$Name' => '

The name of the metric.

', 'TrialComponentMetricSummary$MetricName' => '

The name of the metric.

', ], ], 'MetricRegex' => [ 'base' => NULL, 'refs' => [ 'MetricDefinition$Regex' => '

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.

', ], ], 'MetricSetSource' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$Set' => '

The dataset split from which the AutoML job produced the metric.

', ], ], 'MetricSpecification' => [ 'base' => '

An object containing information about a metric.

', 'refs' => [ 'TargetTrackingScalingPolicyConfiguration$MetricSpecification' => '

An object containing information about a metric.

', ], ], 'MetricValue' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Value' => '

The value of the metric with the best result.

', 'FinalHyperParameterTuningJobObjectiveMetric$Value' => '

The value of the objective metric.

', ], ], 'MetricsSource' => [ 'base' => '

Details about the metrics source.

', 'refs' => [ 'Bias$Report' => '

The bias report for a model

', 'Bias$PreTrainingReport' => '

The pre-training bias report for a model.

', 'Bias$PostTrainingReport' => '

The post-training bias report for a model.

', 'DriftCheckBias$PreTrainingConstraints' => '

The pre-training constraints.

', 'DriftCheckBias$PostTrainingConstraints' => '

The post-training constraints.

', 'DriftCheckExplainability$Constraints' => '

The drift check explainability constraints.

', 'DriftCheckModelDataQuality$Statistics' => '

The drift check model data quality statistics.

', 'DriftCheckModelDataQuality$Constraints' => '

The drift check model data quality constraints.

', 'DriftCheckModelQuality$Statistics' => '

The drift check model quality statistics.

', 'DriftCheckModelQuality$Constraints' => '

The drift check model quality constraints.

', 'Explainability$Report' => '

The explainability report for a model.

', 'ModelDataQuality$Statistics' => '

Data quality statistics for a model.

', 'ModelDataQuality$Constraints' => '

Data quality constraints for a model.

', 'ModelQuality$Statistics' => '

Model quality statistics.

', 'ModelQuality$Constraints' => '

Model quality constraints.

', ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataServiceConfiguration$MinimumInstanceMetadataServiceVersion' => '

Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

', ], ], 'Model' => [ 'base' => '

The properties of a model as returned by the Search API.

', 'refs' => [ 'ModelDashboardModel$Model' => '

A model displayed in the Model Dashboard.

', ], ], 'ModelAccessConfig' => [ 'base' => '

The access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig. For more information, see End-user license agreements.

', 'refs' => [ 'S3ModelDataSource$ModelAccessConfig' => '

Specifies the access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

', 'TextGenerationJobConfig$ModelAccessConfig' => NULL, ], ], 'ModelApprovalStatus' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelApprovalStatus' => '

The approval status of the model.

', 'CreateModelPackageInput$ModelApprovalStatus' => '

Whether the model is approved for deployment.

This parameter is optional for versioned models, and does not apply to unversioned models.

For versioned models, the value of this parameter must be set to Approved to deploy the model.

', 'DescribeModelPackageOutput$ModelApprovalStatus' => '

The approval status of the model package.

', 'ListModelPackagesInput$ModelApprovalStatus' => '

A filter that returns only the model packages with the specified approval status.

', 'ModelPackage$ModelApprovalStatus' => '

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

', 'ModelPackageSummary$ModelApprovalStatus' => '

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

', 'UpdateModelPackageInput$ModelApprovalStatus' => '

The approval status of the model.

', ], ], 'ModelArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelOutput$ModelArn' => '

The ARN of the model created in SageMaker.

', 'DescribeModelOutput$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', 'LabelingJobAlgorithmsConfig$InitialActiveLearningModelArn' => '

At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

', 'LabelingJobOutput$FinalActiveLearningModelArn' => '

The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.

', 'Model$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', 'ModelSummary$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', ], ], 'ModelArtifacts' => [ 'base' => '

Provides information about the location that is configured for storing model artifacts.

Model artifacts are the output that results from training a model, and typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata.

', 'refs' => [ 'DescribeCompilationJobResponse$ModelArtifacts' => '

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

', 'DescribeTrainingJobResponse$ModelArtifacts' => '

Information about the Amazon S3 location that is configured for storing model artifacts.

', 'TrainingJob$ModelArtifacts' => '

Information about the Amazon S3 location that is configured for storing model artifacts.

', ], ], 'ModelBiasAppSpecification' => [ 'base' => '

Docker container image configuration object for the model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasAppSpecification' => '

Configures the model bias job to run a specified Docker container image.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasAppSpecification' => '

Configures the model bias job to run a specified Docker container image.

', ], ], 'ModelBiasBaselineConfig' => [ 'base' => '

The configuration for a baseline model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasBaselineConfig' => '

The baseline configuration for a model bias job.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasBaselineConfig' => '

The baseline configuration for a model bias job.

', ], ], 'ModelBiasJobInput' => [ 'base' => '

Inputs for the model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasJobInput' => '

Inputs for the model bias job.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobInput' => '

Inputs for the model bias job.

', ], ], 'ModelCacheSetting' => [ 'base' => NULL, 'refs' => [ 'MultiModelConfig$ModelCacheSetting' => '

Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.

', ], ], 'ModelCard' => [ 'base' => '

An Amazon SageMaker Model Card.

', 'refs' => [ 'SearchRecord$ModelCard' => '

An Amazon SageMaker Model Card that documents details about a machine learning model.

', ], ], 'ModelCardArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the successfully created model card.

', 'DescribeModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCard$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCardSummary$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCardVersionSummary$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelDashboardModelCard$ModelCardArn' => '

The Amazon Resource Name (ARN) for a model card.

', 'UpdateModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the updated model card.

', ], ], 'ModelCardContent' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$Content' => '

The content of the model card. Content must be in model card JSON schema and provided as a string.

', 'DescribeModelCardResponse$Content' => '

The content of the model card.

', 'ModelCard$Content' => '

The content of the model card. Content uses the model card JSON schema and provided as a string.

', 'UpdateModelCardRequest$Content' => '

The updated model card content. Content must be in model card JSON schema and provided as a string.

When updating model card content, be sure to include the full content and not just updated content.

', ], ], 'ModelCardExportArtifacts' => [ 'base' => '

The artifacts of the model card export job.

', 'refs' => [ 'DescribeModelCardExportJobResponse$ExportArtifacts' => '

The exported model card artifacts.

', ], ], 'ModelCardExportJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobResponse$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', 'DescribeModelCardExportJobRequest$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job to describe.

', 'DescribeModelCardExportJobResponse$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', 'ModelCardExportJobSummary$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', ], ], 'ModelCardExportJobSortBy' => [ 'base' => 'Attribute by which to sort returned export jobs.', 'refs' => [ 'ListModelCardExportJobsRequest$SortBy' => '

Sort model card export jobs by either name or creation time. Sorts by creation time by default.

', ], ], 'ModelCardExportJobSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsRequest$SortOrder' => '

Sort model card export jobs by ascending or descending order.

', ], ], 'ModelCardExportJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardExportJobResponse$Status' => '

The completion status of the model card export job.

  • InProgress: The model card export job is in progress.

  • Completed: The model card export job is complete.

  • Failed: The model card export job failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeModelCardExportJob call.

', 'ListModelCardExportJobsRequest$StatusEquals' => '

Only list model card export jobs with the specified status.

', 'ModelCardExportJobSummary$Status' => '

The completion status of the model card export job.

', ], ], 'ModelCardExportJobSummary' => [ 'base' => '

The summary of the Amazon SageMaker Model Card export job.

', 'refs' => [ 'ModelCardExportJobSummaryList$member' => NULL, ], ], 'ModelCardExportJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsResponse$ModelCardExportJobSummaries' => '

The summaries of the listed model card export jobs.

', ], ], 'ModelCardExportOutputConfig' => [ 'base' => '

Configure the export output details for an Amazon SageMaker Model Card.

', 'refs' => [ 'CreateModelCardExportJobRequest$OutputConfig' => '

The model card output configuration that specifies the Amazon S3 path for exporting.

', 'DescribeModelCardExportJobResponse$OutputConfig' => '

The export output details for the model card.

', ], ], 'ModelCardNameOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to export.

', 'DescribeModelCardRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to describe.

', 'ListModelCardVersionsRequest$ModelCardName' => '

List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

', 'UpdateModelCardRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to update.

', ], ], 'ModelCardProcessingStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardResponse$ModelCardProcessingStatus' => '

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

  • DeletePending: Model card deletion request received.

  • DeleteInProgress: Model card deletion is in progress.

  • ContentDeleted: Deleted model card content.

  • ExportJobsDeleted: Deleted all export jobs associated with the model card.

  • DeleteCompleted: Successfully deleted the model card.

  • DeleteFailed: The model card failed to delete.

', ], ], 'ModelCardSecurityConfig' => [ 'base' => '

Configure the security settings to protect model card data.

', 'refs' => [ 'CreateModelCardRequest$SecurityConfig' => '

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

', 'DescribeModelCardResponse$SecurityConfig' => '

The security configuration used to protect model card content.

', 'ModelCard$SecurityConfig' => '

The security configuration used to protect model card data.

', 'ModelDashboardModelCard$SecurityConfig' => '

The KMS Key ID (KMSKeyId) for encryption of model card information.

', ], ], 'ModelCardSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelCardsRequest$SortBy' => '

Sort model cards by either name or creation time. Sorts by creation time by default.

', ], ], 'ModelCardSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortOrder' => '

Sort model card versions by ascending or descending order.

', 'ListModelCardsRequest$SortOrder' => '

Sort model cards by ascending or descending order.

', ], ], 'ModelCardStatus' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'DescribeModelCardResponse$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ListModelCardVersionsRequest$ModelCardStatus' => '

Only list model card versions with the specified approval status.

', 'ListModelCardsRequest$ModelCardStatus' => '

Only list model cards with the specified approval status.

', 'ModelCard$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelCardSummary$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelCardVersionSummary$ModelCardStatus' => '

The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelDashboardModelCard$ModelCardStatus' => '

The model card status.

', 'UpdateModelCardRequest$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', ], ], 'ModelCardSummary' => [ 'base' => '

A summary of the model card.

', 'refs' => [ 'ModelCardSummaryList$member' => NULL, ], ], 'ModelCardSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardsResponse$ModelCardSummaries' => '

The summaries of the listed model cards.

', ], ], 'ModelCardVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortBy' => '

Sort listed model card versions by version. Sorts by version by default.

', ], ], 'ModelCardVersionSummary' => [ 'base' => '

A summary of a specific version of the model card.

', 'refs' => [ 'ModelCardVersionSummaryList$member' => NULL, ], ], 'ModelCardVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsResponse$ModelCardVersionSummaryList' => '

The summaries of the listed versions of the model card.

', ], ], 'ModelClientConfig' => [ 'base' => '

Configures the timeout and maximum number of retries for processing a transform job invocation.

', 'refs' => [ 'CreateTransformJobRequest$ModelClientConfig' => '

Configures the timeout and maximum number of retries for processing a transform job invocation.

', 'DescribeTransformJobResponse$ModelClientConfig' => '

The timeout and maximum number of retries for processing a transform job invocation.

', 'TransformJob$ModelClientConfig' => NULL, ], ], 'ModelCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$CompressionType' => '

Specifies how the ML model data is prepared.

If you choose Gzip and choose S3Object as the value of S3DataType, S3Uri identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment.

If you choose None and chooose S3Object as the value of S3DataType, S3Uri identifies an object that represents an uncompressed ML model to deploy.

If you choose None and choose S3Prefix as the value of S3DataType, S3Uri identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy.

If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code:

  • If you choose S3Object as the value of S3DataType, then SageMaker will split the key of the S3 object referenced by S3Uri by slash (/), and use the last part as the filename of the file holding the content of the S3 object.

  • If you choose S3Prefix as the value of S3DataType, then for each S3 object under the key name pefix referenced by S3Uri, SageMaker will trim its key by the prefix, and use the remainder as the path (relative to /opt/ml/model) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object.

  • Do not use any of the following as file names or directory names:

    • An empty or blank string

    • A string which contains null bytes

    • A string longer than 255 bytes

    • A single dot (.)

    • A double dot (..)

  • Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects s3://mybucket/model/weights and s3://mybucket/model/weights/part1 and you specify s3://mybucket/model/ as the value of S3Uri and S3Prefix as the value of S3DataType, then it will result in name clash between /opt/ml/model/weights (a regular file) and /opt/ml/model/weights/ (a directory).

  • Do not organize the model artifacts in S3 console using folders. When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure.

', ], ], 'ModelConfiguration' => [ 'base' => '

Defines the model configuration. Includes the specification name and environment parameters.

', 'refs' => [ 'InferenceRecommendation$ModelConfiguration' => '

Defines the model configuration.

', 'RecommendationJobInferenceBenchmark$ModelConfiguration' => NULL, ], ], 'ModelDashboardEndpoint' => [ 'base' => '

An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardEndpoints$member' => NULL, ], ], 'ModelDashboardEndpoints' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$Endpoints' => '

The endpoints that host a model.

', ], ], 'ModelDashboardIndicatorAction' => [ 'base' => '

An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.

', 'refs' => [ 'MonitoringAlertActions$ModelDashboardIndicator' => '

An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.

', ], ], 'ModelDashboardModel' => [ 'base' => '

A model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'SearchRecord$Model' => NULL, ], ], 'ModelDashboardModelCard' => [ 'base' => '

The model card for a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardModel$ModelCard' => '

The model card for a model.

', ], ], 'ModelDashboardMonitoringSchedule' => [ 'base' => '

A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardMonitoringSchedules$member' => NULL, ], ], 'ModelDashboardMonitoringSchedules' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$MonitoringSchedules' => '

The monitoring schedules for a model.

', ], ], 'ModelDataQuality' => [ 'base' => '

Data quality constraints and statistics for a model.

', 'refs' => [ 'ModelMetrics$ModelDataQuality' => '

Metrics that measure the quality of the input data for a model.

', ], ], 'ModelDataSource' => [ 'base' => '

Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.

', 'refs' => [ 'ContainerDefinition$ModelDataSource' => '

Specifies the location of ML model data to deploy.

Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace.

', ], ], 'ModelDeployConfig' => [ 'base' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'refs' => [ 'CreateAutoMLJobRequest$ModelDeployConfig' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'CreateAutoMLJobV2Request$ModelDeployConfig' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'DescribeAutoMLJobResponse$ModelDeployConfig' => '

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

', 'DescribeAutoMLJobV2Response$ModelDeployConfig' => '

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

', ], ], 'ModelDeployResult' => [ 'base' => '

Provides information about the endpoint of the model deployment.

', 'refs' => [ 'DescribeAutoMLJobResponse$ModelDeployResult' => '

Provides information about endpoint for the model deployment.

', 'DescribeAutoMLJobV2Response$ModelDeployResult' => '

Provides information about endpoint for the model deployment.

', ], ], 'ModelDigests' => [ 'base' => '

Provides information to verify the integrity of stored model artifacts.

', 'refs' => [ 'DescribeCompilationJobResponse$ModelDigests' => '

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

', ], ], 'ModelExplainabilityAppSpecification' => [ 'base' => '

Docker container image configuration object for the model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityAppSpecification' => '

Configures the model explainability job to run a specified Docker container image.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityAppSpecification' => '

Configures the model explainability job to run a specified Docker container image.

', ], ], 'ModelExplainabilityBaselineConfig' => [ 'base' => '

The configuration for a baseline model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityBaselineConfig' => '

The baseline configuration for a model explainability job.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityBaselineConfig' => '

The baseline configuration for a model explainability job.

', ], ], 'ModelExplainabilityJobInput' => [ 'base' => '

Inputs for the model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobInput' => '

Inputs for the model explainability job.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobInput' => '

Inputs for the model explainability job.

', ], ], 'ModelInfrastructureConfig' => [ 'base' => '

The configuration for the infrastructure that the model will be deployed to.

', 'refs' => [ 'ModelVariantConfig$InfrastructureConfig' => '

The configuration for the infrastructure that the model will be deployed to.

', 'ModelVariantConfigSummary$InfrastructureConfig' => '

The configuration of the infrastructure that the model has been deployed to.

', ], ], 'ModelInfrastructureType' => [ 'base' => NULL, 'refs' => [ 'ModelInfrastructureConfig$InfrastructureType' => '

The inference option to which to deploy your model. Possible values are the following:

  • RealTime: Deploy to real-time inference.

', ], ], 'ModelInput' => [ 'base' => '

Input object for the model.

', 'refs' => [ 'ModelPackageContainerDefinition$ModelInput' => '

A structure with Model Input details.

', ], ], 'ModelInsightsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$ModelInsights' => '

The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.

', ], ], 'ModelLatencyThreshold' => [ 'base' => '

The model latency threshold.

', 'refs' => [ 'ModelLatencyThresholds$member' => NULL, ], ], 'ModelLatencyThresholds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$ModelLatencyThresholds' => '

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

', ], ], 'ModelMetadataFilter' => [ 'base' => '

Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).

', 'refs' => [ 'ModelMetadataFilters$member' => NULL, ], ], 'ModelMetadataFilterType' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataFilter$Name' => '

The name of the of the model to filter by.

', ], ], 'ModelMetadataFilters' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataSearchExpression$Filters' => '

A list of filter objects.

', ], ], 'ModelMetadataSearchExpression' => [ 'base' => '

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results

', 'refs' => [ 'ListModelMetadataRequest$SearchExpression' => '

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

', ], ], 'ModelMetadataSummaries' => [ 'base' => NULL, 'refs' => [ 'ListModelMetadataResponse$ModelMetadataSummaries' => '

A structure that holds model metadata.

', ], ], 'ModelMetadataSummary' => [ 'base' => '

A summary of the model metadata.

', 'refs' => [ 'ModelMetadataSummaries$member' => NULL, ], ], 'ModelMetrics' => [ 'base' => '

Contains metrics captured from a model.

', 'refs' => [ 'CreateModelPackageInput$ModelMetrics' => '

A structure that contains model metrics reports.

', 'DescribeModelPackageOutput$ModelMetrics' => '

Metrics for the model.

', 'ModelPackage$ModelMetrics' => '

Metrics for the model.

', ], ], 'ModelName' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$ModelName' => '

The name of the new model.

', 'CreateTransformJobRequest$ModelName' => '

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.

', 'DeleteModelInput$ModelName' => '

The name of the model to delete.

', 'DescribeModelInput$ModelName' => '

The name of the model.

', 'DescribeModelOutput$ModelName' => '

Name of the SageMaker model.

', 'DescribeTransformJobResponse$ModelName' => '

The name of the model used in the transform job.

', 'InferenceComponentSpecification$ModelName' => '

The name of an existing SageMaker model object in your account that you want to deploy with the inference component.

', 'InferenceComponentSpecificationSummary$ModelName' => '

The name of the SageMaker model object that is deployed with the inference component.

', 'InferenceRecommendationsJob$ModelName' => '

The name of the created model.

', 'ListInferenceRecommendationsJobsRequest$ModelNameEquals' => '

A filter that returns only jobs that were created for this model.

', 'Model$ModelName' => '

The name of the model.

', 'ModelSummary$ModelName' => '

The name of the model that you want a summary for.

', 'ModelVariantConfig$ModelName' => '

The name of the Amazon SageMaker Model entity.

', 'ModelVariantConfigSummary$ModelName' => '

The name of the Amazon SageMaker Model entity.

', 'ProductionVariant$ModelName' => '

The name of the model that you want to host. This is the name that you specified when creating the model.

', 'RecommendationJobInputConfig$ModelName' => '

The name of the created model.

', 'TransformJob$ModelName' => '

The name of the model associated with the transform job.

', ], ], 'ModelNameContains' => [ 'base' => NULL, 'refs' => [ 'ListModelsInput$NameContains' => '

A string in the model name. This filter returns only models whose name contains the specified string.

', ], ], 'ModelPackage' => [ 'base' => '

A versioned model that can be deployed for SageMaker inference.

', 'refs' => [ 'SearchRecord$ModelPackage' => NULL, ], ], 'ModelPackageArn' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageErrorMap$key' => NULL, 'BatchDescribeModelPackageSummary$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'CreateCompilationJobRequest$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

', 'CreateModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the new model package.

', 'DescribeCompilationJobResponse$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

', 'DescribeModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'InferenceRecommendationsJob$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package.

', 'ListInferenceRecommendationsJobsRequest$ModelPackageVersionArnEquals' => '

A filter that returns only jobs that were created for this versioned model package.

', 'ModelPackage$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'ModelPackageArnList$member' => NULL, 'ModelPackageSummaries$key' => NULL, 'ModelPackageSummary$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'RecommendationJobInputConfig$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package.

', 'UpdateModelPackageInput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'UpdateModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model.

', ], ], 'ModelPackageArnList' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageInput$ModelPackageArnList' => '

The list of Amazon Resource Name (ARN) of the model package groups.

', ], ], 'ModelPackageContainerDefinition' => [ 'base' => '

Describes the Docker container for the model package.

', 'refs' => [ 'ModelPackageContainerDefinitionList$member' => NULL, ], ], 'ModelPackageContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Containers' => '

The Amazon ECR registry path of the Docker image that contains the inference code.

', 'InferenceSpecification$Containers' => '

The Amazon ECR registry path of the Docker image that contains the inference code.

', ], ], 'ModelPackageFrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$FrameworkVersion' => '

The framework version of the Model Package Container Image.

', ], ], 'ModelPackageGroup' => [ 'base' => '

A group of versioned models in the model registry.

', 'refs' => [ 'SearchRecord$ModelPackageGroup' => NULL, ], ], 'ModelPackageGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageGroupOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'ModelPackageGroup$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'PutModelPackageGroupPolicyOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model package group.

', ], ], 'ModelPackageGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsInput$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'ModelPackageGroupStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelPackageGroupOutput$ModelPackageGroupStatus' => '

The status of the model group.

', 'ModelPackageGroup$ModelPackageGroupStatus' => '

The status of the model group. This can be one of the following values.

  • PENDING - The model group is pending being created.

  • IN_PROGRESS - The model group is in the process of being created.

  • COMPLETED - The model group was successfully created.

  • FAILED - The model group failed.

  • DELETING - The model group is in the process of being deleted.

  • DELETE_FAILED - SageMaker failed to delete the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupStatus' => '

The status of the model group.

', ], ], 'ModelPackageGroupSummary' => [ 'base' => '

Summary information about a model group.

', 'refs' => [ 'ModelPackageGroupSummaryList$member' => NULL, ], ], 'ModelPackageGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsOutput$ModelPackageGroupSummaryList' => '

A list of summaries of the model groups in your Amazon Web Services account.

', ], ], 'ModelPackageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesInput$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'ModelPackageStatus' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelPackageStatus' => '

The status of the mortgage package.

', 'DescribeModelPackageOutput$ModelPackageStatus' => '

The current status of the model package.

', 'ModelPackage$ModelPackageStatus' => '

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.

  • IN_PROGRESS - The model package is in the process of being created.

  • COMPLETED - The model package was successfully created.

  • FAILED - The model package failed.

  • DELETING - The model package is in the process of being deleted.

', 'ModelPackageSummary$ModelPackageStatus' => '

The overall status of the model package.

', ], ], 'ModelPackageStatusDetails' => [ 'base' => '

Specifies the validation and image scan statuses of the model package.

', 'refs' => [ 'DescribeModelPackageOutput$ModelPackageStatusDetails' => '

Details about the current status of the model package.

', 'ModelPackage$ModelPackageStatusDetails' => '

Specifies the validation and image scan statuses of the model package.

', ], ], 'ModelPackageStatusItem' => [ 'base' => '

Represents the overall status of a model package.

', 'refs' => [ 'ModelPackageStatusItemList$member' => NULL, ], ], 'ModelPackageStatusItemList' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusDetails$ValidationStatuses' => '

The validation status of the model package.

', 'ModelPackageStatusDetails$ImageScanStatuses' => '

The status of the scan of the Docker image container for the model package.

', ], ], 'ModelPackageSummaries' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$ModelPackageSummaries' => '

The summaries for the model package versions

', ], ], 'ModelPackageSummary' => [ 'base' => '

Provides summary information about a model package.

', 'refs' => [ 'ModelPackageSummaryList$member' => NULL, ], ], 'ModelPackageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesOutput$ModelPackageSummaryList' => '

An array of ModelPackageSummary objects, each of which lists a model package.

', ], ], 'ModelPackageType' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesInput$ModelPackageType' => '

A filter that returns only the model packages of the specified type. This can be one of the following values.

  • UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

  • VERSIONED - List only versioned models.

  • BOTH - List both versioned and unversioned models.

', ], ], 'ModelPackageValidationProfile' => [ 'base' => '

Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

', 'refs' => [ 'ModelPackageValidationProfiles$member' => NULL, ], ], 'ModelPackageValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'ModelPackageValidationSpecification$ValidationProfiles' => '

An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.

', ], ], 'ModelPackageValidationSpecification' => [ 'base' => '

Specifies batch transform jobs that SageMaker runs to validate your model package.

', 'refs' => [ 'CreateModelPackageInput$ValidationSpecification' => '

Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.

', 'DescribeModelPackageOutput$ValidationSpecification' => '

Configurations for one or more transform jobs that SageMaker runs to test the model package.

', 'ModelPackage$ValidationSpecification' => '

Specifies batch transform jobs that SageMaker runs to validate your model package.

', ], ], 'ModelPackageVersion' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelPackageVersion' => '

The version number of a versioned model.

', 'DescribeModelPackageOutput$ModelPackageVersion' => '

The version of the model package.

', 'ModelPackage$ModelPackageVersion' => '

The version number of a versioned model.

', 'ModelPackageSummary$ModelPackageVersion' => '

If the model package is a versioned model, the version of the model.

', ], ], 'ModelQuality' => [ 'base' => '

Model quality statistics and constraints.

', 'refs' => [ 'ModelMetrics$ModelQuality' => '

Metrics that measure the quality of a model.

', ], ], 'ModelQualityAppSpecification' => [ 'base' => '

Container image configuration object for the monitoring job.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityAppSpecification' => '

The container that runs the monitoring job.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityAppSpecification' => '

Configures the model quality job to run a specified Docker container image.

', ], ], 'ModelQualityBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityBaselineConfig' => '

Specifies the constraints and baselines for the monitoring job.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityBaselineConfig' => '

The baseline configuration for a model quality job.

', ], ], 'ModelQualityJobInput' => [ 'base' => '

The input for the model quality monitoring job. Currently endpoints are supported for input for model quality monitoring jobs.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityJobInput' => '

A list of the inputs that are monitored. Currently endpoints are supported.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobInput' => '

Inputs for the model quality job.

', ], ], 'ModelRegisterSettings' => [ 'base' => '

The model registry settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$ModelRegisterSettings' => '

The model registry settings for the SageMaker Canvas application.

', ], ], 'ModelSetupTime' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$ModelSetupTime' => '

The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the model size, how long it takes to download the model, and the start-up time of the container.

NaN indicates that the value is not available.

', ], ], 'ModelSortKey' => [ 'base' => NULL, 'refs' => [ 'ListModelsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'ModelStepMetadata' => [ 'base' => '

Metadata for Model steps.

', 'refs' => [ 'PipelineExecutionStepMetadata$Model' => '

The Amazon Resource Name (ARN) of the model that was created by this step execution.

', ], ], 'ModelSummary' => [ 'base' => '

Provides summary information about a model.

', 'refs' => [ 'ModelSummaryList$member' => NULL, ], ], 'ModelSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelsOutput$Models' => '

An array of ModelSummary objects, each of which lists a model.

', ], ], 'ModelVariantAction' => [ 'base' => NULL, 'refs' => [ 'ModelVariantActionMap$value' => NULL, ], ], 'ModelVariantActionMap' => [ 'base' => NULL, 'refs' => [ 'StopInferenceExperimentRequest$ModelVariantActions' => '

Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

  • Promote - Promote the shadow variant to a production variant

  • Remove - Delete the variant

  • Retain - Keep the variant as it is

', ], ], 'ModelVariantConfig' => [ 'base' => '

Contains information about the deployment options of a model.

', 'refs' => [ 'ModelVariantConfigList$member' => NULL, ], ], 'ModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$ModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.

', 'StopInferenceExperimentRequest$DesiredModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

', 'UpdateInferenceExperimentRequest$ModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.

', ], ], 'ModelVariantConfigSummary' => [ 'base' => '

Summary of the deployment configuration of a model.

', 'refs' => [ 'ModelVariantConfigSummaryList$member' => NULL, ], ], 'ModelVariantConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$ModelVariants' => '

An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

', ], ], 'ModelVariantName' => [ 'base' => NULL, 'refs' => [ 'ModelVariantActionMap$key' => NULL, 'ModelVariantConfig$VariantName' => '

The name of the variant.

', 'ModelVariantConfigSummary$VariantName' => '

The name of the variant.

', 'ShadowModeConfig$SourceModelVariantName' => '

The name of the production variant, which takes all the inference requests.

', 'ShadowModelVariantConfig$ShadowModelVariantName' => '

The name of the shadow variant.

', ], ], 'ModelVariantStatus' => [ 'base' => NULL, 'refs' => [ 'ModelVariantConfigSummary$Status' => '

The status of deployment for the model variant on the hosted inference endpoint.

  • Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.

  • InService - The model variant is running on the hosted inference endpoint.

  • Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.

  • Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.

  • Deleted - The model variant has been deleted on the hosted inference endpoint. This can only happen after stopping the experiment.

', ], ], 'MonitoringAlertActions' => [ 'base' => '

A list of alert actions taken in response to an alert going into InAlert status.

', 'refs' => [ 'MonitoringAlertSummary$Actions' => '

A list of alert actions taken in response to an alert going into InAlert status.

', ], ], 'MonitoringAlertHistoryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryResponse$MonitoringAlertHistory' => '

An alert history for a model monitoring schedule.

', ], ], 'MonitoringAlertHistorySortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$SortBy' => '

The field used to sort results. The default is CreationTime.

', ], ], 'MonitoringAlertHistorySummary' => [ 'base' => '

Provides summary information of an alert\'s history.

', 'refs' => [ 'MonitoringAlertHistoryList$member' => NULL, ], ], 'MonitoringAlertName' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$MonitoringAlertName' => '

The name of a monitoring alert.

', 'MonitoringAlertHistorySummary$MonitoringAlertName' => '

The name of a monitoring alert.

', 'MonitoringAlertSummary$MonitoringAlertName' => '

The name of a monitoring alert.

', 'UpdateMonitoringAlertRequest$MonitoringAlertName' => '

The name of a monitoring alert.

', 'UpdateMonitoringAlertResponse$MonitoringAlertName' => '

The name of a monitoring alert.

', ], ], 'MonitoringAlertStatus' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$StatusEquals' => '

A filter that retrieves only alerts with a specific status.

', 'MonitoringAlertHistorySummary$AlertStatus' => '

The current alert status of an alert.

', 'MonitoringAlertSummary$AlertStatus' => '

The current status of an alert.

', ], ], 'MonitoringAlertSummary' => [ 'base' => '

Provides summary information about a monitor alert.

', 'refs' => [ 'MonitoringAlertSummaryList$member' => NULL, ], ], 'MonitoringAlertSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertsResponse$MonitoringAlertSummaries' => '

A JSON array where each element is a summary for a monitoring alert.

', 'ModelDashboardMonitoringSchedule$MonitoringAlertSummaries' => '

A JSON array where each element is a summary for a monitoring alert.

', ], ], 'MonitoringAppSpecification' => [ 'base' => '

Container image configuration object for the monitoring job.

', 'refs' => [ 'MonitoringJobDefinition$MonitoringAppSpecification' => '

Configures the monitoring job to run a specified Docker container image.

', ], ], 'MonitoringBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'MonitoringJobDefinition$BaselineConfig' => '

Baseline configuration used to validate that the data conforms to the specified constraints and statistics

', ], ], 'MonitoringClusterConfig' => [ 'base' => '

Configuration for the cluster used to run model monitoring jobs.

', 'refs' => [ 'MonitoringResources$ClusterConfig' => '

The configuration for the cluster resources used to run the processing job.

', ], ], 'MonitoringConstraintsResource' => [ 'base' => '

The constraints resource for a monitoring job.

', 'refs' => [ 'DataQualityBaselineConfig$ConstraintsResource' => NULL, 'ModelBiasBaselineConfig$ConstraintsResource' => NULL, 'ModelExplainabilityBaselineConfig$ConstraintsResource' => NULL, 'ModelQualityBaselineConfig$ConstraintsResource' => NULL, 'MonitoringBaselineConfig$ConstraintsResource' => '

The baseline constraint file in Amazon S3 that the current monitoring job should validated against.

', ], ], 'MonitoringContainerArguments' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$ContainerArguments' => '

The arguments to send to the container that the monitoring job runs.

', 'ModelQualityAppSpecification$ContainerArguments' => '

An array of arguments for the container used to run the monitoring job.

', 'MonitoringAppSpecification$ContainerArguments' => '

An array of arguments for the container used to run the monitoring job.

', ], ], 'MonitoringCsvDatasetFormat' => [ 'base' => '

Represents the CSV dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Csv' => '

The CSV dataset used in the monitoring job.

', ], ], 'MonitoringDatapointsToAlert' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$DatapointsToAlert' => '

Within EvaluationPeriod, how many execution failures will raise an alert.

', 'UpdateMonitoringAlertRequest$DatapointsToAlert' => '

Within EvaluationPeriod, how many execution failures will raise an alert.

', ], ], 'MonitoringDatasetFormat' => [ 'base' => '

Represents the dataset format used when running a monitoring job.

', 'refs' => [ 'BatchTransformInput$DatasetFormat' => '

The dataset format for your batch transform job.

', ], ], 'MonitoringEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$Environment' => '

Sets the environment variables in the container that the monitoring job runs.

', 'ModelBiasAppSpecification$Environment' => '

Sets the environment variables in the Docker container.

', 'ModelExplainabilityAppSpecification$Environment' => '

Sets the environment variables in the Docker container.

', 'ModelQualityAppSpecification$Environment' => '

Sets the environment variables in the container that the monitoring job runs.

', 'MonitoringJobDefinition$Environment' => '

Sets the environment variables in the Docker container.

', ], ], 'MonitoringEvaluationPeriod' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$EvaluationPeriod' => '

The number of most recent monitoring executions to consider when evaluating alert status.

', 'UpdateMonitoringAlertRequest$EvaluationPeriod' => '

The number of most recent monitoring executions to consider when evaluating alert status.

', ], ], 'MonitoringExecutionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsRequest$SortBy' => '

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

', ], ], 'MonitoringExecutionSummary' => [ 'base' => '

Summary of information about the last monitoring job to run.

', 'refs' => [ 'DescribeMonitoringScheduleResponse$LastMonitoringExecutionSummary' => '

Describes metadata on the last execution to run, if there was one.

', 'ModelDashboardMonitoringSchedule$LastMonitoringExecutionSummary' => NULL, 'MonitoringExecutionSummaryList$member' => NULL, 'MonitoringSchedule$LastMonitoringExecutionSummary' => NULL, ], ], 'MonitoringExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsResponse$MonitoringExecutionSummaries' => '

A JSON array in which each element is a summary for a monitoring execution.

', ], ], 'MonitoringGroundTruthS3Input' => [ 'base' => '

The ground truth labels for the dataset used for the monitoring job.

', 'refs' => [ 'ModelBiasJobInput$GroundTruthS3Input' => '

Location of ground truth labels to use in model bias job.

', 'ModelQualityJobInput$GroundTruthS3Input' => '

The ground truth label provided for the model.

', ], ], 'MonitoringInput' => [ 'base' => '

The inputs for a monitoring job.

', 'refs' => [ 'MonitoringInputs$member' => NULL, ], ], 'MonitoringInputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringJobDefinition$MonitoringInputs' => '

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

', ], ], 'MonitoringJobDefinition' => [ 'base' => '

Defines the monitoring job.

', 'refs' => [ 'MonitoringScheduleConfig$MonitoringJobDefinition' => '

Defines the monitoring job.

', ], ], 'MonitoringJobDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the job definition.

', 'CreateModelBiasJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model bias job.

', 'CreateModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model explainability job.

', 'CreateModelQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model quality monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the data quality monitoring job definition.

', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model bias job.

', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model explainability job.

', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model quality job.

', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionArn' => '

The Amazon Resource Name (ARN) of the monitoring job.

', ], ], 'MonitoringJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name for the monitoring job definition.

', 'CreateModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'CreateModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'CreateModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the monitoring job definition.

', 'DeleteDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the data quality monitoring job definition to delete.

', 'DeleteModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the model bias job definition to delete.

', 'DeleteModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition to delete.

', 'DeleteModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the model quality monitoring job definition to delete.

', 'DescribeDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the data quality monitoring job definition to describe.

', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionName' => '

The name of the data quality monitoring job definition.

', 'DescribeModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionName' => '

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionName' => '

The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionName' => '

The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'ListMonitoringExecutionsRequest$MonitoringJobDefinitionName' => '

Gets a list of the monitoring job runs of the specified monitoring job definitions.

', 'ListMonitoringSchedulesRequest$MonitoringJobDefinitionName' => '

Gets a list of the monitoring schedules for the specified monitoring job definition.

', 'MonitoringExecutionSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job.

', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job.

', 'MonitoringScheduleConfig$MonitoringJobDefinitionName' => '

The name of the monitoring job definition to schedule.

', 'MonitoringScheduleSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job definition that the schedule is for.

', ], ], 'MonitoringJobDefinitionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListModelBiasJobDefinitionsRequest$SortBy' => '

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

', 'ListModelExplainabilityJobDefinitionsRequest$SortBy' => '

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

', 'ListModelQualityJobDefinitionsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'MonitoringJobDefinitionSummary' => [ 'base' => '

Summary information about a monitoring job.

', 'refs' => [ 'MonitoringJobDefinitionSummaryList$member' => NULL, ], ], 'MonitoringJobDefinitionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsResponse$JobDefinitionSummaries' => '

A list of data quality monitoring job definitions.

', 'ListModelBiasJobDefinitionsResponse$JobDefinitionSummaries' => '

A JSON array in which each element is a summary for a model bias jobs.

', 'ListModelExplainabilityJobDefinitionsResponse$JobDefinitionSummaries' => '

A JSON array in which each element is a summary for a explainability bias jobs.

', 'ListModelQualityJobDefinitionsResponse$JobDefinitionSummaries' => '

A list of summaries of model quality monitoring job definitions.

', ], ], 'MonitoringJsonDatasetFormat' => [ 'base' => '

Represents the JSON dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Json' => '

The JSON dataset used in the monitoring job

', ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'MonitoringStoppingCondition$MaxRuntimeInSeconds' => '

The maximum runtime allowed in seconds.

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.

', ], ], 'MonitoringNetworkConfig' => [ 'base' => '

The networking configuration for the monitoring job.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$NetworkConfig' => '

Specifies networking configuration for the monitoring job.

', 'CreateModelBiasJobDefinitionRequest$NetworkConfig' => '

Networking options for a model bias job.

', 'CreateModelExplainabilityJobDefinitionRequest$NetworkConfig' => '

Networking options for a model explainability job.

', 'CreateModelQualityJobDefinitionRequest$NetworkConfig' => '

Specifies the network configuration for the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$NetworkConfig' => '

The networking configuration for the data quality monitoring job.

', 'DescribeModelBiasJobDefinitionResponse$NetworkConfig' => '

Networking options for a model bias job.

', 'DescribeModelExplainabilityJobDefinitionResponse$NetworkConfig' => '

Networking options for a model explainability job.

', 'DescribeModelQualityJobDefinitionResponse$NetworkConfig' => '

Networking options for a model quality job.

', ], ], 'MonitoringOutput' => [ 'base' => '

The output object for a monitoring job.

', 'refs' => [ 'MonitoringOutputs$member' => NULL, ], ], 'MonitoringOutputConfig' => [ 'base' => '

The output configuration for monitoring jobs.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobOutputConfig' => NULL, 'CreateModelBiasJobDefinitionRequest$ModelBiasJobOutputConfig' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobOutputConfig' => NULL, 'CreateModelQualityJobDefinitionRequest$ModelQualityJobOutputConfig' => NULL, 'DescribeDataQualityJobDefinitionResponse$DataQualityJobOutputConfig' => NULL, 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobOutputConfig' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobOutputConfig' => NULL, 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobOutputConfig' => NULL, 'MonitoringJobDefinition$MonitoringOutputConfig' => '

The array of outputs from the monitoring job to be uploaded to Amazon S3.

', ], ], 'MonitoringOutputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringOutputConfig$MonitoringOutputs' => '

Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.

', ], ], 'MonitoringParquetDatasetFormat' => [ 'base' => '

Represents the Parquet dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Parquet' => '

The Parquet dataset used in the monitoring job

', ], ], 'MonitoringProblemType' => [ 'base' => NULL, 'refs' => [ 'ModelQualityAppSpecification$ProblemType' => '

The machine learning problem type of the model that the monitoring job monitors.

', ], ], 'MonitoringResources' => [ 'base' => '

Identifies the resources to deploy for a monitoring job.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobResources' => NULL, 'CreateModelBiasJobDefinitionRequest$JobResources' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$JobResources' => NULL, 'CreateModelQualityJobDefinitionRequest$JobResources' => NULL, 'DescribeDataQualityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelBiasJobDefinitionResponse$JobResources' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelQualityJobDefinitionResponse$JobResources' => NULL, 'MonitoringJobDefinition$MonitoringResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

', ], ], 'MonitoringS3Output' => [ 'base' => '

Information about where and how you want to store the results of a monitoring job.

', 'refs' => [ 'MonitoringOutput$S3Output' => '

The Amazon S3 storage location where the results of a monitoring job are saved.

', ], ], 'MonitoringS3Uri' => [ 'base' => NULL, 'refs' => [ 'MonitoringGroundTruthS3Input$S3Uri' => '

The address of the Amazon S3 location of the ground truth labels.

', 'MonitoringS3Output$S3Uri' => '

A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.

', ], ], 'MonitoringSchedule' => [ 'base' => '

A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'refs' => [ 'MonitoringScheduleList$member' => NULL, ], ], 'MonitoringScheduleArn' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'DescribeProcessingJobResponse$MonitoringScheduleArn' => '

The ARN of a monitoring schedule for an endpoint associated with this processing job.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of a monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'MonitoringScheduleSummary$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'ProcessingJob$MonitoringScheduleArn' => '

The ARN of a monitoring schedule for an endpoint associated with this processing job.

', 'UpdateMonitoringAlertResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'UpdateMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', ], ], 'MonitoringScheduleConfig' => [ 'base' => '

Configures the monitoring schedule and defines the monitoring job.

', 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleConfig' => NULL, 'MonitoringSchedule$MonitoringScheduleConfig' => NULL, 'UpdateMonitoringScheduleRequest$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', ], ], 'MonitoringScheduleList' => [ 'base' => NULL, 'refs' => [ 'Endpoint$MonitoringSchedules' => '

A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.

', ], ], 'MonitoringScheduleName' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

', 'DeleteMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule to delete.

', 'DescribeMonitoringScheduleRequest$MonitoringScheduleName' => '

Name of a previously created monitoring schedule.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleName' => '

Name of the monitoring schedule.

', 'ListMonitoringAlertHistoryRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'ListMonitoringAlertsRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'ListMonitoringExecutionsRequest$MonitoringScheduleName' => '

Name of a specific schedule to fetch jobs for.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'MonitoringAlertHistorySummary$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'MonitoringExecutionSummary$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'MonitoringScheduleSummary$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'StartMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the schedule to start.

', 'StopMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the schedule to stop.

', 'UpdateMonitoringAlertRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'UpdateMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

', ], ], 'MonitoringScheduleSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesRequest$SortBy' => '

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

', ], ], 'MonitoringScheduleSummary' => [ 'base' => '

Summarizes the monitoring schedule.

', 'refs' => [ 'MonitoringScheduleSummaryList$member' => NULL, ], ], 'MonitoringScheduleSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesResponse$MonitoringScheduleSummaries' => '

A JSON array in which each element is a summary for a monitoring schedule.

', ], ], 'MonitoringStatisticsResource' => [ 'base' => '

The statistics resource for a monitoring job.

', 'refs' => [ 'DataQualityBaselineConfig$StatisticsResource' => NULL, 'MonitoringBaselineConfig$StatisticsResource' => '

The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.

', ], ], 'MonitoringStoppingCondition' => [ 'base' => '

A time limit for how long the monitoring job is allowed to run before stopping.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelBiasJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelQualityJobDefinitionRequest$StoppingCondition' => NULL, 'DescribeDataQualityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelBiasJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelQualityJobDefinitionResponse$StoppingCondition' => NULL, 'MonitoringJobDefinition$StoppingCondition' => '

Specifies a time limit for how long the monitoring job is allowed to run.

', ], ], 'MonitoringTimeOffsetString' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$StartTimeOffset' => '

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'BatchTransformInput$EndTimeOffset' => '

If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'EndpointInput$StartTimeOffset' => '

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'EndpointInput$EndTimeOffset' => '

If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', ], ], 'MonitoringType' => [ 'base' => NULL, 'refs' => [ 'DescribeMonitoringScheduleResponse$MonitoringType' => '

The type of the monitoring job that this schedule runs. This is one of the following values.

  • DATA_QUALITY - The schedule is for a data quality monitoring job.

  • MODEL_QUALITY - The schedule is for a model quality monitoring job.

  • MODEL_BIAS - The schedule is for a bias monitoring job.

  • MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

', 'ListMonitoringExecutionsRequest$MonitoringTypeEquals' => '

A filter that returns only the monitoring job runs of the specified monitoring type.

', 'ListMonitoringSchedulesRequest$MonitoringTypeEquals' => '

A filter that returns only the monitoring schedules for the specified monitoring type.

', 'ModelDashboardMonitoringSchedule$MonitoringType' => '

The monitor type of a model monitor.

', 'MonitoringExecutionSummary$MonitoringType' => '

The type of the monitoring job.

', 'MonitoringSchedule$MonitoringType' => '

The type of the monitoring job definition to schedule.

', 'MonitoringScheduleConfig$MonitoringType' => '

The type of the monitoring job definition to schedule.

', 'MonitoringScheduleSummary$MonitoringType' => '

The type of the monitoring job definition that the schedule is for.

', ], ], 'MountPath' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$MountPath' => '

The path within the image to mount the user\'s EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

', ], ], 'MultiModelConfig' => [ 'base' => '

Specifies additional configuration for hosting multi-model endpoints.

', 'refs' => [ 'ContainerDefinition$MultiModelConfig' => '

Specifies additional configuration for multi-model endpoints.

', ], ], 'NameContains' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$NameContains' => '

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

', 'ListClustersRequest$NameContains' => '

Set the maximum number of instances to print in the list.

', 'ListCompilationJobsRequest$NameContains' => '

A filter that returns the model compilation jobs whose name contains a specified string.

', 'ListDataQualityJobDefinitionsRequest$NameContains' => '

A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.

', 'ListDeviceFleetsRequest$NameContains' => '

Filter for fleets containing this name in their fleet device name.

', 'ListEdgeDeploymentPlansRequest$NameContains' => '

Selects edge deployment plans with names containing this name.

', 'ListEdgeDeploymentPlansRequest$DeviceFleetNameContains' => '

Selects edge deployment plans with a device fleet name containing this name.

', 'ListEdgePackagingJobsRequest$NameContains' => '

Filter for jobs containing this name in their packaging job name.

', 'ListEdgePackagingJobsRequest$ModelNameContains' => '

Filter for jobs where the model name contains this string.

', 'ListHubContentsRequest$NameContains' => '

Only list hub content if the name contains the specified string.

', 'ListHubsRequest$NameContains' => '

Only list hubs with names that contain the specified string.

', 'ListHyperParameterTuningJobsRequest$NameContains' => '

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

', 'ListInferenceExperimentsRequest$NameContains' => '

Selects inference experiments whose names contain this name.

', 'ListInferenceRecommendationsJobsRequest$NameContains' => '

A string in the job name. This filter returns only recommendations whose name contains the specified string.

', 'ListLabelingJobsRequest$NameContains' => '

A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

', 'ListModelBiasJobDefinitionsRequest$NameContains' => '

Filter for model bias jobs whose name contains a specified string.

', 'ListModelExplainabilityJobDefinitionsRequest$NameContains' => '

Filter for model explainability jobs whose name contains a specified string.

', 'ListModelPackageGroupsInput$NameContains' => '

A string in the model group name. This filter returns only model groups whose name contains the specified string.

', 'ListModelPackagesInput$NameContains' => '

A string in the model package name. This filter returns only model packages whose name contains the specified string.

', 'ListModelQualityJobDefinitionsRequest$NameContains' => '

A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.

', 'ListMonitoringSchedulesRequest$NameContains' => '

Filter for monitoring schedules whose name contains a specified string.

', 'ListTrainingJobsRequest$NameContains' => '

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

', 'ListTransformJobsRequest$NameContains' => '

A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

', ], ], 'NeoVpcConfig' => [ 'base' => '

The VpcConfig configuration object that specifies the VPC that you want the compilation jobs to connect to. For more information on controlling access to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker Compilation Jobs Access to Resources in Your Amazon VPC.

', 'refs' => [ 'CreateCompilationJobRequest$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

', 'DescribeCompilationJobResponse$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

', ], ], 'NeoVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'NeoVpcSecurityGroupIds$member' => NULL, ], ], 'NeoVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'NeoVpcConfig$SecurityGroupIds' => '

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'NeoVpcSubnetId' => [ 'base' => NULL, 'refs' => [ 'NeoVpcSubnets$member' => NULL, ], ], 'NeoVpcSubnets' => [ 'base' => NULL, 'refs' => [ 'NeoVpcConfig$Subnets' => '

The ID of the subnets in the VPC that you want to connect the compilation job to for accessing the model in Amazon S3.

', ], ], 'NestedFilters' => [ 'base' => '

A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.

For example, to filter on a training job\'s InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:

  • \'{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"}\',

  • \'{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains", "Value":"mybucket/catdata"}\'

', 'refs' => [ 'NestedFiltersList$member' => NULL, ], ], 'NestedFiltersList' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$NestedFilters' => '

A list of nested filter objects.

', ], ], 'NetworkConfig' => [ 'base' => '

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

', 'refs' => [ 'CreateProcessingJobRequest$NetworkConfig' => '

Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.

', 'DescribeProcessingJobResponse$NetworkConfig' => '

Networking options for a processing job.

', 'MonitoringJobDefinition$NetworkConfig' => '

Specifies networking options for an monitoring job.

', 'ProcessingJob$NetworkConfig' => NULL, ], ], 'NetworkInterfaceId' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NetworkInterfaceId' => '

The network interface IDs that SageMaker created at the time of creating the instance.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceRequest$NextToken' => '

Next token of device description.

', 'DescribeDeviceResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'DescribeEdgeDeploymentPlanRequest$NextToken' => '

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

', 'DescribeEdgeDeploymentPlanResponse$NextToken' => '

Token to use when calling the next set of stages in the edge deployment plan.

', 'DescribeFeatureGroupRequest$NextToken' => '

A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.

', 'DescribeFeatureGroupResponse$NextToken' => '

A token to resume pagination of the list of Features (FeatureDefinitions).

', 'ListActionsRequest$NextToken' => '

If the previous call to ListActions didn\'t return the full set of actions, the call returns a token for getting the next set of actions.

', 'ListActionsResponse$NextToken' => '

A token for getting the next set of actions, if there are any.

', 'ListAlgorithmsInput$NextToken' => '

If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

', 'ListAlgorithmsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListAliasesRequest$NextToken' => '

If the previous call to ListAliases didn\'t return the full set of aliases, the call returns a token for retrieving the next set of aliases.

', 'ListAliasesResponse$NextToken' => '

A token for getting the next set of aliases, if more aliases exist.

', 'ListAppImageConfigsRequest$NextToken' => '

If the previous call to ListImages didn\'t return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

', 'ListAppImageConfigsResponse$NextToken' => '

A token for getting the next set of AppImageConfigs, if there are any.

', 'ListAppsRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListAppsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListArtifactsRequest$NextToken' => '

If the previous call to ListArtifacts didn\'t return the full set of artifacts, the call returns a token for getting the next set of artifacts.

', 'ListArtifactsResponse$NextToken' => '

A token for getting the next set of artifacts, if there are any.

', 'ListAssociationsRequest$NextToken' => '

If the previous call to ListAssociations didn\'t return the full set of associations, the call returns a token for getting the next set of associations.

', 'ListAssociationsResponse$NextToken' => '

A token for getting the next set of associations, if there are any.

', 'ListAutoMLJobsRequest$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListAutoMLJobsResponse$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListCandidatesForAutoMLJobRequest$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListCandidatesForAutoMLJobResponse$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListClusterNodesRequest$NextToken' => '

If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.

', 'ListClusterNodesResponse$NextToken' => '

The next token specified for listing instances in a SageMaker HyperPod cluster.

', 'ListClustersRequest$NextToken' => '

Set the next token to retrieve the list of SageMaker HyperPod clusters.

', 'ListClustersResponse$NextToken' => '

If the result of the previous ListClusters request was truncated, the response includes a NextToken. To retrieve the next set of clusters, use the token in the next request.

', 'ListCodeRepositoriesInput$NextToken' => '

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

', 'ListCodeRepositoriesOutput$NextToken' => '

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

', 'ListCompilationJobsRequest$NextToken' => '

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

', 'ListCompilationJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.

', 'ListContextsRequest$NextToken' => '

If the previous call to ListContexts didn\'t return the full set of contexts, the call returns a token for getting the next set of contexts.

', 'ListContextsResponse$NextToken' => '

A token for getting the next set of contexts, if there are any.

', 'ListDataQualityJobDefinitionsRequest$NextToken' => '

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.>

', 'ListDataQualityJobDefinitionsResponse$NextToken' => '

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next request.

', 'ListDeviceFleetsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDeviceFleetsResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDevicesRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDevicesResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDomainsRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListDomainsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListEdgeDeploymentPlansRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListEdgeDeploymentPlansResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListEdgePackagingJobsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListEdgePackagingJobsResponse$NextToken' => '

Token to use when calling the next page of results.

', 'ListExperimentsRequest$NextToken' => '

If the previous call to ListExperiments didn\'t return the full set of experiments, the call returns a token for getting the next set of experiments.

', 'ListExperimentsResponse$NextToken' => '

A token for getting the next set of experiments, if there are any.

', 'ListFeatureGroupsRequest$NextToken' => '

A token to resume pagination of ListFeatureGroups results.

', 'ListFeatureGroupsResponse$NextToken' => '

A token to resume pagination of ListFeatureGroups results.

', 'ListFlowDefinitionsRequest$NextToken' => '

A token to resume pagination.

', 'ListFlowDefinitionsResponse$NextToken' => '

A token to resume pagination.

', 'ListHubContentVersionsRequest$NextToken' => '

If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.

', 'ListHubContentVersionsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.

', 'ListHubContentsRequest$NextToken' => '

If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.

', 'ListHubContentsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

', 'ListHubsRequest$NextToken' => '

If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

', 'ListHubsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

', 'ListHumanTaskUisRequest$NextToken' => '

A token to resume pagination.

', 'ListHumanTaskUisResponse$NextToken' => '

A token to resume pagination.

', 'ListHyperParameterTuningJobsRequest$NextToken' => '

If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

', 'ListHyperParameterTuningJobsResponse$NextToken' => '

If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

', 'ListImageVersionsRequest$NextToken' => '

If the previous call to ListImageVersions didn\'t return the full set of versions, the call returns a token for getting the next set of versions.

', 'ListImageVersionsResponse$NextToken' => '

A token for getting the next set of versions, if there are any.

', 'ListImagesRequest$NextToken' => '

If the previous call to ListImages didn\'t return the full set of images, the call returns a token for getting the next set of images.

', 'ListImagesResponse$NextToken' => '

A token for getting the next set of images, if there are any.

', 'ListInferenceExperimentsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListInferenceExperimentsResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListInferenceRecommendationsJobStepsRequest$NextToken' => '

A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

', 'ListInferenceRecommendationsJobStepsResponse$NextToken' => '

A token that you can specify in your next request to return more results from the list.

', 'ListInferenceRecommendationsJobsRequest$NextToken' => '

If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

', 'ListInferenceRecommendationsJobsResponse$NextToken' => '

A token for getting the next set of recommendations, if there are any.

', 'ListLabelingJobsForWorkteamRequest$NextToken' => '

If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListLabelingJobsForWorkteamResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

', 'ListLabelingJobsRequest$NextToken' => '

If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListLabelingJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

', 'ListLineageGroupsRequest$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListLineageGroupsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListModelBiasJobDefinitionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelBiasJobDefinitionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelCardExportJobsRequest$NextToken' => '

If the response to a previous ListModelCardExportJobs request was truncated, the response includes a NextToken. To retrieve the next set of model card export jobs, use the token in the next request.

', 'ListModelCardExportJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card export jobs, use it in the subsequent request.

', 'ListModelCardVersionsRequest$NextToken' => '

If the response to a previous ListModelCardVersions request was truncated, the response includes a NextToken. To retrieve the next set of model card versions, use the token in the next request.

', 'ListModelCardVersionsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.

', 'ListModelCardsRequest$NextToken' => '

If the response to a previous ListModelCards request was truncated, the response includes a NextToken. To retrieve the next set of model cards, use the token in the next request.

', 'ListModelCardsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.

', 'ListModelExplainabilityJobDefinitionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelExplainabilityJobDefinitionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelMetadataRequest$NextToken' => '

If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.

', 'ListModelMetadataResponse$NextToken' => '

A token for getting the next set of recommendations, if there are any.

', 'ListModelPackageGroupsInput$NextToken' => '

If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

', 'ListModelPackageGroupsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.

', 'ListModelPackagesInput$NextToken' => '

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

', 'ListModelPackagesOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

', 'ListModelQualityJobDefinitionsRequest$NextToken' => '

If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request.

', 'ListModelQualityJobDefinitionsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.

', 'ListMonitoringAlertHistoryRequest$NextToken' => '

If the result of the previous ListMonitoringAlertHistory request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

', 'ListMonitoringAlertHistoryResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

', 'ListMonitoringAlertsRequest$NextToken' => '

If the result of the previous ListMonitoringAlerts request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

', 'ListMonitoringAlertsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

', 'ListMonitoringExecutionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringExecutionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringSchedulesRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringSchedulesResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListNotebookInstanceLifecycleConfigsInput$NextToken' => '

If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.

', 'ListNotebookInstanceLifecycleConfigsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.

', 'ListNotebookInstancesInput$NextToken' => '

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

', 'ListNotebookInstancesOutput$NextToken' => '

If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

', 'ListPipelineExecutionStepsRequest$NextToken' => '

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

', 'ListPipelineExecutionStepsResponse$NextToken' => '

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

', 'ListPipelineExecutionsRequest$NextToken' => '

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

', 'ListPipelineExecutionsResponse$NextToken' => '

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

', 'ListPipelineParametersForExecutionRequest$NextToken' => '

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

', 'ListPipelineParametersForExecutionResponse$NextToken' => '

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

', 'ListPipelinesRequest$NextToken' => '

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

', 'ListPipelinesResponse$NextToken' => '

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

', 'ListProcessingJobsRequest$NextToken' => '

If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.

', 'ListProcessingJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.

', 'ListProjectsInput$NextToken' => '

If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

', 'ListProjectsOutput$NextToken' => '

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

', 'ListResourceCatalogsRequest$NextToken' => '

A token to resume pagination of ListResourceCatalogs results.

', 'ListResourceCatalogsResponse$NextToken' => '

A token to resume pagination of ListResourceCatalogs results.

', 'ListSpacesRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListSpacesResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListStageDevicesRequest$NextToken' => '

The response from the last list when returning a list large enough to neeed tokening.

', 'ListStageDevicesResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListStudioLifecycleConfigsRequest$NextToken' => '

If the previous call to ListStudioLifecycleConfigs didn\'t return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

', 'ListStudioLifecycleConfigsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListSubscribedWorkteamsRequest$NextToken' => '

If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListSubscribedWorkteamsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

', 'ListTagsInput$NextToken' => '

If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

', 'ListTagsOutput$NextToken' => '

If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$NextToken' => '

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsForHyperParameterTuningJobResponse$NextToken' => '

If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsRequest$NextToken' => '

If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

', 'ListTransformJobsRequest$NextToken' => '

If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

', 'ListTransformJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

', 'ListTrialComponentsRequest$NextToken' => '

If the previous call to ListTrialComponents didn\'t return the full set of components, the call returns a token for getting the next set of components.

', 'ListTrialComponentsResponse$NextToken' => '

A token for getting the next set of components, if there are any.

', 'ListTrialsRequest$NextToken' => '

If the previous call to ListTrials didn\'t return the full set of trials, the call returns a token for getting the next set of trials.

', 'ListTrialsResponse$NextToken' => '

A token for getting the next set of trials, if there are any.

', 'ListUserProfilesRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListUserProfilesResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListWorkforcesRequest$NextToken' => '

A token to resume pagination.

', 'ListWorkforcesResponse$NextToken' => '

A token to resume pagination.

', 'ListWorkteamsRequest$NextToken' => '

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListWorkteamsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

', 'SearchRequest$NextToken' => '

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

', 'SearchResponse$NextToken' => '

If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

', ], ], 'NonEmptyString256' => [ 'base' => NULL, 'refs' => [ 'CustomImageContainerEntrypoint$member' => NULL, 'CustomImageContainerEnvironmentVariables$key' => NULL, ], ], 'NonEmptyString64' => [ 'base' => NULL, 'refs' => [ 'CreateSpaceRequest$SpaceDisplayName' => '

The name of the space that appears in the SageMaker Studio UI.

', 'CustomImageContainerArguments$member' => NULL, 'DescribeSpaceResponse$SpaceDisplayName' => '

The name of the space that appears in the Amazon SageMaker Studio UI.

', 'SpaceDetails$SpaceDisplayName' => '

The name of the space that appears in the Studio UI.

', 'UpdateSpaceRequest$SpaceDisplayName' => '

The name of the space that appears in the Amazon SageMaker Studio UI.

', ], ], 'NotebookInstanceAcceleratorType' => [ 'base' => NULL, 'refs' => [ 'NotebookInstanceAcceleratorTypes$member' => NULL, ], ], 'NotebookInstanceAcceleratorTypes' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$AcceleratorTypes' => '

A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'DescribeNotebookInstanceOutput$AcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'UpdateNotebookInstanceInput$AcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', ], ], 'NotebookInstanceArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceOutput$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', 'DescribeNotebookInstanceOutput$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', 'NotebookInstanceSummary$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', ], ], 'NotebookInstanceLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'NotebookInstanceLifecycleHook$Content' => '

A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigInput$OnCreate' => '

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

', 'CreateNotebookInstanceLifecycleConfigInput$OnStart' => '

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

', 'DescribeNotebookInstanceLifecycleConfigOutput$OnCreate' => '

The shell script that runs only once, when you create a notebook instance.

', 'DescribeNotebookInstanceLifecycleConfigOutput$OnStart' => '

The shell script that runs every time you start a notebook instance, including when you create the notebook instance.

', 'UpdateNotebookInstanceLifecycleConfigInput$OnCreate' => '

The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

', 'UpdateNotebookInstanceLifecycleConfigInput$OnStart' => '

The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

', ], ], 'NotebookInstanceLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$LifecycleConfigName' => '

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'CreateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'DeleteNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration to delete.

', 'DescribeNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration to describe.

', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'DescribeNotebookInstanceOutput$NotebookInstanceLifecycleConfigName' => '

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

', 'ListNotebookInstancesInput$NotebookInstanceLifecycleConfigNameContains' => '

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'NotebookInstanceSummary$NotebookInstanceLifecycleConfigName' => '

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'UpdateNotebookInstanceInput$LifecycleConfigName' => '

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'UpdateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$NameContains' => '

A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.

', ], ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'NotebookInstanceLifecycleConfigSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$SortOrder' => '

The sort order for results.

', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'base' => '

Provides a summary of a notebook instance lifecycle configuration.

', 'refs' => [ 'NotebookInstanceLifecycleConfigSummaryList$member' => NULL, ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsOutput$NotebookInstanceLifecycleConfigs' => '

An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleHook' => [ 'base' => '

Contains the notebook instance lifecycle configuration script.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'refs' => [ 'NotebookInstanceLifecycleConfigList$member' => NULL, ], ], 'NotebookInstanceName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$NotebookInstanceName' => '

The name of the new notebook instance.

', 'CreatePresignedNotebookInstanceUrlInput$NotebookInstanceName' => '

The name of the notebook instance.

', 'DeleteNotebookInstanceInput$NotebookInstanceName' => '

The name of the SageMaker notebook instance to delete.

', 'DescribeNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance that you want information about.

', 'DescribeNotebookInstanceOutput$NotebookInstanceName' => '

The name of the SageMaker notebook instance.

', 'NotebookInstanceSummary$NotebookInstanceName' => '

The name of the notebook instance that you want a summary for.

', 'StartNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to start.

', 'StopNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to terminate.

', 'UpdateNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to update.

', ], ], 'NotebookInstanceNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$NameContains' => '

A string in the notebook instances\' name. This filter returns only notebook instances whose name contains the specified string.

', ], ], 'NotebookInstanceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'NotebookInstanceSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$SortOrder' => '

The sort order for results.

', ], ], 'NotebookInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NotebookInstanceStatus' => '

The status of the notebook instance.

', 'ListNotebookInstancesInput$StatusEquals' => '

A filter that returns only notebook instances with the specified status.

', 'NotebookInstanceSummary$NotebookInstanceStatus' => '

The status of the notebook instance.

', ], ], 'NotebookInstanceSummary' => [ 'base' => '

Provides summary information for an SageMaker notebook instance.

', 'refs' => [ 'NotebookInstanceSummaryList$member' => NULL, ], ], 'NotebookInstanceSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesOutput$NotebookInstances' => '

An array of NotebookInstanceSummary objects, one for each notebook instance.

', ], ], 'NotebookInstanceUrl' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedNotebookInstanceUrlOutput$AuthorizedUrl' => '

A JSON object that contains the URL string.

', 'DescribeNotebookInstanceOutput$Url' => '

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

', 'NotebookInstanceSummary$Url' => '

The URL that you use to connect to the Jupyter notebook running in your notebook instance.

', ], ], 'NotebookInstanceVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

', 'DescribeNotebookInstanceOutput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the notebook instance.

', 'UpdateNotebookInstanceInput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can\'t determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can\'t decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

', ], ], 'NotebookOutputOption' => [ 'base' => NULL, 'refs' => [ 'SharingSettings$NotebookOutputOption' => '

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

', ], ], 'NotificationConfiguration' => [ 'base' => '

Configures Amazon SNS notifications of available or expiring work items for work teams.

', 'refs' => [ 'CreateWorkteamRequest$NotificationConfiguration' => '

Configures notification of workers regarding available or expiring work items.

', 'UpdateWorkteamRequest$NotificationConfiguration' => '

Configures SNS topic notifications for available or expiring work items

', 'Workteam$NotificationConfiguration' => '

Configures SNS notifications of available or expiring work items for work teams.

', ], ], 'NotificationTopicArn' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$NotificationTopicArn' => '

The ARN for the Amazon SNS topic to which notifications should be published.

', ], ], 'NumberOfAcceleratorDevices' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$NumberOfAcceleratorDevicesRequired' => '

The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.

', ], ], 'NumberOfCpuCores' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$NumberOfCpuCoresRequired' => '

The number of CPU cores to allocate to run a model that you assign to an inference component.

', ], ], 'NumberOfHumanWorkersPerDataObject' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$NumberOfHumanWorkersPerDataObject' => '

The number of human workers that will label an object.

', 'LabelingJobForWorkteamSummary$NumberOfHumanWorkersPerDataObject' => '

The configured number of workers per data object.

', ], ], 'NumberOfSteps' => [ 'base' => NULL, 'refs' => [ 'Stairs$NumberOfSteps' => '

Specifies how many steps to perform during traffic.

', ], ], 'ObjectiveStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$ObjectiveStatus' => '

The objective\'s status.

', 'HyperParameterTrainingJobSummary$ObjectiveStatus' => '

The status of the objective metric for the training job:

  • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

  • Pending: The training job is in progress and evaluation of its final objective metric is pending.

  • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

', ], ], 'ObjectiveStatusCounter' => [ 'base' => NULL, 'refs' => [ 'ObjectiveStatusCounters$Succeeded' => '

The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

', 'ObjectiveStatusCounters$Pending' => '

The number of training jobs that are in progress and pending evaluation of their final objective metric.

', 'ObjectiveStatusCounters$Failed' => '

The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

', ], ], 'ObjectiveStatusCounters' => [ 'base' => '

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ObjectiveStatusCounters' => '

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

', 'HyperParameterTuningJobSearchEntity$ObjectiveStatusCounters' => NULL, 'HyperParameterTuningJobSummary$ObjectiveStatusCounters' => '

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

', ], ], 'OfflineStoreConfig' => [ 'base' => '

The configuration of an OfflineStore.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

', 'refs' => [ 'CreateFeatureGroupRequest$OfflineStoreConfig' => '

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

  • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

  • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

  • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

  • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

', 'DescribeFeatureGroupResponse$OfflineStoreConfig' => '

The configuration of the offline store. It includes the following configurations:

  • Amazon S3 location of the offline store.

  • Configuration of the Glue data catalog.

  • Table format of the offline store.

  • Option to disable the automatic creation of a Glue table for the offline store.

  • Encryption configuration.

', 'FeatureGroup$OfflineStoreConfig' => NULL, ], ], 'OfflineStoreStatus' => [ 'base' => '

The status of OfflineStore.

', 'refs' => [ 'DescribeFeatureGroupResponse$OfflineStoreStatus' => '

The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

', 'FeatureGroup$OfflineStoreStatus' => NULL, 'FeatureGroupSummary$OfflineStoreStatus' => '

Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.

', ], ], 'OfflineStoreStatusValue' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$OfflineStoreStatusEquals' => '

An OfflineStore status. Filters by OfflineStore status.

', 'OfflineStoreStatus$Status' => '

An OfflineStore status.

', ], ], 'OidcConfig' => [ 'base' => '

Use this parameter to configure your OIDC Identity Provider (IdP).

', 'refs' => [ 'CreateWorkforceRequest$OidcConfig' => '

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

', 'UpdateWorkforceRequest$OidcConfig' => '

Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.

', ], ], 'OidcConfigForResponse' => [ 'base' => '

Your OIDC IdP workforce configuration.

', 'refs' => [ 'Workforce$OidcConfig' => '

The configuration of an OIDC Identity Provider (IdP) private workforce.

', ], ], 'OidcEndpoint' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$Issuer' => '

The OIDC IdP issuer used to configure your private workforce.

', 'OidcConfig$AuthorizationEndpoint' => '

The OIDC IdP authorization endpoint used to configure your private workforce.

', 'OidcConfig$TokenEndpoint' => '

The OIDC IdP token endpoint used to configure your private workforce.

', 'OidcConfig$UserInfoEndpoint' => '

The OIDC IdP user information endpoint used to configure your private workforce.

', 'OidcConfig$LogoutEndpoint' => '

The OIDC IdP logout endpoint used to configure your private workforce.

', 'OidcConfig$JwksUri' => '

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

', 'OidcConfigForResponse$Issuer' => '

The OIDC IdP issuer used to configure your private workforce.

', 'OidcConfigForResponse$AuthorizationEndpoint' => '

The OIDC IdP authorization endpoint used to configure your private workforce.

', 'OidcConfigForResponse$TokenEndpoint' => '

The OIDC IdP token endpoint used to configure your private workforce.

', 'OidcConfigForResponse$UserInfoEndpoint' => '

The OIDC IdP user information endpoint used to configure your private workforce.

', 'OidcConfigForResponse$LogoutEndpoint' => '

The OIDC IdP logout endpoint used to configure your private workforce.

', 'OidcConfigForResponse$JwksUri' => '

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

', ], ], 'OidcMemberDefinition' => [ 'base' => '

A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

', 'refs' => [ 'MemberDefinition$OidcMemberDefinition' => '

A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

', ], ], 'OnlineStoreConfig' => [ 'base' => '

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.

The default value is False.

', 'refs' => [ 'CreateFeatureGroupRequest$OnlineStoreConfig' => '

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

', 'DescribeFeatureGroupResponse$OnlineStoreConfig' => '

The configuration for the OnlineStore.

', 'FeatureGroup$OnlineStoreConfig' => NULL, ], ], 'OnlineStoreConfigUpdate' => [ 'base' => '

Updates the feature group online store configuration.

', 'refs' => [ 'UpdateFeatureGroupRequest$OnlineStoreConfig' => '

Updates the feature group online store configuration.

', ], ], 'OnlineStoreSecurityConfig' => [ 'base' => '

The security configuration for OnlineStore.

', 'refs' => [ 'OnlineStoreConfig$SecurityConfig' => '

Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.

', ], ], 'OnlineStoreTotalSizeBytes' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupResponse$OnlineStoreTotalSizeBytes' => '

The size of the OnlineStore in bytes.

', ], ], 'Operator' => [ 'base' => NULL, 'refs' => [ 'Filter$Operator' => '

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn\'t equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "\'CONTAINS\' operator usage limit of 1 exceeded."

', ], ], 'OptionalDouble' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$Max' => '

The maximum value of the metric.

', 'TrialComponentMetricSummary$Min' => '

The minimum value of the metric.

', 'TrialComponentMetricSummary$Last' => '

The most recent value of the metric.

', 'TrialComponentMetricSummary$Avg' => '

The average value of the metric.

', 'TrialComponentMetricSummary$StdDev' => '

The standard deviation of the metric.

', ], ], 'OptionalInteger' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$Count' => '

The number of samples used to generate the metric.

', ], ], 'OptionalVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the processing instance.

', 'HyperParameterTuningResourceConfig$VolumeSizeInGB' => '

The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.

Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.

SageMaker supports only the General Purpose SSD (gp2) storage volume type.

', 'ProfilerRuleConfiguration$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the processing instance.

', ], ], 'OrderKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListEndpointsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListInferenceComponentsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListModelsInput$SortOrder' => '

The sort order for results. The default is Descending.

', ], ], 'OutputCompressionType' => [ 'base' => NULL, 'refs' => [ 'OutputDataConfig$CompressionType' => '

The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.

', ], ], 'OutputConfig' => [ 'base' => '

Contains information about the output location for the compiled model and the target device that the model runs on. TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.

', 'refs' => [ 'CreateCompilationJobRequest$OutputConfig' => '

Provides information about the output location for the compiled model and the target device the model runs on.

', 'DescribeCompilationJobResponse$OutputConfig' => '

Information about the output location for the compiled model and the target device that the model runs on.

', ], ], 'OutputDataConfig' => [ 'base' => '

Provides information about how to store model training results (model artifacts).

', 'refs' => [ 'CreateTrainingJobRequest$OutputDataConfig' => '

Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

', 'DescribeTrainingJobResponse$OutputDataConfig' => '

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

', 'HyperParameterTrainingJobDefinition$OutputDataConfig' => '

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

', 'TrainingJob$OutputDataConfig' => '

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

', 'TrainingJobDefinition$OutputDataConfig' => '

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

', ], ], 'OutputParameter' => [ 'base' => '

An output parameter of a pipeline step.

', 'refs' => [ 'OutputParameterList$member' => NULL, ], ], 'OutputParameterList' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$OutputParameters' => '

A list of the output parameters of the callback step.

', 'LambdaStepMetadata$OutputParameters' => '

A list of the output parameters of the Lambda step.

', 'SendPipelineExecutionStepSuccessRequest$OutputParameters' => '

A list of the output parameters of the callback step.

', ], ], 'OwnershipSettings' => [ 'base' => '

The collection of ownership settings for a space.

', 'refs' => [ 'CreateSpaceRequest$OwnershipSettings' => '

A collection of ownership settings.

', 'DescribeSpaceResponse$OwnershipSettings' => '

The collection of ownership settings for a space.

', ], ], 'OwnershipSettingsSummary' => [ 'base' => '

Specifies summary information about the ownership settings.

', 'refs' => [ 'SpaceDetails$OwnershipSettingsSummary' => '

Specifies summary information about the ownership settings.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NextToken' => '

If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.

', 'ListEndpointConfigsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

', 'ListEndpointsInput$NextToken' => '

If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

', 'ListEndpointsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

', 'ListInferenceComponentsInput$NextToken' => '

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

', 'ListInferenceComponentsOutput$NextToken' => '

The token to use in a subsequent request to get the next set of results following a truncated response.

', 'ListModelsInput$NextToken' => '

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

', 'ListModelsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

', ], ], 'ParallelismConfiguration' => [ 'base' => '

Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.

', 'refs' => [ 'CreatePipelineRequest$ParallelismConfiguration' => '

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

', 'DescribePipelineExecutionResponse$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline.

', 'DescribePipelineResponse$ParallelismConfiguration' => '

Lists the parallelism configuration applied to the pipeline.

', 'Pipeline$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline.

', 'PipelineExecution$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline execution.

', 'RetryPipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline.

', 'StartPipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

', 'UpdatePipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

', 'UpdatePipelineRequest$ParallelismConfiguration' => '

If specified, it applies to all executions of this pipeline by default.

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

Assigns a value to a named Pipeline parameter.

', 'refs' => [ 'ParameterList$member' => NULL, ], ], 'ParameterKey' => [ 'base' => NULL, 'refs' => [ 'AutoParameter$Name' => '

The name of the hyperparameter to optimize using Autotune.

', 'CategoricalParameterRange$Name' => '

The name of the categorical hyperparameter to tune.

', 'ContinuousParameterRange$Name' => '

The name of the continuous hyperparameter to tune.

', 'IntegerParameterRange$Name' => '

The name of the hyperparameter to search.

', ], ], 'ParameterList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineParametersForExecutionResponse$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', 'PipelineExecution$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', 'StartPipelineExecutionRequest$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Name' => '

The name of this hyperparameter. The name must be unique.

', ], ], 'ParameterRange' => [ 'base' => '

Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.

', 'refs' => [ 'HyperParameterSpecification$Range' => '

The allowed range for this hyperparameter.

', ], ], 'ParameterRanges' => [ 'base' => '

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can\'t exceed the maximum number specified.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$HyperParameterRanges' => NULL, 'HyperParameterTuningJobConfig$ParameterRanges' => '

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.

', ], ], 'ParameterType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Type' => '

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

', ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'AutoParameter$ValueHint' => '

An example value of the hyperparameter to optimize using Autotune.

', 'ContinuousParameterRange$MinValue' => '

The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

', 'ContinuousParameterRange$MaxValue' => '

The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

', 'ContinuousParameterRangeSpecification$MinValue' => '

The minimum floating-point value allowed.

', 'ContinuousParameterRangeSpecification$MaxValue' => '

The maximum floating-point value allowed.

', 'IntegerParameterRange$MinValue' => '

The minimum value of the hyperparameter to search.

', 'IntegerParameterRange$MaxValue' => '

The maximum value of the hyperparameter to search.

', 'IntegerParameterRangeSpecification$MinValue' => '

The minimum integer value allowed.

', 'IntegerParameterRangeSpecification$MaxValue' => '

The maximum integer value allowed.

', 'ParameterValues$member' => NULL, ], ], 'ParameterValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRange$Values' => '

A list of the categories for the hyperparameter.

', 'CategoricalParameterRangeSpecification$Values' => '

The allowed categories for the hyperparameter.

', ], ], 'Parent' => [ 'base' => '

The trial that a trial component is associated with and the experiment the trial is part of. A component might not be associated with a trial. A component can be associated with multiple trials.

', 'refs' => [ 'Parents$member' => NULL, ], ], 'ParentHyperParameterTuningJob' => [ 'base' => '

A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

', 'refs' => [ 'ParentHyperParameterTuningJobs$member' => NULL, ], ], 'ParentHyperParameterTuningJobs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$ParentHyperParameterTuningJobs' => '

An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

', ], ], 'Parents' => [ 'base' => NULL, 'refs' => [ 'TrialComponent$Parents' => '

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

', ], ], 'PendingDeploymentSummary' => [ 'base' => '

The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.

', 'refs' => [ 'DescribeEndpointOutput$PendingDeploymentSummary' => '

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

', ], ], 'PendingProductionVariantSummary' => [ 'base' => '

The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.

', 'refs' => [ 'PendingProductionVariantSummaryList$member' => NULL, ], ], 'PendingProductionVariantSummaryList' => [ 'base' => NULL, 'refs' => [ 'PendingDeploymentSummary$ProductionVariants' => '

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.

', 'PendingDeploymentSummary$ShadowProductionVariants' => '

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants for the in-progress deployment.

', ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'DeviceSelectionConfig$Percentage' => '

Percentage of devices in the fleet to deploy to the current stage.

', 'ShadowModelVariantConfig$SamplingPercentage' => '

The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.

', ], ], 'Phase' => [ 'base' => '

Defines the traffic pattern.

', 'refs' => [ 'Phases$member' => NULL, ], ], 'Phases' => [ 'base' => NULL, 'refs' => [ 'TrafficPattern$Phases' => '

Defines the phases traffic specification.

', ], ], 'Pipeline' => [ 'base' => '

A SageMaker Model Building Pipeline instance.

', 'refs' => [ 'SearchRecord$Pipeline' => NULL, ], ], 'PipelineArn' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the created pipeline.

', 'DeletePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline to delete.

', 'DescribePipelineExecutionResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'DescribePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'Pipeline$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'PipelineExecution$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline that was executed.

', 'PipelineSummary$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'UpdatePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the updated pipeline.

', ], ], 'PipelineDefinition' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDefinition' => '

The JSON pipeline definition of the pipeline.

', 'DescribePipelineDefinitionForExecutionResponse$PipelineDefinition' => '

The JSON pipeline definition.

', 'DescribePipelineResponse$PipelineDefinition' => '

The JSON pipeline definition.

', 'UpdatePipelineRequest$PipelineDefinition' => '

The JSON pipeline definition.

', ], ], 'PipelineDefinitionS3Location' => [ 'base' => '

The location of the pipeline definition stored in Amazon S3.

', 'refs' => [ 'CreatePipelineRequest$PipelineDefinitionS3Location' => '

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

', 'UpdatePipelineRequest$PipelineDefinitionS3Location' => '

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

', ], ], 'PipelineDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDescription' => '

A description of the pipeline.

', 'DescribePipelineResponse$PipelineDescription' => '

The description of the pipeline.

', 'Pipeline$PipelineDescription' => '

The description of the pipeline.

', 'PipelineSummary$PipelineDescription' => '

The description of the pipeline.

', 'UpdatePipelineRequest$PipelineDescription' => '

The description of the pipeline.

', ], ], 'PipelineExecution' => [ 'base' => '

An execution of a pipeline.

', 'refs' => [ 'SearchRecord$PipelineExecution' => NULL, ], ], 'PipelineExecutionArn' => [ 'base' => NULL, 'refs' => [ 'CacheHitResult$SourcePipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineDefinitionForExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'ListPipelineExecutionStepsRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'ListPipelineParametersForExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'PipelineExecution$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'RetryPipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'RetryPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'SelectiveExecutionConfig$SourcePipelineExecutionArn' => '

The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.

This field is required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.

', 'SelectiveExecutionResult$SourcePipelineExecutionArn' => '

The ARN from an execution of the current pipeline.

', 'SendPipelineExecutionStepFailureResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'SendPipelineExecutionStepSuccessResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StartPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StopPipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StopPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'UpdatePipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the updated pipeline execution.

', ], ], 'PipelineExecutionDescription' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'PipelineExecution$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'StartPipelineExecutionRequest$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionDescription' => '

The description of the pipeline execution.

', ], ], 'PipelineExecutionFailureReason' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$FailureReason' => '

If the execution failed, a message describing why.

', 'PipelineExecution$FailureReason' => '

If the execution failed, a message describing why.

', ], ], 'PipelineExecutionName' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'PipelineExecution$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'StartPipelineExecutionRequest$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', ], ], 'PipelineExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionStatus' => '

The status of the pipeline execution.

', 'PipelineExecution$PipelineExecutionStatus' => '

The status of the pipeline status.

', 'PipelineExecutionSummary$PipelineExecutionStatus' => '

The status of the pipeline execution.

', ], ], 'PipelineExecutionStep' => [ 'base' => '

An execution of a step in a pipeline.

', 'refs' => [ 'PipelineExecutionStepList$member' => NULL, ], ], 'PipelineExecutionStepList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionStepsResponse$PipelineExecutionSteps' => '

A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.

', ], ], 'PipelineExecutionStepMetadata' => [ 'base' => '

Metadata for a step execution.

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

Metadata to run the pipeline step.

', ], ], 'PipelineExecutionSummary' => [ 'base' => '

A pipeline execution summary.

', 'refs' => [ 'PipelineExecutionSummaryList$member' => NULL, ], ], 'PipelineExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsResponse$PipelineExecutionSummaries' => '

Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.

', ], ], 'PipelineExperimentConfig' => [ 'base' => '

Specifies the names of the experiment and trial created by a pipeline.

', 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExperimentConfig' => NULL, 'PipelineExecution$PipelineExperimentConfig' => NULL, ], ], 'PipelineName' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineName' => '

The name of the pipeline.

', 'CreatePipelineRequest$PipelineDisplayName' => '

The display name of the pipeline.

', 'DeletePipelineRequest$PipelineName' => '

The name of the pipeline to delete.

', 'DescribePipelineResponse$PipelineName' => '

The name of the pipeline.

', 'DescribePipelineResponse$PipelineDisplayName' => '

The display name of the pipeline.

', 'ListPipelinesRequest$PipelineNamePrefix' => '

The prefix of the pipeline name.

', 'Pipeline$PipelineName' => '

The name of the pipeline.

', 'Pipeline$PipelineDisplayName' => '

The display name of the pipeline.

', 'PipelineSummary$PipelineName' => '

The name of the pipeline.

', 'PipelineSummary$PipelineDisplayName' => '

The display name of the pipeline.

', 'UpdatePipelineRequest$PipelineName' => '

The name of the pipeline to update.

', 'UpdatePipelineRequest$PipelineDisplayName' => '

The display name of the pipeline.

', ], ], 'PipelineNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline to describe.

', 'ListPipelineExecutionsRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline.

', 'StartPipelineExecutionRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline.

', ], ], 'PipelineParameterName' => [ 'base' => NULL, 'refs' => [ 'Parameter$Name' => '

The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

', ], ], 'PipelineStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineResponse$PipelineStatus' => '

The status of the pipeline execution.

', 'Pipeline$PipelineStatus' => '

The status of the pipeline.

', ], ], 'PipelineSummary' => [ 'base' => '

A summary of a pipeline.

', 'refs' => [ 'PipelineSummaryList$member' => NULL, ], ], 'PipelineSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesResponse$PipelineSummaries' => '

Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

', ], ], 'PlatformIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$PlatformIdentifier' => '

The platform identifier of the notebook instance runtime environment.

', 'DescribeNotebookInstanceOutput$PlatformIdentifier' => '

The platform identifier of the notebook instance runtime environment.

', ], ], 'PolicyString' => [ 'base' => NULL, 'refs' => [ 'GetModelPackageGroupPolicyOutput$ResourcePolicy' => '

The resource policy for the model group.

', 'PutModelPackageGroupPolicyInput$ResourcePolicy' => '

The resource policy for the model group.

', ], ], 'PredefinedMetricSpecification' => [ 'base' => '

A specification for a predefined metric.

', 'refs' => [ 'MetricSpecification$Predefined' => '

Information about a predefined metric.

', ], ], 'PresignedDomainUrl' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlResponse$AuthorizedUrl' => '

The presigned URL.

', ], ], 'ProbabilityThresholdAttribute' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$ProbabilityThresholdAttribute' => '

The threshold for the class probability to be evaluated as a positive result.

', 'EndpointInput$ProbabilityThresholdAttribute' => '

The threshold for the class probability to be evaluated as a positive result.

', ], ], 'ProblemType' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$ProblemType' => '

Defines the type of supervised learning problem available for the candidates. For more information, see Amazon SageMaker Autopilot problem types.

', 'DescribeAutoMLJobResponse$ProblemType' => '

Returns the job\'s problem type.

', 'ResolvedAttributes$ProblemType' => '

The problem type.

', 'TabularJobConfig$ProblemType' => '

The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see Amazon SageMaker Autopilot problem types.

You must either specify the type of supervised learning problem in ProblemType and provide the AutoMLJobObjective metric, or none at all.

', 'TabularResolvedAttributes$ProblemType' => '

The type of supervised learning problem available for the model candidates of the AutoML job V2 (Binary Classification, Multiclass Classification, Regression). For more information, see Amazon SageMaker Autopilot problem types.

', ], ], 'ProcessingClusterConfig' => [ 'base' => '

Configuration for the cluster used to run a processing job.

', 'refs' => [ 'ProcessingResources$ClusterConfig' => '

The configuration for the resources in a cluster used to run the processing job.

', ], ], 'ProcessingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$key' => NULL, 'ProcessingEnvironmentMap$key' => NULL, ], ], 'ProcessingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$Environment' => '

The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.

', 'DescribeProcessingJobResponse$Environment' => '

The environment variables set in the Docker container.

', 'ProcessingJob$Environment' => '

Sets the environment variables in the Docker container.

', ], ], 'ProcessingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$value' => NULL, 'ProcessingEnvironmentMap$value' => NULL, ], ], 'ProcessingFeatureStoreOutput' => [ 'base' => '

Configuration for processing job outputs in Amazon SageMaker Feature Store.

', 'refs' => [ 'ProcessingOutput$FeatureStoreOutput' => '

Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.

', ], ], 'ProcessingInput' => [ 'base' => '

The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.

', 'refs' => [ 'ProcessingInputs$member' => NULL, ], ], 'ProcessingInputs' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$ProcessingInputs' => '

An array of inputs configuring the data to download into the processing container.

', 'DescribeProcessingJobResponse$ProcessingInputs' => '

The inputs for a processing job.

', 'ProcessingJob$ProcessingInputs' => '

List of input configurations for the processing job.

', ], ], 'ProcessingInstanceCount' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$InstanceCount' => '

The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

', 'ProcessingClusterConfig$InstanceCount' => '

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

', ], ], 'ProcessingInstanceType' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$InstanceType' => '

The instance type to deploy a custom rule for debugging a training job.

', 'MonitoringClusterConfig$InstanceType' => '

The ML compute instance type for the processing job.

', 'ProcessingClusterConfig$InstanceType' => '

The ML compute instance type for the processing job.

', 'ProfilerRuleConfiguration$InstanceType' => '

The instance type to deploy a custom rule for profiling a training job.

', ], ], 'ProcessingJob' => [ 'base' => '

An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.

', 'refs' => [ 'TrialComponentSourceDetail$ProcessingJob' => '

Information about a processing job that\'s the source of a trial component.

', ], ], 'ProcessingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobResponse$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'DebugRuleEvaluationStatus$RuleEvaluationJobArn' => '

The Amazon Resource Name (ARN) of the rule evaluation job.

', 'DescribeProcessingJobResponse$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'MonitoringExecutionSummary$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the monitoring job.

', 'ProcessingJob$ProcessingJobArn' => '

The ARN of the processing job.

', 'ProcessingJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'ProcessingJobSummary$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job..

', 'ProfilerRuleEvaluationStatus$RuleEvaluationJobArn' => '

The Amazon Resource Name (ARN) of the rule evaluation job.

', ], ], 'ProcessingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DataQualityBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the data quality monitoring job.

', 'DescribeProcessingJobRequest$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeProcessingJobResponse$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'ModelBiasBaselineConfig$BaseliningJobName' => '

The name of the baseline model bias job.

', 'ModelExplainabilityBaselineConfig$BaseliningJobName' => '

The name of the baseline model explainability job.

', 'ModelQualityBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the monitoring job.

', 'MonitoringBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the monitoring job.

', 'ProcessingJob$ProcessingJobName' => '

The name of the processing job.

', 'ProcessingJobSummary$ProcessingJobName' => '

The name of the processing job.

', 'StopProcessingJobRequest$ProcessingJobName' => '

The name of the processing job to stop.

', ], ], 'ProcessingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ProcessingJobStatus' => '

Provides the status of a processing job.

', 'ListProcessingJobsRequest$StatusEquals' => '

A filter that retrieves only processing jobs with a specific status.

', 'ProcessingJob$ProcessingJobStatus' => '

The status of the processing job.

', 'ProcessingJobSummary$ProcessingJobStatus' => '

The status of the processing job.

', ], ], 'ProcessingJobStepMetadata' => [ 'base' => '

Metadata for a processing job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$ProcessingJob' => '

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

', ], ], 'ProcessingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListProcessingJobsResponse$ProcessingJobSummaries' => '

An array of ProcessingJobSummary objects, each listing a processing job.

', ], ], 'ProcessingJobSummary' => [ 'base' => '

Summary of information about a processing job.

', 'refs' => [ 'ProcessingJobSummaries$member' => NULL, ], ], 'ProcessingLocalPath' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$LocalPath' => '

Path to the filesystem where the batch transform data is available to the container.

', 'DatasetDefinition$LocalPath' => '

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

', 'EndpointInput$LocalPath' => '

Path to the filesystem where the endpoint data is available to the container.

', 'MonitoringS3Output$LocalPath' => '

The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.

', 'ProcessingS3Input$LocalPath' => '

The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).

', 'ProcessingS3Output$LocalPath' => '

The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container\'s entrypoint is invoked.

', ], ], 'ProcessingMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'ProcessingStoppingCondition$MaxRuntimeInSeconds' => '

Specifies the maximum runtime in seconds.

', ], ], 'ProcessingOutput' => [ 'base' => '

Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.

', 'refs' => [ 'ProcessingOutputs$member' => NULL, ], ], 'ProcessingOutputConfig' => [ 'base' => '

Configuration for uploading output from the processing container.

', 'refs' => [ 'CreateProcessingJobRequest$ProcessingOutputConfig' => '

Output configuration for the processing job.

', 'DescribeProcessingJobResponse$ProcessingOutputConfig' => '

Output configuration for the processing job.

', 'ProcessingJob$ProcessingOutputConfig' => NULL, ], ], 'ProcessingOutputs' => [ 'base' => NULL, 'refs' => [ 'ProcessingOutputConfig$Outputs' => '

An array of outputs configuring the data to upload from the processing container.

', ], ], 'ProcessingResources' => [ 'base' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'refs' => [ 'CreateProcessingJobRequest$ProcessingResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'DescribeProcessingJobResponse$ProcessingResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'ProcessingJob$ProcessingResources' => NULL, ], ], 'ProcessingS3CompressionType' => [ 'base' => NULL, 'refs' => [ 'ProcessingS3Input$S3CompressionType' => '

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

', ], ], 'ProcessingS3DataDistributionType' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$S3DataDistributionType' => '

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

', 'EndpointInput$S3DataDistributionType' => '

Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to FullyReplicated

', 'ProcessingS3Input$S3DataDistributionType' => '

Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.

', ], ], 'ProcessingS3DataType' => [ 'base' => NULL, 'refs' => [ 'ProcessingS3Input$S3DataType' => '

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

', ], ], 'ProcessingS3Input' => [ 'base' => '

Configuration for downloading input data from Amazon S3 into the processing container.

', 'refs' => [ 'ProcessingInput$S3Input' => '

Configuration for downloading input data from Amazon S3 into the processing container.

', ], ], 'ProcessingS3InputMode' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$S3InputMode' => '

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

', 'EndpointInput$S3InputMode' => '

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

', 'ProcessingS3Input$S3InputMode' => '

Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.

', ], ], 'ProcessingS3Output' => [ 'base' => '

Configuration for uploading output data to Amazon S3 from the processing container.

', 'refs' => [ 'ProcessingOutput$S3Output' => '

Configuration for processing job outputs in Amazon S3.

', ], ], 'ProcessingS3UploadMode' => [ 'base' => NULL, 'refs' => [ 'MonitoringS3Output$S3UploadMode' => '

Whether to upload the results of the monitoring job continuously or after the job completes.

', 'ProcessingS3Output$S3UploadMode' => '

Whether to upload the results of the processing job continuously or after the job completes.

', ], ], 'ProcessingStoppingCondition' => [ 'base' => '

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.

', 'refs' => [ 'CreateProcessingJobRequest$StoppingCondition' => '

The time limit for how long the processing job is allowed to run.

', 'DescribeProcessingJobResponse$StoppingCondition' => '

The time limit for how long the processing job is allowed to run.

', 'ProcessingJob$StoppingCondition' => NULL, ], ], 'ProcessingVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$VolumeSizeInGB' => '

The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.

', 'ProcessingClusterConfig$VolumeSizeInGB' => '

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can\'t request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

', ], ], 'Processor' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', 'DescribeImageVersionResponse$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', 'UpdateImageVersionRequest$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', ], ], 'ProductId' => [ 'base' => NULL, 'refs' => [ 'DescribeAlgorithmOutput$ProductId' => '

The product identifier of the algorithm.

', 'ModelPackageContainerDefinition$ProductId' => '

The Amazon Web Services Marketplace product ID of the model package.

', ], ], 'ProductListings' => [ 'base' => NULL, 'refs' => [ 'Workteam$ProductListingIds' => '

The Amazon Marketplace identifier for a vendor\'s work team.

', ], ], 'ProductionVariant' => [ 'base' => '

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.

', 'refs' => [ 'ProductionVariantList$member' => NULL, ], ], 'ProductionVariantAcceleratorType' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$AcceleratorType' => '

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'ProductionVariant$AcceleratorType' => '

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentStartupParameters$ContainerStartupHealthCheckTimeoutInSeconds' => '

The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

', 'ProductionVariant$ContainerStartupHealthCheckTimeoutInSeconds' => '

The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

', ], ], 'ProductionVariantCoreDumpConfig' => [ 'base' => '

Specifies configuration for a core dump from the model container when the process crashes.

', 'refs' => [ 'ProductionVariant$CoreDumpConfig' => '

Specifies configuration for a core dump from the model container when the process crashes.

', ], ], 'ProductionVariantInstanceType' => [ 'base' => NULL, 'refs' => [ 'EndpointInputConfiguration$InstanceType' => '

The instance types to use for the load test.

', 'EndpointOutputConfiguration$InstanceType' => '

The instance type recommended by Amazon SageMaker Inference Recommender.

', 'PendingProductionVariantSummary$InstanceType' => '

The type of instances associated with the variant.

', 'ProductionVariant$InstanceType' => '

The ML compute instance type.

', 'RealTimeInferenceRecommendation$InstanceType' => '

The recommended instance type for Real-Time Inference.

', 'RealtimeInferenceInstanceTypes$member' => NULL, ], ], 'ProductionVariantList' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$ProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

', 'CreateEndpointConfigInput$ShadowProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

', 'DescribeEndpointConfigOutput$ProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

', 'DescribeEndpointConfigOutput$ShadowProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

', ], ], 'ProductionVariantManagedInstanceScaling' => [ 'base' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'refs' => [ 'PendingProductionVariantSummary$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'ProductionVariant$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'ProductionVariantSummary$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', ], ], 'ProductionVariantModelDataDownloadTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentStartupParameters$ModelDataDownloadTimeoutInSeconds' => '

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.

', 'ProductionVariant$ModelDataDownloadTimeoutInSeconds' => '

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

', ], ], 'ProductionVariantRoutingConfig' => [ 'base' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'refs' => [ 'PendingProductionVariantSummary$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'ProductionVariant$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'ProductionVariantSummary$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', ], ], 'ProductionVariantSSMAccess' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$EnableSSMAccess' => '

You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.

', ], ], 'ProductionVariantServerlessConfig' => [ 'base' => '

Specifies the serverless configuration for an endpoint variant.

', 'refs' => [ 'EndpointInputConfiguration$ServerlessConfig' => NULL, 'EndpointOutputConfiguration$ServerlessConfig' => NULL, 'PendingProductionVariantSummary$CurrentServerlessConfig' => '

The serverless configuration for the endpoint.

', 'PendingProductionVariantSummary$DesiredServerlessConfig' => '

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

', 'ProductionVariant$ServerlessConfig' => '

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

', 'ProductionVariantSummary$CurrentServerlessConfig' => '

The serverless configuration for the endpoint.

', 'ProductionVariantSummary$DesiredServerlessConfig' => '

The serverless configuration requested for the endpoint update.

', ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'base' => '

Specifies the serverless update concurrency configuration for an endpoint variant.

', 'refs' => [ 'DesiredWeightAndCapacity$ServerlessUpdateConfig' => '

Specifies the serverless update concurrency configuration for an endpoint variant.

', ], ], 'ProductionVariantStatus' => [ 'base' => '

Describes the status of the production variant.

', 'refs' => [ 'ProductionVariantStatusList$member' => NULL, ], ], 'ProductionVariantStatusList' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$VariantStatus' => '

The endpoint variant status which describes the current deployment stage status or operational status.

', 'ProductionVariantSummary$VariantStatus' => '

The endpoint variant status which describes the current deployment stage status or operational status.

', ], ], 'ProductionVariantSummary' => [ 'base' => '

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

', 'refs' => [ 'ProductionVariantSummaryList$member' => NULL, ], ], 'ProductionVariantSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeEndpointOutput$ProductionVariants' => '

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

', 'DescribeEndpointOutput$ShadowProductionVariants' => '

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

', 'Endpoint$ProductionVariants' => '

A list of the production variants hosted on the endpoint. Each production variant is a model.

', 'Endpoint$ShadowProductionVariants' => '

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.

', ], ], 'ProductionVariantVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.

', ], ], 'ProfilerConfig' => [ 'base' => '

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

', 'refs' => [ 'CreateTrainingJobRequest$ProfilerConfig' => NULL, 'DescribeTrainingJobResponse$ProfilerConfig' => NULL, 'TrainingJob$ProfilerConfig' => NULL, ], ], 'ProfilerConfigForUpdate' => [ 'base' => '

Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.

', 'refs' => [ 'UpdateTrainingJobRequest$ProfilerConfig' => '

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

', ], ], 'ProfilerRuleConfiguration' => [ 'base' => '

Configuration information for profiling rules.

', 'refs' => [ 'ProfilerRuleConfigurations$member' => NULL, ], ], 'ProfilerRuleConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', 'DescribeTrainingJobResponse$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', 'UpdateTrainingJobRequest$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', ], ], 'ProfilerRuleEvaluationStatus' => [ 'base' => '

Information about the status of the rule evaluation.

', 'refs' => [ 'ProfilerRuleEvaluationStatuses$member' => NULL, ], ], 'ProfilerRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$ProfilerRuleEvaluationStatuses' => '

Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

', ], ], 'ProfilingIntervalInMilliseconds' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingIntervalInMilliseconds' => '

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

', 'ProfilerConfigForUpdate$ProfilingIntervalInMilliseconds' => '

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

', ], ], 'ProfilingParameters' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingParameters' => '

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'ProfilerConfigForUpdate$ProfilingParameters' => '

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', ], ], 'ProfilingStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$ProfilingStatus' => '

Profiling status of a training job.

', ], ], 'ProgrammingLang' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ProgrammingLang' => '

The supported programming language and its version.

', 'DescribeImageVersionResponse$ProgrammingLang' => '

The supported programming language and its version.

', 'UpdateImageVersionRequest$ProgrammingLang' => '

The supported programming language and its version.

', ], ], 'Project' => [ 'base' => '

The properties of a project as returned by the Search API.

', 'refs' => [ 'SearchRecord$Project' => '

The properties of a project.

', ], ], 'ProjectArn' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'DescribeProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'Project$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'ProjectSummary$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'UpdateProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', ], ], 'ProjectEntityName' => [ 'base' => NULL, 'refs' => [ 'CreateProjectInput$ProjectName' => '

The name of the project.

', 'DeleteProjectInput$ProjectName' => '

The name of the project to delete.

', 'DescribeProjectInput$ProjectName' => '

The name of the project to describe.

', 'DescribeProjectOutput$ProjectName' => '

The name of the project.

', 'ListProjectsInput$NameContains' => '

A filter that returns the projects whose name contains a specified string.

', 'Project$ProjectName' => '

The name of the project.

', 'ProjectSummary$ProjectName' => '

The name of the project.

', 'UpdateProjectInput$ProjectName' => '

The name of the project.

', ], ], 'ProjectId' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectId' => '

The ID of the new project.

', 'DescribeProjectOutput$ProjectId' => '

The ID of the project.

', 'Project$ProjectId' => '

The ID of the project.

', 'ProjectSummary$ProjectId' => '

The ID of the project.

', ], ], 'ProjectSortBy' => [ 'base' => NULL, 'refs' => [ 'ListProjectsInput$SortBy' => '

The field by which to sort results. The default is CreationTime.

', ], ], 'ProjectSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListProjectsInput$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'ProjectStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeProjectOutput$ProjectStatus' => '

The status of the project.

', 'Project$ProjectStatus' => '

The status of the project.

', 'ProjectSummary$ProjectStatus' => '

The status of the project.

', ], ], 'ProjectSummary' => [ 'base' => '

Information about a project.

', 'refs' => [ 'ProjectSummaryList$member' => NULL, ], ], 'ProjectSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListProjectsOutput$ProjectSummaryList' => '

A list of summaries of projects.

', ], ], 'PropertyNameHint' => [ 'base' => NULL, 'refs' => [ 'PropertyNameQuery$PropertyNameHint' => '

Text that begins a property\'s name.

', ], ], 'PropertyNameQuery' => [ 'base' => '

Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.

', 'refs' => [ 'SuggestionQuery$PropertyNameQuery' => '

Defines a property name hint. Only property names that begin with the specified hint are included in the response.

', ], ], 'PropertyNameSuggestion' => [ 'base' => '

A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

', 'refs' => [ 'PropertyNameSuggestionList$member' => NULL, ], ], 'PropertyNameSuggestionList' => [ 'base' => NULL, 'refs' => [ 'GetSearchSuggestionsResponse$PropertyNameSuggestions' => '

A list of property names for a Resource that match a SuggestionQuery.

', ], ], 'ProvisionedProductStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisionedProductDetails$ProvisionedProductStatusMessage' => '

The current status of the product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

', ], ], 'ProvisioningParameter' => [ 'base' => '

A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'ProvisioningParameters$member' => NULL, ], ], 'ProvisioningParameterKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Key' => '

The key that identifies a provisioning parameter.

', ], ], 'ProvisioningParameterValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Value' => '

The value of the provisioning parameter.

', ], ], 'ProvisioningParameters' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisioningDetails$ProvisioningParameters' => '

A list of key value pairs that you specify when you provision a product.

', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningParameters' => '

A list of key value pairs that you specify when you provision a product.

', ], ], 'PublicWorkforceTaskPrice' => [ 'base' => '

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

  • 0.012

  • 0.024

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.

  • 2.400

  • 2.280

  • 2.160

  • 2.040

  • 1.920

  • 1.800

  • 1.680

  • 1.560

  • 1.440

  • 1.320

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

', 'refs' => [ 'HumanLoopConfig$PublicWorkforceTaskPrice' => NULL, 'HumanTaskConfig$PublicWorkforceTaskPrice' => '

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

', ], ], 'PutModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'PutModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'QualityCheckStepMetadata' => [ 'base' => '

Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'PipelineExecutionStepMetadata$QualityCheck' => '

The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted.

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The Boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

', ], ], 'QueryFilters' => [ 'base' => '

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.

', 'refs' => [ 'QueryLineageRequest$Filters' => '

A set of filtering parameters that allow you to specify which entities should be returned.

  • Properties - Key-value pairs to match on the lineage entities\' properties.

  • LineageTypes - A set of lineage entity types to match on. For example: TrialComponent, Artifact, or Context.

  • CreatedBefore - Filter entities created before this date.

  • ModifiedBefore - Filter entities modified before this date.

  • ModifiedAfter - Filter entities modified after this date.

', ], ], 'QueryLineageMaxDepth' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$MaxDepth' => '

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

', ], ], 'QueryLineageMaxResults' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$MaxResults' => '

Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

', ], ], 'QueryLineageRequest' => [ 'base' => NULL, 'refs' => [], ], 'QueryLineageResponse' => [ 'base' => NULL, 'refs' => [], ], 'QueryLineageStartArns' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$StartArns' => '

A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

', ], ], 'QueryLineageTypes' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$LineageTypes' => '

Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.

', ], ], 'QueryProperties' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$Properties' => '

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

', ], ], 'QueryTypes' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$Types' => '

Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.

', ], ], 'RSessionAppSettings' => [ 'base' => '

A collection of settings that apply to an RSessionGateway app.

', 'refs' => [ 'UserSettings$RSessionAppSettings' => '

A collection of settings that configure the RSessionGateway app.

', ], ], 'RStudioServerProAccessStatus' => [ 'base' => NULL, 'refs' => [ 'RStudioServerProAppSettings$AccessStatus' => '

Indicates whether the current user has access to the RStudioServerPro app.

', ], ], 'RStudioServerProAppSettings' => [ 'base' => '

A collection of settings that configure user interaction with the RStudioServerPro app.

', 'refs' => [ 'UserSettings$RStudioServerProAppSettings' => '

A collection of settings that configure user interaction with the RStudioServerPro app.

', ], ], 'RStudioServerProDomainSettings' => [ 'base' => '

A collection of settings that configure the RStudioServerPro Domain-level app.

', 'refs' => [ 'DomainSettings$RStudioServerProDomainSettings' => '

A collection of settings that configure the RStudioServerPro Domain-level app.

', ], ], 'RStudioServerProDomainSettingsForUpdate' => [ 'base' => '

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

', 'refs' => [ 'DomainSettingsForUpdate$RStudioServerProDomainSettingsForUpdate' => '

A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

', ], ], 'RStudioServerProUserGroup' => [ 'base' => NULL, 'refs' => [ 'RStudioServerProAppSettings$UserGroup' => '

The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.

', ], ], 'RandomSeed' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobConfig$RandomSeed' => '

A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.

', ], ], 'RealTimeInferenceConfig' => [ 'base' => '

The infrastructure configuration for deploying the model to a real-time inference endpoint.

', 'refs' => [ 'ModelInfrastructureConfig$RealTimeInferenceConfig' => '

The infrastructure configuration for deploying the model to real-time inference.

', ], ], 'RealTimeInferenceRecommendation' => [ 'base' => '

The recommended configuration to use for Real-Time Inference.

', 'refs' => [ 'RealTimeInferenceRecommendations$member' => NULL, ], ], 'RealTimeInferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RealTimeInferenceRecommendations' => '

A list of RealTimeInferenceRecommendation items.

', ], ], 'RealtimeInferenceInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedRealtimeInferenceInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

', 'InferenceSpecification$SupportedRealtimeInferenceInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

', ], ], 'RecommendationFailureReason' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInferenceBenchmark$FailureReason' => '

The reason why a benchmark failed.

', ], ], 'RecommendationJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the recommendation job.

', 'DescribeInferenceRecommendationsJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'InferenceRecommendationsJob$JobArn' => '

The Amazon Resource Name (ARN) of the recommendation job.

', ], ], 'RecommendationJobCompilationJobName' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$CompilationJobName' => '

The name of the compilation job used to create the recommended model artifacts.

', ], ], 'RecommendationJobCompiledOutputConfig' => [ 'base' => '

Provides information about the output configuration for the compiled model.

', 'refs' => [ 'RecommendationJobOutputConfig$CompiledOutputConfig' => '

Provides information about the output configuration for the compiled model.

', ], ], 'RecommendationJobContainerConfig' => [ 'base' => '

Specifies mandatory fields for running an Inference Recommender job directly in the CreateInferenceRecommendationsJob API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use ContainerConfig if you want to specify these fields for the recommendation job but don\'t want to edit them in your model package.

', 'refs' => [ 'RecommendationJobInputConfig$ContainerConfig' => '

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

', ], ], 'RecommendationJobDataInputConfig' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$DataInputConfig' => '

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.

', ], ], 'RecommendationJobDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobDescription' => '

Description of the recommendation job.

', 'DescribeInferenceRecommendationsJobResponse$JobDescription' => '

The job description that you provided when you initiated the job.

', 'InferenceRecommendationsJob$JobDescription' => '

The job description.

', ], ], 'RecommendationJobFrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$FrameworkVersion' => '

The framework version of the container image.

', ], ], 'RecommendationJobInferenceBenchmark' => [ 'base' => '

The details for a specific benchmark from an Inference Recommender job.

', 'refs' => [ 'InferenceRecommendationsJobStep$InferenceBenchmark' => '

The details for a specific benchmark.

', ], ], 'RecommendationJobInputConfig' => [ 'base' => '

The input configuration of the recommendation job.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$InputConfig' => '

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

', 'DescribeInferenceRecommendationsJobResponse$InputConfig' => '

Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

', ], ], 'RecommendationJobName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobName' => '

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

', 'DescribeInferenceRecommendationsJobRequest$JobName' => '

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeInferenceRecommendationsJobResponse$JobName' => '

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'GetScalingConfigurationRecommendationRequest$InferenceRecommendationsJobName' => '

The name of a previously completed Inference Recommender job.

', 'GetScalingConfigurationRecommendationResponse$InferenceRecommendationsJobName' => '

The name of a previously completed Inference Recommender job.

', 'InferenceRecommendationsJob$JobName' => '

The name of the job.

', 'InferenceRecommendationsJobStep$JobName' => '

The name of the Inference Recommender job.

', 'ListInferenceRecommendationsJobStepsRequest$JobName' => '

The name for the Inference Recommender job.

', 'StopInferenceRecommendationsJobRequest$JobName' => '

The name of the job you want to stop.

', ], ], 'RecommendationJobOutputConfig' => [ 'base' => '

Provides information about the output configuration for the compiled model.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$OutputConfig' => '

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

', ], ], 'RecommendationJobPayloadConfig' => [ 'base' => '

The configuration for the payload for a recommendation job.

', 'refs' => [ 'RecommendationJobContainerConfig$PayloadConfig' => '

Specifies the SamplePayloadUrl and all other sample payload-related fields.

', ], ], 'RecommendationJobResourceLimit' => [ 'base' => '

Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.

', 'refs' => [ 'RecommendationJobInputConfig$ResourceLimit' => '

Defines the resource limit of the job.

', ], ], 'RecommendationJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$Status' => '

The status of the job.

', 'InferenceRecommendationsJob$Status' => '

The status of the job.

', 'InferenceRecommendationsJobStep$Status' => '

The current status of the benchmark.

', 'ListInferenceRecommendationsJobStepsRequest$Status' => '

A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

', 'ListInferenceRecommendationsJobsRequest$StatusEquals' => '

A filter that retrieves only inference recommendations jobs with a specific status.

', ], ], 'RecommendationJobStoppingConditions' => [ 'base' => '

Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$StoppingConditions' => '

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

', 'DescribeInferenceRecommendationsJobResponse$StoppingConditions' => '

The stopping conditions that you provided when you initiated the job.

', ], ], 'RecommendationJobSupportedContentType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobSupportedContentTypes$member' => NULL, ], ], 'RecommendationJobSupportedContentTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobPayloadConfig$SupportedContentTypes' => '

The supported MIME types for the input data.

', ], ], 'RecommendationJobSupportedEndpointType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedEndpointType' => '

The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.

', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

', ], ], 'RecommendationJobSupportedResponseMIMEType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobSupportedResponseMIMETypes$member' => NULL, ], ], 'RecommendationJobSupportedResponseMIMETypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', ], ], 'RecommendationJobType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobType' => '

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

', 'DescribeInferenceRecommendationsJobResponse$JobType' => '

The job type that you provided when you initiated the job.

', 'InferenceRecommendationsJob$JobType' => '

The recommendation job type.

', ], ], 'RecommendationJobVpcConfig' => [ 'base' => '

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

', 'refs' => [ 'RecommendationJobInputConfig$VpcConfig' => '

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

', ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcSecurityGroupIds$member' => NULL, ], ], 'RecommendationJobVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcConfig$SecurityGroupIds' => '

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'RecommendationJobVpcSubnetId' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcSubnets$member' => NULL, ], ], 'RecommendationJobVpcSubnets' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcConfig$Subnets' => '

The ID of the subnets in the VPC to which you want to connect your model.

', ], ], 'RecommendationMetrics' => [ 'base' => '

The metrics of recommendations.

', 'refs' => [ 'InferenceRecommendation$Metrics' => '

The metrics used to decide what recommendation to make.

', 'RecommendationJobInferenceBenchmark$Metrics' => NULL, ], ], 'RecommendationStatus' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RecommendationStatus' => '

Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.

', ], ], 'RecommendationStepType' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendationsJobStep$StepType' => '

The type of the subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

', 'ListInferenceRecommendationsJobStepsRequest$StepType' => '

A filter to return details about the specified type of subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

', ], ], 'RecordWrapper' => [ 'base' => NULL, 'refs' => [ 'Channel$RecordWrapperType' => '

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don\'t need to set this attribute. For more information, see Create a Dataset Using RecordIO.

In File mode, leave this field unset or set it to None.

', ], ], 'RedshiftClusterId' => [ 'base' => '

The Redshift cluster Identifier.

', 'refs' => [ 'RedshiftDatasetDefinition$ClusterId' => NULL, ], ], 'RedshiftDatabase' => [ 'base' => '

The name of the Redshift database used in Redshift query execution.

', 'refs' => [ 'RedshiftDatasetDefinition$Database' => NULL, ], ], 'RedshiftDatasetDefinition' => [ 'base' => '

Configuration for Redshift Dataset Definition input.

', 'refs' => [ 'DatasetDefinition$RedshiftDatasetDefinition' => NULL, ], ], 'RedshiftQueryString' => [ 'base' => '

The SQL query statements to be executed.

', 'refs' => [ 'RedshiftDatasetDefinition$QueryString' => NULL, ], ], 'RedshiftResultCompressionType' => [ 'base' => '

The compression used for Redshift query results.

', 'refs' => [ 'RedshiftDatasetDefinition$OutputCompression' => NULL, ], ], 'RedshiftResultFormat' => [ 'base' => '

The data storage format for Redshift query results.

', 'refs' => [ 'RedshiftDatasetDefinition$OutputFormat' => NULL, ], ], 'RedshiftUserName' => [ 'base' => '

The database user name used in Redshift query execution.

', 'refs' => [ 'RedshiftDatasetDefinition$DbUser' => NULL, ], ], 'RegisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterModelStepMetadata' => [ 'base' => '

Metadata for a register model job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$RegisterModel' => '

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

', ], ], 'ReleaseNotes' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ReleaseNotes' => '

The maintainer description of the image version.

', 'DescribeImageVersionResponse$ReleaseNotes' => '

The maintainer description of the image version.

', 'UpdateImageVersionRequest$ReleaseNotes' => '

The maintainer description of the image version.

', ], ], 'RemoteDebugConfig' => [ 'base' => '

Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'refs' => [ 'CreateTrainingJobRequest$RemoteDebugConfig' => '

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'DescribeTrainingJobResponse$RemoteDebugConfig' => '

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', ], ], 'RemoteDebugConfigForUpdate' => [ 'base' => '

Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'refs' => [ 'UpdateTrainingJobRequest$RemoteDebugConfig' => '

Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the SecondaryStatus of the job is Downloading or Training.To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', ], ], 'RenderUiTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RenderUiTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenderableTask' => [ 'base' => '

Contains input values for a task.

', 'refs' => [ 'RenderUiTemplateRequest$Task' => '

A RenderableTask object containing a representative task to render.

', ], ], 'RenderingError' => [ 'base' => '

A description of an error that occurred while rendering the template.

', 'refs' => [ 'RenderingErrorList$member' => NULL, ], ], 'RenderingErrorList' => [ 'base' => NULL, 'refs' => [ 'RenderUiTemplateResponse$Errors' => '

A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

', ], ], 'RepositoryAccessMode' => [ 'base' => NULL, 'refs' => [ 'ImageConfig$RepositoryAccessMode' => '

Set this to one of the following values:

  • Platform - The model image is hosted in Amazon ECR.

  • Vpc - The model image is hosted in a private Docker registry in your VPC.

', ], ], 'RepositoryAuthConfig' => [ 'base' => '

Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field of the ImageConfig object that you passed to a call to CreateModel and the private Docker registry where the model image is hosted requires authentication.

', 'refs' => [ 'ImageConfig$RepositoryAuthConfig' => '

(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication.

', ], ], 'RepositoryCredentialsProviderArn' => [ 'base' => NULL, 'refs' => [ 'RepositoryAuthConfig$RepositoryCredentialsProviderArn' => '

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an Amazon Web Services Lambda function, see Create a Lambda function with the console in the Amazon Web Services Lambda Developer Guide.

', ], ], 'RepositoryUrl' => [ 'base' => NULL, 'refs' => [ 'CodeRepository$RepositoryUrl' => '

The URL of the Git repository.

', ], ], 'ResolvedAttributes' => [ 'base' => '

The resolved attributes.

', 'refs' => [ 'DescribeAutoMLJobResponse$ResolvedAttributes' => '

Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to tag.

', 'DeleteTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource whose tags you want to delete.

', 'ListTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

', ], ], 'ResourceCatalog' => [ 'base' => '

A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'ResourceCatalogList$member' => NULL, ], ], 'ResourceCatalogArn' => [ 'base' => NULL, 'refs' => [ 'ResourceCatalog$ResourceCatalogArn' => '

The Amazon Resource Name (ARN) of the ResourceCatalog.

', ], ], 'ResourceCatalogDescription' => [ 'base' => NULL, 'refs' => [ 'ResourceCatalog$Description' => '

A free form description of the ResourceCatalog.

', ], ], 'ResourceCatalogList' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsResponse$ResourceCatalogs' => '

A list of the requested ResourceCatalogs.

', ], ], 'ResourceCatalogName' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$NameContains' => '

A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.

', 'ResourceCatalog$ResourceCatalogName' => '

The name of the ResourceCatalog.

', ], ], 'ResourceCatalogSortBy' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$SortBy' => '

The value on which the resource catalog list is sorted.

', ], ], 'ResourceCatalogSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$SortOrder' => '

The order in which the resource catalogs are listed.

', ], ], 'ResourceConfig' => [ 'base' => '

Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.

', 'refs' => [ 'CreateTrainingJobRequest$ResourceConfig' => '

The resources, including the ML compute instances and ML storage volumes, to use for model training.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

', 'DescribeTrainingJobResponse$ResourceConfig' => '

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

', 'HyperParameterTrainingJobDefinition$ResourceConfig' => '

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

', 'TrainingJob$ResourceConfig' => '

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

', 'TrainingJobDefinition$ResourceConfig' => '

The resources, including the ML compute instances and ML storage volumes, to use for model training.

', ], ], 'ResourceConfigForUpdate' => [ 'base' => '

The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.

', 'refs' => [ 'UpdateTrainingJobRequest$ResourceConfig' => '

The training job ResourceConfig to update warm pool retention length.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$HomeEfsFileSystemId' => '

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

', ], ], 'ResourceInUse' => [ 'base' => '

Resource being accessed is in use.

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

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

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

Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.

', 'refs' => [ 'HyperParameterTuningJobConfig$ResourceLimits' => '

The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$ResourceLimits' => '

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

', ], ], 'ResourceNotFound' => [ 'base' => '

Resource being access is not found.

', 'refs' => [], ], 'ResourcePolicyString' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyResponse$ResourcePolicy' => '

The resource policy that gives access to the lineage group in another account.

', ], ], 'ResourcePropertyName' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

', 'NestedFilters$NestedPropertyName' => '

The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.

', 'PropertyNameSuggestion$PropertyName' => '

A suggested property name based on what you entered in the search textbox in the SageMaker console.

', 'SearchRequest$SortBy' => '

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

', ], ], 'ResourceRetainedBillableTimeInSeconds' => [ 'base' => 'Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after resource reaches ResourceReused or ResourceReleased state.', 'refs' => [ 'WarmPoolStatus$ResourceRetainedBillableTimeInSeconds' => '

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

', ], ], 'ResourceSpec' => [ 'base' => '

Specifies the ARN\'s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

', 'refs' => [ 'AppDetails$ResourceSpec' => NULL, 'CodeEditorAppSettings$DefaultResourceSpec' => NULL, 'CreateAppRequest$ResourceSpec' => '

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

', 'DescribeAppResponse$ResourceSpec' => '

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

', 'JupyterLabAppSettings$DefaultResourceSpec' => NULL, 'JupyterServerAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

', 'KernelGatewayAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

', 'RSessionAppSettings$DefaultResourceSpec' => NULL, 'RStudioServerProDomainSettings$DefaultResourceSpec' => NULL, 'RStudioServerProDomainSettingsForUpdate$DefaultResourceSpec' => NULL, 'SpaceCodeEditorAppSettings$DefaultResourceSpec' => NULL, 'SpaceJupyterLabAppSettings$DefaultResourceSpec' => NULL, 'TensorBoardAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'GetSearchSuggestionsRequest$Resource' => '

The name of the SageMaker resource to search for.

', 'SearchRequest$Resource' => '

The name of the SageMaker resource to search for.

', ], ], 'ResponseMIMEType' => [ 'base' => NULL, 'refs' => [ 'ResponseMIMETypes$member' => NULL, ], ], 'ResponseMIMETypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', 'InferenceSpecification$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', ], ], 'RetentionPolicy' => [ 'base' => '

The retention policy for data stored on an Amazon Elastic File System (EFS) volume.

', 'refs' => [ 'DeleteDomainRequest$RetentionPolicy' => '

The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).

', ], ], 'RetentionType' => [ 'base' => NULL, 'refs' => [ 'RetentionPolicy$HomeEfsFileSystem' => '

The default is Retain, which specifies to keep the data stored on the EFS volume.

Specify Delete to delete the data stored on the EFS volume.

', ], ], 'RetryPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetryPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetryStrategy' => [ 'base' => '

The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.

', 'refs' => [ 'CreateTrainingJobRequest$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'DescribeTrainingJobResponse$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'HyperParameterTrainingJobDefinition$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'TrainingJob$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'AlgorithmValidationSpecification$ValidationRole' => '

The IAM roles that SageMaker uses to run the training jobs.

', 'ClusterInstanceGroupDetails$ExecutionRole' => '

The execution role for the instance group to assume.

', 'ClusterInstanceGroupSpecification$ExecutionRole' => '

Specifies an IAM execution role to be assumed by the instance group.

', 'CreateAutoMLJobRequest$RoleArn' => '

The ARN of the role that is used to access the data.

', 'CreateAutoMLJobV2Request$RoleArn' => '

The ARN of the role that is used to access the data.

', 'CreateCompilationJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model compilation, Amazon SageMaker needs your permission to:

  • Read input data from an S3 bucket

  • Write model artifacts to an S3 bucket

  • Write logs to Amazon CloudWatch Logs

  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

', 'CreateDataQualityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateDeviceFleetRequest$RoleArn' => '

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

', 'CreateEdgePackagingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.

', 'CreateEndpointConfigInput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this action must have the iam:PassRole permission.

', 'CreateFeatureGroupRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

', 'CreateFlowDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

', 'CreateImageRequest$RoleArn' => '

The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'CreateInferenceExperimentRequest$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'CreateInferenceRecommendationsJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'CreateLabelingJobRequest$RoleArn' => '

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

', 'CreateModelBiasJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateModelExplainabilityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateModelInput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'CreateModelQualityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateNotebookInstanceInput$RoleArn' => '

When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'CreatePipelineRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

', 'CreateProcessingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateTrainingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.

During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'DefaultSpaceSettings$ExecutionRole' => '

The ARN of the execution role for the space.

', 'DescribeAutoMLJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeAutoMLJobV2Response$RoleArn' => '

The ARN of the Identity and Access Management role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeCompilationJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

', 'DescribeDataQualityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeDeviceFleetResponse$RoleArn' => '

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

', 'DescribeEdgePackagingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

', 'DescribeEndpointConfigOutput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.

', 'DescribeFeatureGroupResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

', 'DescribeFlowDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

', 'DescribeImageResponse$RoleArn' => '

The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'DescribeInferenceExperimentResponse$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'DescribeInferenceRecommendationsJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

', 'DescribeLabelingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.

', 'DescribeModelBiasJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeModelExplainabilityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeModelOutput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

', 'DescribeModelQualityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeNotebookInstanceOutput$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

', 'DescribePipelineResponse$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline uses to execute.

', 'DescribeProcessingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeTrainingJobResponse$RoleArn' => '

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

', 'FeatureGroup$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

', 'HyperParameterTrainingJobDefinition$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

', 'InferenceExperimentSummary$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'InferenceRecommendationsJob$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'Model$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

', 'ModelPackageValidationSpecification$ValidationRole' => '

The IAM roles to be used for the validation of the model package.

', 'ModelRegisterSettings$CrossAccountModelRegisterRoleArn' => '

The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

', 'MonitoringJobDefinition$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'Pipeline$RoleArn' => '

The Amazon Resource Name (ARN) of the role that created the pipeline.

', 'PipelineSummary$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline used to execute.

', 'ProcessingJob$RoleArn' => '

The ARN of the role used to create the processing job.

', 'RStudioServerProDomainSettings$DomainExecutionRoleArn' => '

The ARN of the execution role for the RStudioServerPro Domain-level app.

', 'RStudioServerProDomainSettingsForUpdate$DomainExecutionRoleArn' => '

The execution role for the RStudioServerPro Domain-level app.

', 'RedshiftDatasetDefinition$ClusterRoleArn' => '

The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

', 'RenderUiTemplateRequest$RoleArn' => '

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

', 'TimeSeriesForecastingSettings$AmazonForecastRoleArn' => '

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

', 'TrainingJob$RoleArn' => '

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

', 'UpdateDeviceFleetRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the device.

', 'UpdateImageRequest$RoleArn' => '

The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'UpdateNotebookInstanceInput$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'UpdatePipelineRequest$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline uses to execute.

', 'UserSettings$ExecutionRole' => '

The execution role for the user.

', ], ], 'RollingUpdatePolicy' => [ 'base' => '

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

', 'refs' => [ 'DeploymentConfig$RollingUpdatePolicy' => '

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

', ], ], 'RootAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

', 'DescribeNotebookInstanceOutput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

', 'UpdateNotebookInstanceInput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don\'t have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

', ], ], 'RoutingStrategy' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantRoutingConfig$RoutingStrategy' => '

Sets how the endpoint routes incoming traffic:

  • LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the specific instances that have more capacity to process them.

  • RANDOM: The endpoint routes each request to a randomly chosen instance.

', ], ], 'RuleConfigurationName' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$RuleConfigurationName' => '

The name of the rule configuration. It must be unique relative to other rule configuration names.

', 'DebugRuleEvaluationStatus$RuleConfigurationName' => '

The name of the rule configuration.

', 'ProfilerRuleConfiguration$RuleConfigurationName' => '

The name of the rule configuration. It must be unique relative to other rule configuration names.

', 'ProfilerRuleEvaluationStatus$RuleConfigurationName' => '

The name of the rule configuration.

', ], ], 'RuleEvaluationStatus' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$RuleEvaluationStatus' => '

Status of the rule evaluation.

', 'ProfilerRuleEvaluationStatus$RuleEvaluationStatus' => '

Status of the rule evaluation.

', ], ], 'RuleParameters' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$RuleParameters' => '

Runtime configuration for rule container.

', 'ProfilerRuleConfiguration$RuleParameters' => '

Runtime configuration for rule container.

', ], ], 'S3DataDistribution' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataDistributionType' => '

If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

If you want SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

Don\'t choose more ML compute instances for training than available S3 objects. If you do, some nodes won\'t get any data and you will pay for nodes that aren\'t getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

', ], ], 'S3DataSource' => [ 'base' => '

Describes the S3 data source.

Your input bucket must be in the same Amazon Web Services region as your training job.

', 'refs' => [ 'DataSource$S3DataSource' => '

The S3 location of the data source that is associated with a channel.

', ], ], 'S3DataType' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataType' => '

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel\'s input mode is Pipe.

', 'TransformS3DataSource$S3DataType' => '

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

', ], ], 'S3ModelDataSource' => [ 'base' => '

Specifies the S3 location of ML model data to deploy.

', 'refs' => [ 'ModelDataSource$S3DataSource' => '

Specifies the S3 location of ML model data to deploy.

', ], ], 'S3ModelDataType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$S3DataType' => '

Specifies the type of ML model data to deploy.

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/).

If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy.

', ], ], 'S3ModelUri' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$S3Uri' => '

Specifies the S3 path of ML model data to deploy.

', ], ], 'S3OutputPath' => [ 'base' => NULL, 'refs' => [ 'HubS3StorageConfig$S3OutputPath' => '

The Amazon S3 bucket prefix for hosting hub content.

', ], ], 'S3StorageConfig' => [ 'base' => '

The Amazon Simple Storage (Amazon S3) location and and security configuration for OfflineStore.

', 'refs' => [ 'OfflineStoreConfig$S3StorageConfig' => '

The Amazon Simple Storage (Amazon S3) location of OfflineStore.

', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$S3Uri' => '

The uniform resource identifier (URI) used to identify an additional data source used in inference or training.

', 'AthenaDatasetDefinition$OutputS3Uri' => '

The location in Amazon S3 where Athena query results are stored.

', 'AutoMLCandidateGenerationConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

', 'AutoMLOutputDataConfig$S3OutputPath' => '

The Amazon S3 output path. Must be 128 characters or less.

', 'AutoMLS3DataSource$S3Uri' => '

The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.

', 'BatchDataCaptureConfig$DestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'CheckpointConfig$S3Uri' => '

Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

', 'ClusterLifeCycleConfig$SourceS3Uri' => '

An Amazon S3 bucket path where your LifeCycle scripts are stored.

', 'CreateLabelingJobRequest$LabelCategoryConfigS3Uri' => '

The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.

For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

For named entity recognition jobs, in addition to "labels", you must provide worker instructions in the label category configuration file using the "instructions" parameter: "instructions": {"shortInstruction":"<h1>Add header</h1><p>Add Instructions</p>", "fullInstruction":"<p>Add additional instructions.</p>"}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .

For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.

{

"document-version": "2018-11-28",

"labels": [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

}

Note the following about the label category configuration file:

  • For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.

  • Each label category must be unique, you cannot specify duplicate label categories.

  • If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include auditLabelAttributeName in the label category configuration. Use this parameter to enter the LabelAttributeName of the labeling job you want to adjust or verify annotations of.

', 'CreateModelPackageInput$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.

', 'DataQualityAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'DataQualityAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'DebugHookConfig$S3OutputPath' => '

Path to Amazon S3 storage location for metrics and tensors.

', 'DebugRuleConfiguration$S3OutputPath' => '

Path to Amazon S3 storage location for rules.

', 'DescribeEdgePackagingJobResponse$ModelArtifact' => '

The Amazon Simple Storage (S3) URI where model artifacts ares stored.

', 'DescribeLabelingJobResponse$LabelCategoryConfigS3Uri' => '

The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

  • Semantic segmentation labeling jobs using automated labeling: 20 labels

  • Box bounding labeling jobs (all): 10 labels

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

', 'EdgeOutputConfig$S3OutputLocation' => '

The Amazon Simple Storage (S3) bucker URI.

', 'FileSource$S3Uri' => '

The Amazon S3 URI for the file source.

', 'FlowDefinitionOutputConfig$S3OutputPath' => '

The Amazon S3 path where the object containing human output will be made available.

To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.

', 'InferenceRecommendationsJob$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'InputConfig$S3Uri' => '

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'LabelingJobOutput$OutputDatasetS3Uri' => '

The Amazon S3 bucket location of the manifest file for labeled data.

', 'LabelingJobOutputConfig$S3OutputPath' => '

The Amazon S3 location to write output data.

', 'LabelingJobS3DataSource$ManifestS3Uri' => '

The Amazon S3 location of the manifest file that describes the input data objects.

The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:

  • source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.

  • source: The source of the object is the value. Use this value when the object is a text value.

If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.

', 'MetricsSource$S3Uri' => '

The S3 URI for the metrics source.

', 'ModelArtifacts$S3ModelArtifacts' => '

The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

', 'ModelBiasAppSpecification$ConfigUri' => '

JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.

', 'ModelCardExportArtifacts$S3ExportArtifacts' => '

The Amazon S3 URI of the exported model artifacts.

', 'ModelCardExportOutputConfig$S3OutputPath' => '

The Amazon S3 output path to export your model card PDF.

', 'ModelExplainabilityAppSpecification$ConfigUri' => '

JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.

', 'ModelQualityAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'ModelQualityAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'MonitoringAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'MonitoringAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'MonitoringConstraintsResource$S3Uri' => '

The Amazon S3 URI for the constraints resource.

', 'MonitoringStatisticsResource$S3Uri' => '

The Amazon S3 URI for the statistics resource.

', 'OutputConfig$S3OutputLocation' => '

Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

', 'OutputDataConfig$S3OutputPath' => '

Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

', 'ProcessingS3Input$S3Uri' => '

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

', 'ProcessingS3Output$S3Uri' => '

A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

', 'ProfilerConfig$S3OutputPath' => '

Path to Amazon S3 storage location for system and framework metrics.

', 'ProfilerConfigForUpdate$S3OutputPath' => '

Path to Amazon S3 storage location for system and framework metrics.

', 'ProfilerRuleConfiguration$S3OutputPath' => '

Path to Amazon S3 storage location for rules.

', 'RecommendationJobCompiledOutputConfig$S3OutputUri' => '

Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.

', 'RecommendationJobPayloadConfig$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'RedshiftDatasetDefinition$OutputS3Uri' => '

The location in Amazon S3 where the Redshift query results are stored.

', 'S3DataSource$S3Uri' => '

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix

  • A manifest might look like this: s3://bucketname/example.manifest

    A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.

    The following code example shows a valid manifest format:

    [ {"prefix": "s3://customer_bucket/some/prefix/"},

    "relative/path/to/custdata-1",

    "relative/path/custdata-2",

    ...

    "relative/path/custdata-N"

    ]

    This JSON is equivalent to the following S3Uri list:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.

Your input bucket must be located in same Amazon Web Services region as your training job.

', 'S3StorageConfig$S3Uri' => '

The S3 URI, or location in Amazon S3, of OfflineStore.

S3 URIs have a format similar to the following: s3://example-bucket/prefix/.

', 'S3StorageConfig$ResolvedOutputS3Uri' => '

The S3 path where offline records are written.

', 'SharingSettings$S3OutputPath' => '

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

', 'TabularJobConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job V2. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

', 'TensorBoardOutputConfig$S3OutputPath' => '

Path to Amazon S3 storage location for TensorBoard output.

', 'TimeSeriesForecastingJobConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing additional selected features that complement the target, itemID, timestamp, and grouped columns set in TimeSeriesConfig. When not provided, the AutoML job V2 includes all the columns from the original dataset that are not already declared in TimeSeriesConfig. If provided, the AutoML job V2 only considers these additional columns as a complement to the ones declared in TimeSeriesConfig.

You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

Autopilot supports the following data types: numeric, categorical, text, and datetime.

These column keys must not include any column set in TimeSeriesConfig.

', 'TransformOutput$S3OutputPath' => '

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn\'t upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

', 'TransformS3DataSource$S3Uri' => '

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix.

  • A manifest might look like this: s3://bucketname/example.manifest

    The manifest is an S3 object which is a JSON file with the following format:

    [ {"prefix": "s3://customer_bucket/some/prefix/"},

    "relative/path/to/custdata-1",

    "relative/path/custdata-2",

    ...

    "relative/path/custdata-N"

    ]

    The preceding JSON matches the following S3Uris:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

', 'UiConfig$UiTemplateS3Uri' => '

The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

', 'WorkspaceSettings$S3ArtifactPath' => '

The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

', ], ], 'SageMakerImageVersionAlias' => [ 'base' => NULL, 'refs' => [ 'DeleteImageVersionRequest$Alias' => '

The alias of the image to delete.

', 'DescribeImageVersionRequest$Alias' => '

The alias of the image version.

', 'ListAliasesRequest$Alias' => '

The alias of the image version.

', 'SageMakerImageVersionAliases$member' => NULL, 'UpdateImageVersionRequest$Alias' => '

The alias of the image version.

', ], ], 'SageMakerImageVersionAliases' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Aliases' => '

A list of aliases created with the image version.

', 'ListAliasesResponse$SageMakerImageVersionAliases' => '

A list of SageMaker image version aliases.

', 'UpdateImageVersionRequest$AliasesToAdd' => '

A list of aliases to add.

', 'UpdateImageVersionRequest$AliasesToDelete' => '

A list of aliases to delete.

', ], ], 'SagemakerServicecatalogStatus' => [ 'base' => NULL, 'refs' => [ 'GetSagemakerServicecatalogPortfolioStatusOutput$Status' => '

Whether Service Catalog is enabled or disabled in SageMaker.

', ], ], 'SampleWeightAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$SampleWeightAttributeName' => '

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

', 'TabularJobConfig$SampleWeightAttributeName' => '

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

', ], ], 'SamplingPercentage' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$InitialSamplingPercentage' => '

The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.

', 'DataCaptureConfigSummary$CurrentSamplingPercentage' => '

The percentage of requests being captured by your Endpoint.

', ], ], 'ScalingPolicies' => [ 'base' => NULL, 'refs' => [ 'DynamicScalingConfiguration$ScalingPolicies' => '

An object of the scaling policies for each metric.

', ], ], 'ScalingPolicy' => [ 'base' => '

An object containing a recommended scaling policy.

', 'refs' => [ 'ScalingPolicies$member' => NULL, ], ], 'ScalingPolicyMetric' => [ 'base' => '

The metric for a scaling policy.

', 'refs' => [ 'GetScalingConfigurationRecommendationResponse$Metric' => '

An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.

', ], ], 'ScalingPolicyObjective' => [ 'base' => '

An object where you specify the anticipated traffic pattern for an endpoint.

', 'refs' => [ 'GetScalingConfigurationRecommendationRequest$ScalingPolicyObjective' => '

An object where you specify the anticipated traffic pattern for an endpoint.

', 'GetScalingConfigurationRecommendationResponse$ScalingPolicyObjective' => '

An object representing the anticipated traffic pattern for an endpoint that you specified in the request.

', ], ], 'ScheduleConfig' => [ 'base' => '

Configuration details about the monitoring schedule.

', 'refs' => [ 'MonitoringScheduleConfig$ScheduleConfig' => '

Configures the monitoring schedule.

', ], ], 'ScheduleExpression' => [ 'base' => NULL, 'refs' => [ 'ScheduleConfig$ScheduleExpression' => '

A cron expression that describes details about the monitoring schedule.

The supported cron expressions are:

  • If you want to set the job to start every hour, use the following:

    Hourly: cron(0 * ? * * *)

  • If you want to start the job daily:

    cron(0 [00-23] ? * * *)

  • If you want to run the job one time, immediately, use the following keyword:

    NOW

For example, the following are valid cron expressions:

  • Daily at noon UTC: cron(0 12 ? * * *)

  • Daily at midnight UTC: cron(0 0 ? * * *)

To support running every 6, 12 hours, the following are also supported:

cron(0 [00-23]/[01-24] ? * * *)

For example, the following are valid cron expressions:

  • Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)

  • Every two hours starting at midnight: cron(0 0/2 ? * * *)

  • Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.

  • We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will pick a time for running every day.

You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.

', ], ], 'ScheduleStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeMonitoringScheduleResponse$MonitoringScheduleStatus' => '

The status of an monitoring job.

', 'ListMonitoringSchedulesRequest$StatusEquals' => '

A filter that returns only monitoring schedules modified before a specified time.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleStatus' => '

The status of the monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleStatus' => '

The status of the monitoring schedule. This can be one of the following values.

  • PENDING - The schedule is pending being created.

  • FAILED - The schedule failed.

  • SCHEDULED - The schedule was successfully created.

  • STOPPED - The schedule was stopped.

', 'MonitoringScheduleSummary$MonitoringScheduleStatus' => '

The status of the monitoring schedule.

', ], ], 'SearchExpression' => [ 'base' => '

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:

  • A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

  • A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

  • A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

  • A Boolean operator: And or Or.

', 'refs' => [ 'SearchExpressionList$member' => NULL, 'SearchRequest$SearchExpression' => '

A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

', ], ], 'SearchExpressionList' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$SubExpressions' => '

A list of search expression objects.

', ], ], 'SearchRecord' => [ 'base' => '

A single resource returned as part of the Search API response.

', 'refs' => [ 'SearchResultsList$member' => NULL, ], ], 'SearchRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchResultsList' => [ 'base' => NULL, 'refs' => [ 'SearchResponse$Results' => '

A list of SearchRecord objects.

', ], ], 'SearchSortOrder' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$SortOrder' => '

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

', ], ], 'SecondaryStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$SecondaryStatus' => '

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

', 'SecondaryStatusTransition$Status' => '

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

', 'TrainingJob$SecondaryStatus' => '

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

', ], ], 'SecondaryStatusTransition' => [ 'base' => '

An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job\'s secondary status.

', 'refs' => [ 'SecondaryStatusTransitions$member' => NULL, ], ], 'SecondaryStatusTransitions' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$SecondaryStatusTransitions' => '

A history of all of the secondary statuses that the training job has transitioned through.

', 'TrainingJob$SecondaryStatusTransitions' => '

A history of all of the secondary statuses that the training job has transitioned through.

', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'GitConfig$SecretArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', 'GitConfigForUpdate$SecretArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', 'IdentityProviderOAuthSetting$SecretArn' => '

The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$SecurityGroupIdForDomainBoundary' => '

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

', 'DomainSecurityGroupIds$member' => NULL, 'SecurityGroupIds$member' => NULL, 'VpcSecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', 'DefaultSpaceSettings$SecurityGroups' => '

The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

', 'DescribeNotebookInstanceOutput$SecurityGroups' => '

The IDs of the VPC security groups.

', 'UserSettings$SecurityGroups' => '

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

', ], ], 'Seed' => [ 'base' => NULL, 'refs' => [ 'ShuffleConfig$Seed' => '

Determines the shuffling order in ShuffleConfig value.

', ], ], 'SelectedStep' => [ 'base' => '

A step selected to run in selective execution mode.

', 'refs' => [ 'SelectedStepList$member' => NULL, ], ], 'SelectedStepList' => [ 'base' => NULL, 'refs' => [ 'SelectiveExecutionConfig$SelectedSteps' => '

A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.

', ], ], 'SelectiveExecutionConfig' => [ 'base' => '

The selective execution configuration applied to the pipeline run.

', 'refs' => [ 'DescribePipelineExecutionResponse$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', 'PipelineExecution$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', 'StartPipelineExecutionRequest$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', ], ], 'SelectiveExecutionResult' => [ 'base' => '

The ARN from an execution of the current pipeline.

', 'refs' => [ 'PipelineExecutionStep$SelectiveExecutionResult' => '

The ARN from an execution of the current pipeline from which results are reused for this step.

', ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepFailureResponse' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerlessMaxConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MaxConcurrency' => '

The maximum number of concurrent invocations your serverless endpoint can process.

', 'ProductionVariantServerlessUpdateConfig$MaxConcurrency' => '

The updated maximum number of concurrent invocations your serverless endpoint can process.

', ], ], 'ServerlessMemorySizeInMB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MemorySizeInMB' => '

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

', ], ], 'ServerlessProvisionedConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$ProvisionedConcurrency' => '

The amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see CreateInferenceRecommendationsJobs.

', 'ProductionVariantServerlessUpdateConfig$ProvisionedConcurrency' => '

The updated amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

', ], ], 'ServiceCatalogEntityId' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisionedProductDetails$ProvisionedProductId' => '

The ID of the provisioned product.

', 'ServiceCatalogProvisioningDetails$ProductId' => '

The ID of the product to provision.

', 'ServiceCatalogProvisioningDetails$ProvisioningArtifactId' => '

The ID of the provisioning artifact.

', 'ServiceCatalogProvisioningDetails$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningArtifactId' => '

The ID of the provisioning artifact.

', ], ], 'ServiceCatalogProvisionedProductDetails' => [ 'base' => '

Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'DescribeProjectOutput$ServiceCatalogProvisionedProductDetails' => '

Information about a provisioned service catalog product.

', 'Project$ServiceCatalogProvisionedProductDetails' => NULL, ], ], 'ServiceCatalogProvisioningDetails' => [ 'base' => '

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'CreateProjectInput$ServiceCatalogProvisioningDetails' => '

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don\'t provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

', 'DescribeProjectOutput$ServiceCatalogProvisioningDetails' => '

Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.

', 'Project$ServiceCatalogProvisioningDetails' => NULL, ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'base' => '

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'UpdateProjectInput$ServiceCatalogProvisioningUpdateDetails' => '

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don\'t provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

', ], ], 'SessionExpirationDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$SessionExpirationDurationInSeconds' => '

The session expiration duration in seconds. This value defaults to 43200.

', 'CreatePresignedNotebookInstanceUrlInput$SessionExpirationDurationInSeconds' => '

The duration of the session, in seconds. The default is 12 hours.

', ], ], 'ShadowModeConfig' => [ 'base' => '

The configuration of ShadowMode inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.

', 'refs' => [ 'CreateInferenceExperimentRequest$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

', 'DescribeInferenceExperimentResponse$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

', 'UpdateInferenceExperimentRequest$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

', ], ], 'ShadowModelVariantConfig' => [ 'base' => '

The name and sampling percentage of a shadow variant.

', 'refs' => [ 'ShadowModelVariantConfigList$member' => NULL, ], ], 'ShadowModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'ShadowModeConfig$ShadowModelVariants' => '

List of shadow variant configurations.

', ], ], 'SharingSettings' => [ 'base' => '

Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn\'t allowed.

', 'refs' => [ 'UserSettings$SharingSettings' => '

Specifies options for sharing Amazon SageMaker Studio notebooks.

', ], ], 'SharingType' => [ 'base' => NULL, 'refs' => [ 'SpaceSharingSettings$SharingType' => '

Specifies the sharing type of the space.

', 'SpaceSharingSettingsSummary$SharingType' => '

Specifies the sharing type of the space.

', ], ], 'ShuffleConfig' => [ 'base' => '

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, when ShuffleConfig is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

', 'refs' => [ 'Channel$ShuffleConfig' => '

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

', ], ], 'SingleSignOnApplicationArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$SingleSignOnApplicationArn' => '

The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.

', ], ], 'SingleSignOnUserIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateUserProfileRequest$SingleSignOnUserIdentifier' => '

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain\'s AuthMode is IAM Identity Center, this field is required. If the Domain\'s AuthMode is not IAM Identity Center, this field cannot be specified.

', 'DescribeUserProfileResponse$SingleSignOnUserIdentifier' => '

The IAM Identity Center user identifier.

', ], ], 'SkipModelValidation' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$SkipModelValidation' => '

Indicates if you want to skip model validation.

', 'DescribeModelPackageOutput$SkipModelValidation' => '

Indicates if you want to skip model validation.

', 'ModelPackage$SkipModelValidation' => '

Indicates if you want to skip model validation.

', ], ], 'SnsTopicArn' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$SuccessTopic' => '

Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.

', 'AsyncInferenceNotificationConfig$ErrorTopic' => '

Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.

', 'LabelingJobOutputConfig$SnsTopicArn' => '

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

', 'LabelingJobSnsDataSource$SnsTopicArn' => '

The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.

', ], ], 'SortActionsBy' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortArtifactsBy' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortAssociationsBy' => [ 'base' => NULL, 'refs' => [ 'ListAssociationsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortBy' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListProcessingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListTrainingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListTransformJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'SortContextsBy' => [ 'base' => NULL, 'refs' => [ 'ListContextsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortExperimentsBy' => [ 'base' => NULL, 'refs' => [ 'ListExperimentsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortInferenceExperimentsBy' => [ 'base' => NULL, 'refs' => [ 'ListInferenceExperimentsRequest$SortBy' => '

The column by which to sort the listed inference experiments.

', ], ], 'SortLineageGroupsBy' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAlgorithmsInput$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListAppImageConfigsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAppsRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListArtifactsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAssociationsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListClusterNodesRequest$SortOrder' => '

The sort order for results. The default value is Ascending.

', 'ListClustersRequest$SortOrder' => '

The sort order for results. The default value is Ascending.

', 'ListCompilationJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListContextsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListDataQualityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListDeviceFleetsRequest$SortOrder' => '

What direction to sort in.

', 'ListEdgeDeploymentPlansRequest$SortOrder' => '

The direction of the sorting (ascending or descending).

', 'ListEdgePackagingJobsRequest$SortOrder' => '

What direction to sort by.

', 'ListExperimentsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListFlowDefinitionsRequest$SortOrder' => '

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

', 'ListHubContentVersionsRequest$SortOrder' => '

Sort hub content versions by ascending or descending order.

', 'ListHubContentsRequest$SortOrder' => '

Sort hubs by ascending or descending order.

', 'ListHubsRequest$SortOrder' => '

Sort hubs by ascending or descending order.

', 'ListHumanTaskUisRequest$SortOrder' => '

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

', 'ListHyperParameterTuningJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListInferenceExperimentsRequest$SortOrder' => '

The direction of sorting (ascending or descending).

', 'ListInferenceRecommendationsJobsRequest$SortOrder' => '

The sort order for the results.

', 'ListLabelingJobsForWorkteamRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListLabelingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListLineageGroupsRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListModelBiasJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListModelExplainabilityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListModelPackageGroupsInput$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListModelPackagesInput$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListModelQualityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListMonitoringAlertHistoryRequest$SortOrder' => '

The sort order, whether Ascending or Descending, of the alert history. The default is Descending.

', 'ListMonitoringExecutionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListMonitoringSchedulesRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListPipelineExecutionStepsRequest$SortOrder' => '

The field by which to sort results. The default is CreatedTime.

', 'ListPipelineExecutionsRequest$SortOrder' => '

The sort order for results.

', 'ListPipelinesRequest$SortOrder' => '

The sort order for results.

', 'ListProcessingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListSpacesRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListStudioLifecycleConfigsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListTrainingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListTransformJobsRequest$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListTrialComponentsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListTrialsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListUserProfilesRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListWorkforcesRequest$SortOrder' => '

Sort workforces in ascending or descending order.

', 'ListWorkteamsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'SortPipelineExecutionsBy' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsRequest$SortBy' => '

The field by which to sort results. The default is CreatedTime.

', ], ], 'SortPipelinesBy' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesRequest$SortBy' => '

The field by which to sort results. The default is CreatedTime.

', ], ], 'SortTrialComponentsBy' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortTrialsBy' => [ 'base' => NULL, 'refs' => [ 'ListTrialsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SourceAlgorithm' => [ 'base' => '

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

', 'refs' => [ 'SourceAlgorithmList$member' => NULL, ], ], 'SourceAlgorithmList' => [ 'base' => NULL, 'refs' => [ 'SourceAlgorithmSpecification$SourceAlgorithms' => '

A list of the algorithms that were used to create a model package.

', ], ], 'SourceAlgorithmSpecification' => [ 'base' => '

A list of algorithms that were used to create a model package.

', 'refs' => [ 'CreateModelPackageInput$SourceAlgorithmSpecification' => '

Details about the algorithm that was used to create the model package.

', 'DescribeModelPackageOutput$SourceAlgorithmSpecification' => '

Details about the algorithm that was used to create the model package.

', 'ModelPackage$SourceAlgorithmSpecification' => '

A list of algorithms that were used to create a model package.

', ], ], 'SourceIpConfig' => [ 'base' => '

A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an IP address within this range. By default, a workforce isn\'t restricted to specific IP addresses.

', 'refs' => [ 'CreateWorkforceRequest$SourceIpConfig' => NULL, 'UpdateWorkforceRequest$SourceIpConfig' => '

A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Ten CIDR values

', 'Workforce$SourceIpConfig' => '

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn\'t restricted to specific IP addresses.

', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceType' => '

The source type.

', 'TrialComponentSource$SourceType' => '

The source job type.

', 'TrialSource$SourceType' => '

The source job type.

', ], ], 'SourceUri' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceUri' => '

The URI of the source.

', 'ArtifactSource$SourceUri' => '

The URI of the source.

', 'ContextSource$SourceUri' => '

The URI of the source.

', 'ListActionsRequest$SourceUri' => '

A filter that returns only actions with the specified source URI.

', 'ListArtifactsRequest$SourceUri' => '

A filter that returns only artifacts with the specified source URI.

', 'ListContextsRequest$SourceUri' => '

A filter that returns only contexts with the specified source URI.

', ], ], 'SpaceArn' => [ 'base' => NULL, 'refs' => [ 'CreateSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', 'DescribeSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', 'UpdateSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', ], ], 'SpaceCodeEditorAppSettings' => [ 'base' => '

The application settings for a Code Editor space.

', 'refs' => [ 'SpaceSettings$CodeEditorAppSettings' => '

The Code Editor application settings.

', ], ], 'SpaceDetails' => [ 'base' => '

The space\'s details.

', 'refs' => [ 'SpaceList$member' => NULL, ], ], 'SpaceEbsVolumeSizeInGb' => [ 'base' => NULL, 'refs' => [ 'DefaultEbsStorageSettings$DefaultEbsVolumeSizeInGb' => '

The default size of the EBS storage volume for a private space.

', 'DefaultEbsStorageSettings$MaximumEbsVolumeSizeInGb' => '

The maximum size of the EBS storage volume for a private space.

', 'EbsStorageSettings$EbsVolumeSizeInGb' => '

The size of an EBS storage volume for a private space.

', ], ], 'SpaceJupyterLabAppSettings' => [ 'base' => '

The settings for the JupyterLab application within a space.

', 'refs' => [ 'SpaceSettings$JupyterLabAppSettings' => '

The settings for the JupyterLab application.

', ], ], 'SpaceList' => [ 'base' => NULL, 'refs' => [ 'ListSpacesResponse$Spaces' => '

The list of spaces.

', ], ], 'SpaceName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$SpaceName' => '

The name of the space.

', 'CreateAppRequest$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'CreatePresignedDomainUrlRequest$SpaceName' => '

The name of the space.

', 'CreateSpaceRequest$SpaceName' => '

The name of the space.

', 'DeleteAppRequest$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'DeleteSpaceRequest$SpaceName' => '

The name of the space.

', 'DescribeAppRequest$SpaceName' => '

The name of the space.

', 'DescribeAppResponse$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'DescribeSpaceRequest$SpaceName' => '

The name of the space.

', 'DescribeSpaceResponse$SpaceName' => '

The name of the space.

', 'ListAppsRequest$SpaceNameEquals' => '

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

', 'ListSpacesRequest$SpaceNameContains' => '

A parameter by which to filter the results.

', 'SpaceDetails$SpaceName' => '

The name of the space.

', 'UpdateSpaceRequest$SpaceName' => '

The name of the space.

', ], ], 'SpaceSettings' => [ 'base' => '

A collection of space settings.

', 'refs' => [ 'CreateSpaceRequest$SpaceSettings' => '

A collection of space settings.

', 'DescribeSpaceResponse$SpaceSettings' => '

A collection of space settings.

', 'UpdateSpaceRequest$SpaceSettings' => '

A collection of space settings.

', ], ], 'SpaceSettingsSummary' => [ 'base' => '

Specifies summary information about the space settings.

', 'refs' => [ 'SpaceDetails$SpaceSettingsSummary' => '

Specifies summary information about the space settings.

', ], ], 'SpaceSharingSettings' => [ 'base' => '

A collection of space sharing settings.

', 'refs' => [ 'CreateSpaceRequest$SpaceSharingSettings' => '

A collection of space sharing settings.

', 'DescribeSpaceResponse$SpaceSharingSettings' => '

The collection of space sharing settings for a space.

', ], ], 'SpaceSharingSettingsSummary' => [ 'base' => '

Specifies summary information about the space sharing settings.

', 'refs' => [ 'SpaceDetails$SpaceSharingSettingsSummary' => '

Specifies summary information about the space sharing settings.

', ], ], 'SpaceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListSpacesRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'SpaceStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeSpaceResponse$Status' => '

The status.

', 'SpaceDetails$Status' => '

The status.

', ], ], 'SpaceStorageSettings' => [ 'base' => '

The storage settings for a private space.

', 'refs' => [ 'SpaceSettings$SpaceStorageSettings' => '

The storage settings for a private space.

', 'SpaceSettingsSummary$SpaceStorageSettings' => '

The storage settings for a private space.

', ], ], 'SpawnRate' => [ 'base' => NULL, 'refs' => [ 'Phase$SpawnRate' => '

Specified how many new users to spawn in a minute.

', ], ], 'SplitType' => [ 'base' => NULL, 'refs' => [ 'TransformInput$SplitType' => '

The method to use to split the transform job\'s data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:

  • RecordIO

  • TFRecord

When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.

For more information about RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

', ], ], 'StageStatus' => [ 'base' => NULL, 'refs' => [ 'EdgeDeploymentStatus$StageStatus' => '

The general status of the current stage.

', ], ], 'Stairs' => [ 'base' => '

Defines the stairs traffic pattern for an Inference Recommender load test. This pattern type consists of multiple steps where the number of users increases at each step.

Specify either the stairs or phases traffic pattern.

', 'refs' => [ 'TrafficPattern$Stairs' => '

Defines the stairs traffic pattern.

', ], ], 'StartEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistic' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Statistic' => '

The statistic of the customized metric.

', ], ], 'StatusDetails' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$StatusDetails' => '

Details from the rule evaluation.

', 'ProfilerRuleEvaluationStatus$StatusDetails' => '

Details from the rule evaluation.

', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'SecondaryStatusTransition$StatusMessage' => '

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting

  • Starting the training job.

  • Launching requested ML instances.

  • Insufficient capacity error from EC2 while launching instances, retrying!

  • Launched instance was unhealthy, replacing it!

  • Preparing the instances for training.

Training

  • Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don\'t use status messages in if statements.

To have an overview of your training job\'s progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

  • TrainingJobStatus - InProgress

  • SecondaryStatus - Training

  • StatusMessage - Downloading the training image

', ], ], 'StepDescription' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepDescription' => '

The description of the step.

', ], ], 'StepDisplayName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepDisplayName' => '

The display name of the step.

', ], ], 'StepName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepName' => '

The name of the step that is executed.

', ], ], 'StepStatus' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepStatus' => '

The status of the step execution.

', ], ], 'StopAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StoppingCondition' => [ 'base' => '

Specifies a limit to how long a model training job or model compilation job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

', 'refs' => [ 'CreateCompilationJobRequest$StoppingCondition' => '

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

', 'CreateTrainingJobRequest$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'DescribeCompilationJobResponse$StoppingCondition' => '

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

', 'DescribeTrainingJobResponse$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'HyperParameterTrainingJobDefinition$StoppingCondition' => '

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

', 'TrainingJob$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'TrainingJobDefinition$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

', ], ], 'StorageType' => [ 'base' => NULL, 'refs' => [ 'OnlineStoreConfig$StorageType' => '

Option for different tiers of low latency storage for real-time data retrieval.

  • Standard: A managed low latency data store for feature groups.

  • InMemory: A managed data store for feature groups that supports very low latency retrieval.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$FailureReason' => '

if the overall status is Failed, the reason for the failure.

', 'BatchDescribeModelPackageError$ErrorCode' => '

', 'BatchDescribeModelPackageError$ErrorResponse' => '

', 'BatchTransformInput$FeaturesAttribute' => '

The attributes of the input data that are the input features.

', 'BatchTransformInput$InferenceAttribute' => '

The attribute of the input data that represents the ground truth label.

', 'BatchTransformInput$ProbabilityAttribute' => '

In a classification problem, the attribute that represents the class probability.

', 'ClusterInstanceStatusDetails$Message' => '

The message from an instance in a SageMaker HyperPod cluster.

', 'ClusterNodeDetails$InstanceId' => '

The ID of the instance.

', 'ClusterNodeSummary$InstanceId' => '

The ID of the instance.

', 'CreateModelPackageInput$Domain' => '

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

', 'CreateModelPackageInput$Task' => '

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".

Specify "OTHER" if none of the tasks listed fit your use case.

', 'CustomizedMetricSpecification$MetricName' => '

The name of the customized metric.

', 'CustomizedMetricSpecification$Namespace' => '

The namespace of the customized metric.

', 'DescribeClusterResponse$FailureMessage' => '

The failure message of the SageMaker HyperPod cluster.

', 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatusMessage' => '

Returns a message describing the job status and error messages.

', 'DescribeEdgePackagingJobResponse$ModelSignature' => '

The signature document of files in the model artifact.

', 'DescribeModelPackageOutput$Domain' => '

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

', 'DescribeModelPackageOutput$Task' => '

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

', 'DescribeModelPackageOutput$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

', 'DeviceDeploymentSummary$DeviceDeploymentStatusMessage' => '

The detailed error message for the deployoment status result.

', 'EdgeDeploymentStatus$EdgeDeploymentStatusMessage' => '

A detailed message about deployment status in current stage.

', 'EdgeOutputConfig$PresetDeploymentConfig' => '

The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

  • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.

  • ComponentDescription (optional) - Description of the component.

  • ComponentVersion (optional) - The version of the component.

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

  • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

  • PlatformArchitecture (optional) - The processor architecture for the platform.

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

', 'EdgePresetDeploymentOutput$StatusMessage' => '

Returns a message describing the status of the deployed resource.

', 'EndpointInput$FeaturesAttribute' => '

The attributes of the input data that are the input features.

', 'EndpointInput$InferenceAttribute' => '

The attribute of the input data that represents the ground truth label.

', 'EndpointInput$ProbabilityAttribute' => '

In a classification problem, the attribute that represents the class probability.

', 'EndpointOutputConfiguration$EndpointName' => '

The name of the endpoint made during a recommendation job.

', 'EndpointOutputConfiguration$VariantName' => '

The name of the production variant (deployed model) made during a recommendation job.

', 'EnvironmentParameter$Key' => '

The environment key suggested by the Amazon SageMaker Inference Recommender.

', 'EnvironmentParameter$ValueType' => '

The value type suggested by the Amazon SageMaker Inference Recommender.

', 'EnvironmentParameter$Value' => '

The value suggested by the Amazon SageMaker Inference Recommender.

', 'GetScalingConfigurationRecommendationRequest$RecommendationId' => '

The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the EndpointName field.

', 'GetScalingConfigurationRecommendationResponse$RecommendationId' => '

The recommendation ID of a previously completed inference recommendation.

', 'IamIdentity$Arn' => '

The Amazon Resource Name (ARN) of the IAM identity.

', 'IamIdentity$PrincipalId' => '

The ID of the principal that assumes the IAM identity.

', 'IamIdentity$SourceIdentity' => '

The person or application which assumes the IAM identity.

', 'InferenceRecommendation$RecommendationId' => '

The recommendation ID which uniquely identifies each recommendation.

', 'ListProcessingJobsRequest$NameContains' => '

A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

', 'ModelCard$ModelId' => '

The unique name (ID) of the model.

', 'ModelCard$RiskRating' => '

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

', 'ModelCard$ModelPackageGroupName' => '

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.

', 'ModelDashboardModelCard$ModelId' => '

For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.

', 'ModelDashboardModelCard$RiskRating' => '

A model card\'s risk rating. Can be low, medium, or high.

', 'ModelMetadataSummary$Domain' => '

The machine learning domain of the model.

', 'ModelMetadataSummary$Framework' => '

The machine learning framework of the model.

', 'ModelMetadataSummary$Task' => '

The machine learning task of the model.

', 'ModelMetadataSummary$Model' => '

The name of the model.

', 'ModelMetadataSummary$FrameworkVersion' => '

The framework version of the model.

', 'ModelPackage$Domain' => '

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

', 'ModelPackage$Task' => '

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

', 'ModelPackage$SamplePayloadUrl' => '

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'ModelPackageContainerDefinition$Framework' => '

The machine learning framework of the model package container image.

', 'ModelPackageContainerDefinition$NearestModelName' => '

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.

', 'ModelPackageStatusItem$FailureReason' => '

if the overall status is Failed, the reason for the failure.

', 'PredefinedMetricSpecification$PredefinedMetricType' => '

The metric type. You can only apply SageMaker metric types to SageMaker endpoints.

', 'ProcessingInput$InputName' => '

The name for the processing job input.

', 'ProcessingOutput$OutputName' => '

The name for the processing job output.

', 'ProductListings$member' => NULL, 'RStudioServerProDomainSettings$RStudioConnectUrl' => '

A URL pointing to an RStudio Connect server.

', 'RStudioServerProDomainSettings$RStudioPackageManagerUrl' => '

A URL pointing to an RStudio Package Manager server.

', 'RStudioServerProDomainSettingsForUpdate$RStudioConnectUrl' => '

A URL pointing to an RStudio Connect server.

', 'RStudioServerProDomainSettingsForUpdate$RStudioPackageManagerUrl' => '

A URL pointing to an RStudio Package Manager server.

', 'RealTimeInferenceRecommendation$RecommendationId' => '

The recommendation ID which uniquely identifies each recommendation.

', 'RecommendationJobContainerConfig$Domain' => '

The machine learning domain of the model and its components.

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING

', 'RecommendationJobContainerConfig$Task' => '

The machine learning task that the model accomplishes.

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER

', 'RecommendationJobContainerConfig$Framework' => '

The machine learning framework of the container image.

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN

', 'RecommendationJobContainerConfig$NearestModelName' => '

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet

', 'RecommendationJobSupportedInstanceTypes$member' => NULL, 'RenderUiTemplateResponse$RenderedContent' => '

A Liquid template that renders the HTML for the worker UI.

', 'RenderingError$Code' => '

A unique identifier for a specific class of errors.

', 'RenderingError$Message' => '

A human-readable message describing the error.

', 'ScheduleConfig$DataAnalysisStartTime' => '

Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H".

The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

', 'ScheduleConfig$DataAnalysisEndTime' => '

Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H".

The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

', 'SubscribedWorkteam$SellerName' => '

The name of the vendor in the Amazon Marketplace.

', 'SubscribedWorkteam$ListingId' => '

Marketplace product listing ID.

', 'UserContext$UserProfileArn' => '

The Amazon Resource Name (ARN) of the user\'s profile.

', 'UserContext$UserProfileName' => '

The name of the user\'s profile.

', 'UserContext$DomainId' => '

The domain associated with the user.

', 'Workforce$SubDomain' => '

The subdomain for your OIDC Identity Provider.

', 'Workteam$SubDomain' => '

The URI of the labeling job\'s user interface. Workers open this URI to start labeling your data objects.

', ], ], 'String1024' => [ 'base' => NULL, 'refs' => [ 'ClarifyCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => '

The Amazon S3 URI of baseline constraints file to be used for the drift check.

', 'ClarifyCheckStepMetadata$CalculatedBaselineConstraints' => '

The Amazon S3 URI of the newly calculated baseline constraints file.

', 'ClarifyCheckStepMetadata$ViolationReport' => '

The Amazon S3 URI of the violation report if violations are detected.

', 'CreateDomainResponse$Url' => '

The URL to the created domain.

', 'DescribeDomainResponse$Url' => '

The domain\'s URL.

', 'DescribeSpaceResponse$Url' => '

Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

The following application types are supported:

  • Studio Classic: &redirect=JupyterServer

  • JupyterLab: &redirect=JupyterLab

  • Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

', 'DomainDetails$Url' => '

The domain\'s URL.

', 'EMRStepMetadata$LogFilePath' => '

The path to the log file where the cluster step\'s failure root cause is recorded.

', 'OutputParameter$Value' => '

The value of the output parameter.

', 'Parameter$Value' => '

The literal value for the parameter.

', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckStatistics' => '

The Amazon S3 URI of the baseline statistics file used for the drift check.

', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => '

The Amazon S3 URI of the baseline constraints file used for the drift check.

', 'QualityCheckStepMetadata$CalculatedBaselineStatistics' => '

The Amazon S3 URI of the newly calculated baseline statistics file.

', 'QualityCheckStepMetadata$CalculatedBaselineConstraints' => '

The Amazon S3 URI of the newly calculated baseline constraints file.

', 'QualityCheckStepMetadata$ViolationReport' => '

The Amazon S3 URI of violation report if violations are detected.

', ], ], 'String128' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRangeValues$member' => NULL, ], ], 'String200' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$Description' => '

A description of the work team.

', 'SubscribedWorkteam$MarketplaceTitle' => '

The title of the service provided by the vendor in the Amazon Marketplace.

', 'SubscribedWorkteam$MarketplaceDescription' => '

The description of the vendor from the Amazon Marketplace.

', 'UpdateWorkteamRequest$Description' => '

An updated description for the work team.

', 'Workteam$Description' => '

A description of the work team.

', ], ], 'String256' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceType' => '

The type of the source.

', 'ActionSource$SourceId' => '

The ID of the source.

', 'ArtifactSourceType$Value' => '

The ID.

', 'ArtifactSummary$ArtifactType' => '

The type of the artifact.

', 'AssociationSummary$SourceType' => '

The source type.

', 'AssociationSummary$DestinationType' => '

The destination type.

', 'CallbackStepMetadata$SqsQueueUrl' => '

The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

', 'ClarifyCheckStepMetadata$CheckType' => '

The type of the Clarify Check step

', 'ClarifyCheckStepMetadata$ModelPackageGroupName' => '

The model package group name.

', 'ClarifyCheckStepMetadata$CheckJobArn' => '

The Amazon Resource Name (ARN) of the check processing job that was run by this step\'s execution.

', 'ContextSource$SourceType' => '

The type of the source.

', 'ContextSource$SourceId' => '

The ID of the source.

', 'ContextSummary$ContextType' => '

The type of the context.

', 'CreateActionRequest$ActionType' => '

The action type.

', 'CreateArtifactRequest$ArtifactType' => '

The artifact type.

', 'CreateContextRequest$ContextType' => '

The context type.

', 'CreateUserProfileRequest$SingleSignOnUserValue' => '

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain\'s AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain\'s AuthMode is not IAM Identity Center, this field cannot be specified.

', 'CustomImageContainerEnvironmentVariables$value' => NULL, 'DescribeActionResponse$ActionType' => '

The type of the action.

', 'DescribeArtifactResponse$ArtifactType' => '

The type of the artifact.

', 'DescribeContextResponse$ContextType' => '

The type of the context.

', 'DescribeDomainResponse$SingleSignOnManagedApplicationInstanceId' => '

The IAM Identity Center managed application instance ID.

', 'DescribeUserProfileResponse$SingleSignOnUserValue' => '

The IAM Identity Center user value.

', 'EMRStepMetadata$ClusterId' => '

The identifier of the EMR cluster.

', 'EMRStepMetadata$StepId' => '

The identifier of the EMR cluster step.

', 'EMRStepMetadata$StepName' => '

The name of the EMR cluster step.

', 'LambdaStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

', 'ListActionsRequest$ActionType' => '

A filter that returns only actions of the specified type.

', 'ListArtifactsRequest$ArtifactType' => '

A filter that returns only artifacts of the specified type.

', 'ListAssociationsRequest$SourceType' => '

A filter that returns only associations with the specified source type.

', 'ListAssociationsRequest$DestinationType' => '

A filter that returns only associations with the specified destination type.

', 'ListContextsRequest$ContextType' => '

A filter that returns only contexts of the specified type.

', 'ListTrialComponentsRequest$SourceArn' => '

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can\'t filter by ExperimentName or TrialName.

', 'ModelMetadataFilter$Value' => '

The value to filter the model metadata.

', 'ModelStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the created model.

', 'OutputParameter$Name' => '

The name of the output parameter.

', 'QualityCheckStepMetadata$CheckType' => '

The type of the Quality check step.

', 'QualityCheckStepMetadata$ModelPackageGroupName' => '

The model package group name.

', 'QualityCheckStepMetadata$CheckJobArn' => '

The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

', 'QueryProperties$key' => NULL, 'QueryProperties$value' => NULL, 'RegisterModelStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the model package.

', 'SelectedStep$StepName' => '

The name of the pipeline step.

', 'SendPipelineExecutionStepFailureRequest$FailureReason' => '

A message describing why the step failed.

', ], ], 'String3072' => [ 'base' => NULL, 'refs' => [ 'FailStepMetadata$ErrorMessage' => '

A message that you define and then is processed and rendered by the Fail step when the error occurs.

', 'PipelineExecutionSummary$PipelineExecutionFailureReason' => '

A message generated by SageMaker Pipelines describing why the pipeline execution failed.

', ], ], 'String40' => [ 'base' => NULL, 'refs' => [ 'QueryTypes$member' => NULL, 'Vertex$Type' => '

The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...

', ], ], 'String64' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionType' => '

The type of the action.

', 'CategoricalParameter$Name' => '

The Name of the environment variable.

', 'ModelLatencyThreshold$Percentile' => '

The model latency percentile threshold. Acceptable values are P95 and P99. For custom load tests, specify the value as P95.

', ], ], 'String8192' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$NextToken' => '

Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.

', 'QueryLineageResponse$NextToken' => '

Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.

', ], ], 'StringParameterValue' => [ 'base' => NULL, 'refs' => [ 'ArtifactProperties$key' => NULL, 'LineageEntityParameters$key' => NULL, 'LineageEntityParameters$value' => NULL, 'ListLineageEntityParameterKey$member' => NULL, 'TrialComponentParameterValue$StringValue' => '

The string value of a categorical hyperparameter. If you specify a value for this parameter, you can\'t specify the NumberValue parameter.

', ], ], 'StudioLifecycleConfigAppType' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigAppType' => '

The App type that the Lifecycle Configuration is attached to.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigAppType' => '

The App type that the Lifecycle Configuration is attached to.

', 'ListStudioLifecycleConfigsRequest$AppTypeEquals' => '

A parameter to search for the App Type to which the Lifecycle Configuration is attached.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigAppType' => '

The App type to which the Lifecycle Configuration is attached.

', ], ], 'StudioLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => '

The ARN of your created Lifecycle Configuration.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => '

The ARN of the Lifecycle Configuration to describe.

', 'LifecycleConfigArns$member' => NULL, 'ResourceSpec$LifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the Lifecycle Configuration.

', ], ], 'StudioLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigContent' => '

The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigContent' => '

The content of your Amazon SageMaker Studio Lifecycle Configuration script.

', ], ], 'StudioLifecycleConfigDetails' => [ 'base' => '

Details of the Amazon SageMaker Studio Lifecycle Configuration.

', 'refs' => [ 'StudioLifecycleConfigsList$member' => NULL, ], ], 'StudioLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to create.

', 'DeleteStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.

', 'DescribeStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.

', 'ListStudioLifecycleConfigsRequest$NameContains' => '

A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration.

', ], ], 'StudioLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'StudioLifecycleConfigsList' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsResponse$StudioLifecycleConfigs' => '

A list of Lifecycle Configurations and their properties.

', ], ], 'StudioWebPortal' => [ 'base' => NULL, 'refs' => [ 'UserSettings$StudioWebPortal' => '

Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$SubnetId' => '

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

', 'DescribeNotebookInstanceOutput$SubnetId' => '

The ID of the VPC subnet.

', 'Subnets$member' => NULL, ], ], 'Subnets' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$SubnetIds' => '

The VPC subnets that the domain uses for communication.

', 'DescribeDomainResponse$SubnetIds' => '

The VPC subnets that the domain uses for communication.

', 'UpdateDomainRequest$SubnetIds' => '

The VPC subnets that Studio uses for communication.

If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.

', 'VpcConfig$Subnets' => '

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

', ], ], 'SubscribedWorkteam' => [ 'base' => '

Describes a work team of a vendor that does the a labelling job.

', 'refs' => [ 'DescribeSubscribedWorkteamResponse$SubscribedWorkteam' => '

A Workteam instance that contains information about the work team.

', 'SubscribedWorkteams$member' => NULL, ], ], 'SubscribedWorkteams' => [ 'base' => NULL, 'refs' => [ 'ListSubscribedWorkteamsResponse$SubscribedWorkteams' => '

An array of Workteam objects, each describing a work team.

', ], ], 'Success' => [ 'base' => NULL, 'refs' => [ 'DeleteWorkteamResponse$Success' => '

Returns true if the work team was successfully deleted; otherwise, returns false.

', ], ], 'SuggestionQuery' => [ 'base' => '

Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.

', 'refs' => [ 'GetSearchSuggestionsRequest$SuggestionQuery' => '

Limits the property names that are included in the response.

', ], ], 'TableFormat' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreConfig$TableFormat' => '

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

', ], ], 'TableName' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$TableName' => '

The name of the Glue table.

', ], ], 'TabularJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the tabular problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TabularJobConfig' => '

Settings used to configure an AutoML job V2 for the tabular problem type (regression, classification).

', ], ], 'TabularResolvedAttributes' => [ 'base' => '

The resolved attributes specific to the tabular problem type.

', 'refs' => [ 'AutoMLProblemTypeResolvedAttributes$TabularResolvedAttributes' => '

The resolved attributes for the tabular problem type.

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

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

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

The tag key. Tag keys must be unique per resource.

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

An array or one or more tag keys to delete.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'AddTagsOutput$Tags' => '

A list of tags associated with the SageMaker resource.

', 'CreateActionRequest$Tags' => '

A list of tags to apply to the action.

', 'CreateAlgorithmInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateAppImageConfigRequest$Tags' => '

A list of tags to apply to the AppImageConfig.

', 'CreateAppRequest$Tags' => '

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

', 'CreateArtifactRequest$Tags' => '

A list of tags to apply to the artifact.

', 'CreateAutoMLJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

', 'CreateAutoMLJobV2Request$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, such as by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

', 'CreateClusterRequest$Tags' => '

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

', 'CreateCodeRepositoryInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateCompilationJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateContextRequest$Tags' => '

A list of tags to apply to the context.

', 'CreateDataQualityJobDefinitionRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateDeviceFleetRequest$Tags' => '

Creates tags for the specified fleet.

', 'CreateDomainRequest$Tags' => '

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

', 'CreateEdgeDeploymentPlanRequest$Tags' => '

List of tags with which to tag the edge deployment plan.

', 'CreateEdgePackagingJobRequest$Tags' => '

Creates tags for the packaging job.

', 'CreateEndpointConfigInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateEndpointInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateExperimentRequest$Tags' => '

A list of tags to associate with the experiment. You can use Search API to search on the tags.

', 'CreateFeatureGroupRequest$Tags' => '

Tags used to identify Features in each FeatureGroup.

', 'CreateFlowDefinitionRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

', 'CreateHubRequest$Tags' => '

Any tags to associate with the hub.

', 'CreateHumanTaskUiRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

', 'CreateHyperParameterTuningJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

', 'CreateImageRequest$Tags' => '

A list of tags to apply to the image.

', 'CreateInferenceComponentInput$Tags' => '

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

', 'CreateInferenceExperimentRequest$Tags' => '

Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.

', 'CreateInferenceRecommendationsJobRequest$Tags' => '

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

', 'CreateLabelingJobRequest$Tags' => '

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateModelBiasJobDefinitionRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateModelCardRequest$Tags' => '

Key-value pairs used to manage metadata for model cards.

', 'CreateModelExplainabilityJobDefinitionRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateModelInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateModelPackageGroupInput$Tags' => '

A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'CreateModelPackageInput$Tags' => '

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.

', 'CreateModelQualityJobDefinitionRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateMonitoringScheduleRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateNotebookInstanceInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreatePipelineRequest$Tags' => '

A list of tags to apply to the created pipeline.

', 'CreateProcessingJobRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateProjectInput$Tags' => '

An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'CreateSpaceRequest$Tags' => '

Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.

', 'CreateStudioLifecycleConfigRequest$Tags' => '

Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

', 'CreateTrainingJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateTransformJobRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateTrialComponentRequest$Tags' => '

A list of tags to associate with the component. You can use Search API to search on the tags.

', 'CreateTrialRequest$Tags' => '

A list of tags to associate with the trial. You can use Search API to search on the tags.

', 'CreateUserProfileRequest$Tags' => '

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

', 'CreateWorkforceRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

', 'CreateWorkteamRequest$Tags' => '

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'DescribeLabelingJobResponse$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'Endpoint$Tags' => '

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'Experiment$Tags' => '

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

', 'FeatureGroup$Tags' => '

Tags used to define a FeatureGroup.

', 'HyperParameterTuningJobSearchEntity$Tags' => '

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

', 'ImportHubContentRequest$Tags' => '

Any tags associated with the hub content.

', 'ListTagsOutput$Tags' => '

An array of Tag objects, each with a tag key and a value.

', 'Model$Tags' => '

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'ModelCard$Tags' => '

Key-value pairs used to manage metadata for the model card.

', 'ModelDashboardModelCard$Tags' => '

The tags associated with a model card.

', 'ModelPackage$Tags' => '

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'ModelPackageGroup$Tags' => '

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'MonitoringSchedule$Tags' => '

A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'Pipeline$Tags' => '

A list of tags that apply to the pipeline.

', 'ProcessingJob$Tags' => '

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'Project$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'RegisterDevicesRequest$Tags' => '

The tags associated with devices.

', 'TrainingJob$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'TransformJob$Tags' => '

A list of tags associated with the transform job.

', 'Trial$Tags' => '

The list of tags that are associated with the trial. You can use Search API to search on the tags.

', 'TrialComponent$Tags' => '

The list of tags that are associated with the component. You can use Search API to search on the tags.

', 'UpdateProjectInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints.

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

The tag value.

', ], ], 'TargetAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$TargetAttributeName' => '

The name of the target variable in supervised learning, usually represented by \'y\'.

', 'TabularJobConfig$TargetAttributeName' => '

The name of the target variable in supervised learning, usually represented by \'y\'.

', 'TimeSeriesConfig$TargetAttributeName' => '

The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.

', ], ], 'TargetDevice' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetDevice' => '

The type of device that the model will run on after the compilation job has completed.

', 'OutputConfig$TargetDevice' => '

Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.

Currently ml_trn1 is available only in US East (N. Virginia) Region, and ml_inf2 is available only in US East (Ohio) Region.

', ], ], 'TargetLabelColumn' => [ 'base' => NULL, 'refs' => [ 'TextClassificationJobConfig$TargetLabelColumn' => '

The name of the column used to provide the class labels. It should not be same as the content column.

', ], ], 'TargetObjectiveMetricValue' => [ 'base' => NULL, 'refs' => [ 'TuningJobCompletionCriteria$TargetObjectiveMetricValue' => '

The value of the objective metric.

', ], ], 'TargetPlatform' => [ 'base' => '

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

', 'refs' => [ 'OutputConfig$TargetPlatform' => '

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:

  • Raspberry Pi 3 Model B+

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM_EABIHF"},

    "CompilerOptions": {\'mattr\': [\'+neon\']}

  • Jetson TX2

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "NVIDIA"},

    "CompilerOptions": {\'gpu-code\': \'sm_62\', \'trt-ver\': \'6.0.1\', \'cuda-ver\': \'10.0\'}

  • EC2 m5.2xlarge instance OS

    "TargetPlatform": {"Os": "LINUX", "Arch": "X86_64", "Accelerator": "NVIDIA"},

    "CompilerOptions": {\'mcpu\': \'skylake-avx512\'}

  • RK3399

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "MALI"}

  • ARMv7 phone (CPU)

    "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM_EABI"},

    "CompilerOptions": {\'ANDROID_PLATFORM\': 25, \'mattr\': [\'+neon\']}

  • ARMv8 phone (CPU)

    "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"},

    "CompilerOptions": {\'ANDROID_PLATFORM\': 29}

', ], ], 'TargetPlatformAccelerator' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformAccelerator' => '

The type of accelerator that the model will run on after the compilation job has completed.

', 'TargetPlatform$Accelerator' => '

Specifies a target platform accelerator (optional).

  • NVIDIA: Nvidia graphics processing unit. It also requires gpu-code, trt-ver, cuda-ver compiler options

  • MALI: ARM Mali graphics processor

  • INTEL_GRAPHICS: Integrated Intel graphics

', ], ], 'TargetPlatformArch' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformArch' => '

The type of architecture that the model will run on after the compilation job has completed.

', 'TargetPlatform$Arch' => '

Specifies a target platform architecture.

  • X86_64: 64-bit version of the x86 instruction set.

  • X86: 32-bit version of the x86 instruction set.

  • ARM64: ARMv8 64-bit CPU.

  • ARM_EABIHF: ARMv7 32-bit, Hard Float.

  • ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.

', ], ], 'TargetPlatformOs' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformOs' => '

The type of OS that the model will run on after the compilation job has completed.

', 'TargetPlatform$Os' => '

Specifies a target platform OS.

  • LINUX: Linux-based operating systems.

  • ANDROID: Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, "CompilerOptions": {\'ANDROID_PLATFORM\': 28}

', ], ], 'TargetTrackingScalingPolicyConfiguration' => [ 'base' => '

A target tracking scaling policy. Includes support for predefined or customized metrics.

When using the PutScalingPolicy API, this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

', 'refs' => [ 'ScalingPolicy$TargetTracking' => '

A target tracking scaling policy. Includes support for predefined or customized metrics.

', ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskAvailabilityLifetimeInSeconds' => '

The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.

  • If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).

  • If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

', ], ], 'TaskCount' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$DesiredInstanceCount' => '

The variant\'s capacity.

', 'PendingProductionVariantSummary$CurrentInstanceCount' => '

The number of instances associated with the variant.

', 'PendingProductionVariantSummary$DesiredInstanceCount' => '

The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

', 'ProductionVariantSummary$CurrentInstanceCount' => '

The number of instances associated with the variant.

', 'ProductionVariantSummary$DesiredInstanceCount' => '

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

', 'RealTimeInferenceConfig$InstanceCount' => '

The number of instances of the type specified by InstanceType.

', ], ], 'TaskDescription' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskDescription' => '

A description of the task for your human workers.

', ], ], 'TaskInput' => [ 'base' => NULL, 'refs' => [ 'RenderableTask$Input' => '

A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as "text": "sample text".

', ], ], 'TaskKeyword' => [ 'base' => NULL, 'refs' => [ 'TaskKeywords$member' => NULL, ], ], 'TaskKeywords' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskKeywords' => '

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

', ], ], 'TaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskTimeLimitInSeconds' => '

The amount of time that a worker has to complete a task.

If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).

If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:

  • For image and text labeling jobs, the maximum is 8 hours (28,800 seconds).

  • For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

', ], ], 'TaskTitle' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskTitle' => '

A title for the task for your human workers.

', ], ], 'TemplateContent' => [ 'base' => NULL, 'refs' => [ 'UiTemplate$Content' => '

The content of the Liquid template for the worker user interface.

', ], ], 'TemplateContentSha256' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$ContentSha256' => '

The SHA-256 digest of the contents of the template.

', ], ], 'TemplateUrl' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$Url' => '

The URL for the user interface template.

', ], ], 'TensorBoardAppSettings' => [ 'base' => '

The TensorBoard app settings.

', 'refs' => [ 'UserSettings$TensorBoardAppSettings' => '

The TensorBoard app settings.

', ], ], 'TensorBoardOutputConfig' => [ 'base' => '

Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

', 'refs' => [ 'CreateTrainingJobRequest$TensorBoardOutputConfig' => NULL, 'DescribeTrainingJobResponse$TensorBoardOutputConfig' => NULL, 'TrainingJob$TensorBoardOutputConfig' => NULL, ], ], 'TenthFractionsOfACent' => [ 'base' => NULL, 'refs' => [ 'USD$TenthFractionsOfACent' => '

Fractions of a cent, in tenths.

', ], ], 'TerminationWaitInSeconds' => [ 'base' => NULL, 'refs' => [ 'BlueGreenUpdatePolicy$TerminationWaitInSeconds' => '

Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.

', ], ], 'TextClassificationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the text classification problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TextClassificationJobConfig' => '

Settings used to configure an AutoML job V2 for the text classification problem type.

', ], ], 'TextGenerationHyperParameterKey' => [ 'base' => NULL, 'refs' => [ 'TextGenerationHyperParameters$key' => NULL, ], ], 'TextGenerationHyperParameterValue' => [ 'base' => NULL, 'refs' => [ 'TextGenerationHyperParameters$value' => NULL, ], ], 'TextGenerationHyperParameters' => [ 'base' => NULL, 'refs' => [ 'TextGenerationJobConfig$TextGenerationHyperParameters' => '

The hyperparameters used to configure and optimize the learning process of the base model. You can set any combination of the following hyperparameters for all base models. For more information on each supported hyperparameter, see Optimize the learning process of your text generation models with hyperparameters.

  • "epochCount": The number of times the model goes through the entire training dataset. Its value should be a string containing an integer value within the range of "1" to "10".

  • "batchSize": The number of data samples used in each iteration of training. Its value should be a string containing an integer value within the range of "1" to "64".

  • "learningRate": The step size at which a model\'s parameters are updated during training. Its value should be a string containing a floating-point value within the range of "0" to "1".

  • "learningRateWarmupSteps": The number of training steps during which the learning rate gradually increases before reaching its target or maximum value. Its value should be a string containing an integer value within the range of "0" to "250".

Here is an example where all four hyperparameters are configured.

{ "epochCount":"5", "learningRate":"0.5", "batchSize": "32", "learningRateWarmupSteps": "10" }

', ], ], 'TextGenerationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the text generation problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

', 'refs' => [ 'AutoMLProblemTypeConfig$TextGenerationJobConfig' => '

Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning) problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

', ], ], 'TextGenerationResolvedAttributes' => [ 'base' => '

The resolved attributes specific to the text generation problem type.

', 'refs' => [ 'AutoMLProblemTypeResolvedAttributes$TextGenerationResolvedAttributes' => '

The resolved attributes for the text generation problem type.

', ], ], 'ThingName' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$IotThingName' => '

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

', 'Device$IotThingName' => '

Amazon Web Services Internet of Things (IoT) object name.

', 'DeviceSummary$IotThingName' => '

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

', ], ], 'TimeSeriesConfig' => [ 'base' => '

The collection of components that defines the time-series.

', 'refs' => [ 'TimeSeriesForecastingJobConfig$TimeSeriesConfig' => '

The collection of components that defines the time-series.

', ], ], 'TimeSeriesForecastingJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the time-series forecasting problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TimeSeriesForecastingJobConfig' => '

Settings used to configure an AutoML job V2 for the time-series forecasting problem type.

', ], ], 'TimeSeriesForecastingSettings' => [ 'base' => '

Time series forecast settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$TimeSeriesForecastingSettings' => '

Time series forecast settings for the SageMaker Canvas application.

', ], ], 'TimeSeriesTransformations' => [ 'base' => '

Transformations allowed on the dataset. Supported transformations are Filling and Aggregation. Filling specifies how to add values to missing values in the dataset. Aggregation defines how to aggregate data that does not align with forecast frequency.

', 'refs' => [ 'TimeSeriesForecastingJobConfig$Transformations' => '

The transformations modifying specific attributes of the time-series, such as filling strategies for missing values.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$CreationTime' => '

When the action was created.

', 'ActionSummary$LastModifiedTime' => '

When the action was last modified.

', 'AppImageConfigDetails$CreationTime' => '

When the AppImageConfig was created.

', 'AppImageConfigDetails$LastModifiedTime' => '

When the AppImageConfig was last modified.

', 'ArtifactSummary$CreationTime' => '

When the artifact was created.

', 'ArtifactSummary$LastModifiedTime' => '

When the artifact was last modified.

', 'AssociationSummary$CreationTime' => '

When the association was created.

', 'AutoMLCandidate$CreationTime' => '

The creation time.

', 'AutoMLCandidate$EndTime' => '

The end time.

', 'AutoMLCandidate$LastModifiedTime' => '

The last modified time.

', 'AutoMLJobSummary$CreationTime' => '

When the AutoML job was created.

', 'AutoMLJobSummary$EndTime' => '

The end time of an AutoML job.

', 'AutoMLJobSummary$LastModifiedTime' => '

When the AutoML job was last modified.

', 'ClusterNodeDetails$LaunchTime' => '

The time when the instance is launched.

', 'ClusterNodeSummary$LaunchTime' => '

The time when the instance is launched.

', 'ClusterSummary$CreationTime' => '

The time when the SageMaker HyperPod cluster is created.

', 'CompilationJobSummary$CompilationStartTime' => '

The time when the model compilation job started.

', 'CompilationJobSummary$CompilationEndTime' => '

The time when the model compilation job completed.

', 'ContextSummary$CreationTime' => '

When the context was created.

', 'ContextSummary$LastModifiedTime' => '

When the context was last modified.

', 'CreateTrialComponentRequest$StartTime' => '

When the component started.

', 'CreateTrialComponentRequest$EndTime' => '

When the component ended.

', 'DebugRuleEvaluationStatus$LastModifiedTime' => '

Timestamp when the rule evaluation status was last modified.

', 'DeployedImage$ResolutionTime' => '

The date and time when the image path for the model resolved to the ResolvedImage

', 'DescribeActionResponse$CreationTime' => '

When the action was created.

', 'DescribeActionResponse$LastModifiedTime' => '

When the action was last modified.

', 'DescribeAppImageConfigResponse$CreationTime' => '

When the AppImageConfig was created.

', 'DescribeAppImageConfigResponse$LastModifiedTime' => '

When the AppImageConfig was last modified.

', 'DescribeAppResponse$LastHealthCheckTimestamp' => '

The timestamp of the last health check.

', 'DescribeAppResponse$LastUserActivityTimestamp' => '

The timestamp of the last user\'s activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

', 'DescribeAppResponse$CreationTime' => '

The creation time.

', 'DescribeArtifactResponse$CreationTime' => '

When the artifact was created.

', 'DescribeArtifactResponse$LastModifiedTime' => '

When the artifact was last modified.

', 'DescribeAutoMLJobResponse$CreationTime' => '

Returns the creation time of the AutoML job.

', 'DescribeAutoMLJobResponse$EndTime' => '

Returns the end time of the AutoML job.

', 'DescribeAutoMLJobResponse$LastModifiedTime' => '

Returns the job\'s last modified time.

', 'DescribeAutoMLJobV2Response$CreationTime' => '

Returns the creation time of the AutoML job V2.

', 'DescribeAutoMLJobV2Response$EndTime' => '

Returns the end time of the AutoML job V2.

', 'DescribeAutoMLJobV2Response$LastModifiedTime' => '

Returns the job\'s last modified time.

', 'DescribeClusterResponse$CreationTime' => '

The time when the SageMaker Cluster is created.

', 'DescribeCompilationJobResponse$CompilationStartTime' => '

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That\'s because it takes time to download the compilation job, which depends on the size of the compilation job container.

', 'DescribeCompilationJobResponse$CompilationEndTime' => '

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job\'s model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

', 'DescribeContextResponse$CreationTime' => '

When the context was created.

', 'DescribeContextResponse$LastModifiedTime' => '

When the context was last modified.

', 'DescribeDataQualityJobDefinitionResponse$CreationTime' => '

The time that the data quality monitoring job definition was created.

', 'DescribeDeviceFleetResponse$CreationTime' => '

Timestamp of when the device fleet was created.

', 'DescribeDeviceFleetResponse$LastModifiedTime' => '

Timestamp of when the device fleet was last updated.

', 'DescribeDeviceResponse$RegistrationTime' => '

The timestamp of the last registration or de-reregistration.

', 'DescribeDeviceResponse$LatestHeartbeat' => '

The last heartbeat received from the device.

', 'DescribeEdgeDeploymentPlanResponse$CreationTime' => '

The time when the edge deployment plan was created.

', 'DescribeEdgeDeploymentPlanResponse$LastModifiedTime' => '

The time when the edge deployment plan was last updated.

', 'DescribeEdgePackagingJobResponse$CreationTime' => '

The timestamp of when the packaging job was created.

', 'DescribeEdgePackagingJobResponse$LastModifiedTime' => '

The timestamp of when the job was last updated.

', 'DescribeEndpointConfigOutput$CreationTime' => '

A timestamp that shows when the endpoint configuration was created.

', 'DescribeEndpointOutput$CreationTime' => '

A timestamp that shows when the endpoint was created.

', 'DescribeEndpointOutput$LastModifiedTime' => '

A timestamp that shows when the endpoint was last modified.

', 'DescribeExperimentResponse$CreationTime' => '

When the experiment was created.

', 'DescribeExperimentResponse$LastModifiedTime' => '

When the experiment was last modified.

', 'DescribeFlowDefinitionResponse$CreationTime' => '

The timestamp when the flow definition was created.

', 'DescribeHubContentResponse$CreationTime' => '

The date and time that hub content was created.

', 'DescribeHubResponse$CreationTime' => '

The date and time that the hub was created.

', 'DescribeHubResponse$LastModifiedTime' => '

The date and time that the hub was last modified.

', 'DescribeHumanTaskUiResponse$CreationTime' => '

The timestamp when the human task user interface was created.

', 'DescribeHyperParameterTuningJobResponse$CreationTime' => '

The date and time that the tuning job started.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningEndTime' => '

The date and time that the tuning job ended.

', 'DescribeHyperParameterTuningJobResponse$LastModifiedTime' => '

The date and time that the status of the tuning job was modified.

', 'DescribeImageResponse$CreationTime' => '

When the image was created.

', 'DescribeImageResponse$LastModifiedTime' => '

When the image was last modified.

', 'DescribeImageVersionResponse$CreationTime' => '

When the version was created.

', 'DescribeImageVersionResponse$LastModifiedTime' => '

When the version was last modified.

', 'DescribeInferenceComponentOutput$CreationTime' => '

The time when the inference component was created.

', 'DescribeInferenceComponentOutput$LastModifiedTime' => '

The time when the inference component was last updated.

', 'DescribeInferenceExperimentResponse$CreationTime' => '

The timestamp at which you created the inference experiment.

', 'DescribeInferenceExperimentResponse$CompletionTime' => '

The timestamp at which the inference experiment was completed.

', 'DescribeInferenceExperimentResponse$LastModifiedTime' => '

The timestamp at which you last modified the inference experiment.

', 'DescribeInferenceRecommendationsJobResponse$CompletionTime' => '

A timestamp that shows when the job completed.

', 'DescribeLabelingJobResponse$CreationTime' => '

The date and time that the labeling job was created.

', 'DescribeLabelingJobResponse$LastModifiedTime' => '

The date and time that the labeling job was last updated.

', 'DescribeLineageGroupResponse$CreationTime' => '

The creation time of lineage group.

', 'DescribeLineageGroupResponse$LastModifiedTime' => '

The last modified time of the lineage group.

', 'DescribeModelBiasJobDefinitionResponse$CreationTime' => '

The time at which the model bias job was created.

', 'DescribeModelCardExportJobResponse$CreatedAt' => '

The date and time that the model export job was created.

', 'DescribeModelCardExportJobResponse$LastModifiedAt' => '

The date and time that the model export job was last modified.

', 'DescribeModelCardResponse$CreationTime' => '

The date and time the model card was created.

', 'DescribeModelCardResponse$LastModifiedTime' => '

The date and time the model card was last modified.

', 'DescribeModelExplainabilityJobDefinitionResponse$CreationTime' => '

The time at which the model explainability job was created.

', 'DescribeModelOutput$CreationTime' => '

A timestamp that shows when the model was created.

', 'DescribeModelPackageOutput$LastModifiedTime' => '

The last time that the model package was modified.

', 'DescribeModelQualityJobDefinitionResponse$CreationTime' => '

The time at which the model quality job was created.

', 'DescribeMonitoringScheduleResponse$CreationTime' => '

The time at which the monitoring job was created.

', 'DescribeMonitoringScheduleResponse$LastModifiedTime' => '

The time at which the monitoring job was last modified.

', 'DescribePipelineDefinitionForExecutionResponse$CreationTime' => '

The time when the pipeline was created.

', 'DescribePipelineExecutionResponse$CreationTime' => '

The time when the pipeline execution was created.

', 'DescribePipelineExecutionResponse$LastModifiedTime' => '

The time when the pipeline execution was modified last.

', 'DescribePipelineResponse$CreationTime' => '

The time when the pipeline was created.

', 'DescribePipelineResponse$LastModifiedTime' => '

The time when the pipeline was last modified.

', 'DescribePipelineResponse$LastRunTime' => '

The time when the pipeline was last run.

', 'DescribeProcessingJobResponse$ProcessingEndTime' => '

The time at which the processing job completed.

', 'DescribeProcessingJobResponse$ProcessingStartTime' => '

The time at which the processing job started.

', 'DescribeProcessingJobResponse$LastModifiedTime' => '

The time at which the processing job was last modified.

', 'DescribeProcessingJobResponse$CreationTime' => '

The time at which the processing job was created.

', 'DescribeProjectOutput$CreationTime' => '

The time when the project was created.

', 'DescribeProjectOutput$LastModifiedTime' => '

The timestamp when project was last modified.

', 'DescribeStudioLifecycleConfigResponse$CreationTime' => '

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

', 'DescribeStudioLifecycleConfigResponse$LastModifiedTime' => '

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

', 'DescribeTrainingJobResponse$CreationTime' => '

A timestamp that indicates when the training job was created.

', 'DescribeTrainingJobResponse$TrainingStartTime' => '

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

', 'DescribeTrainingJobResponse$TrainingEndTime' => '

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'DescribeTrainingJobResponse$LastModifiedTime' => '

A timestamp that indicates when the status of the training job was last modified.

', 'DescribeTransformJobResponse$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'DescribeTransformJobResponse$TransformStartTime' => '

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

', 'DescribeTransformJobResponse$TransformEndTime' => '

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

', 'DescribeTrialComponentResponse$StartTime' => '

When the component started.

', 'DescribeTrialComponentResponse$EndTime' => '

When the component ended.

', 'DescribeTrialComponentResponse$CreationTime' => '

When the component was created.

', 'DescribeTrialComponentResponse$LastModifiedTime' => '

When the component was last modified.

', 'DescribeTrialResponse$CreationTime' => '

When the trial was created.

', 'DescribeTrialResponse$LastModifiedTime' => '

When the trial was last modified.

', 'DeviceDeploymentSummary$DeploymentStartTime' => '

The time when the deployment on the device started.

', 'DeviceFleetSummary$CreationTime' => '

Timestamp of when the device fleet was created.

', 'DeviceFleetSummary$LastModifiedTime' => '

Timestamp of when the device fleet was last updated.

', 'DeviceSummary$RegistrationTime' => '

The timestamp of the last registration or de-reregistration.

', 'DeviceSummary$LatestHeartbeat' => '

The last heartbeat received from the device.

', 'EdgeDeploymentPlanSummary$CreationTime' => '

The time when the edge deployment plan was created.

', 'EdgeDeploymentPlanSummary$LastModifiedTime' => '

The time when the edge deployment plan was last updated.

', 'EdgeDeploymentStatus$EdgeDeploymentStageStartTime' => '

The time when the deployment API started.

', 'EdgeModel$LatestSampleTime' => '

The timestamp of the last data sample taken.

', 'EdgeModel$LatestInference' => '

The timestamp of the last inference that was made.

', 'EdgePackagingJobSummary$CreationTime' => '

The timestamp of when the job was created.

', 'EdgePackagingJobSummary$LastModifiedTime' => '

The timestamp of when the edge packaging job was last updated.

', 'Endpoint$CreationTime' => '

The time that the endpoint was created.

', 'Endpoint$LastModifiedTime' => '

The last time the endpoint was modified.

', 'EndpointConfigSummary$CreationTime' => '

A timestamp that shows when the endpoint configuration was created.

', 'EndpointSummary$CreationTime' => '

A timestamp that shows when the endpoint was created.

', 'EndpointSummary$LastModifiedTime' => '

A timestamp that shows when the endpoint was last modified.

', 'Experiment$CreationTime' => '

When the experiment was created.

', 'Experiment$LastModifiedTime' => '

When the experiment was last modified.

', 'ExperimentSummary$CreationTime' => '

When the experiment was created.

', 'ExperimentSummary$LastModifiedTime' => '

When the experiment was last modified.

', 'FeatureGroupSummary$CreationTime' => '

A timestamp indicating the time of creation time of the FeatureGroup.

', 'FlowDefinitionSummary$CreationTime' => '

The timestamp when SageMaker created the flow definition.

', 'GetDeviceFleetReportResponse$ReportGenerated' => '

Timestamp of when the report was generated.

', 'HubContentInfo$CreationTime' => '

The date and time that the hub content was created.

', 'HubInfo$CreationTime' => '

The date and time that the hub was created.

', 'HubInfo$LastModifiedTime' => '

The date and time that the hub was last modified.

', 'HumanTaskUiSummary$CreationTime' => '

A timestamp when SageMaker created the human task user interface.

', 'HyperParameterTrainingJobSummary$CreationTime' => '

The date and time that the training job was created.

', 'HyperParameterTrainingJobSummary$TrainingStartTime' => '

The date and time that the training job started.

', 'HyperParameterTrainingJobSummary$TrainingEndTime' => '

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'HyperParameterTuningJobCompletionDetails$ConvergenceDetectedTime' => '

The time in timestamp format that AMT detected model convergence, as defined by a lack of significant improvement over time based on criteria developed over a wide range of diverse benchmarking tests.

', 'HyperParameterTuningJobSearchEntity$CreationTime' => '

The time that a hyperparameter tuning job was created.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningEndTime' => '

The time that a hyperparameter tuning job ended.

', 'HyperParameterTuningJobSearchEntity$LastModifiedTime' => '

The time that a hyperparameter tuning job was last modified.

', 'HyperParameterTuningJobSummary$CreationTime' => '

The date and time that the tuning job was created.

', 'HyperParameterTuningJobSummary$HyperParameterTuningEndTime' => '

The date and time that the tuning job ended.

', 'HyperParameterTuningJobSummary$LastModifiedTime' => '

The date and time that the tuning job was modified.

', 'Image$CreationTime' => '

When the image was created.

', 'Image$LastModifiedTime' => '

When the image was last modified.

', 'ImageVersion$CreationTime' => '

When the version was created.

', 'ImageVersion$LastModifiedTime' => '

When the version was last modified.

', 'InferenceComponentSummary$CreationTime' => '

The time when the inference component was created.

', 'InferenceComponentSummary$LastModifiedTime' => '

The time when the inference component was last updated.

', 'InferenceExperimentSchedule$StartTime' => '

The timestamp at which the inference experiment started or will start.

', 'InferenceExperimentSchedule$EndTime' => '

The timestamp at which the inference experiment ended or will end.

', 'InferenceExperimentSummary$CreationTime' => '

The timestamp at which the inference experiment was created.

', 'InferenceExperimentSummary$CompletionTime' => '

The timestamp at which the inference experiment was completed.

', 'InferenceExperimentSummary$LastModifiedTime' => '

The timestamp when you last modified the inference experiment.

', 'InferenceRecommendationsJob$CompletionTime' => '

A timestamp that shows when the job completed.

', 'LabelingJobForWorkteamSummary$CreationTime' => '

The date and time that the labeling job was created.

', 'LabelingJobSummary$CreationTime' => '

The date and time that the job was created (timestamp).

', 'LabelingJobSummary$LastModifiedTime' => '

The date and time that the job was last modified (timestamp).

', 'LineageGroupSummary$CreationTime' => '

The creation time of the lineage group summary.

', 'LineageGroupSummary$LastModifiedTime' => '

The last modified time of the lineage group summary.

', 'ListActionsRequest$CreatedAfter' => '

A filter that returns only actions created on or after the specified time.

', 'ListActionsRequest$CreatedBefore' => '

A filter that returns only actions created on or before the specified time.

', 'ListAppImageConfigsRequest$CreationTimeBefore' => '

A filter that returns only AppImageConfigs created on or before the specified time.

', 'ListAppImageConfigsRequest$CreationTimeAfter' => '

A filter that returns only AppImageConfigs created on or after the specified time.

', 'ListAppImageConfigsRequest$ModifiedTimeBefore' => '

A filter that returns only AppImageConfigs modified on or before the specified time.

', 'ListAppImageConfigsRequest$ModifiedTimeAfter' => '

A filter that returns only AppImageConfigs modified on or after the specified time.

', 'ListArtifactsRequest$CreatedAfter' => '

A filter that returns only artifacts created on or after the specified time.

', 'ListArtifactsRequest$CreatedBefore' => '

A filter that returns only artifacts created on or before the specified time.

', 'ListAssociationsRequest$CreatedAfter' => '

A filter that returns only associations created on or after the specified time.

', 'ListAssociationsRequest$CreatedBefore' => '

A filter that returns only associations created on or before the specified time.

', 'ListAutoMLJobsRequest$CreationTimeAfter' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$CreationTimeBefore' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$LastModifiedTimeAfter' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$LastModifiedTimeBefore' => '

Request a list of jobs, using a filter for time.

', 'ListClusterNodesRequest$CreationTimeAfter' => '

A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClusterNodesRequest$CreationTimeBefore' => '

A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClustersRequest$CreationTimeAfter' => '

Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClustersRequest$CreationTimeBefore' => '

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListCodeRepositoriesInput$LastModifiedTimeAfter' => '

A filter that returns only Git repositories that were last modified after the specified time.

', 'ListCodeRepositoriesInput$LastModifiedTimeBefore' => '

A filter that returns only Git repositories that were last modified before the specified time.

', 'ListContextsRequest$CreatedAfter' => '

A filter that returns only contexts created on or after the specified time.

', 'ListContextsRequest$CreatedBefore' => '

A filter that returns only contexts created on or before the specified time.

', 'ListDataQualityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only data quality monitoring job definitions created before the specified time.

', 'ListDataQualityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only data quality monitoring job definitions created after the specified time.

', 'ListDeviceFleetsRequest$CreationTimeAfter' => '

Filter fleets where packaging job was created after specified time.

', 'ListDeviceFleetsRequest$CreationTimeBefore' => '

Filter fleets where the edge packaging job was created before specified time.

', 'ListDeviceFleetsRequest$LastModifiedTimeAfter' => '

Select fleets where the job was updated after X

', 'ListDeviceFleetsRequest$LastModifiedTimeBefore' => '

Select fleets where the job was updated before X

', 'ListDevicesRequest$LatestHeartbeatAfter' => '

Select fleets where the job was updated after X

', 'ListEdgeDeploymentPlansRequest$CreationTimeAfter' => '

Selects edge deployment plans created after this time.

', 'ListEdgeDeploymentPlansRequest$CreationTimeBefore' => '

Selects edge deployment plans created before this time.

', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeAfter' => '

Selects edge deployment plans that were last updated after this time.

', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeBefore' => '

Selects edge deployment plans that were last updated before this time.

', 'ListEdgePackagingJobsRequest$CreationTimeAfter' => '

Select jobs where the job was created after specified time.

', 'ListEdgePackagingJobsRequest$CreationTimeBefore' => '

Select jobs where the job was created before specified time.

', 'ListEdgePackagingJobsRequest$LastModifiedTimeAfter' => '

Select jobs where the job was updated after specified time.

', 'ListEdgePackagingJobsRequest$LastModifiedTimeBefore' => '

Select jobs where the job was updated before specified time.

', 'ListEndpointConfigsInput$CreationTimeBefore' => '

A filter that returns only endpoint configurations created before the specified time (timestamp).

', 'ListEndpointConfigsInput$CreationTimeAfter' => '

A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).

', 'ListEndpointsInput$CreationTimeBefore' => '

A filter that returns only endpoints that were created before the specified time (timestamp).

', 'ListEndpointsInput$CreationTimeAfter' => '

A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

', 'ListEndpointsInput$LastModifiedTimeBefore' => '

A filter that returns only endpoints that were modified before the specified timestamp.

', 'ListEndpointsInput$LastModifiedTimeAfter' => '

A filter that returns only endpoints that were modified after the specified timestamp.

', 'ListExperimentsRequest$CreatedAfter' => '

A filter that returns only experiments created after the specified time.

', 'ListExperimentsRequest$CreatedBefore' => '

A filter that returns only experiments created before the specified time.

', 'ListFlowDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

', 'ListFlowDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only flow definitions that were created before the specified timestamp.

', 'ListHubContentVersionsRequest$CreationTimeBefore' => '

Only list hub content versions that were created before the time specified.

', 'ListHubContentVersionsRequest$CreationTimeAfter' => '

Only list hub content versions that were created after the time specified.

', 'ListHubContentsRequest$CreationTimeBefore' => '

Only list hub content that was created before the time specified.

', 'ListHubContentsRequest$CreationTimeAfter' => '

Only list hub content that was created after the time specified.

', 'ListHubsRequest$CreationTimeBefore' => '

Only list hubs that were created before the time specified.

', 'ListHubsRequest$CreationTimeAfter' => '

Only list hubs that were created after the time specified.

', 'ListHubsRequest$LastModifiedTimeBefore' => '

Only list hubs that were last modified before the time specified.

', 'ListHubsRequest$LastModifiedTimeAfter' => '

Only list hubs that were last modified after the time specified.

', 'ListHumanTaskUisRequest$CreationTimeAfter' => '

A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

', 'ListHumanTaskUisRequest$CreationTimeBefore' => '

A filter that returns only human task user interfaces that were created before the specified timestamp.

', 'ListHyperParameterTuningJobsRequest$CreationTimeAfter' => '

A filter that returns only tuning jobs that were created after the specified time.

', 'ListHyperParameterTuningJobsRequest$CreationTimeBefore' => '

A filter that returns only tuning jobs that were created before the specified time.

', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only tuning jobs that were modified after the specified time.

', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only tuning jobs that were modified before the specified time.

', 'ListImageVersionsRequest$CreationTimeAfter' => '

A filter that returns only versions created on or after the specified time.

', 'ListImageVersionsRequest$CreationTimeBefore' => '

A filter that returns only versions created on or before the specified time.

', 'ListImageVersionsRequest$LastModifiedTimeAfter' => '

A filter that returns only versions modified on or after the specified time.

', 'ListImageVersionsRequest$LastModifiedTimeBefore' => '

A filter that returns only versions modified on or before the specified time.

', 'ListImagesRequest$CreationTimeAfter' => '

A filter that returns only images created on or after the specified time.

', 'ListImagesRequest$CreationTimeBefore' => '

A filter that returns only images created on or before the specified time.

', 'ListImagesRequest$LastModifiedTimeAfter' => '

A filter that returns only images modified on or after the specified time.

', 'ListImagesRequest$LastModifiedTimeBefore' => '

A filter that returns only images modified on or before the specified time.

', 'ListInferenceComponentsInput$CreationTimeBefore' => '

Filters the results to only those inference components that were created before the specified time.

', 'ListInferenceComponentsInput$CreationTimeAfter' => '

Filters the results to only those inference components that were created after the specified time.

', 'ListInferenceComponentsInput$LastModifiedTimeBefore' => '

Filters the results to only those inference components that were updated before the specified time.

', 'ListInferenceComponentsInput$LastModifiedTimeAfter' => '

Filters the results to only those inference components that were updated after the specified time.

', 'ListInferenceExperimentsRequest$CreationTimeAfter' => '

Selects inference experiments which were created after this timestamp.

', 'ListInferenceExperimentsRequest$CreationTimeBefore' => '

Selects inference experiments which were created before this timestamp.

', 'ListInferenceExperimentsRequest$LastModifiedTimeAfter' => '

Selects inference experiments which were last modified after this timestamp.

', 'ListInferenceExperimentsRequest$LastModifiedTimeBefore' => '

Selects inference experiments which were last modified before this timestamp.

', 'ListLabelingJobsForWorkteamRequest$CreationTimeAfter' => '

A filter that returns only labeling jobs created after the specified time (timestamp).

', 'ListLabelingJobsForWorkteamRequest$CreationTimeBefore' => '

A filter that returns only labeling jobs created before the specified time (timestamp).

', 'ListLabelingJobsRequest$CreationTimeAfter' => '

A filter that returns only labeling jobs created after the specified time (timestamp).

', 'ListLabelingJobsRequest$CreationTimeBefore' => '

A filter that returns only labeling jobs created before the specified time (timestamp).

', 'ListLabelingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only labeling jobs modified after the specified time (timestamp).

', 'ListLabelingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only labeling jobs modified before the specified time (timestamp).

', 'ListLineageGroupsRequest$CreatedAfter' => '

A timestamp to filter against lineage groups created after a certain point in time.

', 'ListLineageGroupsRequest$CreatedBefore' => '

A timestamp to filter against lineage groups created before a certain point in time.

', 'ListModelBiasJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model bias jobs created before a specified time.

', 'ListModelBiasJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model bias jobs created after a specified time.

', 'ListModelCardExportJobsRequest$CreationTimeAfter' => '

Only list model card export jobs that were created after the time specified.

', 'ListModelCardExportJobsRequest$CreationTimeBefore' => '

Only list model card export jobs that were created before the time specified.

', 'ListModelCardVersionsRequest$CreationTimeAfter' => '

Only list model card versions that were created after the time specified.

', 'ListModelCardVersionsRequest$CreationTimeBefore' => '

Only list model card versions that were created before the time specified.

', 'ListModelCardsRequest$CreationTimeAfter' => '

Only list model cards that were created after the time specified.

', 'ListModelCardsRequest$CreationTimeBefore' => '

Only list model cards that were created before the time specified.

', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model explainability jobs created before a specified time.

', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model explainability jobs created after a specified time.

', 'ListModelQualityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model quality monitoring job definitions created before the specified time.

', 'ListModelQualityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model quality monitoring job definitions created after the specified time.

', 'ListModelsInput$CreationTimeBefore' => '

A filter that returns only models created before the specified time (timestamp).

', 'ListModelsInput$CreationTimeAfter' => '

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

', 'ListMonitoringAlertHistoryRequest$CreationTimeBefore' => '

A filter that returns only alerts created on or before the specified time.

', 'ListMonitoringAlertHistoryRequest$CreationTimeAfter' => '

A filter that returns only alerts created on or after the specified time.

', 'ListMonitoringExecutionsRequest$ScheduledTimeBefore' => '

Filter for jobs scheduled before a specified time.

', 'ListMonitoringExecutionsRequest$ScheduledTimeAfter' => '

Filter for jobs scheduled after a specified time.

', 'ListMonitoringExecutionsRequest$CreationTimeBefore' => '

A filter that returns only jobs created before a specified time.

', 'ListMonitoringExecutionsRequest$CreationTimeAfter' => '

A filter that returns only jobs created after a specified time.

', 'ListMonitoringExecutionsRequest$LastModifiedTimeBefore' => '

A filter that returns only jobs modified after a specified time.

', 'ListMonitoringExecutionsRequest$LastModifiedTimeAfter' => '

A filter that returns only jobs modified before a specified time.

', 'ListMonitoringSchedulesRequest$CreationTimeBefore' => '

A filter that returns only monitoring schedules created before a specified time.

', 'ListMonitoringSchedulesRequest$CreationTimeAfter' => '

A filter that returns only monitoring schedules created after a specified time.

', 'ListMonitoringSchedulesRequest$LastModifiedTimeBefore' => '

A filter that returns only monitoring schedules modified before a specified time.

', 'ListMonitoringSchedulesRequest$LastModifiedTimeAfter' => '

A filter that returns only monitoring schedules modified after a specified time.

', 'ListPipelineExecutionsRequest$CreatedAfter' => '

A filter that returns the pipeline executions that were created after a specified time.

', 'ListPipelineExecutionsRequest$CreatedBefore' => '

A filter that returns the pipeline executions that were created before a specified time.

', 'ListPipelinesRequest$CreatedAfter' => '

A filter that returns the pipelines that were created after a specified time.

', 'ListPipelinesRequest$CreatedBefore' => '

A filter that returns the pipelines that were created before a specified time.

', 'ListProcessingJobsRequest$CreationTimeAfter' => '

A filter that returns only processing jobs created after the specified time.

', 'ListProcessingJobsRequest$CreationTimeBefore' => '

A filter that returns only processing jobs created after the specified time.

', 'ListProcessingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only processing jobs modified after the specified time.

', 'ListProcessingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only processing jobs modified before the specified time.

', 'ListProjectsInput$CreationTimeAfter' => '

A filter that returns the projects that were created after a specified time.

', 'ListProjectsInput$CreationTimeBefore' => '

A filter that returns the projects that were created before a specified time.

', 'ListResourceCatalogsRequest$CreationTimeAfter' => '

Use this parameter to search for ResourceCatalogs created after a specific date and time.

', 'ListResourceCatalogsRequest$CreationTimeBefore' => '

Use this parameter to search for ResourceCatalogs created before a specific date and time.

', 'ListStudioLifecycleConfigsRequest$CreationTimeBefore' => '

A filter that returns only Lifecycle Configurations created on or before the specified time.

', 'ListStudioLifecycleConfigsRequest$CreationTimeAfter' => '

A filter that returns only Lifecycle Configurations created on or after the specified time.

', 'ListStudioLifecycleConfigsRequest$ModifiedTimeBefore' => '

A filter that returns only Lifecycle Configurations modified before the specified time.

', 'ListStudioLifecycleConfigsRequest$ModifiedTimeAfter' => '

A filter that returns only Lifecycle Configurations modified after the specified time.

', 'ListTrainingJobsRequest$CreationTimeAfter' => '

A filter that returns only training jobs created after the specified time (timestamp).

', 'ListTrainingJobsRequest$CreationTimeBefore' => '

A filter that returns only training jobs created before the specified time (timestamp).

', 'ListTrainingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only training jobs modified after the specified time (timestamp).

', 'ListTrainingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only training jobs modified before the specified time (timestamp).

', 'ListTransformJobsRequest$CreationTimeAfter' => '

A filter that returns only transform jobs created after the specified time.

', 'ListTransformJobsRequest$CreationTimeBefore' => '

A filter that returns only transform jobs created before the specified time.

', 'ListTransformJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only transform jobs modified after the specified time.

', 'ListTransformJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only transform jobs modified before the specified time.

', 'ListTrialComponentsRequest$CreatedAfter' => '

A filter that returns only components created after the specified time.

', 'ListTrialComponentsRequest$CreatedBefore' => '

A filter that returns only components created before the specified time.

', 'ListTrialsRequest$CreatedAfter' => '

A filter that returns only trials created after the specified time.

', 'ListTrialsRequest$CreatedBefore' => '

A filter that returns only trials created before the specified time.

', 'MetricData$Timestamp' => '

The date and time that the algorithm emitted the metric.

', 'Model$CreationTime' => '

A timestamp that indicates when the model was created.

', 'ModelCard$CreationTime' => '

The date and time that the model card was created.

', 'ModelCard$LastModifiedTime' => '

The date and time that the model card was last modified.

', 'ModelCardExportJobSummary$CreatedAt' => '

The date and time that the model card export job was created.

', 'ModelCardExportJobSummary$LastModifiedAt' => '

The date and time that the model card export job was last modified..

', 'ModelCardSummary$CreationTime' => '

The date and time that the model card was created.

', 'ModelCardSummary$LastModifiedTime' => '

The date and time that the model card was last modified.

', 'ModelCardVersionSummary$CreationTime' => '

The date and time that the model card version was created.

', 'ModelCardVersionSummary$LastModifiedTime' => '

The time date and time that the model card version was last modified.

', 'ModelDashboardEndpoint$CreationTime' => '

A timestamp that indicates when the endpoint was created.

', 'ModelDashboardEndpoint$LastModifiedTime' => '

The last time the endpoint was modified.

', 'ModelDashboardModelCard$CreationTime' => '

A timestamp that indicates when the model card was created.

', 'ModelDashboardModelCard$LastModifiedTime' => '

A timestamp that indicates when the model card was last updated.

', 'ModelDashboardMonitoringSchedule$CreationTime' => '

A timestamp that indicates when the monitoring schedule was created.

', 'ModelDashboardMonitoringSchedule$LastModifiedTime' => '

A timestamp that indicates when the monitoring schedule was last updated.

', 'ModelPackage$LastModifiedTime' => '

The last time the model package was modified.

', 'ModelSummary$CreationTime' => '

A timestamp that indicates when the model was created.

', 'MonitoringAlertHistorySummary$CreationTime' => '

A timestamp that indicates when the first alert transition occurred in an alert history. An alert transition can be from status InAlert to OK, or from OK to InAlert.

', 'MonitoringAlertSummary$CreationTime' => '

A timestamp that indicates when a monitor alert was created.

', 'MonitoringAlertSummary$LastModifiedTime' => '

A timestamp that indicates when a monitor alert was last updated.

', 'MonitoringExecutionSummary$ScheduledTime' => '

The time the monitoring job was scheduled.

', 'MonitoringExecutionSummary$CreationTime' => '

The time at which the monitoring job was created.

', 'MonitoringExecutionSummary$LastModifiedTime' => '

A timestamp that indicates the last time the monitoring job was modified.

', 'MonitoringJobDefinitionSummary$CreationTime' => '

The time that the monitoring job was created.

', 'MonitoringSchedule$CreationTime' => '

The time that the monitoring schedule was created.

', 'MonitoringSchedule$LastModifiedTime' => '

The last time the monitoring schedule was changed.

', 'MonitoringScheduleSummary$CreationTime' => '

The creation time of the monitoring schedule.

', 'MonitoringScheduleSummary$LastModifiedTime' => '

The last time the monitoring schedule was modified.

', 'PendingDeploymentSummary$StartTime' => '

The start time of the deployment.

', 'Pipeline$CreationTime' => '

The creation time of the pipeline.

', 'Pipeline$LastModifiedTime' => '

The time that the pipeline was last modified.

', 'Pipeline$LastRunTime' => '

The time when the pipeline was last run.

', 'PipelineExecution$CreationTime' => '

The creation time of the pipeline execution.

', 'PipelineExecution$LastModifiedTime' => '

The time that the pipeline execution was last modified.

', 'PipelineExecutionStep$StartTime' => '

The time that the step started executing.

', 'PipelineExecutionStep$EndTime' => '

The time that the step stopped executing.

', 'PipelineExecutionSummary$StartTime' => '

The start time of the pipeline execution.

', 'PipelineSummary$CreationTime' => '

The creation time of the pipeline.

', 'PipelineSummary$LastModifiedTime' => '

The time that the pipeline was last modified.

', 'PipelineSummary$LastExecutionTime' => '

The last time that a pipeline execution began.

', 'ProcessingJob$ProcessingEndTime' => '

The time that the processing job ended.

', 'ProcessingJob$ProcessingStartTime' => '

The time that the processing job started.

', 'ProcessingJob$LastModifiedTime' => '

The time the processing job was last modified.

', 'ProcessingJob$CreationTime' => '

The time the processing job was created.

', 'ProcessingJobSummary$CreationTime' => '

The time at which the processing job was created.

', 'ProcessingJobSummary$ProcessingEndTime' => '

The time at which the processing job completed.

', 'ProcessingJobSummary$LastModifiedTime' => '

A timestamp that indicates the last time the processing job was modified.

', 'ProductionVariantStatus$StartTime' => '

The start time of the current status change.

', 'ProfilerRuleEvaluationStatus$LastModifiedTime' => '

Timestamp when the rule evaluation status was last modified.

', 'Project$CreationTime' => '

A timestamp specifying when the project was created.

', 'Project$LastModifiedTime' => '

A timestamp container for when the project was last modified.

', 'ProjectSummary$CreationTime' => '

The time that the project was created.

', 'QueryFilters$CreatedBefore' => '

Filter the lineage entities connected to the StartArn(s) by created date.

', 'QueryFilters$CreatedAfter' => '

Filter the lineage entities connected to the StartArn(s) after the create date.

', 'QueryFilters$ModifiedBefore' => '

Filter the lineage entities connected to the StartArn(s) before the last modified date.

', 'QueryFilters$ModifiedAfter' => '

Filter the lineage entities connected to the StartArn(s) after the last modified date.

', 'ResourceCatalog$CreationTime' => '

The time the ResourceCatalog was created.

', 'SecondaryStatusTransition$StartTime' => '

A timestamp that shows when the training job transitioned to the current secondary status state.

', 'SecondaryStatusTransition$EndTime' => '

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

', 'StudioLifecycleConfigDetails$CreationTime' => '

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

', 'StudioLifecycleConfigDetails$LastModifiedTime' => '

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

', 'TrainingJob$CreationTime' => '

A timestamp that indicates when the training job was created.

', 'TrainingJob$TrainingStartTime' => '

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

', 'TrainingJob$TrainingEndTime' => '

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'TrainingJob$LastModifiedTime' => '

A timestamp that indicates when the status of the training job was last modified.

', 'TrainingJobSummary$CreationTime' => '

A timestamp that shows when the training job was created.

', 'TrainingJobSummary$TrainingEndTime' => '

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

', 'TrainingJobSummary$LastModifiedTime' => '

Timestamp when the training job was last modified.

', 'TransformJob$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'TransformJob$TransformStartTime' => '

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

', 'TransformJob$TransformEndTime' => '

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

', 'TransformJobSummary$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'TransformJobSummary$TransformEndTime' => '

Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

', 'TransformJobSummary$LastModifiedTime' => '

Indicates when the transform job was last modified.

', 'Trial$CreationTime' => '

When the trial was created.

', 'Trial$LastModifiedTime' => '

Who last modified the trial.

', 'TrialComponent$StartTime' => '

When the component started.

', 'TrialComponent$EndTime' => '

When the component ended.

', 'TrialComponent$CreationTime' => '

When the component was created.

', 'TrialComponent$LastModifiedTime' => '

When the component was last modified.

', 'TrialComponentMetricSummary$TimeStamp' => '

When the metric was last updated.

', 'TrialComponentSimpleSummary$CreationTime' => '

When the component was created.

', 'TrialComponentSummary$StartTime' => '

When the component started.

', 'TrialComponentSummary$EndTime' => '

When the component ended.

', 'TrialComponentSummary$CreationTime' => '

When the component was created.

', 'TrialComponentSummary$LastModifiedTime' => '

When the component was last modified.

', 'TrialSummary$CreationTime' => '

When the trial was created.

', 'TrialSummary$LastModifiedTime' => '

When the trial was last modified.

', 'UpdateTrialComponentRequest$StartTime' => '

When the component started.

', 'UpdateTrialComponentRequest$EndTime' => '

When the component ended.

', 'Workforce$LastUpdatedDate' => '

The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce\'s allow list.

', 'Workforce$CreateDate' => '

The date that the workforce is created.

', 'Workteam$CreateDate' => '

The date and time that the work team was created (timestamp).

', 'Workteam$LastUpdatedDate' => '

The date and time that the work team was last updated (timestamp).

', ], ], 'TimestampAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$TimestampAttributeName' => '

The name of the column indicating a point in time at which the target value of a given item is recorded.

', ], ], 'TrafficDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'Phase$DurationInSeconds' => '

Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600. This value should not exceed JobDurationInSeconds.

', 'Stairs$DurationInSeconds' => '

Defines how long each traffic step should be.

', ], ], 'TrafficPattern' => [ 'base' => '

Defines the traffic pattern of the load test.

', 'refs' => [ 'RecommendationJobInputConfig$TrafficPattern' => '

Specifies the traffic pattern of the job.

', ], ], 'TrafficRoutingConfig' => [ 'base' => '

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

', 'refs' => [ 'BlueGreenUpdatePolicy$TrafficRoutingConfiguration' => '

Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.

', ], ], 'TrafficRoutingConfigType' => [ 'base' => NULL, 'refs' => [ 'TrafficRoutingConfig$Type' => '

Traffic routing strategy type.

  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

', ], ], 'TrafficType' => [ 'base' => NULL, 'refs' => [ 'TrafficPattern$TrafficType' => '

Defines the traffic patterns. Choose either PHASES or STAIRS.

', ], ], 'TrainingContainerArgument' => [ 'base' => NULL, 'refs' => [ 'TrainingContainerArguments$member' => NULL, ], ], 'TrainingContainerArguments' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$ContainerArguments' => '

The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.

', ], ], 'TrainingContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$ContainerEntrypoint' => '

The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.

', ], ], 'TrainingContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'TrainingContainerEntrypoint$member' => NULL, ], ], 'TrainingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$key' => NULL, ], ], 'TrainingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$Environment' => '

The environment variables to set in the Docker container.

', 'DescribeTrainingJobResponse$Environment' => '

The environment variables to set in the Docker container.

', 'TrainingJob$Environment' => '

The environment variables to set in the Docker container.

', ], ], 'TrainingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$value' => NULL, ], ], 'TrainingImageConfig' => [ 'base' => '

The configuration to use an image from a private Docker registry for a training job.

', 'refs' => [ 'AlgorithmSpecification$TrainingImageConfig' => '

The configuration to use an image from a private Docker registry for a training job.

', ], ], 'TrainingInputMode' => [ 'base' => '

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won\'t be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren\'t supported. The startup time is lower when there are fewer files in the S3 bucket provided.

', 'refs' => [ 'AlgorithmSpecification$TrainingInputMode' => NULL, 'Channel$InputMode' => '

(Optional) The input mode to use for the data channel in a training job. If you don\'t set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job\'s general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

', 'HyperParameterAlgorithmSpecification$TrainingInputMode' => NULL, 'InputModes$member' => NULL, 'TrainingJobDefinition$TrainingInputMode' => NULL, ], ], 'TrainingInstanceCount' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$InstanceCount' => '

The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.

', 'HyperParameterTuningResourceConfig$InstanceCount' => '

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

', 'InstanceGroup$InstanceCount' => '

Specifies the number of instances of the instance group.

', 'ResourceConfig$InstanceCount' => '

The number of ML compute instances to use. For distributed training, provide a value greater than 1.

', ], ], 'TrainingInstanceType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$InstanceType' => '

The instance type used for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

', 'HyperParameterTuningResourceConfig$InstanceType' => '

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

', 'InstanceGroup$InstanceType' => '

Specifies the instance type of the instance group.

', 'ResourceConfig$InstanceType' => '

The ML compute instance type.

SageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting December 9th, 2022.

Amazon EC2 P4de instances (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance HBM2e GPU memory, which accelerate the speed of training ML models that need to be trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker supports ML training jobs on P4de instances (ml.p4de.24xlarge) to reduce model training time. The ml.p4de.24xlarge instances are available in the following Amazon Web Services Regions.

  • US East (N. Virginia) (us-east-1)

  • US West (Oregon) (us-west-2)

To request quota limit increase and start using P4de instances, contact the SageMaker Training service team through your account team.

', 'TrainingInstanceTypes$member' => NULL, ], ], 'TrainingInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedTrainingInstanceTypes' => '

A list of the instance types that this algorithm can use for training.

', ], ], 'TrainingJob' => [ 'base' => '

Contains information about a training job.

', 'refs' => [ 'SearchRecord$TrainingJob' => '

The properties of a training job.

', 'TrialComponentSourceDetail$TrainingJob' => '

Information about a training job that\'s the source of a trial component.

', ], ], 'TrainingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'DescribeProcessingJobResponse$TrainingJobArn' => '

The ARN of a training job associated with this processing job.

', 'DescribeTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'HyperParameterTrainingJobSummary$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'ProcessingJob$TrainingJobArn' => '

The ARN of the training job associated with this processing job.

', 'TrainingJob$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'TrainingJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

', 'TrainingJobSummary$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'UpdateTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', ], ], 'TrainingJobDefinition' => [ 'base' => '

Defines the input needed to run a training job using the algorithm.

', 'refs' => [ 'AlgorithmValidationProfile$TrainingJobDefinition' => '

The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.

', ], ], 'TrainingJobEarlyStoppingType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobConfig$TrainingJobEarlyStoppingType' => '

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

', ], ], 'TrainingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$TrainingJobName' => '

The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeTrainingJobRequest$TrainingJobName' => '

The name of the training job.

', 'DescribeTrainingJobResponse$TrainingJobName' => '

Name of the model training job.

', 'HyperParameterTrainingJobSummary$TrainingJobName' => '

The name of the training job.

', 'StopTrainingJobRequest$TrainingJobName' => '

The name of the training job to stop.

', 'TrainingJob$TrainingJobName' => '

The name of the training job.

', 'TrainingJobSummary$TrainingJobName' => '

The name of the training job that you want a summary for.

', 'UpdateTrainingJobRequest$TrainingJobName' => '

The name of a training job to update the Debugger profiling configuration.

', 'WarmPoolStatus$ReusedByJob' => '

The name of the matching training job that reused the warm pool.

', ], ], 'TrainingJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsForHyperParameterTuningJobRequest$SortBy' => '

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

', ], ], 'TrainingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$TrainingJobStatus' => '

The status of the training job.

SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

', 'HyperParameterTrainingJobSummary$TrainingJobStatus' => '

The status of the training job.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$StatusEquals' => '

A filter that returns only training jobs with the specified status.

', 'ListTrainingJobsRequest$StatusEquals' => '

A filter that retrieves only training jobs with a specific status.

', 'TrainingJob$TrainingJobStatus' => '

The status of the training job.

Training job statuses are:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

', 'TrainingJobSummary$TrainingJobStatus' => '

The status of the training job.

', ], ], 'TrainingJobStatusCounter' => [ 'base' => NULL, 'refs' => [ 'TrainingJobStatusCounters$Completed' => '

The number of completed training jobs launched by the hyperparameter tuning job.

', 'TrainingJobStatusCounters$InProgress' => '

The number of in-progress training jobs launched by a hyperparameter tuning job.

', 'TrainingJobStatusCounters$RetryableError' => '

The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

', 'TrainingJobStatusCounters$NonRetryableError' => '

The number of training jobs that failed and can\'t be retried. A failed training job can\'t be retried if it failed because a client error occurred.

', 'TrainingJobStatusCounters$Stopped' => '

The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

', ], ], 'TrainingJobStatusCounters' => [ 'base' => '

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TrainingJobStatusCounters' => '

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

', 'HyperParameterTuningJobSearchEntity$TrainingJobStatusCounters' => NULL, 'HyperParameterTuningJobSummary$TrainingJobStatusCounters' => '

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

', ], ], 'TrainingJobStepMetadata' => [ 'base' => '

Metadata for a training job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TrainingJob' => '

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

', ], ], 'TrainingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsResponse$TrainingJobSummaries' => '

An array of TrainingJobSummary objects, each listing a training job.

', ], ], 'TrainingJobSummary' => [ 'base' => '

Provides summary information about a training job.

', 'refs' => [ 'TrainingJobSummaries$member' => NULL, ], ], 'TrainingRepositoryAccessMode' => [ 'base' => NULL, 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAccessMode' => '

The method that your training job will use to gain access to the images in your private Docker registry. For access to an image in a private Docker registry, set to Vpc.

', ], ], 'TrainingRepositoryAuthConfig' => [ 'base' => '

An object containing authentication information for a private Docker registry.

', 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAuthConfig' => '

An object containing authentication information for a private Docker registry containing your training images.

', ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'base' => NULL, 'refs' => [ 'TrainingRepositoryAuthConfig$TrainingRepositoryCredentialsProviderArn' => '

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access credentials to your private Docker registry.

', ], ], 'TrainingSpecification' => [ 'base' => '

Defines how the algorithm is used for a training job.

', 'refs' => [ 'CreateAlgorithmInput$TrainingSpecification' => '

Specifies details about training jobs run by this algorithm, including the following:

  • The Amazon ECR path of the container and the version digest of the algorithm.

  • The hyperparameters that the algorithm supports.

  • The instance types that the algorithm supports for training.

  • Whether the algorithm supports distributed training.

  • The metrics that the algorithm emits to Amazon CloudWatch.

  • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

  • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

', 'DescribeAlgorithmOutput$TrainingSpecification' => '

Details about training jobs run by this algorithm.

', ], ], 'TrainingTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$TrainingTimeInSeconds' => '

The training time in seconds.

', 'TrainingJob$TrainingTimeInSeconds' => '

The training time in seconds.

', ], ], 'TransformDataSource' => [ 'base' => '

Describes the location of the channel data.

', 'refs' => [ 'TransformInput$DataSource' => '

Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

', ], ], 'TransformEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$key' => NULL, ], ], 'TransformEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'DescribeTransformJobResponse$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'TransformJob$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'TransformJobDefinition$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', ], ], 'TransformEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$value' => NULL, ], ], 'TransformInput' => [ 'base' => '

Describes the input source of a transform job and the way the transform job consumes it.

', 'refs' => [ 'CreateTransformJobRequest$TransformInput' => '

Describes the input source and the way the transform job consumes it.

', 'DescribeTransformJobResponse$TransformInput' => '

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

', 'TransformJob$TransformInput' => NULL, 'TransformJobDefinition$TransformInput' => '

A description of the input source and the way the transform job consumes it.

', ], ], 'TransformInstanceCount' => [ 'base' => NULL, 'refs' => [ 'TransformResources$InstanceCount' => '

The number of ML compute instances to use in the transform job. The default value is 1, and the maximum is 100. For distributed transform jobs, specify a value greater than 1.

', ], ], 'TransformInstanceType' => [ 'base' => NULL, 'refs' => [ 'TransformInstanceTypes$member' => NULL, 'TransformResources$InstanceType' => '

The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.

', ], ], 'TransformInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedTransformInstanceTypes' => '

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

', 'InferenceSpecification$SupportedTransformInstanceTypes' => '

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

', ], ], 'TransformJob' => [ 'base' => '

A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.

', 'refs' => [ 'ModelDashboardModel$LastBatchTransformJob' => NULL, 'TrialComponentSourceDetail$TransformJob' => '

Information about a transform job that\'s the source of a trial component.

', ], ], 'TransformJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobResponse$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'DescribeTransformJobResponse$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'TransformJob$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'TransformJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

', 'TransformJobSummary$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', ], ], 'TransformJobDefinition' => [ 'base' => '

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

', 'refs' => [ 'AlgorithmValidationProfile$TransformJobDefinition' => '

The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.

', 'ModelPackageValidationProfile$TransformJobDefinition' => '

The TransformJobDefinition object that describes the transform job used for the validation of the model package.

', ], ], 'TransformJobName' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$TransformJobName' => '

The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeTransformJobRequest$TransformJobName' => '

The name of the transform job that you want to view details of.

', 'DescribeTransformJobResponse$TransformJobName' => '

The name of the transform job.

', 'StopTransformJobRequest$TransformJobName' => '

The name of the batch transform job to stop.

', 'TransformJob$TransformJobName' => '

The name of the transform job.

', 'TransformJobSummary$TransformJobName' => '

The name of the transform job.

', ], ], 'TransformJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTransformJobResponse$TransformJobStatus' => '

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

', 'ListTransformJobsRequest$StatusEquals' => '

A filter that retrieves only transform jobs with a specific status.

', 'TransformJob$TransformJobStatus' => '

The status of the transform job.

Transform job statuses are:

  • InProgress - The job is in progress.

  • Completed - The job has completed.

  • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.

  • Stopping - The transform job is stopping.

  • Stopped - The transform job has stopped.

', 'TransformJobSummary$TransformJobStatus' => '

The status of the transform job.

', ], ], 'TransformJobStepMetadata' => [ 'base' => '

Metadata for a transform job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TransformJob' => '

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

', ], ], 'TransformJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTransformJobsResponse$TransformJobSummaries' => '

An array of TransformJobSummary objects.

', ], ], 'TransformJobSummary' => [ 'base' => '

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

', 'refs' => [ 'TransformJobSummaries$member' => NULL, ], ], 'TransformOutput' => [ 'base' => '

Describes the results of a transform job.

', 'refs' => [ 'CreateTransformJobRequest$TransformOutput' => '

Describes the results of the transform job.

', 'DescribeTransformJobResponse$TransformOutput' => '

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

', 'TransformJob$TransformOutput' => NULL, 'TransformJobDefinition$TransformOutput' => '

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

', ], ], 'TransformResources' => [ 'base' => '

Describes the resources, including ML instance types and ML instance count, to use for transform job.

', 'refs' => [ 'CreateTransformJobRequest$TransformResources' => '

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

', 'DescribeTransformJobResponse$TransformResources' => '

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

', 'TransformJob$TransformResources' => NULL, 'TransformJobDefinition$TransformResources' => '

Identifies the ML compute instances for the transform job.

', ], ], 'TransformS3DataSource' => [ 'base' => '

Describes the S3 data source.

', 'refs' => [ 'TransformDataSource$S3DataSource' => '

The S3 location of the data source that is associated with a channel.

', ], ], 'TransformationAttributeName' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$key' => NULL, 'FillingTransformations$key' => NULL, ], ], 'Trial' => [ 'base' => '

The properties of a trial as returned by the Search API.

', 'refs' => [ 'SearchRecord$Trial' => '

The properties of a trial.

', ], ], 'TrialArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'CreateTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'DeleteTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial that is being deleted.

', 'DescribeTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'DisassociateTrialComponentResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'Trial$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'TrialSummary$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'UpdateTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', ], ], 'TrialComponent' => [ 'base' => '

The properties of a trial component as returned by the Search API.

', 'refs' => [ 'SearchRecord$TrialComponent' => '

The properties of a trial component.

', ], ], 'TrialComponentArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'CreateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'DeleteTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the component is being deleted.

', 'DescribeTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'DisassociateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponent$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponentSimpleSummary$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponentSummary$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'UpdateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', ], ], 'TrialComponentArtifact' => [ 'base' => '

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

', 'refs' => [ 'TrialComponentArtifacts$value' => NULL, ], ], 'TrialComponentArtifactValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifact$Value' => '

The location of the artifact.

', ], ], 'TrialComponentArtifacts' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$InputArtifacts' => '

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

', 'CreateTrialComponentRequest$OutputArtifacts' => '

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

', 'DescribeTrialComponentResponse$InputArtifacts' => '

The input artifacts of the component.

', 'DescribeTrialComponentResponse$OutputArtifacts' => '

The output artifacts of the component.

', 'TrialComponent$InputArtifacts' => '

The input artifacts of the component.

', 'TrialComponent$OutputArtifacts' => '

The output artifacts of the component.

', 'UpdateTrialComponentRequest$InputArtifacts' => '

Replaces all of the component\'s input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

', 'UpdateTrialComponentRequest$OutputArtifacts' => '

Replaces all of the component\'s output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

', ], ], 'TrialComponentKey128' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifacts$key' => NULL, ], ], 'TrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentKey256$member' => NULL, ], ], 'TrialComponentKey320' => [ 'base' => NULL, 'refs' => [ 'TrialComponentParameters$key' => NULL, ], ], 'TrialComponentMetricSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Metrics' => '

The metrics for the component.

', 'TrialComponent$Metrics' => '

The metrics for the component.

', ], ], 'TrialComponentMetricSummary' => [ 'base' => '

A summary of the metrics of a trial component.

', 'refs' => [ 'TrialComponentMetricSummaries$member' => NULL, ], ], 'TrialComponentParameterValue' => [ 'base' => '

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

This object is specified in the CreateTrialComponent request.

', 'refs' => [ 'TrialComponentParameters$value' => NULL, ], ], 'TrialComponentParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$Parameters' => '

The hyperparameters for the component.

', 'DescribeTrialComponentResponse$Parameters' => '

The hyperparameters of the component.

', 'TrialComponent$Parameters' => '

The hyperparameters of the component.

', 'UpdateTrialComponentRequest$Parameters' => '

Replaces all of the component\'s hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

', ], ], 'TrialComponentPrimaryStatus' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$PrimaryStatus' => '

The status of the trial component.

', ], ], 'TrialComponentSimpleSummaries' => [ 'base' => NULL, 'refs' => [ 'Trial$TrialComponentSummaries' => '

A list of the components associated with the trial. For each component, a summary of the component\'s properties is included.

', ], ], 'TrialComponentSimpleSummary' => [ 'base' => '

A short summary of a trial component.

', 'refs' => [ 'TrialComponentSimpleSummaries$member' => NULL, ], ], 'TrialComponentSource' => [ 'base' => '

The Amazon Resource Name (ARN) and job type of the source of a trial component.

', 'refs' => [ 'DescribeTrialComponentResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

', 'TrialComponent$Source' => '

The Amazon Resource Name (ARN) and job type of the source of the component.

', 'TrialComponentSimpleSummary$TrialComponentSource' => NULL, 'TrialComponentSources$member' => NULL, 'TrialComponentSummary$TrialComponentSource' => NULL, ], ], 'TrialComponentSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', 'TrialComponentSource$SourceArn' => '

The source Amazon Resource Name (ARN).

', 'TrialComponentSourceDetail$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'TrialComponentSourceDetail' => [ 'base' => '

Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.

', 'refs' => [ 'TrialComponent$SourceDetail' => '

Details of the source of the component.

', ], ], 'TrialComponentSources' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Sources' => '

A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

', ], ], 'TrialComponentStatus' => [ 'base' => '

The status of the trial component.

', 'refs' => [ 'CreateTrialComponentRequest$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'DescribeTrialComponentResponse$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'TrialComponent$Status' => NULL, 'TrialComponentSummary$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'UpdateTrialComponentRequest$Status' => '

The new status of the component.

', ], ], 'TrialComponentStatusMessage' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$Message' => '

If the component failed, a message describing why.

', ], ], 'TrialComponentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentsResponse$TrialComponentSummaries' => '

A list of the summaries of your trial components.

', ], ], 'TrialComponentSummary' => [ 'base' => '

A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.

', 'refs' => [ 'TrialComponentSummaries$member' => NULL, ], ], 'TrialSource' => [ 'base' => '

The source of the trial.

', 'refs' => [ 'DescribeTrialResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

', 'Trial$Source' => NULL, 'TrialSummary$TrialSource' => NULL, ], ], 'TrialSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialSource$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'TrialSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialsResponse$TrialSummaries' => '

A list of the summaries of your trials.

', ], ], 'TrialSummary' => [ 'base' => '

A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.

', 'refs' => [ 'TrialSummaries$member' => NULL, ], ], 'TtlDuration' => [ 'base' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', 'refs' => [ 'OnlineStoreConfig$TtlDuration' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', 'OnlineStoreConfigUpdate$TtlDuration' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', ], ], 'TtlDurationUnit' => [ 'base' => NULL, 'refs' => [ 'TtlDuration$Unit' => '

TtlDuration time unit.

', ], ], 'TtlDurationValue' => [ 'base' => NULL, 'refs' => [ 'TtlDuration$Value' => '

TtlDuration time value.

', ], ], 'TuningJobCompletionCriteria' => [ 'base' => '

The job completion criteria.

', 'refs' => [ 'HyperParameterTuningJobConfig$TuningJobCompletionCriteria' => '

The tuning job\'s completion criteria.

', ], ], 'TuningJobStepMetaData' => [ 'base' => '

Metadata for a tuning step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TuningJob' => '

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

', ], ], 'USD' => [ 'base' => '

Represents an amount of money in United States dollars.

', 'refs' => [ 'PublicWorkforceTaskPrice$AmountInUsd' => '

Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

', ], ], 'UiConfig' => [ 'base' => '

Provided configuration information for the worker UI for a labeling job. Provide either HumanTaskUiArn or UiTemplateS3Uri.

For named entity recognition, 3D point cloud and video frame labeling jobs, use HumanTaskUiArn.

For all other Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to specify the location of a worker task template in Amazon S3.

', 'refs' => [ 'HumanTaskConfig$UiConfig' => '

Information about the user interface that workers use to complete the labeling task.

', ], ], 'UiTemplate' => [ 'base' => '

The Liquid template for the worker user interface.

', 'refs' => [ 'CreateHumanTaskUiRequest$UiTemplate' => NULL, 'RenderUiTemplateRequest$UiTemplate' => '

A Template object containing the worker UI template to render.

', ], ], 'UiTemplateInfo' => [ 'base' => '

Container for user interface template information.

', 'refs' => [ 'DescribeHumanTaskUiResponse$UiTemplate' => NULL, ], ], 'Uid' => [ 'base' => NULL, 'refs' => [ 'CustomPosixUserConfig$Uid' => '

The POSIX user ID.

', ], ], 'UpdateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentRuntimeConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentRuntimeConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$ModelDataUrl' => '

The location of the model artifacts. For more information, see ContainerDefinition.

', 'ClarifyShapBaselineConfig$ShapBaselineUri' => '

The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.

', 'ContainerDefinition$ModelDataUrl' => '

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

', 'InferenceComponentContainerSpecification$ArtifactUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'InferenceComponentContainerSpecificationSummary$ArtifactUrl' => '

The Amazon S3 path where the model artifacts are stored.

', 'ModelPackageContainerDefinition$ModelDataUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

', 'SourceAlgorithm$ModelDataUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the algorithm.

', ], ], 'UserContext' => [ 'base' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

', 'refs' => [ 'AssociationSummary$CreatedBy' => NULL, 'DescribeActionResponse$CreatedBy' => NULL, 'DescribeActionResponse$LastModifiedBy' => NULL, 'DescribeArtifactResponse$CreatedBy' => NULL, 'DescribeArtifactResponse$LastModifiedBy' => NULL, 'DescribeContextResponse$CreatedBy' => NULL, 'DescribeContextResponse$LastModifiedBy' => NULL, 'DescribeExperimentResponse$CreatedBy' => '

Who created the experiment.

', 'DescribeExperimentResponse$LastModifiedBy' => '

Who last modified the experiment.

', 'DescribeLineageGroupResponse$CreatedBy' => NULL, 'DescribeLineageGroupResponse$LastModifiedBy' => NULL, 'DescribeModelCardResponse$CreatedBy' => NULL, 'DescribeModelCardResponse$LastModifiedBy' => NULL, 'DescribeModelPackageGroupOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$LastModifiedBy' => NULL, 'DescribePipelineExecutionResponse$CreatedBy' => NULL, 'DescribePipelineExecutionResponse$LastModifiedBy' => NULL, 'DescribePipelineResponse$CreatedBy' => NULL, 'DescribePipelineResponse$LastModifiedBy' => NULL, 'DescribeProjectOutput$CreatedBy' => NULL, 'DescribeProjectOutput$LastModifiedBy' => NULL, 'DescribeTrialComponentResponse$CreatedBy' => '

Who created the trial component.

', 'DescribeTrialComponentResponse$LastModifiedBy' => '

Who last modified the component.

', 'DescribeTrialResponse$CreatedBy' => '

Who created the trial.

', 'DescribeTrialResponse$LastModifiedBy' => '

Who last modified the trial.

', 'Experiment$CreatedBy' => '

Who created the experiment.

', 'Experiment$LastModifiedBy' => NULL, 'ModelCard$CreatedBy' => NULL, 'ModelCard$LastModifiedBy' => NULL, 'ModelDashboardModelCard$CreatedBy' => NULL, 'ModelDashboardModelCard$LastModifiedBy' => NULL, 'ModelPackage$CreatedBy' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

', 'ModelPackage$LastModifiedBy' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

', 'ModelPackageGroup$CreatedBy' => NULL, 'Pipeline$CreatedBy' => NULL, 'Pipeline$LastModifiedBy' => NULL, 'PipelineExecution$CreatedBy' => NULL, 'PipelineExecution$LastModifiedBy' => NULL, 'Project$CreatedBy' => '

Who created the project.

', 'Project$LastModifiedBy' => NULL, 'Trial$CreatedBy' => '

Who created the trial.

', 'Trial$LastModifiedBy' => NULL, 'TrialComponent$CreatedBy' => '

Who created the trial component.

', 'TrialComponent$LastModifiedBy' => NULL, 'TrialComponentSimpleSummary$CreatedBy' => NULL, 'TrialComponentSummary$CreatedBy' => '

Who created the trial component.

', 'TrialComponentSummary$LastModifiedBy' => '

Who last modified the component.

', ], ], 'UserProfileArn' => [ 'base' => NULL, 'refs' => [ 'CreateUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', 'DescribeUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', 'UpdateUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', ], ], 'UserProfileDetails' => [ 'base' => '

The user profile details.

', 'refs' => [ 'UserProfileList$member' => NULL, ], ], 'UserProfileList' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesResponse$UserProfiles' => '

The list of user profiles.

', ], ], 'UserProfileName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$UserProfileName' => '

The user profile name.

', 'CreateAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'CreatePresignedDomainUrlRequest$UserProfileName' => '

The name of the UserProfile to sign-in as.

', 'CreateUserProfileRequest$UserProfileName' => '

A name for the UserProfile. This value is not case sensitive.

', 'DeleteAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'DeleteUserProfileRequest$UserProfileName' => '

The user profile name.

', 'DescribeAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'DescribeAppResponse$UserProfileName' => '

The user profile name.

', 'DescribeUserProfileRequest$UserProfileName' => '

The user profile name. This value is not case sensitive.

', 'DescribeUserProfileResponse$UserProfileName' => '

The user profile name.

', 'ListAppsRequest$UserProfileNameEquals' => '

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

', 'ListUserProfilesRequest$UserProfileNameContains' => '

A parameter by which to filter the results.

', 'OwnershipSettings$OwnerUserProfileName' => '

The user profile who is the owner of the private space.

', 'OwnershipSettingsSummary$OwnerUserProfileName' => '

The user profile who is the owner of the private space.

', 'UpdateUserProfileRequest$UserProfileName' => '

The user profile name.

', 'UserProfileDetails$UserProfileName' => '

The user profile name.

', ], ], 'UserProfileSortKey' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'UserProfileStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeUserProfileResponse$Status' => '

The status.

', 'UserProfileDetails$Status' => '

The status.

', ], ], 'UserSettings' => [ 'base' => '

A collection of settings that apply to users in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

', 'refs' => [ 'CreateDomainRequest$DefaultUserSettings' => '

The default settings to use to create a user profile when UserSettings isn\'t specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

', 'CreateUserProfileRequest$UserSettings' => '

A collection of settings.

', 'DescribeDomainResponse$DefaultUserSettings' => '

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

', 'DescribeUserProfileResponse$UserSettings' => '

A collection of settings.

', 'UpdateDomainRequest$DefaultUserSettings' => '

A collection of settings.

', 'UpdateUserProfileRequest$UserSettings' => '

A collection of settings.

', ], ], 'UsersPerStep' => [ 'base' => NULL, 'refs' => [ 'Stairs$UsersPerStep' => '

Specifies how many new users to spawn in each step.

', ], ], 'UtilizationMetric' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$CpuUtilization' => '

The expected CPU utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

', 'RecommendationMetrics$MemoryUtilization' => '

The expected memory utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

', ], ], 'UtilizationPercentagePerCore' => [ 'base' => NULL, 'refs' => [ 'GetScalingConfigurationRecommendationRequest$TargetCpuUtilizationPerCore' => '

The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.

', 'GetScalingConfigurationRecommendationResponse$TargetCpuUtilizationPerCore' => '

The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.

', ], ], 'ValidationFraction' => [ 'base' => NULL, 'refs' => [ 'AutoMLDataSplitConfig$ValidationFraction' => '

The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.

', ], ], 'VariantName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentInput$VariantName' => '

The name of an existing production variant where you host the inference component.

', 'DescribeInferenceComponentOutput$VariantName' => '

The name of the production variant that hosts the inference component.

', 'DesiredWeightAndCapacity$VariantName' => '

The name of the variant to update.

', 'InferenceComponentSummary$VariantName' => '

The name of the production variant that hosts the inference component.

', 'ListInferenceComponentsInput$VariantNameEquals' => '

A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

', 'PendingProductionVariantSummary$VariantName' => '

The name of the variant.

', 'ProductionVariant$VariantName' => '

The name of the production variant.

', 'ProductionVariantSummary$VariantName' => '

The name of the variant.

', ], ], 'VariantProperty' => [ 'base' => '

Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.

', 'refs' => [ 'VariantPropertyList$member' => NULL, ], ], 'VariantPropertyList' => [ 'base' => NULL, 'refs' => [ 'UpdateEndpointInput$ExcludeRetainedVariantProperties' => '

When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don\'t specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

', ], ], 'VariantPropertyType' => [ 'base' => NULL, 'refs' => [ 'VariantProperty$VariantPropertyType' => '

The type of variant property. The supported values are:

  • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

  • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

  • DataCaptureConfig: (Not currently supported.)

', ], ], 'VariantStatus' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantStatus$Status' => '

The endpoint variant status which describes the current deployment stage status or operational status.

  • Creating: Creating inference resources for the production variant.

  • Deleting: Terminating inference resources for the production variant.

  • Updating: Updating capacity for the production variant.

  • ActivatingTraffic: Turning on traffic for the production variant.

  • Baking: Waiting period to monitor the CloudWatch alarms in the automatic rollback configuration.

', ], ], 'VariantStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantStatus$StatusMessage' => '

A message that describes the status of the production variant.

', ], ], 'VariantWeight' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$DesiredWeight' => '

The variant\'s weight.

', 'PendingProductionVariantSummary$CurrentWeight' => '

The weight associated with the variant.

', 'PendingProductionVariantSummary$DesiredWeight' => '

The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

', 'ProductionVariant$InitialVariantWeight' => '

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

', 'ProductionVariantSummary$CurrentWeight' => '

The weight associated with the variant.

', 'ProductionVariantSummary$DesiredWeight' => '

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

', ], ], 'VectorConfig' => [ 'base' => '

Configuration for your vector collection type.

', 'refs' => [ 'CollectionConfig$VectorConfig' => '

Configuration for your vector collection type.

  • Dimension: The number of elements in your vector.

', ], ], 'VendorGuidance' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$VendorGuidance' => '

The stability of the image version, specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', 'DescribeImageVersionResponse$VendorGuidance' => '

The stability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', 'UpdateImageVersionRequest$VendorGuidance' => '

The availability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', ], ], 'VersionId' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$VersionId' => '

Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

', ], ], 'VersionedArnOrName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

', 'DeleteModelPackageInput$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to delete.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'DescribeModelPackageInput$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to describe.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', ], ], 'Vertex' => [ 'base' => '

A lineage entity connected to the starting entity(ies).

', 'refs' => [ 'Vertices$member' => NULL, ], ], 'Vertices' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Vertices' => '

A list of vertices connected to the start entity(ies) in the lineage graph.

', ], ], 'VisibilityConditions' => [ 'base' => '

The list of key-value pairs that you specify for your resources.

', 'refs' => [ 'VisibilityConditionsList$member' => NULL, ], ], 'VisibilityConditionsKey' => [ 'base' => NULL, 'refs' => [ 'VisibilityConditions$Key' => '

The key for that specifies the tag that you\'re using to filter the search results. The key must start with Tags..

', ], ], 'VisibilityConditionsList' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$VisibilityConditions' => '

Limits the results of your search request to the resources that you can access.

', ], ], 'VisibilityConditionsValue' => [ 'base' => NULL, 'refs' => [ 'VisibilityConditions$Value' => '

The value for the tag that you\'re using to filter the search results.

', ], ], 'VolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$VolumeSizeInGB' => '

The volume size in GB of the data to be processed for hyperparameter optimization (optional).

', 'ResourceConfig$VolumeSizeInGB' => '

The size of the ML storage volume that you want to provision.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

When using an ML instance with NVMe SSD volumes, SageMaker doesn\'t provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance\'s storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and ml.g5.

When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example, ML instance families that use EBS volumes include ml.c5 and ml.p2.

To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.

To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.

', ], ], 'VpcConfig' => [ 'base' => '

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

', 'refs' => [ 'AutoMLSecurityConfig$VpcConfig' => '

The VPC configuration.

', 'CreateClusterRequest$VpcConfig' => NULL, 'CreateEndpointConfigInput$VpcConfig' => NULL, 'CreateModelInput$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

', 'CreateTrainingJobRequest$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'DescribeClusterResponse$VpcConfig' => NULL, 'DescribeEndpointConfigOutput$VpcConfig' => NULL, 'DescribeModelOutput$VpcConfig' => '

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

', 'DescribeTrainingJobResponse$VpcConfig' => '

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'HyperParameterTrainingJobDefinition$VpcConfig' => '

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'LabelingJobResourceConfig$VpcConfig' => NULL, 'Model$VpcConfig' => NULL, 'MonitoringNetworkConfig$VpcConfig' => NULL, 'NetworkConfig$VpcConfig' => NULL, 'TrainingJob$VpcConfig' => '

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$VpcId' => '

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

', 'DescribeDomainResponse$VpcId' => '

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

', ], ], 'VpcOnlyTrustedAccounts' => [ 'base' => NULL, 'refs' => [ 'DockerSettings$VpcOnlyTrustedAccounts' => '

The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.

', ], ], 'VpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'WaitIntervalInSeconds' => [ 'base' => NULL, 'refs' => [ 'RollingUpdatePolicy$WaitIntervalInSeconds' => '

The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.

', 'TrafficRoutingConfig$WaitIntervalInSeconds' => '

The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

', ], ], 'WarmPoolResourceStatus' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsRequest$WarmPoolStatusEquals' => '

A filter that retrieves only training jobs with a specific warm pool status.

', 'WarmPoolStatus$Status' => '

The status of the warm pool.

  • InUse: The warm pool is in use for the training job.

  • Available: The warm pool is available to reuse for a matching training job.

  • Reused: The warm pool moved to a matching training job for reuse.

  • Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

', ], ], 'WarmPoolStatus' => [ 'base' => '

Status and billing information about the warm pool.

', 'refs' => [ 'DescribeTrainingJobResponse$WarmPoolStatus' => '

The status of the warm pool associated with the training job.

', 'TrainingJobSummary$WarmPoolStatus' => '

The status of the warm pool associated with the training job.

', ], ], 'Workforce' => [ 'base' => '

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'refs' => [ 'DescribeWorkforceResponse$Workforce' => '

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'UpdateWorkforceResponse$Workforce' => '

A single private workforce. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'Workforces$member' => NULL, ], ], 'WorkforceArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceResponse$WorkforceArn' => '

The Amazon Resource Name (ARN) of the workforce.

', 'Workforce$WorkforceArn' => '

The Amazon Resource Name (ARN) of the private workforce.

', 'Workteam$WorkforceArn' => '

The Amazon Resource Name (ARN) of the workforce.

', ], ], 'WorkforceFailureReason' => [ 'base' => NULL, 'refs' => [ 'Workforce$FailureReason' => '

The reason your workforce failed.

', ], ], 'WorkforceName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceRequest$WorkforceName' => '

The name of the private workforce.

', 'CreateWorkteamRequest$WorkforceName' => '

The name of the workforce.

', 'DeleteWorkforceRequest$WorkforceName' => '

The name of the workforce.

', 'DescribeWorkforceRequest$WorkforceName' => '

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

', 'ListWorkforcesRequest$NameContains' => '

A filter you can use to search for workforces using part of the workforce name.

', 'UpdateWorkforceRequest$WorkforceName' => '

The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.

', 'Workforce$WorkforceName' => '

The name of the private workforce.

', ], ], 'WorkforceSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSecurityGroupIds$member' => NULL, ], ], 'WorkforceSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', 'WorkforceVpcConfigResponse$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', ], ], 'WorkforceStatus' => [ 'base' => NULL, 'refs' => [ 'Workforce$Status' => '

The status of your workforce.

', ], ], 'WorkforceSubnetId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSubnets$member' => NULL, ], ], 'WorkforceSubnets' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$Subnets' => '

The ID of the subnets in the VPC that you want to connect.

', 'WorkforceVpcConfigResponse$Subnets' => '

The ID of the subnets in the VPC that you want to connect.

', ], ], 'WorkforceVpcConfigRequest' => [ 'base' => '

The VPC object you use to create or update a workforce.

', 'refs' => [ 'CreateWorkforceRequest$WorkforceVpcConfig' => '

Use this parameter to configure a workforce using VPC.

', 'UpdateWorkforceRequest$WorkforceVpcConfig' => '

Use this parameter to update your VPC configuration for a workforce.

', ], ], 'WorkforceVpcConfigResponse' => [ 'base' => '

A VpcConfig object that specifies the VPC that you want your workforce to connect to.

', 'refs' => [ 'Workforce$WorkforceVpcConfig' => '

The configuration of a VPC workforce.

', ], ], 'WorkforceVpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigResponse$VpcEndpointId' => '

The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

', ], ], 'WorkforceVpcId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$VpcId' => '

The ID of the VPC that the workforce uses for communication.

', 'WorkforceVpcConfigResponse$VpcId' => '

The ID of the VPC that the workforce uses for communication.

', ], ], 'Workforces' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesResponse$Workforces' => '

A list containing information about your workforce.

', ], ], 'WorkspaceSettings' => [ 'base' => '

The workspace settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$WorkspaceSettings' => '

The workspace settings for the SageMaker Canvas application.

', ], ], 'Workteam' => [ 'base' => '

Provides details about a labeling work team.

', 'refs' => [ 'DescribeWorkteamResponse$Workteam' => '

A Workteam instance that contains information about the work team.

', 'UpdateWorkteamResponse$Workteam' => '

A Workteam object that describes the updated work team.

', 'Workteams$member' => NULL, ], ], 'WorkteamArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamResponse$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

', 'DescribeSubscribedWorkteamRequest$WorkteamArn' => '

The Amazon Resource Name (ARN) of the subscribed work team to describe.

', 'HumanLoopConfig$WorkteamArn' => '

Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.

', 'HumanTaskConfig$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

', 'LabelingJobSummary$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team assigned to the job.

', 'ListLabelingJobsForWorkteamRequest$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

', 'SubscribedWorkteam$WorkteamArn' => '

The Amazon Resource Name (ARN) of the vendor that you have subscribed.

', 'Workteam$WorkteamArn' => '

The Amazon Resource Name (ARN) that identifies the work team.

', ], ], 'WorkteamName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$WorkteamName' => '

The name of the work team. Use this name to identify the work team.

', 'DeleteWorkteamRequest$WorkteamName' => '

The name of the work team to delete.

', 'DescribeWorkteamRequest$WorkteamName' => '

The name of the work team to return a description of.

', 'ListSubscribedWorkteamsRequest$NameContains' => '

A string in the work team name. This filter returns only work teams whose name contains the specified string.

', 'ListWorkteamsRequest$NameContains' => '

A string in the work team\'s name. This filter returns only work teams whose name contains the specified string.

', 'UpdateWorkteamRequest$WorkteamName' => '

The name of the work team to update.

', 'Workteam$WorkteamName' => '

The name of the work team.

', ], ], 'Workteams' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsResponse$Workteams' => '

An array of Workteam objects, each describing a work team.

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

Provides APIs for creating and managing SageMaker resources.

Other Resources:

', 'operations' => [ 'AddAssociation' => '

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'AddTags' => '

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

', 'AssociateTrialComponent' => '

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

', 'BatchDescribeModelPackage' => '

This action batch describes a list of versioned model packages

', 'CreateAction' => '

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateAlgorithm' => '

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

', 'CreateApp' => '

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

', 'CreateAppImageConfig' => '

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.

', 'CreateArtifact' => '

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateAutoMLJob' => '

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.

', 'CreateAutoMLJobV2' => '

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.

You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

', 'CreateCluster' => '

Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

', 'CreateCodeRepository' => '

Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

', 'CreateCompilationJob' => '

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

  • A name for the compilation job

  • Information about the input model artifacts

  • The output location for the compiled model and the device (target) that the model runs on

  • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.

You can also provide a Tag to track the model compilation job\'s resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

', 'CreateContext' => '

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

', 'CreateDataQualityJobDefinition' => '

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'CreateDeviceFleet' => '

Creates a device fleet.

', 'CreateDomain' => '

Creates a Domain. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All traffic between the domain and the EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.

  • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

    When internet access is disabled, you won\'t be able to run a Amazon SageMaker Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully.

For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.

', 'CreateEdgeDeploymentPlan' => '

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

', 'CreateEdgeDeploymentStage' => '

Creates a new stage in an existing edge deployment plan.

', 'CreateEdgePackagingJob' => '

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

', 'CreateEndpoint' => '

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

  • Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.

  • Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:

    "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"]

    "Resource": [

    "arn:aws:sagemaker:region:account-id:endpoint/endpointName"

    "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"

    ]

    For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.

', 'CreateEndpointConfig' => '

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

Use this API if you want to use SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

', 'CreateExperiment' => '

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment\'s properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

', 'CreateFeatureGroup' => '

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

', 'CreateFlowDefinition' => '

Creates a flow definition.

', 'CreateHub' => '

Create a hub.

Hub APIs are only callable through SageMaker Studio.

', 'CreateHumanTaskUi' => '

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

', 'CreateHyperParameterTuningJob' => '

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.

Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

', 'CreateImage' => '

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image.

', 'CreateImageVersion' => '

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.

', 'CreateInferenceComponent' => '

Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

', 'CreateInferenceExperiment' => '

Creates an inference experiment using the configurations specified in the request.

Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.

Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint\'s model variants based on your specified configuration.

While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.

', 'CreateInferenceRecommendationsJob' => '

Starts a recommendation job. You can create either an instance recommendation or load test job.

', 'CreateLabelingJob' => '

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

  • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

  • One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.

  • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

', 'CreateModel' => '

Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

For an example that calls this method when deploying a model to SageMaker hosting services, see Create a Model (Amazon Web Services SDK for Python (Boto 3)).

To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

', 'CreateModelBiasJobDefinition' => '

Creates the definition for a model bias job.

', 'CreateModelCard' => '

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card.

', 'CreateModelCardExportJob' => '

Creates an Amazon SageMaker Model Card export job.

', 'CreateModelExplainabilityJobDefinition' => '

Creates the definition for a model explainability job.

', 'CreateModelPackage' => '

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

  • Versioned - a model that is part of a model group in the model registry.

  • Unversioned - a model package that is not part of a model group.

', 'CreateModelPackageGroup' => '

Creates a model group. A model group contains a group of model versions.

', 'CreateModelQualityJobDefinition' => '

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'CreateMonitoringSchedule' => '

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.

', 'CreateNotebookInstance' => '

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, SageMaker does the following:

  1. Creates a network interface in the SageMaker VPC.

  2. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

  3. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can\'t change the name of a notebook instance after you create it.

After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models.

For more information, see How It Works.

', 'CreateNotebookInstanceLifecycleConfig' => '

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'CreatePipeline' => '

Creates a pipeline using a JSON pipeline definition.

', 'CreatePresignedDomainUrl' => '

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain\'s Amazon Elastic File System (EFS) volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

', 'CreatePresignedNotebookInstanceUrl' => '

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

', 'CreateProcessingJob' => '

Creates a processing job.

', 'CreateProject' => '

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

', 'CreateSpace' => '

Creates a space used for real time collaboration in a Domain.

', 'CreateStudioLifecycleConfig' => '

Creates a new Amazon SageMaker Studio Lifecycle Configuration.

', 'CreateTrainingJob' => '

Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.

In the request body, you provide the following:

  • AlgorithmSpecification - Identifies the training algorithm to use.

  • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

    Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

  • InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.

  • OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.

  • ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.

  • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.

  • RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.

  • StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.

  • Environment - The environment variables to set in the Docker container.

  • RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.

For more information about SageMaker, see How It Works.

', 'CreateTransformJob' => '

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

  • TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

  • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.

  • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

  • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

  • TransformResources - Identifies the ML compute instances for the transform job.

For more information about how batch transformation works, see Batch Transform.

', 'CreateTrial' => '

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial\'s properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

', 'CreateTrialComponent' => '

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

', 'CreateUserProfile' => '

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user\'s private Amazon Elastic File System (EFS) home directory.

', 'CreateWorkforce' => '

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

', 'CreateWorkteam' => '

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

', 'DeleteAction' => '

Deletes an action.

', 'DeleteAlgorithm' => '

Removes the specified algorithm from your account.

', 'DeleteApp' => '

Used to stop and delete an app.

', 'DeleteAppImageConfig' => '

Deletes an AppImageConfig.

', 'DeleteArtifact' => '

Deletes an artifact. Either ArtifactArn or Source must be specified.

', 'DeleteAssociation' => '

Deletes an association.

', 'DeleteCluster' => '

Delete a SageMaker HyperPod cluster.

', 'DeleteCodeRepository' => '

Deletes the specified Git repository from your account.

', 'DeleteCompilationJob' => '

Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker. It doesn\'t delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.

You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomes STOPPED.

', 'DeleteContext' => '

Deletes an context.

', 'DeleteDataQualityJobDefinition' => '

Deletes a data quality monitoring job definition.

', 'DeleteDeviceFleet' => '

Deletes a fleet.

', 'DeleteDomain' => '

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

', 'DeleteEdgeDeploymentPlan' => '

Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

', 'DeleteEdgeDeploymentStage' => '

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

', 'DeleteEndpoint' => '

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don\'t need to use the RevokeGrant API call.

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.

', 'DeleteEndpointConfig' => '

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

', 'DeleteExperiment' => '

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

', 'DeleteFeatureGroup' => '

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.

', 'DeleteFlowDefinition' => '

Deletes the specified flow definition.

', 'DeleteHub' => '

Delete a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DeleteHubContent' => '

Delete the contents of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DeleteHumanTaskUi' => '

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

', 'DeleteImage' => '

Deletes a SageMaker image and all versions of the image. The container images aren\'t deleted.

', 'DeleteImageVersion' => '

Deletes a version of a SageMaker image. The container image the version represents isn\'t deleted.

', 'DeleteInferenceComponent' => '

Deletes an inference component.

', 'DeleteInferenceExperiment' => '

Deletes an inference experiment.

This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.

', 'DeleteModel' => '

Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

', 'DeleteModelBiasJobDefinition' => '

Deletes an Amazon SageMaker model bias job definition.

', 'DeleteModelCard' => '

Deletes an Amazon SageMaker Model Card.

', 'DeleteModelExplainabilityJobDefinition' => '

Deletes an Amazon SageMaker model explainability job definition.

', 'DeleteModelPackage' => '

Deletes a model package.

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

', 'DeleteModelPackageGroup' => '

Deletes the specified model group.

', 'DeleteModelPackageGroupPolicy' => '

Deletes a model group resource policy.

', 'DeleteModelQualityJobDefinition' => '

Deletes the secified model quality monitoring job definition.

', 'DeleteMonitoringSchedule' => '

Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

', 'DeleteNotebookInstance' => '

Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

', 'DeleteNotebookInstanceLifecycleConfig' => '

Deletes a notebook instance lifecycle configuration.

', 'DeletePipeline' => '

Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.

', 'DeleteProject' => '

Delete the specified project.

', 'DeleteSpace' => '

Used to delete a space.

', 'DeleteStudioLifecycleConfig' => '

Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

', 'DeleteTags' => '

Deletes the specified tags from an SageMaker resource.

To list a resource\'s tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.

', 'DeleteTrial' => '

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

', 'DeleteTrialComponent' => '

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

', 'DeleteUserProfile' => '

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

', 'DeleteWorkforce' => '

Use this operation to delete a workforce.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.

', 'DeleteWorkteam' => '

Deletes an existing work team. This operation can\'t be undone.

', 'DeregisterDevices' => '

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

', 'DescribeAction' => '

Describes an action.

', 'DescribeAlgorithm' => '

Returns a description of the specified algorithm that is in your account.

', 'DescribeApp' => '

Describes the app.

', 'DescribeAppImageConfig' => '

Describes an AppImageConfig.

', 'DescribeArtifact' => '

Describes an artifact.

', 'DescribeAutoMLJob' => '

Returns information about an AutoML job created by calling CreateAutoMLJob.

AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.

', 'DescribeAutoMLJobV2' => '

Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.

', 'DescribeCluster' => '

Retrieves information of a SageMaker HyperPod cluster.

', 'DescribeClusterNode' => '

Retrieves information of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

', 'DescribeCodeRepository' => '

Gets details about the specified Git repository.

', 'DescribeCompilationJob' => '

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

', 'DescribeContext' => '

Describes a context.

', 'DescribeDataQualityJobDefinition' => '

Gets the details of a data quality monitoring job definition.

', 'DescribeDevice' => '

Describes the device.

', 'DescribeDeviceFleet' => '

A description of the fleet the device belongs to.

', 'DescribeDomain' => '

The description of the domain.

', 'DescribeEdgeDeploymentPlan' => '

Describes an edge deployment plan with deployment status per stage.

', 'DescribeEdgePackagingJob' => '

A description of edge packaging jobs.

', 'DescribeEndpoint' => '

Returns the description of an endpoint.

', 'DescribeEndpointConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', 'DescribeExperiment' => '

Provides a list of an experiment\'s properties.

', 'DescribeFeatureGroup' => '

Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

', 'DescribeFeatureMetadata' => '

Shows the metadata for a feature within a feature group.

', 'DescribeFlowDefinition' => '

Returns information about the specified flow definition.

', 'DescribeHub' => '

Describe a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DescribeHubContent' => '

Describe the content of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'DescribeHumanTaskUi' => '

Returns information about the requested human task user interface (worker task template).

', 'DescribeHyperParameterTuningJob' => '

Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.

', 'DescribeImage' => '

Describes a SageMaker image.

', 'DescribeImageVersion' => '

Describes a version of a SageMaker image.

', 'DescribeInferenceComponent' => '

Returns information about an inference component.

', 'DescribeInferenceExperiment' => '

Returns details about an inference experiment.

', 'DescribeInferenceRecommendationsJob' => '

Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

', 'DescribeLabelingJob' => '

Gets information about a labeling job.

', 'DescribeLineageGroup' => '

Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

', 'DescribeModel' => '

Describes a model that you created using the CreateModel API.

', 'DescribeModelBiasJobDefinition' => '

Returns a description of a model bias job definition.

', 'DescribeModelCard' => '

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

', 'DescribeModelCardExportJob' => '

Describes an Amazon SageMaker Model Card export job.

', 'DescribeModelExplainabilityJobDefinition' => '

Returns a description of a model explainability job definition.

', 'DescribeModelPackage' => '

Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

', 'DescribeModelPackageGroup' => '

Gets a description for the specified model group.

', 'DescribeModelQualityJobDefinition' => '

Returns a description of a model quality job definition.

', 'DescribeMonitoringSchedule' => '

Describes the schedule for a monitoring job.

', 'DescribeNotebookInstance' => '

Returns information about a notebook instance.

', 'DescribeNotebookInstanceLifecycleConfig' => '

Returns a description of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'DescribePipeline' => '

Describes the details of a pipeline.

', 'DescribePipelineDefinitionForExecution' => '

Describes the details of an execution\'s pipeline definition.

', 'DescribePipelineExecution' => '

Describes the details of a pipeline execution.

', 'DescribeProcessingJob' => '

Returns a description of a processing job.

', 'DescribeProject' => '

Describes the details of a project.

', 'DescribeSpace' => '

Describes the space.

', 'DescribeStudioLifecycleConfig' => '

Describes the Amazon SageMaker Studio Lifecycle Configuration.

', 'DescribeSubscribedWorkteam' => '

Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.

', 'DescribeTrainingJob' => '

Returns information about a training job.

Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.

', 'DescribeTransformJob' => '

Returns information about a transform job.

', 'DescribeTrial' => '

Provides a list of a trial\'s properties.

', 'DescribeTrialComponent' => '

Provides a list of a trials component\'s properties.

', 'DescribeUserProfile' => '

Describes a user profile. For more information, see CreateUserProfile.

', 'DescribeWorkforce' => '

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

', 'DescribeWorkteam' => '

Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team\'s Amazon Resource Name (ARN).

', 'DisableSagemakerServicecatalogPortfolio' => '

Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'DisassociateTrialComponent' => '

Disassociates a trial component from a trial. This doesn\'t effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

', 'EnableSagemakerServicecatalogPortfolio' => '

Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'GetDeviceFleetReport' => '

Describes a fleet.

', 'GetLineageGroupPolicy' => '

The resource policy for the lineage group.

', 'GetModelPackageGroupPolicy' => '

Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

', 'GetSagemakerServicecatalogPortfolioStatus' => '

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

', 'GetScalingConfigurationRecommendation' => '

Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.

', 'GetSearchSuggestions' => '

An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

', 'ImportHubContent' => '

Import hub content.

Hub APIs are only callable through SageMaker Studio.

', 'ListActions' => '

Lists the actions in your account and their properties.

', 'ListAlgorithms' => '

Lists the machine learning algorithms that have been created.

', 'ListAliases' => '

Lists the aliases of a specified image or image version.

', 'ListAppImageConfigs' => '

Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

', 'ListApps' => '

Lists apps.

', 'ListArtifacts' => '

Lists the artifacts in your account and their properties.

', 'ListAssociations' => '

Lists the associations in your account and their properties.

', 'ListAutoMLJobs' => '

Request a list of jobs.

', 'ListCandidatesForAutoMLJob' => '

List the candidates created for the job.

', 'ListClusterNodes' => '

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

', 'ListClusters' => '

Retrieves the list of SageMaker HyperPod clusters.

', 'ListCodeRepositories' => '

Gets a list of the Git repositories in your account.

', 'ListCompilationJobs' => '

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

', 'ListContexts' => '

Lists the contexts in your account and their properties.

', 'ListDataQualityJobDefinitions' => '

Lists the data quality job definitions in your account.

', 'ListDeviceFleets' => '

Returns a list of devices in the fleet.

', 'ListDevices' => '

A list of devices.

', 'ListDomains' => '

Lists the domains.

', 'ListEdgeDeploymentPlans' => '

Lists all edge deployment plans.

', 'ListEdgePackagingJobs' => '

Returns a list of edge packaging jobs.

', 'ListEndpointConfigs' => '

Lists endpoint configurations.

', 'ListEndpoints' => '

Lists endpoints.

', 'ListExperiments' => '

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

', 'ListFeatureGroups' => '

List FeatureGroups based on given filter and order.

', 'ListFlowDefinitions' => '

Returns information about the flow definitions in your account.

', 'ListHubContentVersions' => '

List hub content versions.

Hub APIs are only callable through SageMaker Studio.

', 'ListHubContents' => '

List the contents of a hub.

Hub APIs are only callable through SageMaker Studio.

', 'ListHubs' => '

List all existing hubs.

Hub APIs are only callable through SageMaker Studio.

', 'ListHumanTaskUis' => '

Returns information about the human task user interfaces in your account.

', 'ListHyperParameterTuningJobs' => '

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

', 'ListImageVersions' => '

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

', 'ListImages' => '

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

', 'ListInferenceComponents' => '

Lists the inference components in your account and their properties.

', 'ListInferenceExperiments' => '

Returns the list of all inference experiments.

', 'ListInferenceRecommendationsJobSteps' => '

Returns a list of the subtasks for an Inference Recommender job.

The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

', 'ListInferenceRecommendationsJobs' => '

Lists recommendation jobs that satisfy various filters.

', 'ListLabelingJobs' => '

Gets a list of labeling jobs.

', 'ListLabelingJobsForWorkteam' => '

Gets a list of labeling jobs assigned to a specified work team.

', 'ListLineageGroups' => '

A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

', 'ListModelBiasJobDefinitions' => '

Lists model bias jobs definitions that satisfy various filters.

', 'ListModelCardExportJobs' => '

List the export jobs for the Amazon SageMaker Model Card.

', 'ListModelCardVersions' => '

List existing versions of an Amazon SageMaker Model Card.

', 'ListModelCards' => '

List existing model cards.

', 'ListModelExplainabilityJobDefinitions' => '

Lists model explainability job definitions that satisfy various filters.

', 'ListModelMetadata' => '

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

', 'ListModelPackageGroups' => '

Gets a list of the model groups in your Amazon Web Services account.

', 'ListModelPackages' => '

Lists the model packages that have been created.

', 'ListModelQualityJobDefinitions' => '

Gets a list of model quality monitoring job definitions in your account.

', 'ListModels' => '

Lists models created with the CreateModel API.

', 'ListMonitoringAlertHistory' => '

Gets a list of past alerts in a model monitoring schedule.

', 'ListMonitoringAlerts' => '

Gets the alerts for a single monitoring schedule.

', 'ListMonitoringExecutions' => '

Returns list of all monitoring job executions.

', 'ListMonitoringSchedules' => '

Returns list of all monitoring schedules.

', 'ListNotebookInstanceLifecycleConfigs' => '

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

', 'ListNotebookInstances' => '

Returns a list of the SageMaker notebook instances in the requester\'s account in an Amazon Web Services Region.

', 'ListPipelineExecutionSteps' => '

Gets a list of PipeLineExecutionStep objects.

', 'ListPipelineExecutions' => '

Gets a list of the pipeline executions.

', 'ListPipelineParametersForExecution' => '

Gets a list of parameters for a pipeline execution.

', 'ListPipelines' => '

Gets a list of pipelines.

', 'ListProcessingJobs' => '

Lists processing jobs that satisfy various filters.

', 'ListProjects' => '

Gets a list of the projects in an Amazon Web Services account.

', 'ListResourceCatalogs' => '

Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.

', 'ListSpaces' => '

Lists spaces.

', 'ListStageDevices' => '

Lists devices allocated to the stage, containing detailed device information and deployment status.

', 'ListStudioLifecycleConfigs' => '

Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

', 'ListSubscribedWorkteams' => '

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

', 'ListTags' => '

Returns the tags for the specified SageMaker resource.

', 'ListTrainingJobs' => '

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

', 'ListTrainingJobsForHyperParameterTuningJob' => '

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

', 'ListTransformJobs' => '

Lists transform jobs.

', 'ListTrialComponents' => '

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

  • ExperimentName

  • SourceArn

  • TrialName

', 'ListTrials' => '

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

', 'ListUserProfiles' => '

Lists user profiles.

', 'ListWorkforces' => '

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

', 'ListWorkteams' => '

Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

', 'PutModelPackageGroupPolicy' => '

Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

', 'QueryLineage' => '

Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.

', 'RegisterDevices' => '

Register devices.

', 'RenderUiTemplate' => '

Renders the UI template so that you can preview the worker\'s experience.

', 'RetryPipelineExecution' => '

Retry the execution of the pipeline.

', 'Search' => '

Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numeric, text, Boolean, and timestamp.

The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.

', 'SendPipelineExecutionStepFailure' => '

Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

', 'SendPipelineExecutionStepSuccess' => '

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step\'s output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

', 'StartEdgeDeploymentStage' => '

Starts a stage in an edge deployment plan.

', 'StartInferenceExperiment' => '

Starts an inference experiment.

', 'StartMonitoringSchedule' => '

Starts a previously stopped monitoring schedule.

By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.

', 'StartNotebookInstance' => '

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance\'s status must be InService before you can connect to your Jupyter notebook.

', 'StartPipelineExecution' => '

Starts a pipeline execution.

', 'StopAutoMLJob' => '

A method for forcing a running job to shut down.

', 'StopCompilationJob' => '

Stops a model compilation job.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn\'t stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.

', 'StopEdgeDeploymentStage' => '

Stops a stage in an edge deployment plan.

', 'StopEdgePackagingJob' => '

Request to stop an edge packaging job.

', 'StopHyperParameterTuningJob' => '

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

', 'StopInferenceExperiment' => '

Stops an inference experiment.

', 'StopInferenceRecommendationsJob' => '

Stops an Inference Recommender job.

', 'StopLabelingJob' => '

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

', 'StopMonitoringSchedule' => '

Stops a previously started monitoring schedule.

', 'StopNotebookInstance' => '

Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

', 'StopPipelineExecution' => '

Stops a pipeline execution.

Callback Step

A pipeline execution won\'t stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping".

You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

Lambda Step

A pipeline execution can\'t be stopped while a lambda step is running because the Lambda function invoked by the lambda step can\'t be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.

', 'StopProcessingJob' => '

Stops a processing job.

', 'StopTrainingJob' => '

Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.

', 'StopTransformJob' => '

Stops a batch transform job.

When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn\'t store the job\'s output in Amazon S3.

', 'UpdateAction' => '

Updates an action.

', 'UpdateAppImageConfig' => '

Updates the properties of an AppImageConfig.

', 'UpdateArtifact' => '

Updates an artifact.

', 'UpdateCluster' => '

Update a SageMaker HyperPod cluster.

', 'UpdateCodeRepository' => '

Updates the specified Git repository with the specified values.

', 'UpdateContext' => '

Updates a context.

', 'UpdateDeviceFleet' => '

Updates a fleet of devices.

', 'UpdateDevices' => '

Updates one or more devices in a fleet.

', 'UpdateDomain' => '

Updates the default settings for new user profiles in the domain.

', 'UpdateEndpoint' => '

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

', 'UpdateEndpointWeightsAndCapacities' => '

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

', 'UpdateExperiment' => '

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

', 'UpdateFeatureGroup' => '

Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API.

You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.

You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration.

', 'UpdateFeatureMetadata' => '

Updates the description and parameters of the feature group.

', 'UpdateHub' => '

Update a hub.

Hub APIs are only callable through SageMaker Studio.

', 'UpdateImage' => '

Updates the properties of a SageMaker image. To change the image\'s tags, use the AddTags and DeleteTags APIs.

', 'UpdateImageVersion' => '

Updates the properties of a SageMaker image version.

', 'UpdateInferenceComponent' => '

Updates an inference component.

', 'UpdateInferenceComponentRuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceExperiment' => '

Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.

', 'UpdateModelCard' => '

Update an Amazon SageMaker Model Card.

You cannot update both model card content and model card status in a single call.

', 'UpdateModelPackage' => '

Updates a versioned model.

', 'UpdateMonitoringAlert' => '

Update the parameters of a model monitor alert.

', 'UpdateMonitoringSchedule' => '

Updates a previously created schedule.

', 'UpdateNotebookInstance' => '

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

', 'UpdateNotebookInstanceLifecycleConfig' => '

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

', 'UpdatePipeline' => '

Updates a pipeline.

', 'UpdatePipelineExecution' => '

Updates a pipeline execution.

', 'UpdateProject' => '

Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.

', 'UpdateSpace' => '

Updates the settings of a space.

', 'UpdateTrainingJob' => '

Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.

', 'UpdateTrial' => '

Updates the display name of a trial.

', 'UpdateTrialComponent' => '

Updates one or more properties of a trial component.

', 'UpdateUserProfile' => '

Updates a user profile.

', 'UpdateWorkforce' => '

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

The worker portal is now supported in VPC and public internet.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn\'t restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as "10.0.0.0/16".

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

This operation only applies to private workforces.

', 'UpdateWorkteam' => '

Updates an existing work team with new member definitions or description.

', ], 'shapes' => [ 'Accept' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$Accept' => '

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

', ], ], 'AcceptEula' => [ 'base' => NULL, 'refs' => [ 'ModelAccessConfig$AcceptEula' => '

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'LabelingJobForWorkteamSummary$WorkRequesterAccountId' => '

The Amazon Web Services account ID of the account used to start the labeling job.

', 'VpcOnlyTrustedAccounts$member' => NULL, ], ], 'ActionArn' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'CreateActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'DeleteActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'DescribeActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', 'UpdateActionResponse$ActionArn' => '

The Amazon Resource Name (ARN) of the action.

', ], ], 'ActionSource' => [ 'base' => '

A structure describing the source of an action.

', 'refs' => [ 'ActionSummary$Source' => '

The source of the action.

', 'CreateActionRequest$Source' => '

The source type, ID, and URI.

', 'DescribeActionResponse$Source' => '

The source of the action.

', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$Status' => '

The status of the action.

', 'CreateActionRequest$Status' => '

The status of the action.

', 'DescribeActionResponse$Status' => '

The status of the action.

', 'UpdateActionRequest$Status' => '

The new status for the action.

', ], ], 'ActionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListActionsResponse$ActionSummaries' => '

A list of actions and their properties.

', ], ], 'ActionSummary' => [ 'base' => '

Lists the properties of an action. An action represents an action or activity. Some examples are a workflow step and a model deployment. Generally, an action involves at least one input artifact or output artifact.

', 'refs' => [ 'ActionSummaries$member' => NULL, ], ], 'AddAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AddAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'AddTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'AdditionalCodeRepositoryNamesOrUrls' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$AdditionalCodeRepositories' => '

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'DescribeNotebookInstanceOutput$AdditionalCodeRepositories' => '

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'NotebookInstanceSummary$AdditionalCodeRepositories' => '

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'UpdateNotebookInstanceInput$AdditionalCodeRepositories' => '

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', ], ], 'AdditionalInferenceSpecificationDefinition' => [ 'base' => '

A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package

', 'refs' => [ 'AdditionalInferenceSpecifications$member' => NULL, ], ], 'AdditionalInferenceSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', 'DescribeModelPackageOutput$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', 'ModelPackage$AdditionalInferenceSpecifications' => '

An array of additional Inference Specification objects.

', 'UpdateModelPackageInput$AdditionalInferenceSpecificationsToAdd' => '

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

', ], ], 'AdditionalS3DataSource' => [ 'base' => '

A data source used for training or inference that is in addition to the input dataset or model data.

', 'refs' => [ 'ModelPackageContainerDefinition$AdditionalS3DataSource' => '

The additional data source that is used during inference in the Docker container for your model package.

', 'TrainingSpecification$AdditionalS3DataSource' => '

The additional data source used during the training job.

', ], ], 'AdditionalS3DataSourceDataType' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$S3DataType' => '

The data type of the additional data source that you specify for use in inference or training.

', ], ], 'AgentVersion' => [ 'base' => '

Edge Manager agent version.

', 'refs' => [ 'AgentVersions$member' => NULL, ], ], 'AgentVersions' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$AgentVersions' => '

The versions of Edge Manager agent deployed on the fleet.

', ], ], 'AggregationTransformationValue' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$value' => NULL, ], ], 'AggregationTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Aggregation' => '

A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.

The supported aggregation methods are sum (default), avg, first, min, max.

Aggregation is only supported for the target column.

', ], ], 'Alarm' => [ 'base' => '

An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.

', 'refs' => [ 'AlarmList$member' => NULL, ], ], 'AlarmList' => [ 'base' => NULL, 'refs' => [ 'AutoRollbackConfig$Alarms' => '

List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.

', ], ], 'AlarmName' => [ 'base' => NULL, 'refs' => [ 'Alarm$AlarmName' => '

The name of a CloudWatch alarm in your account.

', ], ], 'AlgorithmArn' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm.

', 'CreateAlgorithmOutput$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the new algorithm.

', 'DescribeAlgorithmOutput$AlgorithmArn' => '

The Amazon Resource Name (ARN) of the algorithm.

', ], ], 'AlgorithmImage' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$TrainingImage' => '

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

For more information, see the note in the AlgorithmName parameter description.

', 'DebugRuleConfiguration$RuleEvaluatorImage' => '

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

', 'HyperParameterAlgorithmSpecification$TrainingImage' => '

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

', 'ProfilerRuleConfiguration$RuleEvaluatorImage' => '

The Amazon Elastic Container Registry Image for the managed rule evaluation.

', ], ], 'AlgorithmSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'AlgorithmSpecification' => [ 'base' => '

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

', 'refs' => [ 'CreateTrainingJobRequest$AlgorithmSpecification' => '

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

', 'DescribeTrainingJobResponse$AlgorithmSpecification' => '

Information about the algorithm used for training, and algorithm metadata.

', 'TrainingJob$AlgorithmSpecification' => '

Information about the algorithm used for training, and algorithm metadata.

', ], ], 'AlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$AlgorithmStatus' => '

The overall status of the algorithm.

', 'DescribeAlgorithmOutput$AlgorithmStatus' => '

The current status of the algorithm.

', ], ], 'AlgorithmStatusDetails' => [ 'base' => '

Specifies the validation and image scan statuses of the algorithm.

', 'refs' => [ 'DescribeAlgorithmOutput$AlgorithmStatusDetails' => '

Details about the current status of the algorithm.

', ], ], 'AlgorithmStatusItem' => [ 'base' => '

Represents the overall status of an algorithm.

', 'refs' => [ 'AlgorithmStatusItemList$member' => NULL, ], ], 'AlgorithmStatusItemList' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusDetails$ValidationStatuses' => '

The status of algorithm validation.

', 'AlgorithmStatusDetails$ImageScanStatuses' => '

The status of the scan of the algorithm\'s Docker image container.

', ], ], 'AlgorithmSummary' => [ 'base' => '

Provides summary information about an algorithm.

', 'refs' => [ 'AlgorithmSummaryList$member' => NULL, ], ], 'AlgorithmSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsOutput$AlgorithmSummaryList' => '

>An array of AlgorithmSummary objects, each of which lists an algorithm.

', ], ], 'AlgorithmValidationProfile' => [ 'base' => '

Defines a training job and a batch transform job that SageMaker runs to validate your algorithm.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

', 'refs' => [ 'AlgorithmValidationProfiles$member' => NULL, ], ], 'AlgorithmValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'AlgorithmValidationSpecification$ValidationProfiles' => '

An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.

', ], ], 'AlgorithmValidationSpecification' => [ 'base' => '

Specifies configurations for one or more training jobs that SageMaker runs to test the algorithm.

', 'refs' => [ 'CreateAlgorithmInput$ValidationSpecification' => '

Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm\'s training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm\'s inference code.

', 'DescribeAlgorithmOutput$ValidationSpecification' => '

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

', ], ], 'AnnotationConsolidationConfig' => [ 'base' => '

Configures how labels are consolidated across human workers and processes output data.

', 'refs' => [ 'HumanTaskConfig$AnnotationConsolidationConfig' => '

Configures how labels are consolidated across human workers.

', ], ], 'AppArn' => [ 'base' => NULL, 'refs' => [ 'CreateAppResponse$AppArn' => '

The Amazon Resource Name (ARN) of the app.

', 'DescribeAppResponse$AppArn' => '

The Amazon Resource Name (ARN) of the app.

', ], ], 'AppDetails' => [ 'base' => '

Details about an Amazon SageMaker app.

', 'refs' => [ 'AppList$member' => NULL, ], ], 'AppImageConfigArn' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigArn' => '

The Amazon Resource Name (ARN) of the AppImageConfig.

', 'CreateAppImageConfigResponse$AppImageConfigArn' => '

The Amazon Resource Name (ARN) of the AppImageConfig.

', 'DescribeAppImageConfigResponse$AppImageConfigArn' => '

The Amazon Resource Name (ARN) of the AppImageConfig.

', 'UpdateAppImageConfigResponse$AppImageConfigArn' => '

The Amazon Resource Name (ARN) for the AppImageConfig.

', ], ], 'AppImageConfigDetails' => [ 'base' => '

The configuration for running a SageMaker image as a KernelGateway app.

', 'refs' => [ 'AppImageConfigList$member' => NULL, ], ], 'AppImageConfigList' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsResponse$AppImageConfigs' => '

A list of AppImageConfigs and their properties.

', ], ], 'AppImageConfigName' => [ 'base' => NULL, 'refs' => [ 'AppImageConfigDetails$AppImageConfigName' => '

The name of the AppImageConfig. Must be unique to your account.

', 'CreateAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig. Must be unique to your account.

', 'CustomImage$AppImageConfigName' => '

The name of the AppImageConfig.

', 'DeleteAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to delete.

', 'DescribeAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to describe.

', 'DescribeAppImageConfigResponse$AppImageConfigName' => '

The name of the AppImageConfig.

', 'ListAppImageConfigsRequest$NameContains' => '

A filter that returns only AppImageConfigs whose name contains the specified string.

', 'UpdateAppImageConfigRequest$AppImageConfigName' => '

The name of the AppImageConfig to update.

', ], ], 'AppImageConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListAppImageConfigsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'AppInstanceType' => [ 'base' => NULL, 'refs' => [ 'ResourceSpec$InstanceType' => '

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

', ], ], 'AppList' => [ 'base' => NULL, 'refs' => [ 'ListAppsResponse$Apps' => '

The list of apps.

', ], ], 'AppManaged' => [ 'base' => NULL, 'refs' => [ 'ProcessingInput$AppManaged' => '

When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.

', 'ProcessingOutput$AppManaged' => '

When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.

', ], ], 'AppName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$AppName' => '

The name of the app.

', 'CreateAppRequest$AppName' => '

The name of the app.

', 'DeleteAppRequest$AppName' => '

The name of the app.

', 'DescribeAppRequest$AppName' => '

The name of the app.

', 'DescribeAppResponse$AppName' => '

The name of the app.

', ], ], 'AppNetworkAccessType' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

', 'DescribeDomainResponse$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

', 'UpdateDomainRequest$AppNetworkAccessType' => '

Specifies the VPC used for non-EFS traffic.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access.

  • VpcOnly - All Studio traffic is through the specified VPC and subnets.

This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

', ], ], 'AppSecurityGroupManagement' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

', 'DescribeDomainResponse$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

', 'UpdateDomainRequest$AppSecurityGroupManagement' => '

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

', ], ], 'AppSortKey' => [ 'base' => NULL, 'refs' => [ 'ListAppsRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'AppSpecification' => [ 'base' => '

Configuration to run a processing job in a specified container image.

', 'refs' => [ 'CreateProcessingJobRequest$AppSpecification' => '

Configures the processing job to run a specified Docker container image.

', 'DescribeProcessingJobResponse$AppSpecification' => '

Configures the processing job to run a specified container image.

', 'ProcessingJob$AppSpecification' => NULL, ], ], 'AppStatus' => [ 'base' => NULL, 'refs' => [ 'AppDetails$Status' => '

The status.

', 'DescribeAppResponse$Status' => '

The status.

', ], ], 'AppType' => [ 'base' => NULL, 'refs' => [ 'AppDetails$AppType' => '

The type of app.

', 'CreateAppRequest$AppType' => '

The type of app.

', 'DeleteAppRequest$AppType' => '

The type of app.

', 'DescribeAppRequest$AppType' => '

The type of app.

', 'DescribeAppResponse$AppType' => '

The type of app.

', 'SpaceSettings$AppType' => '

The type of app created within the space.

', 'SpaceSettingsSummary$AppType' => '

The type of app created within the space.

', ], ], 'ApprovalDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeModelPackageOutput$ApprovalDescription' => '

A description provided for the model approval.

', 'ModelPackage$ApprovalDescription' => '

A description provided when the model approval is set.

', 'UpdateModelPackageInput$ApprovalDescription' => '

A description for the approval status of the model.

', ], ], 'ArnOrName' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$AlgorithmName' => '

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can\'t specify a value for TrainingImage, and vice versa.

If you specify values for both parameters, the training job might break; if you don\'t specify any value for both parameters, the training job might raise a null error.

', 'CreateModelPackageInput$ModelPackageGroupName' => '

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

', 'DeleteModelPackageGroupInput$ModelPackageGroupName' => '

The name of the model group to delete.

', 'DescribeAlgorithmInput$AlgorithmName' => '

The name of the algorithm to describe.

', 'DescribeModelPackageGroupInput$ModelPackageGroupName' => '

The name of gthe model group to describe.

', 'HyperParameterAlgorithmSpecification$AlgorithmName' => '

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

', 'ListModelPackagesInput$ModelPackageGroupName' => '

A filter that returns only model versions that belong to the specified model group.

', 'SourceAlgorithm$AlgorithmName' => '

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

', ], ], 'ArtifactArn' => [ 'base' => NULL, 'refs' => [ 'ArtifactSummary$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'CreateArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'DeleteArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to delete.

', 'DeleteArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'DescribeArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to describe.

', 'DescribeArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', 'UpdateArtifactRequest$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact to update.

', 'UpdateArtifactResponse$ArtifactArn' => '

The Amazon Resource Name (ARN) of the artifact.

', ], ], 'ArtifactDigest' => [ 'base' => NULL, 'refs' => [ 'ModelDigests$ArtifactDigest' => '

Provides a hash value that uniquely identifies the stored model artifacts.

', ], ], 'ArtifactProperties' => [ 'base' => NULL, 'refs' => [ 'CreateArtifactRequest$Properties' => '

A list of properties to add to the artifact.

', 'UpdateArtifactRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', ], ], 'ArtifactPropertyValue' => [ 'base' => NULL, 'refs' => [ 'ArtifactProperties$value' => NULL, ], ], 'ArtifactSource' => [ 'base' => '

A structure describing the source of an artifact.

', 'refs' => [ 'ArtifactSummary$Source' => '

The source of the artifact.

', 'CreateArtifactRequest$Source' => '

The ID, ID type, and URI of the source.

', 'DeleteArtifactRequest$Source' => '

The URI of the source.

', 'DescribeArtifactResponse$Source' => '

The source of the artifact.

', ], ], 'ArtifactSourceIdType' => [ 'base' => NULL, 'refs' => [ 'ArtifactSourceType$SourceIdType' => '

The type of ID.

', ], ], 'ArtifactSourceType' => [ 'base' => '

The ID and ID type of an artifact source.

', 'refs' => [ 'ArtifactSourceTypes$member' => NULL, ], ], 'ArtifactSourceTypes' => [ 'base' => NULL, 'refs' => [ 'ArtifactSource$SourceTypes' => '

A list of source types.

', ], ], 'ArtifactSummaries' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsResponse$ArtifactSummaries' => '

A list of artifacts and their properties.

', ], ], 'ArtifactSummary' => [ 'base' => '

Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.

', 'refs' => [ 'ArtifactSummaries$member' => NULL, ], ], 'AssemblyType' => [ 'base' => NULL, 'refs' => [ 'TransformOutput$AssembleWith' => '

Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

', ], ], 'AssociateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociationEdgeType' => [ 'base' => NULL, 'refs' => [ 'AddAssociationRequest$AssociationType' => '

The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.

  • ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.

  • AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.

  • DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.

  • Produced - The source generated the destination. For example, a training job produced a model artifact.

', 'AssociationSummary$AssociationType' => '

The type of the association.

', 'Edge$AssociationType' => '

The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.

', 'ListAssociationsRequest$AssociationType' => '

A filter that returns only associations of the specified type.

', ], ], 'AssociationEntityArn' => [ 'base' => NULL, 'refs' => [ 'AddAssociationRequest$SourceArn' => '

The ARN of the source.

', 'AddAssociationRequest$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'AddAssociationResponse$SourceArn' => '

The ARN of the source.

', 'AddAssociationResponse$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'AssociationSummary$SourceArn' => '

The ARN of the source.

', 'AssociationSummary$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'DeleteAssociationRequest$SourceArn' => '

The ARN of the source.

', 'DeleteAssociationRequest$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'DeleteAssociationResponse$SourceArn' => '

The ARN of the source.

', 'DeleteAssociationResponse$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination.

', 'Edge$SourceArn' => '

The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

', 'Edge$DestinationArn' => '

The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

', 'ListAssociationsRequest$SourceArn' => '

A filter that returns only associations with the specified source ARN.

', 'ListAssociationsRequest$DestinationArn' => '

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

', 'QueryLineageStartArns$member' => NULL, 'Vertex$Arn' => '

The Amazon Resource Name (ARN) of the lineage entity resource.

', ], ], 'AssociationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAssociationsResponse$AssociationSummaries' => '

A list of associations and their properties.

', ], ], 'AssociationSummary' => [ 'base' => '

Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.

', 'refs' => [ 'AssociationSummaries$member' => NULL, ], ], 'AsyncInferenceClientConfig' => [ 'base' => '

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

', 'refs' => [ 'AsyncInferenceConfig$ClientConfig' => '

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

', ], ], 'AsyncInferenceConfig' => [ 'base' => '

Specifies configuration for how an endpoint performs asynchronous inference.

', 'refs' => [ 'CreateEndpointConfigInput$AsyncInferenceConfig' => '

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

', 'DescribeEndpointConfigOutput$AsyncInferenceConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', 'DescribeEndpointOutput$AsyncInferenceConfig' => '

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

', ], ], 'AsyncInferenceNotificationConfig' => [ 'base' => '

Specifies the configuration for notifications of inference results for asynchronous inference.

', 'refs' => [ 'AsyncInferenceOutputConfig$NotificationConfig' => '

Specifies the configuration for notifications of inference results for asynchronous inference.

', ], ], 'AsyncInferenceOutputConfig' => [ 'base' => '

Specifies the configuration for asynchronous inference invocation outputs.

', 'refs' => [ 'AsyncInferenceConfig$OutputConfig' => '

Specifies the configuration for asynchronous inference invocation outputs.

', ], ], 'AsyncNotificationTopicTypeList' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$IncludeInferenceResponseIn' => '

The Amazon SNS topics where you want the inference response to be included.

The inference response is included only if the response size is less than or equal to 128 KB.

', ], ], 'AsyncNotificationTopicTypes' => [ 'base' => NULL, 'refs' => [ 'AsyncNotificationTopicTypeList$member' => NULL, ], ], 'AthenaCatalog' => [ 'base' => '

The name of the data catalog used in Athena query execution.

', 'refs' => [ 'AthenaDatasetDefinition$Catalog' => NULL, ], ], 'AthenaDatabase' => [ 'base' => '

The name of the database used in the Athena query execution.

', 'refs' => [ 'AthenaDatasetDefinition$Database' => NULL, ], ], 'AthenaDatasetDefinition' => [ 'base' => '

Configuration for Athena Dataset Definition input.

', 'refs' => [ 'DatasetDefinition$AthenaDatasetDefinition' => NULL, ], ], 'AthenaQueryString' => [ 'base' => '

The SQL query statements, to be executed.

', 'refs' => [ 'AthenaDatasetDefinition$QueryString' => NULL, ], ], 'AthenaResultCompressionType' => [ 'base' => '

The compression used for Athena query results.

', 'refs' => [ 'AthenaDatasetDefinition$OutputCompression' => NULL, ], ], 'AthenaResultFormat' => [ 'base' => '

The data storage format for Athena query results.

', 'refs' => [ 'AthenaDatasetDefinition$OutputFormat' => NULL, ], ], 'AthenaWorkGroup' => [ 'base' => '

The name of the workgroup in which the Athena query is being started.

', 'refs' => [ 'AthenaDatasetDefinition$WorkGroup' => NULL, ], ], 'AttributeName' => [ 'base' => NULL, 'refs' => [ 'AttributeNames$member' => NULL, ], ], 'AttributeNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$AttributeNames' => '

A list of one or more attribute names to use that are found in a specified augmented manifest file.

', ], ], 'AuthMode' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$AuthMode' => '

The mode of authentication that members use to access the domain.

', 'DescribeDomainResponse$AuthMode' => '

The domain\'s authentication mode.

', ], ], 'AutoGenerateEndpointName' => [ 'base' => NULL, 'refs' => [ 'ModelDeployConfig$AutoGenerateEndpointName' => '

Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.

If you set AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a 400 error is thrown.

', ], ], 'AutoMLAlgorithm' => [ 'base' => NULL, 'refs' => [ 'AutoMLAlgorithms$member' => NULL, ], ], 'AutoMLAlgorithmConfig' => [ 'base' => '

The collection of algorithms run on a dataset for training the model candidates of an Autopilot job.

', 'refs' => [ 'AutoMLAlgorithmsConfig$member' => NULL, ], ], 'AutoMLAlgorithms' => [ 'base' => NULL, 'refs' => [ 'AutoMLAlgorithmConfig$AutoMLAlgorithms' => '

The selection of algorithms run on a dataset to train the model candidates of an Autopilot job.

Selected algorithms must belong to the list corresponding to the training mode set in AutoMLJobConfig.Mode (ENSEMBLING or HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.

  • In ENSEMBLING mode:

    • "catboost"

    • "extra-trees"

    • "fastai"

    • "lightgbm"

    • "linear-learner"

    • "nn-torch"

    • "randomforest"

    • "xgboost"

  • In HYPERPARAMETER_TUNING mode:

    • "linear-learner"

    • "mlp"

    • "xgboost"

', ], ], 'AutoMLAlgorithmsConfig' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateGenerationConfig$AlgorithmsConfig' => '

Stores the configuration information for the selection of algorithms used to train the model candidates.

The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .

  • AlgorithmsConfig should not be set in AUTO training mode.

  • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

    If the list of algorithms provided as values for AutoMLAlgorithms is empty, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.

  • When AlgorithmsConfig is not provided, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.

For the list of all algorithms per training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

', 'CandidateGenerationConfig$AlgorithmsConfig' => '

Stores the configuration information for the selection of algorithms used to train model candidates on tabular data.

The list of available algorithms to choose from depends on the training mode set in TabularJobConfig.Mode .

  • AlgorithmsConfig should not be set in AUTO training mode.

  • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

    If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

  • When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

For the list of all algorithms per problem type and training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

', ], ], 'AutoMLCandidate' => [ 'base' => '

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

', 'refs' => [ 'AutoMLCandidates$member' => NULL, 'DescribeAutoMLJobResponse$BestCandidate' => '

The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

', 'DescribeAutoMLJobV2Response$BestCandidate' => '

Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.

', ], ], 'AutoMLCandidateGenerationConfig' => [ 'base' => '

Stores the configuration information for how a candidate is generated (optional).

', 'refs' => [ 'AutoMLJobConfig$CandidateGenerationConfig' => '

The configuration for generating a candidate for an AutoML job (optional).

', ], ], 'AutoMLCandidateStep' => [ 'base' => '

Information about the steps for a candidate and what step it is working on.

', 'refs' => [ 'CandidateSteps$member' => NULL, ], ], 'AutoMLCandidates' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobResponse$Candidates' => '

Summaries about the AutoMLCandidates.

', ], ], 'AutoMLChannel' => [ 'base' => '

A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see Channel.

A validation dataset must contain the same headers as the training dataset.

', 'refs' => [ 'AutoMLInputDataConfig$member' => NULL, ], ], 'AutoMLChannelType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$ChannelType' => '

The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName. For information on specifying training and validation channel types, see How to specify training and validation datasets.

', 'AutoMLJobChannel$ChannelType' => '

The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType

The type of channel defaults to training for the time-series forecasting problem type.

', ], ], 'AutoMLContainerDefinition' => [ 'base' => '

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.

', 'refs' => [ 'AutoMLContainerDefinitions$member' => NULL, ], ], 'AutoMLContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$InferenceContainers' => '

Information about the recommended inference container definitions.

', 'AutoMLInferenceContainerDefinitions$value' => '

Information about the recommended inference container definitions.

', ], ], 'AutoMLDataSource' => [ 'base' => '

The data source for the Autopilot job.

', 'refs' => [ 'AutoMLChannel$DataSource' => '

The data source for an AutoML channel.

', 'AutoMLJobChannel$DataSource' => '

The data source for an AutoML channel (Required).

', ], ], 'AutoMLDataSplitConfig' => [ 'base' => '

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

', 'refs' => [ 'AutoMLJobConfig$DataSplitConfig' => '

The configuration for splitting the input training dataset.

Type: AutoMLDataSplitConfig

', 'CreateAutoMLJobV2Request$DataSplitConfig' => '

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

This attribute must not be set for the time-series forecasting problem type, as Autopilot automatically splits the input dataset into training and validation sets.

', 'DescribeAutoMLJobV2Response$DataSplitConfig' => '

Returns the configuration settings of how the data are split into train and validation datasets.

', ], ], 'AutoMLFailureReason' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$FailureReason' => '

The failure reason.

', 'AutoMLJobSummary$FailureReason' => '

The failure reason of an AutoML job.

', 'AutoMLPartialFailureReason$PartialFailureMessage' => '

The message containing the reason for a partial failure of an AutoML job.

', 'DescribeAutoMLJobResponse$FailureReason' => '

Returns the failure reason for an AutoML job, when applicable.

', 'DescribeAutoMLJobV2Response$FailureReason' => '

Returns the reason for the failure of the AutoML job V2, when applicable.

', ], ], 'AutoMLInferenceContainerDefinitions' => [ 'base' => '

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the V2 API only (for example, for jobs created by calling CreateAutoMLJobV2).

', 'refs' => [ 'AutoMLCandidate$InferenceContainerDefinitions' => '

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling CreateAutoMLJobV2) related to image or text classification problem types only.

', ], ], 'AutoMLInputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$InputDataConfig' => '

An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

', 'DescribeAutoMLJobResponse$InputDataConfig' => '

Returns the input data configuration for the AutoML job.

', ], ], 'AutoMLJobArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the AutoML job.

', 'AutoMLJobSummary$AutoMLJobArn' => '

The ARN of the AutoML job.

', 'CreateAutoMLJobResponse$AutoMLJobArn' => '

The unique ARN assigned to the AutoML job when it is created.

', 'CreateAutoMLJobV2Response$AutoMLJobArn' => '

The unique ARN assigned to the AutoMLJob when it is created.

', 'DescribeAutoMLJobResponse$AutoMLJobArn' => '

Returns the ARN of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobArn' => '

Returns the Amazon Resource Name (ARN) of the AutoML job V2.

', 'DescribeProcessingJobResponse$AutoMLJobArn' => '

The ARN of an AutoML job associated with this processing job.

', 'DescribeTrainingJobResponse$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of an AutoML job.

', 'DescribeTransformJobResponse$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML transform job.

', 'ProcessingJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

', 'TrainingJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'TransformJob$AutoMLJobArn' => '

The Amazon Resource Name (ARN) of the AutoML job that created the transform job.

', ], ], 'AutoMLJobArtifacts' => [ 'base' => '

The artifacts that are generated during an AutoML job.

', 'refs' => [ 'DescribeAutoMLJobResponse$AutoMLJobArtifacts' => '

Returns information on the job\'s artifacts found in AutoMLJobArtifacts.

', 'DescribeAutoMLJobV2Response$AutoMLJobArtifacts' => NULL, ], ], 'AutoMLJobChannel' => [ 'base' => '

A channel is a named input source that training algorithms can consume. This channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).

', 'refs' => [ 'AutoMLJobInputDataConfig$member' => NULL, ], ], 'AutoMLJobCompletionCriteria' => [ 'base' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'refs' => [ 'AutoMLJobConfig$CompletionCriteria' => '

How long an AutoML job is allowed to run, or how many candidates a job is allowed to generate.

', 'AutoMLResolvedAttributes$CompletionCriteria' => NULL, 'ImageClassificationJobConfig$CompletionCriteria' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'ResolvedAttributes$CompletionCriteria' => NULL, 'TabularJobConfig$CompletionCriteria' => NULL, 'TextClassificationJobConfig$CompletionCriteria' => '

How long a job is allowed to run, or how many candidates a job is allowed to generate.

', 'TextGenerationJobConfig$CompletionCriteria' => '

How long a fine-tuning job is allowed to run. For TextGenerationJobConfig problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h (259200s).

', 'TimeSeriesForecastingJobConfig$CompletionCriteria' => NULL, ], ], 'AutoMLJobConfig' => [ 'base' => '

A collection of settings used for an AutoML job.

', 'refs' => [ 'CreateAutoMLJobRequest$AutoMLJobConfig' => '

A collection of settings used to configure an AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobConfig' => '

Returns the configuration for the AutoML job.

', ], ], 'AutoMLJobInputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLJobInputDataConfig' => '

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters. The supported formats depend on the problem type:

  • For tabular problem types: S3Prefix, ManifestFile.

  • For image classification: S3Prefix, ManifestFile, AugmentedManifestFile.

  • For text classification: S3Prefix.

  • For time-series forecasting: S3Prefix.

  • For text generation (LLMs fine-tuning): S3Prefix.

', 'DescribeAutoMLJobV2Response$AutoMLJobInputDataConfig' => '

Returns an array of channel objects describing the input data and their location.

', ], ], 'AutoMLJobName' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobName' => '

The name of the AutoML job you are requesting.

', 'CreateAutoMLJobRequest$AutoMLJobName' => '

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

', 'CreateAutoMLJobV2Request$AutoMLJobName' => '

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

', 'DescribeAutoMLJobRequest$AutoMLJobName' => '

Requests information about an AutoML job using its unique name.

', 'DescribeAutoMLJobResponse$AutoMLJobName' => '

Returns the name of the AutoML job.

', 'DescribeAutoMLJobV2Request$AutoMLJobName' => '

Requests information about an AutoML job V2 using its unique name.

', 'DescribeAutoMLJobV2Response$AutoMLJobName' => '

Returns the name of the AutoML job V2.

', 'ListCandidatesForAutoMLJobRequest$AutoMLJobName' => '

List the candidates created for the job by providing the job\'s name.

', 'StopAutoMLJobRequest$AutoMLJobName' => '

The name of the object you are requesting.

', ], ], 'AutoMLJobObjective' => [ 'base' => '

Specifies a metric to minimize or maximize as the objective of an AutoML job.

', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLJobObjective' => NULL, 'CreateAutoMLJobRequest$AutoMLJobObjective' => '

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.

', 'CreateAutoMLJobV2Request$AutoMLJobObjective' => '

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. For the list of default values per problem type, see AutoMLJobObjective.

  • For tabular problem types: You must either provide both the AutoMLJobObjective and indicate the type of supervised learning problem in AutoMLProblemTypeConfig (TabularJobConfig.ProblemType), or none at all.

  • For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.

', 'DescribeAutoMLJobResponse$AutoMLJobObjective' => '

Returns the job\'s objective.

', 'DescribeAutoMLJobV2Response$AutoMLJobObjective' => '

Returns the job\'s objective.

', 'ResolvedAttributes$AutoMLJobObjective' => NULL, ], ], 'AutoMLJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Type' => '

The type of metric with the best result.

', ], ], 'AutoMLJobSecondaryStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobSecondaryStatus' => '

The secondary status of the AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobSecondaryStatus' => '

Returns the secondary status of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobSecondaryStatus' => '

Returns the secondary status of the AutoML job V2.

', ], ], 'AutoMLJobStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$AutoMLJobStatus' => '

The status of the AutoML job.

', 'DescribeAutoMLJobResponse$AutoMLJobStatus' => '

Returns the status of the AutoML job.

', 'DescribeAutoMLJobV2Response$AutoMLJobStatus' => '

Returns the status of the AutoML job V2.

', 'ListAutoMLJobsRequest$StatusEquals' => '

Request a list of jobs, using a filter for status.

', ], ], 'AutoMLJobStepMetadata' => [ 'base' => '

Metadata for an AutoML job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$AutoMLJob' => '

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

', ], ], 'AutoMLJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsResponse$AutoMLJobSummaries' => '

Returns a summary list of jobs.

', ], ], 'AutoMLJobSummary' => [ 'base' => '

Provides a summary about an AutoML job.

', 'refs' => [ 'AutoMLJobSummaries$member' => NULL, ], ], 'AutoMLMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$MaxResults' => '

Request a list of jobs up to a specified limit.

', ], ], 'AutoMLMaxResultsForTrials' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobRequest$MaxResults' => '

List the job\'s candidates up to a specified limit.

', ], ], 'AutoMLMetricEnum' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobObjective$MetricName' => '

The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model\'s parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.

The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.

  • For tabular problem types:

    • List of available metrics:

      • Regression: InferenceLatency, MAE, MSE, R2, RMSE

      • Binary classification: Accuracy, AUC, BalancedAccuracy, F1, InferenceLatency, LogLoss, Precision, Recall

      • Multiclass classification: Accuracy, BalancedAccuracy, F1macro, InferenceLatency, LogLoss, PrecisionMacro, RecallMacro

      For a description of each metric, see Autopilot metrics for classification and regression.

    • Default objective metrics:

      • Regression: MSE.

      • Binary classification: F1.

      • Multiclass classification: Accuracy.

  • For image or text classification problem types:

  • For time-series forecasting problem types:

  • For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.

', 'FinalAutoMLJobObjectiveMetric$MetricName' => '

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.

', 'FinalAutoMLJobObjectiveMetric$StandardMetricName' => '

The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.

', 'MetricDatum$MetricName' => '

The name of the metric.

', ], ], 'AutoMLMetricExtendedEnum' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$StandardMetricName' => '

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

', ], ], 'AutoMLMode' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobConfig$Mode' => '

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

', 'TabularJobConfig$Mode' => '

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

', ], ], 'AutoMLNameContains' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$NameContains' => '

Request a list of jobs, using a search filter for name.

', ], ], 'AutoMLOutputDataConfig' => [ 'base' => '

The output data configuration.

', 'refs' => [ 'CreateAutoMLJobRequest$OutputDataConfig' => '

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.

', 'CreateAutoMLJobV2Request$OutputDataConfig' => '

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.

', 'DescribeAutoMLJobResponse$OutputDataConfig' => '

Returns the job\'s output data config.

', 'DescribeAutoMLJobV2Response$OutputDataConfig' => '

Returns the job\'s output data config.

', ], ], 'AutoMLPartialFailureReason' => [ 'base' => '

The reason for a partial failure of an AutoML job.

', 'refs' => [ 'AutoMLPartialFailureReasons$member' => NULL, ], ], 'AutoMLPartialFailureReasons' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobSummary$PartialFailureReasons' => '

The list of reasons for partial failures within an AutoML job.

', 'DescribeAutoMLJobResponse$PartialFailureReasons' => '

Returns a list of reasons for partial failures within an AutoML job.

', 'DescribeAutoMLJobV2Response$PartialFailureReasons' => '

Returns a list of reasons for partial failures within an AutoML job V2.

', ], ], 'AutoMLProblemTypeConfig' => [ 'base' => '

A collection of settings specific to the problem type used to configure an AutoML job V2. There must be one and only one config of the following type.

', 'refs' => [ 'CreateAutoMLJobV2Request$AutoMLProblemTypeConfig' => '

Defines the configuration settings of one of the supported problem types.

', 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfig' => '

Returns the configuration settings of the problem type set for the AutoML job V2.

', ], ], 'AutoMLProblemTypeConfigName' => [ 'base' => NULL, 'refs' => [ 'DescribeAutoMLJobV2Response$AutoMLProblemTypeConfigName' => '

Returns the name of the problem type configuration set for the AutoML job V2.

', ], ], 'AutoMLProblemTypeResolvedAttributes' => [ 'base' => '

Stores resolved attributes specific to the problem type of an AutoML job V2.

', 'refs' => [ 'AutoMLResolvedAttributes$AutoMLProblemTypeResolvedAttributes' => '

Defines the resolved attributes specific to a problem type.

', ], ], 'AutoMLProcessingUnit' => [ 'base' => NULL, 'refs' => [ 'AutoMLInferenceContainerDefinitions$key' => '

Processing unit for an inference container. Currently Autopilot only supports CPU or GPU.

', ], ], 'AutoMLResolvedAttributes' => [ 'base' => '

The resolved attributes used to configure an AutoML job V2.

', 'refs' => [ 'DescribeAutoMLJobV2Response$ResolvedAttributes' => '

Returns the resolved attributes used by the AutoML job V2.

', ], ], 'AutoMLS3DataSource' => [ 'base' => '

Describes the Amazon S3 data source.

', 'refs' => [ 'AutoMLDataSource$S3DataSource' => '

The Amazon S3 location of the input data.

', ], ], 'AutoMLS3DataType' => [ 'base' => NULL, 'refs' => [ 'AutoMLS3DataSource$S3DataType' => '

The data type.

  • If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

    The S3Prefix should have the following format:

    s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE

  • If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

    A ManifestFile should have the format shown below:

    [ {"prefix": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/"},

    "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1",

    "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2",

    ... "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N" ]

  • If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile is available for V2 API jobs only (for example, for jobs created by calling CreateAutoMLJobV2).

    Here is a minimal, single-record example of an AugmentedManifestFile:

    {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",

    "label-metadata": {"class-name": "cat" }

    For more information on AugmentedManifestFile, see Provide Dataset Metadata to Training Jobs with an Augmented Manifest File.

', ], ], 'AutoMLSecurityConfig' => [ 'base' => '

Security options.

', 'refs' => [ 'AutoMLJobConfig$SecurityConfig' => '

The security configuration for traffic encryption or Amazon VPC settings.

', 'CreateAutoMLJobV2Request$SecurityConfig' => '

The security configuration for traffic encryption or Amazon VPC settings.

', 'DescribeAutoMLJobV2Response$SecurityConfig' => '

Returns the security configuration for traffic encryption or Amazon VPC settings.

', ], ], 'AutoMLSortBy' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$SortBy' => '

The parameter by which to sort the results. The default is Name.

', ], ], 'AutoMLSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListAutoMLJobsRequest$SortOrder' => '

The sort order for the results. The default is Descending.

', 'ListCandidatesForAutoMLJobRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', ], ], 'AutoParameter' => [ 'base' => '

The name and an example value of the hyperparameter that you want to use in Autotune. If Automatic model tuning (AMT) determines that your hyperparameter is eligible for Autotune, an optimal hyperparameter range is selected for you.

', 'refs' => [ 'AutoParameters$member' => NULL, ], ], 'AutoParameters' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$AutoParameters' => '

A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.

', ], ], 'AutoRollbackConfig' => [ 'base' => '

Automatic rollback configuration for handling endpoint deployment failures and recovery.

', 'refs' => [ 'DeploymentConfig$AutoRollbackConfiguration' => '

Automatic rollback configuration for handling endpoint deployment failures and recovery.

', ], ], 'Autotune' => [ 'base' => '

A flag to indicate if you want to use Autotune to automatically find optimal values for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$Autotune' => '

Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

', 'DescribeHyperParameterTuningJobResponse$Autotune' => '

A flag to indicate if autotune is enabled for the hyperparameter tuning job.

', ], ], 'AutotuneMode' => [ 'base' => NULL, 'refs' => [ 'Autotune$Mode' => '

Set Mode to Enabled if you want to use Autotune.

', ], ], 'AwsManagedHumanLoopRequestSource' => [ 'base' => NULL, 'refs' => [ 'HumanLoopRequestSource$AwsManagedHumanLoopRequestSource' => '

Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:

', ], ], 'BacktestResultsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$BacktestResults' => '

The Amazon S3 prefix to the accuracy metrics and the inference results observed over the testing window. Available only for the time-series forecasting problem type.

', ], ], 'BaseModelName' => [ 'base' => NULL, 'refs' => [ 'TextGenerationJobConfig$BaseModelName' => '

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no BaseModelName is provided, the default model used is Falcon7BInstruct.

', 'TextGenerationResolvedAttributes$BaseModelName' => '

The name of the base model to fine-tune.

', ], ], 'BatchDataCaptureConfig' => [ 'base' => '

Configuration to control how SageMaker captures inference data for batch transform jobs.

', 'refs' => [ 'CreateTransformJobRequest$DataCaptureConfig' => '

Configuration to control how SageMaker captures inference data.

', 'DescribeTransformJobResponse$DataCaptureConfig' => '

Configuration to control how SageMaker captures inference data.

', 'TransformJob$DataCaptureConfig' => NULL, ], ], 'BatchDescribeModelPackageError' => [ 'base' => '

The error code and error description associated with the resource.

', 'refs' => [ 'BatchDescribeModelPackageErrorMap$value' => NULL, ], ], 'BatchDescribeModelPackageErrorMap' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$BatchDescribeModelPackageErrorMap' => '

A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.

', ], ], 'BatchDescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeModelPackageSummary' => [ 'base' => '

Provides summary information about the model package.

', 'refs' => [ 'ModelPackageSummaries$value' => NULL, ], ], 'BatchStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

', 'DescribeTransformJobResponse$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

', 'TransformJob$BatchStrategy' => '

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

', 'TransformJobDefinition$BatchStrategy' => '

A string that determines the number of records included in a single mini-batch.

SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

', ], ], 'BatchTransformInput' => [ 'base' => '

Input object for the batch transform job.

', 'refs' => [ 'DataQualityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelBiasJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelDashboardMonitoringSchedule$BatchTransformInput' => NULL, 'ModelExplainabilityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'ModelQualityJobInput$BatchTransformInput' => '

Input object for the batch transform job.

', 'MonitoringInput$BatchTransformInput' => '

Input object for the batch transform job.

', ], ], 'BestObjectiveNotImproving' => [ 'base' => '

A structure that keeps track of which training jobs launched by your hyperparameter tuning job are not improving model performance as evaluated against an objective function.

', 'refs' => [ 'TuningJobCompletionCriteria$BestObjectiveNotImproving' => '

A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.

', ], ], 'Bias' => [ 'base' => '

Contains bias metrics for a model.

', 'refs' => [ 'ModelMetrics$Bias' => '

Metrics that measure bais in a model.

', ], ], 'BillableTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$BillableTimeInSeconds' => '

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

', 'TrainingJob$BillableTimeInSeconds' => '

The billable time in seconds.

', ], ], 'BlockedReason' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreStatus$BlockedReason' => '

The justification for why the OfflineStoreStatus is Blocked (if applicable).

', ], ], 'BlueGreenUpdatePolicy' => [ 'base' => '

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

', 'refs' => [ 'DeploymentConfig$BlueGreenUpdatePolicy' => '

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$EnableSageMakerMetricsTimeSeries' => '

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren\'t generated except in the following cases:

', 'AutoMLSecurityConfig$EnableInterContainerTrafficEncryption' => '

Whether to use traffic encryption between the container layers.

', 'BatchDataCaptureConfig$GenerateInferenceId' => '

Flag that indicates whether to append inference id to the output.

', 'ChannelSpecification$IsRequired' => '

Indicates whether the channel is required by the algorithm.

', 'ClarifyCheckStepMetadata$SkipCheck' => '

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

', 'ClarifyCheckStepMetadata$RegisterNewBaseline' => '

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

', 'CreateEndpointConfigInput$EnableNetworkIsolation' => '

Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

', 'CreateModelInput$EnableNetworkIsolation' => '

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

', 'CreateTrainingJobRequest$EnableNetworkIsolation' => '

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'CreateTrainingJobRequest$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

', 'CreateTrainingJobRequest$EnableManagedSpotTraining' => '

To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

', 'DescribeEndpointConfigOutput$EnableNetworkIsolation' => '

Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

', 'DescribeModelOutput$EnableNetworkIsolation' => '

If True, no inbound or outbound network calls can be made to or from the model container.

', 'DescribeTrainingJobResponse$EnableNetworkIsolation' => '

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'DescribeTrainingJobResponse$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

', 'DescribeTrainingJobResponse$EnableManagedSpotTraining' => '

A Boolean indicating whether managed spot training is enabled (True) or not (False).

', 'HyperParameterSpecification$IsTunable' => '

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

', 'HyperParameterSpecification$IsRequired' => '

Indicates whether this hyperparameter is required.

', 'HyperParameterTrainingJobDefinition$EnableNetworkIsolation' => '

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

', 'HyperParameterTrainingJobDefinition$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

', 'HyperParameterTrainingJobDefinition$EnableManagedSpotTraining' => '

A Boolean indicating whether managed spot training is enabled (True) or not (False).

', 'ListStageDevicesRequest$ExcludeDevicesDeployedInOtherStage' => '

Toggle for excluding devices deployed in other stages.

', 'Model$EnableNetworkIsolation' => '

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

', 'ModelDashboardIndicatorAction$Enabled' => '

Indicates whether the alert action is turned on.

', 'MonitoringCsvDatasetFormat$Header' => '

Indicates if the CSV data has a header.

', 'MonitoringJsonDatasetFormat$Line' => '

Indicates if the file should be read as a JSON object per line.

', 'MonitoringNetworkConfig$EnableInterContainerTrafficEncryption' => '

Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.

', 'MonitoringNetworkConfig$EnableNetworkIsolation' => '

Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.

', 'NetworkConfig$EnableInterContainerTrafficEncryption' => '

Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

', 'NetworkConfig$EnableNetworkIsolation' => '

Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

', 'OfflineStoreConfig$DisableGlueTableCreation' => '

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena\'s naming recommendations.

The default value is False.

', 'OnlineStoreConfig$EnableOnlineStore' => '

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False.

', 'QualityCheckStepMetadata$SkipCheck' => '

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

', 'QualityCheckStepMetadata$RegisterNewBaseline' => '

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.

', 'QueryLineageRequest$IncludeEdges' => '

Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

', 'TrainingJob$EnableNetworkIsolation' => '

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can\'t communicate beyond the VPC they run in.

', 'TrainingJob$EnableInterContainerTrafficEncryption' => '

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

', 'TrainingJob$EnableManagedSpotTraining' => '

When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

', 'TrainingSpecification$SupportsDistributedTraining' => '

Indicates whether the algorithm supports distributed training. If set to false, buyers can\'t request more than one instance during training.

', 'UpdateEndpointInput$RetainAllVariantProperties' => '

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.

', 'UpdateEndpointInput$RetainDeploymentConfig' => '

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

', ], ], 'BooleanOperator' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$Operator' => '

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

', ], ], 'Branch' => [ 'base' => NULL, 'refs' => [ 'GitConfig$Branch' => '

The default branch for the Git repository.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$Bucket' => '

Name of the S3 bucket.

', ], ], 'CacheHitResult' => [ 'base' => '

Details on the cache hit of a pipeline execution step.

', 'refs' => [ 'PipelineExecutionStep$CacheHitResult' => '

If this pipeline execution step was cached, details on the cache hit.

', ], ], 'CallbackStepMetadata' => [ 'base' => '

Metadata about a callback step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Callback' => '

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

', ], ], 'CallbackToken' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', 'SendPipelineExecutionStepFailureRequest$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', 'SendPipelineExecutionStepSuccessRequest$CallbackToken' => '

The pipeline generated token from the Amazon SQS queue.

', ], ], 'CandidateArtifactLocations' => [ 'base' => '

The location of artifacts for an AutoML candidate job.

', 'refs' => [ 'CandidateProperties$CandidateArtifactLocations' => '

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

', ], ], 'CandidateDefinitionNotebookLocation' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobArtifacts$CandidateDefinitionNotebookLocation' => '

The URL of the notebook location.

', ], ], 'CandidateGenerationConfig' => [ 'base' => '

Stores the configuration information for how model candidates are generated using an AutoML job V2.

', 'refs' => [ 'TabularJobConfig$CandidateGenerationConfig' => '

The configuration information of how model candidates are generated.

', ], ], 'CandidateName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateName' => '

The name of the candidate.

', 'ListCandidatesForAutoMLJobRequest$CandidateNameEquals' => '

List the candidates for the job and filter by candidate name.

', ], ], 'CandidateProperties' => [ 'base' => '

The properties of an AutoML candidate job.

', 'refs' => [ 'AutoMLCandidate$CandidateProperties' => '

The properties of an AutoML candidate job.

', ], ], 'CandidateSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCandidatesForAutoMLJobRequest$SortBy' => '

The parameter by which to sort the results. The default is Descending.

', ], ], 'CandidateStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateStatus' => '

The candidate\'s status.

', 'ListCandidatesForAutoMLJobRequest$StatusEquals' => '

List the candidates for the job and filter by status.

', ], ], 'CandidateStepArn' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepArn' => '

The ARN for the candidate\'s step.

', ], ], 'CandidateStepName' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepName' => '

The name for the candidate\'s step.

', ], ], 'CandidateStepType' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidateStep$CandidateStepType' => '

Whether the candidate is at the transform, training, or processing step.

', ], ], 'CandidateSteps' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$CandidateSteps' => '

Information about the candidate\'s steps.

', ], ], 'CanvasAppSettings' => [ 'base' => '

The SageMaker Canvas application settings.

', 'refs' => [ 'UserSettings$CanvasAppSettings' => '

The Canvas app settings.

', ], ], 'CapacitySize' => [ 'base' => '

Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your fleet.

For a rollback strategy, if you don\'t specify the fields in this object, or if you set the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

', 'refs' => [ 'RollingUpdatePolicy$MaximumBatchSize' => '

Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between 5% to 50% of the variant\'s total instance count.

', 'RollingUpdatePolicy$RollbackMaximumBatchSize' => '

Batch size for rollback to the old endpoint fleet. Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.

', 'TrafficRoutingConfig$CanarySize' => '

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant\'s total instance count.

', 'TrafficRoutingConfig$LinearStepSize' => '

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant\'s total instance count.

', ], ], 'CapacitySizeType' => [ 'base' => NULL, 'refs' => [ 'CapacitySize$Type' => '

Specifies the endpoint capacity type.

  • INSTANCE_COUNT: The endpoint activates based on the number of instances.

  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.

', ], ], 'CapacitySizeValue' => [ 'base' => NULL, 'refs' => [ 'CapacitySize$Value' => '

Defines the capacity size, either as a number of instances or a capacity percentage.

', ], ], 'CapacityUnit' => [ 'base' => NULL, 'refs' => [ 'ThroughputConfig$ProvisionedReadCapacityUnits' => '

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfig$ProvisionedWriteCapacityUnits' => '

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfigDescription$ProvisionedReadCapacityUnits' => '

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfigDescription$ProvisionedWriteCapacityUnits' => '

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

', 'ThroughputConfigUpdate$ProvisionedReadCapacityUnits' => '

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

', 'ThroughputConfigUpdate$ProvisionedWriteCapacityUnits' => '

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

', ], ], 'CaptureContentTypeHeader' => [ 'base' => '

Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker will by default base64 encode when capturing the data.

', 'refs' => [ 'DataCaptureConfig$CaptureContentTypeHeader' => '

Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

', 'InferenceExperimentDataStorageConfig$ContentType' => NULL, ], ], 'CaptureMode' => [ 'base' => NULL, 'refs' => [ 'CaptureOption$CaptureMode' => '

Specify the boundary of data to capture.

', ], ], 'CaptureOption' => [ 'base' => '

Specifies data Model Monitor will capture.

', 'refs' => [ 'CaptureOptionList$member' => NULL, ], ], 'CaptureOptionList' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$CaptureOptions' => '

Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

', ], ], 'CaptureStatus' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfigSummary$CaptureStatus' => '

Whether data capture is currently functional.

', ], ], 'Catalog' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Catalog' => '

The name of the Glue table catalog.

', ], ], 'CategoricalParameter' => [ 'base' => '

Environment parameters you want to benchmark your load test against.

', 'refs' => [ 'CategoricalParameters$member' => NULL, ], ], 'CategoricalParameterRange' => [ 'base' => '

A list of categorical hyperparameters to tune.

', 'refs' => [ 'CategoricalParameterRanges$member' => NULL, ], ], 'CategoricalParameterRangeSpecification' => [ 'base' => '

Defines the possible values for a categorical hyperparameter.

', 'refs' => [ 'ParameterRange$CategoricalParameterRangeSpecification' => '

A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

', ], ], 'CategoricalParameterRangeValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameter$Value' => '

The list of values you can pass.

', ], ], 'CategoricalParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$CategoricalParameterRanges' => '

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

', ], ], 'CategoricalParameters' => [ 'base' => NULL, 'refs' => [ 'EnvironmentParameterRanges$CategoricalParameterRanges' => '

Specified a list of parameters for each category.

', ], ], 'Cents' => [ 'base' => NULL, 'refs' => [ 'USD$Cents' => '

The fractional portion, in cents, of the amount.

', ], ], 'CertifyForMarketplace' => [ 'base' => NULL, 'refs' => [ 'CreateAlgorithmInput$CertifyForMarketplace' => '

Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

', 'CreateModelPackageInput$CertifyForMarketplace' => '

Whether to certify the model package for listing on Amazon Web Services Marketplace.

This parameter is optional for unversioned models, and does not apply to versioned models.

', 'DescribeAlgorithmOutput$CertifyForMarketplace' => '

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

', 'DescribeModelPackageOutput$CertifyForMarketplace' => '

Whether the model package is certified for listing on Amazon Web Services Marketplace.

', 'ModelPackage$CertifyForMarketplace' => '

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

', ], ], 'Channel' => [ 'base' => '

A channel is a named input source that training algorithms can consume.

', 'refs' => [ 'InputDataConfig$member' => NULL, ], ], 'ChannelName' => [ 'base' => NULL, 'refs' => [ 'Channel$ChannelName' => '

The name of the channel.

', 'ChannelSpecification$Name' => '

The name of the channel.

', ], ], 'ChannelSpecification' => [ 'base' => '

Defines a named input source, called a channel, to be used by an algorithm.

', 'refs' => [ 'ChannelSpecifications$member' => NULL, ], ], 'ChannelSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$TrainingChannels' => '

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

', ], ], 'CheckpointConfig' => [ 'base' => '

Contains information about the output location for managed spot training checkpoint data.

', 'refs' => [ 'CreateTrainingJobRequest$CheckpointConfig' => '

Contains information about the output location for managed spot training checkpoint data.

', 'DescribeTrainingJobResponse$CheckpointConfig' => NULL, 'HyperParameterTrainingJobDefinition$CheckpointConfig' => NULL, 'TrainingJob$CheckpointConfig' => NULL, ], ], 'Cidr' => [ 'base' => NULL, 'refs' => [ 'Cidrs$member' => NULL, ], ], 'Cidrs' => [ 'base' => NULL, 'refs' => [ 'SourceIpConfig$Cidrs' => '

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

Maximum: Ten CIDR values

The following Length Constraints apply to individual CIDR values in the CIDR value list.

', ], ], 'ClarifyCheckStepMetadata' => [ 'base' => '

The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'PipelineExecutionStepMetadata$ClarifyCheck' => '

Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted,

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

', ], ], 'ClarifyContentTemplate' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ContentTemplate' => '

A template string used to format a JSON record into an acceptable model container input. For example, a ContentTemplate string \'{"myfeatures":$features}\' will format a list of features [1,2,3] into the record string \'{"myfeatures":[1,2,3]}\'. Required only when the model container input is in JSON Lines format.

', ], ], 'ClarifyEnableExplanations' => [ 'base' => NULL, 'refs' => [ 'ClarifyExplainerConfig$EnableExplanations' => '

A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.

', ], ], 'ClarifyExplainerConfig' => [ 'base' => '

The configuration parameters for the SageMaker Clarify explainer.

', 'refs' => [ 'ExplainerConfig$ClarifyExplainerConfig' => '

A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.

', ], ], 'ClarifyFeatureHeaders' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeatureHeaders' => '

The names of the features. If provided, these are included in the endpoint response payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint in the Developer Guide for more information.

', ], ], 'ClarifyFeatureType' => [ 'base' => NULL, 'refs' => [ 'ClarifyFeatureTypes$member' => NULL, ], ], 'ClarifyFeatureTypes' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeatureTypes' => '

A list of data types of the features (optional). Applicable only to NLP explainability. If provided, FeatureTypes must have at least one \'text\' string (for example, [\'text\']). If FeatureTypes is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the response section under Invoke the endpoint in the Developer Guide for more information.

', ], ], 'ClarifyFeaturesAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$FeaturesAttribute' => '

Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if FeaturesAttribute is the JMESPath expression \'myfeatures\', it extracts a list of features [1,2,3] from request data \'{"myfeatures":[1,2,3]}\'.

', ], ], 'ClarifyHeader' => [ 'base' => NULL, 'refs' => [ 'ClarifyFeatureHeaders$member' => NULL, 'ClarifyLabelHeaders$member' => NULL, ], ], 'ClarifyInferenceConfig' => [ 'base' => '

The inference configuration parameter for the model container.

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

The inference configuration parameter for the model container.

', ], ], 'ClarifyLabelAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelAttribute' => '

A JMESPath expression used to locate the list of label headers in the model container output.

Example: If the model container output of a batch request is \'{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}\', then set LabelAttribute to \'labels\' to extract the list of label headers ["cat","dog","fish"]

', ], ], 'ClarifyLabelHeaders' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelHeaders' => '

For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the InvokeEndpoint API. See the response section under Invoke the endpoint in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.

', ], ], 'ClarifyLabelIndex' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$LabelIndex' => '

A zero-based index used to extract a label header or list of label headers from model container output in CSV format.

Example for a multiclass model: If the model container output consists of label headers followed by probabilities: \'"[\\\'cat\\\',\\\'dog\\\',\\\'fish\\\']","[0.1,0.6,0.3]"\', set LabelIndex to 0 to select the label headers [\'cat\',\'dog\',\'fish\'].

', ], ], 'ClarifyMaxPayloadInMB' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$MaxPayloadInMB' => '

The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.

', ], ], 'ClarifyMaxRecordCount' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$MaxRecordCount' => '

The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If MaxRecordCount is 1, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container\'s capacity at runtime.

', ], ], 'ClarifyMimeType' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapBaselineConfig$MimeType' => '

The MIME type of the baseline data. Choose from \'text/csv\' or \'application/jsonlines\'. Defaults to \'text/csv\'.

', ], ], 'ClarifyProbabilityAttribute' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ProbabilityAttribute' => '

A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.

Example: If the model container output of a single request is \'{"predicted_label":1,"probability":0.6}\', then set ProbabilityAttribute to \'probability\'.

', ], ], 'ClarifyProbabilityIndex' => [ 'base' => NULL, 'refs' => [ 'ClarifyInferenceConfig$ProbabilityIndex' => '

A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.

Example for a single class model: If the model container output consists of a string-formatted prediction label followed by its probability: \'1,0.6\', set ProbabilityIndex to 1 to select the probability value 0.6.

Example for a multiclass model: If the model container output consists of a string-formatted prediction label followed by its probability: \'"[\\\'cat\\\',\\\'dog\\\',\\\'fish\\\']","[0.1,0.6,0.3]"\', set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3].

', ], ], 'ClarifyShapBaseline' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapBaselineConfig$ShapBaseline' => '

The inline SHAP baseline data in string format. ShapBaseline can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the Granularity of the TextConfig parameter. The size limit for ShapBasline is 4 KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB of baseline data.

', ], ], 'ClarifyShapBaselineConfig' => [ 'base' => '

The configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.

  • The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

  • ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.

', 'refs' => [ 'ClarifyShapConfig$ShapBaselineConfig' => '

The configuration for the SHAP baseline of the Kernal SHAP algorithm.

', ], ], 'ClarifyShapConfig' => [ 'base' => '

The configuration for SHAP analysis using SageMaker Clarify Explainer.

', 'refs' => [ 'ClarifyExplainerConfig$ShapConfig' => '

The configuration for SHAP analysis.

', ], ], 'ClarifyShapNumberOfSamples' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$NumberOfSamples' => '

The number of samples to be used for analysis by the Kernal SHAP algorithm.

The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

', ], ], 'ClarifyShapSeed' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$Seed' => '

The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.

', ], ], 'ClarifyShapUseLogit' => [ 'base' => NULL, 'refs' => [ 'ClarifyShapConfig$UseLogit' => '

A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.

', ], ], 'ClarifyTextConfig' => [ 'base' => '

A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text. Required only for natural language processing (NLP) explainability.

', 'refs' => [ 'ClarifyShapConfig$TextConfig' => '

A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. Required for natural language processing (NLP) explainability only.

', ], ], 'ClarifyTextGranularity' => [ 'base' => NULL, 'refs' => [ 'ClarifyTextConfig$Granularity' => '

The unit of granularity for the analysis of text features. For example, if the unit is \'token\', then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.

', ], ], 'ClarifyTextLanguage' => [ 'base' => NULL, 'refs' => [ 'ClarifyTextConfig$Language' => '

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

For a mix of multiple languages, use code \'xx\'.

', ], ], 'ClientId' => [ 'base' => NULL, 'refs' => [ 'CognitoConfig$ClientId' => '

The client ID for your Amazon Cognito user pool.

', 'CognitoMemberDefinition$ClientId' => '

An identifier for an application client. You must create the app client ID using Amazon Cognito.

', 'OidcConfig$ClientId' => '

The OIDC IdP client ID used to configure your private workforce.

', 'OidcConfigForResponse$ClientId' => '

The OIDC IdP client ID used to configure your private workforce.

', ], ], 'ClientSecret' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$ClientSecret' => '

The OIDC IdP client secret used to configure your private workforce.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ClientToken' => '

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

', 'CreateModelPackageInput$ClientToken' => '

A unique token that guarantees that the call to this API is idempotent.

', ], ], 'ClusterArn' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'CreateClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the cluster.

', 'DeleteClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

', 'DescribeClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'UpdateClusterResponse$ClusterArn' => '

The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$TargetCount' => '

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceCount' => '

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceGroupDetails' => [ 'base' => '

Details of an instance group in a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterInstanceGroupDetailsList$member' => NULL, ], ], 'ClusterInstanceGroupDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribeClusterResponse$InstanceGroups' => '

The instance groups of the SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceGroupName' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$InstanceGroupName' => '

The name of the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceGroupName' => '

Specifies the name of the instance group.

', 'ClusterNodeDetails$InstanceGroupName' => '

The instance group name in which the instance is.

', 'ClusterNodeSummary$InstanceGroupName' => '

The name of the instance group in which the instance is.

', 'ListClusterNodesRequest$InstanceGroupNameContains' => '

A filter that returns the instance groups whose name contain a specified string.

', ], ], 'ClusterInstanceGroupSpecification' => [ 'base' => '

The specifications of an instance group that you need to define.

', 'refs' => [ 'ClusterInstanceGroupSpecifications$member' => NULL, ], ], 'ClusterInstanceGroupSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateClusterRequest$InstanceGroups' => '

The instance groups to be created in the SageMaker HyperPod cluster.

', 'UpdateClusterRequest$InstanceGroups' => '

Specify the instance groups to update.

', ], ], 'ClusterInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceStatusDetails$Status' => '

The status of an instance in a SageMaker HyperPod cluster.

', ], ], 'ClusterInstanceStatusDetails' => [ 'base' => '

Details of an instance in a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterNodeDetails$InstanceStatus' => '

The status of the instance.

', 'ClusterNodeSummary$InstanceStatus' => '

The status of the instance.

', ], ], 'ClusterInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$InstanceType' => '

The instance type of the instance group of a SageMaker HyperPod cluster.

', 'ClusterInstanceGroupSpecification$InstanceType' => '

Specifies the instance type of the instance group.

', 'ClusterNodeDetails$InstanceType' => '

The type of the instance.

', 'ClusterNodeSummary$InstanceType' => '

The type of the instance.

', ], ], 'ClusterLifeCycleConfig' => [ 'base' => '

The LifeCycle configuration for a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterInstanceGroupDetails$LifeCycleConfig' => '

Details of LifeCycle configuration for the instance group.

', 'ClusterInstanceGroupSpecification$LifeCycleConfig' => '

Specifies the LifeCycle configuration for the instance group.

', 'ClusterNodeDetails$LifeCycleConfig' => '

The LifeCycle configuration applied to the instance.

', ], ], 'ClusterLifeCycleConfigFileName' => [ 'base' => NULL, 'refs' => [ 'ClusterLifeCycleConfig$OnCreate' => '

The directory of the LifeCycle script under SourceS3Uri. This LifeCycle script runs during cluster creation.

', ], ], 'ClusterName' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterName' => '

The name of the SageMaker HyperPod cluster.

', 'CreateClusterRequest$ClusterName' => '

The name for the new SageMaker HyperPod cluster.

', 'DescribeClusterResponse$ClusterName' => '

The name of the SageMaker HyperPod cluster.

', ], ], 'ClusterNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DeleteClusterRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

', 'DescribeClusterNodeRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the instance is.

', 'DescribeClusterRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

', 'ListClusterNodesRequest$ClusterName' => '

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

', 'UpdateClusterRequest$ClusterName' => '

Specify the name of the SageMaker HyperPod cluster you want to update.

', ], ], 'ClusterNodeDetails' => [ 'base' => '

Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

', 'refs' => [ 'DescribeClusterNodeResponse$NodeDetails' => '

The details of the instance.

', ], ], 'ClusterNodeId' => [ 'base' => NULL, 'refs' => [ 'DescribeClusterNodeRequest$NodeId' => '

The ID of the instance.

', ], ], 'ClusterNodeSummaries' => [ 'base' => NULL, 'refs' => [ 'ListClusterNodesResponse$ClusterNodeSummaries' => '

The summaries of listed instances in a SageMaker HyperPod cluster

', ], ], 'ClusterNodeSummary' => [ 'base' => '

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterNodeSummaries$member' => NULL, ], ], 'ClusterNonNegativeInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$CurrentCount' => '

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

', ], ], 'ClusterSortBy' => [ 'base' => NULL, 'refs' => [ 'ListClusterNodesRequest$SortBy' => '

The field by which to sort results. The default value is CREATION_TIME.

', 'ListClustersRequest$SortBy' => '

The field by which to sort results. The default value is CREATION_TIME.

', ], ], 'ClusterStatus' => [ 'base' => NULL, 'refs' => [ 'ClusterSummary$ClusterStatus' => '

The status of the SageMaker HyperPod cluster.

', 'DescribeClusterResponse$ClusterStatus' => '

The status of the SageMaker HyperPod cluster.

', ], ], 'ClusterSummaries' => [ 'base' => NULL, 'refs' => [ 'ListClustersResponse$ClusterSummaries' => '

The summaries of listed SageMaker HyperPod clusters.

', ], ], 'ClusterSummary' => [ 'base' => '

Lists a summary of the properties of a SageMaker HyperPod cluster.

', 'refs' => [ 'ClusterSummaries$member' => NULL, ], ], 'ClusterThreadsPerCore' => [ 'base' => NULL, 'refs' => [ 'ClusterInstanceGroupDetails$ThreadsPerCore' => '

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

', 'ClusterInstanceGroupSpecification$ThreadsPerCore' => '

Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn\'t support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

', 'ClusterNodeDetails$ThreadsPerCore' => '

The number of threads per CPU core you specified under CreateCluster.

', ], ], 'CodeEditorAppSettings' => [ 'base' => '

The Code Editor application settings.

For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.

', 'refs' => [ 'UserSettings$CodeEditorAppSettings' => '

The Code Editor application settings.

', ], ], 'CodeRepositories' => [ 'base' => NULL, 'refs' => [ 'JupyterLabAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

', 'JupyterServerAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.

', 'SpaceJupyterLabAppSettings$CodeRepositories' => '

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

', ], ], 'CodeRepository' => [ 'base' => '

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

', 'refs' => [ 'CodeRepositories$member' => NULL, ], ], 'CodeRepositoryArn' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the Git repository.

', 'CreateCodeRepositoryOutput$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the new repository.

', 'DescribeCodeRepositoryOutput$CodeRepositoryArn' => '

The Amazon Resource Name (ARN) of the Git repository.

', 'UpdateCodeRepositoryOutput$CodeRepositoryArn' => '

The ARN of the Git repository.

', ], ], 'CodeRepositoryContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$DefaultCodeRepositoryContains' => '

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

', ], ], 'CodeRepositoryNameContains' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$NameContains' => '

A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.

', ], ], 'CodeRepositoryNameOrUrl' => [ 'base' => NULL, 'refs' => [ 'AdditionalCodeRepositoryNamesOrUrls$member' => NULL, 'CreateNotebookInstanceInput$DefaultCodeRepository' => '

A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'DescribeNotebookInstanceOutput$DefaultCodeRepository' => '

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'ListNotebookInstancesInput$AdditionalCodeRepositoryEquals' => '

A filter that returns only notebook instances with associated with the specified git repository.

', 'NotebookInstanceSummary$DefaultCodeRepository' => '

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', 'UpdateNotebookInstanceInput$DefaultCodeRepository' => '

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

', ], ], 'CodeRepositorySortBy' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'CodeRepositorySortOrder' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesInput$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'CodeRepositorySummary' => [ 'base' => '

Specifies summary information about a Git repository.

', 'refs' => [ 'CodeRepositorySummaryList$member' => NULL, ], ], 'CodeRepositorySummaryList' => [ 'base' => NULL, 'refs' => [ 'ListCodeRepositoriesOutput$CodeRepositorySummaryList' => '

Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:

  • Name

  • Amazon Resource Name (ARN)

  • Creation time

  • Last modified time

  • Configuration information, including the URL location of the repository and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', ], ], 'CognitoConfig' => [ 'base' => '

Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

', 'refs' => [ 'CreateWorkforceRequest$CognitoConfig' => '

Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

', 'Workforce$CognitoConfig' => '

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

', ], ], 'CognitoMemberDefinition' => [ 'base' => '

Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.

', 'refs' => [ 'MemberDefinition$CognitoMemberDefinition' => '

The Amazon Cognito user group that is part of the work team.

', ], ], 'CognitoUserGroup' => [ 'base' => NULL, 'refs' => [ 'CognitoMemberDefinition$UserGroup' => '

An identifier for a user group.

', ], ], 'CognitoUserPool' => [ 'base' => NULL, 'refs' => [ 'CognitoConfig$UserPool' => '

A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.

', 'CognitoMemberDefinition$UserPool' => '

An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

', ], ], 'CollectionConfig' => [ 'base' => '

Configuration for your collection.

', 'refs' => [ 'FeatureDefinition$CollectionConfig' => '

Configuration for your collection.

', ], ], 'CollectionConfiguration' => [ 'base' => '

Configuration information for the Amazon SageMaker Debugger output tensor collections.

', 'refs' => [ 'CollectionConfigurations$member' => NULL, ], ], 'CollectionConfigurations' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$CollectionConfigurations' => '

Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', ], ], 'CollectionName' => [ 'base' => NULL, 'refs' => [ 'CollectionConfiguration$CollectionName' => '

The name of the tensor collection. The name must be unique relative to other rule configuration names.

', ], ], 'CollectionParameters' => [ 'base' => NULL, 'refs' => [ 'CollectionConfiguration$CollectionParameters' => '

Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".

', ], ], 'CollectionType' => [ 'base' => NULL, 'refs' => [ 'FeatureDefinition$CollectionType' => '

A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).

  • List: An ordered collection of elements.

  • Set: An unordered collection of unique elements.

  • Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

', ], ], 'CompilationJobArn' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationJobArn' => '

The Amazon Resource Name (ARN) of the model compilation job.

', 'CreateCompilationJobResponse$CompilationJobArn' => '

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:

  • CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.

', 'DescribeCompilationJobResponse$CompilationJobArn' => '

The Amazon Resource Name (ARN) of the model compilation job.

', ], ], 'CompilationJobStatus' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationJobStatus' => '

The status of the model compilation job.

', 'DescribeCompilationJobResponse$CompilationJobStatus' => '

The status of the model compilation job.

', 'ListCompilationJobsRequest$StatusEquals' => '

A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.

', ], ], 'CompilationJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListCompilationJobsResponse$CompilationJobSummaries' => '

An array of CompilationJobSummary objects, each describing a model compilation job.

', ], ], 'CompilationJobSummary' => [ 'base' => '

A summary of a model compilation job.

', 'refs' => [ 'CompilationJobSummaries$member' => NULL, ], ], 'CompilerOptions' => [ 'base' => NULL, 'refs' => [ 'OutputConfig$CompilerOptions' => '

Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.

  • DTYPE: Specifies the data type for the input. When compiling for ml_* (except for ml_inf) instances using PyTorch framework, provide the data type (dtype) of the model\'s input. "float32" is used if "DTYPE" is not specified. Options for data type are:

    • float32: Use either "float" or "float32".

    • int64: Use either "int64" or "long".

    For example, {"dtype" : "float32"}.

  • CPU: Compilation for CPU supports the following compiler options.

    • mcpu: CPU micro-architecture. For example, {\'mcpu\': \'skylake-avx512\'}

    • mattr: CPU flags. For example, {\'mattr\': [\'+neon\', \'+vfpv4\']}

  • ARM: Details of ARM CPU compilations.

    • NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.

      For example, add {\'mattr\': [\'+neon\']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.

  • NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.

    • gpu_code: Specifies the targeted architecture.

    • trt-ver: Specifies the TensorRT versions in x.y.z. format.

    • cuda-ver: Specifies the CUDA version in x.y format.

    For example, {\'gpu-code\': \'sm_72\', \'trt-ver\': \'6.0.1\', \'cuda-ver\': \'10.1\'}

  • ANDROID: Compilation for the Android OS supports the following compiler options:

    • ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {\'ANDROID_PLATFORM\': 28}.

    • mattr: Add {\'mattr\': [\'+neon\']} to compiler options if compiling for ARM 32-bit platform with NEON support.

  • INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, "CompilerOptions": "\\"--verbose 1 --num-neuroncores 2 -O2\\"".

    For information about supported compiler options, see Neuron Compiler CLI Reference Guide.

  • CoreML: Compilation for the CoreML OutputConfig TargetDevice supports the following compiler options:

    • class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {"class_labels": "imagenet_labels_1000.txt"}. Labels inside the txt file should be separated by newlines.

  • EIA: Compilation for the Elastic Inference Accelerator supports the following compiler options:

    • precision_mode: Specifies the precision of compiled artifacts. Supported values are "FP16" and "FP32". Default is "FP32".

    • signature_def_key: Specifies the signature to use for models in SavedModel format. Defaults is TensorFlow\'s default signature def key.

    • output_names: Specifies a list of output tensor names for models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.

    For example: {"precision_mode": "FP32", "output_names": ["output:0"]}

', ], ], 'CompleteOnConvergence' => [ 'base' => NULL, 'refs' => [ 'ConvergenceDetected$CompleteOnConvergence' => '

A flag to stop a tuning job once AMT has detected that the job has converged.

', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$CompressionType' => '

The type of compression used for an additional data source used in inference or training. Specify None if your additional data source is not compressed.

', 'AutoMLChannel$CompressionType' => '

You can use Gzip or None. The default value is None.

', 'AutoMLJobChannel$CompressionType' => '

The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default to None.

', 'Channel$CompressionType' => '

If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

', 'CompressionTypes$member' => NULL, 'TransformInput$CompressionType' => '

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

', ], ], 'CompressionTypes' => [ 'base' => NULL, 'refs' => [ 'ChannelSpecification$SupportedCompressionTypes' => '

The allowed compression types, if data compression is used.

', ], ], 'ConditionOutcome' => [ 'base' => NULL, 'refs' => [ 'ConditionStepMetadata$Outcome' => '

The outcome of the Condition step evaluation.

', ], ], 'ConditionStepMetadata' => [ 'base' => '

Metadata for a Condition step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Condition' => '

The outcome of the condition evaluation that was run by this step execution.

', ], ], 'ConfigKey' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$key' => NULL, 'HookParameters$key' => NULL, 'ProfilingParameters$key' => NULL, 'RuleParameters$key' => NULL, ], ], 'ConfigValue' => [ 'base' => NULL, 'refs' => [ 'CollectionParameters$value' => NULL, 'HookParameters$value' => NULL, 'ProfilingParameters$value' => NULL, 'RuleParameters$value' => NULL, ], ], 'ConflictException' => [ 'base' => '

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

', 'refs' => [], ], 'ContainerArgument' => [ 'base' => NULL, 'refs' => [ 'ContainerArguments$member' => NULL, 'MonitoringContainerArguments$member' => NULL, ], ], 'ContainerArguments' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ContainerArguments' => '

The arguments for a container used to run a processing job.

', ], ], 'ContainerConfig' => [ 'base' => '

The configuration used to run the application image container.

', 'refs' => [ 'JupyterLabAppImageConfig$ContainerConfig' => NULL, ], ], 'ContainerDefinition' => [ 'base' => '

Describes the container, as part of model definition.

', 'refs' => [ 'ContainerDefinitionList$member' => NULL, 'CreateModelInput$PrimaryContainer' => '

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

', 'DescribeModelOutput$PrimaryContainer' => '

The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

', 'Model$PrimaryContainer' => NULL, ], ], 'ContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$Containers' => '

Specifies the containers in the inference pipeline.

', 'DescribeModelOutput$Containers' => '

The containers in the inference pipeline.

', 'Model$Containers' => '

The containers in the inference pipeline.

', ], ], 'ContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ContainerEntrypoint' => '

The entrypoint for a container used to run a processing job.

', 'DataQualityAppSpecification$ContainerEntrypoint' => '

The entrypoint for a container used to run a monitoring job.

', 'ModelQualityAppSpecification$ContainerEntrypoint' => '

Specifies the entrypoint for a container that the monitoring job runs.

', 'MonitoringAppSpecification$ContainerEntrypoint' => '

Specifies the entrypoint for a container used to run the monitoring job.

', ], ], 'ContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'ContainerEntrypoint$member' => NULL, ], ], 'ContainerHostname' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ContainerHostname' => '

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don\'t specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

', 'ModelPackageContainerDefinition$ContainerHostname' => '

The DNS host name for the Docker container.

', ], ], 'ContainerImage' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Image' => '

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.

', 'ContainerDefinition$Image' => '

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

', 'DeployedImage$SpecifiedImage' => '

The image path you specified when you created the model.

', 'DeployedImage$ResolvedImage' => '

The specific digest path of the image hosted in this ProductionVariant.

', 'InferenceComponentContainerSpecification$Image' => '

The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

', 'ModelPackageContainerDefinition$Image' => '

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

', 'TrainingSpecification$TrainingImage' => '

The Amazon ECR registry path of the Docker image that contains the training algorithm.

', ], ], 'ContainerMode' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$Mode' => '

Whether the container hosts a single model or multiple models.

', ], ], 'ContentClassifier' => [ 'base' => NULL, 'refs' => [ 'ContentClassifiers$member' => NULL, ], ], 'ContentClassifiers' => [ 'base' => NULL, 'refs' => [ 'LabelingJobDataAttributes$ContentClassifiers' => '

Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

', ], ], 'ContentColumn' => [ 'base' => NULL, 'refs' => [ 'TextClassificationJobConfig$ContentColumn' => '

The name of the column used to provide the sentences to be classified. It should not be the same as the target column.

', ], ], 'ContentDigest' => [ 'base' => NULL, 'refs' => [ 'FileSource$ContentDigest' => '

The digest of the file source.

', 'MetricsSource$ContentDigest' => '

The hash key used for the metrics source.

', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$ContentType' => '

The content type of the data from the input source. You can use text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

', 'AutoMLJobChannel$ContentType' => '

The content type of the data from the input source. The following are the allowed content types for different problems:

  • For tabular problem types: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For image classification: image/png, image/jpeg, or image/*. The default value is image/*.

  • For text classification: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For time-series forecasting: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For text generation (LLMs fine-tuning): text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

', 'Channel$ContentType' => '

The MIME type of the data.

', 'ContentTypes$member' => NULL, 'FileSource$ContentType' => '

The type of content stored in the file source.

', 'MetricsSource$ContentType' => '

The metric source content type.

', 'TransformInput$ContentType' => '

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

', ], ], 'ContentTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedContentTypes' => '

The supported MIME types for the input data.

', 'ChannelSpecification$SupportedContentTypes' => '

The supported MIME types for the data.

', 'InferenceSpecification$SupportedContentTypes' => '

The supported MIME types for the input data.

', ], ], 'ContextArn' => [ 'base' => NULL, 'refs' => [ 'ContextSummary$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'CreateContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'DeleteContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'DescribeContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', 'UpdateContextResponse$ContextArn' => '

The Amazon Resource Name (ARN) of the context.

', ], ], 'ContextName' => [ 'base' => NULL, 'refs' => [ 'ContextSummary$ContextName' => '

The name of the context.

', 'CreateContextRequest$ContextName' => '

The name of the context. Must be unique to your account in an Amazon Web Services Region.

', 'DeleteContextRequest$ContextName' => '

The name of the context to delete.

', 'DescribeContextResponse$ContextName' => '

The name of the context.

', 'UpdateContextRequest$ContextName' => '

The name of the context to update.

', ], ], 'ContextNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeContextRequest$ContextName' => '

The name of the context to describe.

', ], ], 'ContextSource' => [ 'base' => '

A structure describing the source of a context.

', 'refs' => [ 'ContextSummary$Source' => '

The source of the context.

', 'CreateContextRequest$Source' => '

The source type, ID, and URI.

', 'DescribeContextResponse$Source' => '

The source of the context.

', ], ], 'ContextSummaries' => [ 'base' => NULL, 'refs' => [ 'ListContextsResponse$ContextSummaries' => '

A list of contexts and their properties.

', ], ], 'ContextSummary' => [ 'base' => '

Lists a summary of the properties of a context. A context provides a logical grouping of other entities.

', 'refs' => [ 'ContextSummaries$member' => NULL, ], ], 'ContinuousParameterRange' => [ 'base' => '

A list of continuous hyperparameters to tune.

', 'refs' => [ 'ContinuousParameterRanges$member' => NULL, ], ], 'ContinuousParameterRangeSpecification' => [ 'base' => '

Defines the possible values for a continuous hyperparameter.

', 'refs' => [ 'ParameterRange$ContinuousParameterRangeSpecification' => '

A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

', ], ], 'ContinuousParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$ContinuousParameterRanges' => '

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

', ], ], 'ConvergenceDetected' => [ 'base' => '

A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.

', 'refs' => [ 'TuningJobCompletionCriteria$ConvergenceDetected' => '

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.

', ], ], 'CountryCode' => [ 'base' => NULL, 'refs' => [ 'HolidayConfigAttributes$CountryCode' => '

The country code for the holiday calendar.

For the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your choice.

', ], ], 'CreateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'CreateAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedDomainUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlInput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePresignedNotebookInstanceUrlOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSummary$CreationTime' => '

A timestamp that shows when the algorithm was created.

', 'AppDetails$CreationTime' => '

The creation time.

', 'BatchDescribeModelPackageSummary$CreationTime' => '

The creation time of the mortgage package summary.

', 'CodeRepositorySummary$CreationTime' => '

The date and time that the Git repository was created.

', 'CompilationJobSummary$CreationTime' => '

The time when the model compilation job was created.

', 'DescribeAlgorithmOutput$CreationTime' => '

A timestamp specifying when the algorithm was created.

', 'DescribeCodeRepositoryOutput$CreationTime' => '

The date and time that the repository was created.

', 'DescribeCompilationJobResponse$CreationTime' => '

The time that the model compilation job was created.

', 'DescribeDomainResponse$CreationTime' => '

The creation time.

', 'DescribeFeatureGroupResponse$CreationTime' => '

A timestamp indicating when SageMaker created the FeatureGroup.

', 'DescribeFeatureMetadataResponse$CreationTime' => '

A timestamp indicating when the feature was created.

', 'DescribeInferenceRecommendationsJobResponse$CreationTime' => '

A timestamp that shows when the job was created.

', 'DescribeModelPackageGroupOutput$CreationTime' => '

The time that the model group was created.

', 'DescribeModelPackageOutput$CreationTime' => '

A timestamp specifying when the model package was created.

', 'DescribeNotebookInstanceLifecycleConfigOutput$CreationTime' => '

A timestamp that tells when the lifecycle configuration was created.

', 'DescribeNotebookInstanceOutput$CreationTime' => '

A timestamp. Use this parameter to return the time when the notebook instance was created

', 'DescribeSpaceResponse$CreationTime' => '

The creation time.

', 'DescribeUserProfileResponse$CreationTime' => '

The creation time.

', 'DomainDetails$CreationTime' => '

The creation time.

', 'FeatureGroup$CreationTime' => '

The time a FeatureGroup was created.

', 'FeatureMetadata$CreationTime' => '

A timestamp indicating when the feature was created.

', 'InferenceRecommendationsJob$CreationTime' => '

A timestamp that shows when the job was created.

', 'ListAlgorithmsInput$CreationTimeAfter' => '

A filter that returns only algorithms created after the specified time (timestamp).

', 'ListAlgorithmsInput$CreationTimeBefore' => '

A filter that returns only algorithms created before the specified time (timestamp).

', 'ListCodeRepositoriesInput$CreationTimeAfter' => '

A filter that returns only Git repositories that were created after the specified time.

', 'ListCodeRepositoriesInput$CreationTimeBefore' => '

A filter that returns only Git repositories that were created before the specified time.

', 'ListCompilationJobsRequest$CreationTimeAfter' => '

A filter that returns the model compilation jobs that were created after a specified time.

', 'ListCompilationJobsRequest$CreationTimeBefore' => '

A filter that returns the model compilation jobs that were created before a specified time.

', 'ListFeatureGroupsRequest$CreationTimeAfter' => '

Use this parameter to search for FeatureGroupss created after a specific date and time.

', 'ListFeatureGroupsRequest$CreationTimeBefore' => '

Use this parameter to search for FeatureGroupss created before a specific date and time.

', 'ListInferenceRecommendationsJobsRequest$CreationTimeAfter' => '

A filter that returns only jobs created after the specified time (timestamp).

', 'ListInferenceRecommendationsJobsRequest$CreationTimeBefore' => '

A filter that returns only jobs created before the specified time (timestamp).

', 'ListModelPackageGroupsInput$CreationTimeAfter' => '

A filter that returns only model groups created after the specified time.

', 'ListModelPackageGroupsInput$CreationTimeBefore' => '

A filter that returns only model groups created before the specified time.

', 'ListModelPackagesInput$CreationTimeAfter' => '

A filter that returns only model packages created after the specified time (timestamp).

', 'ListModelPackagesInput$CreationTimeBefore' => '

A filter that returns only model packages created before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeBefore' => '

A filter that returns only lifecycle configurations that were created before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$CreationTimeAfter' => '

A filter that returns only lifecycle configurations that were created after the specified time (timestamp).

', 'ListNotebookInstancesInput$CreationTimeBefore' => '

A filter that returns only notebook instances that were created before the specified time (timestamp).

', 'ListNotebookInstancesInput$CreationTimeAfter' => '

A filter that returns only notebook instances that were created after the specified time (timestamp).

', 'ModelPackage$CreationTime' => '

The time that the model package was created.

', 'ModelPackageGroup$CreationTime' => '

The time that the model group was created.

', 'ModelPackageGroupSummary$CreationTime' => '

The time that the model group was created.

', 'ModelPackageSummary$CreationTime' => '

A timestamp that shows when the model package was created.

', 'NotebookInstanceLifecycleConfigSummary$CreationTime' => '

A timestamp that tells when the lifecycle configuration was created.

', 'NotebookInstanceSummary$CreationTime' => '

A timestamp that shows when the notebook instance was created.

', 'SpaceDetails$CreationTime' => '

The creation time.

', 'UserProfileDetails$CreationTime' => '

The creation time.

', ], ], 'CrossAccountFilterOption' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$CrossAccountFilterOption' => '

A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

', ], ], 'CsvContentType' => [ 'base' => NULL, 'refs' => [ 'CsvContentTypes$member' => NULL, ], ], 'CsvContentTypes' => [ 'base' => NULL, 'refs' => [ 'CaptureContentTypeHeader$CsvContentTypes' => '

The list of all content type headers that Amazon SageMaker will treat as CSV and capture accordingly.

', ], ], 'CustomFileSystem' => [ 'base' => '

A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystems$member' => NULL, ], ], 'CustomFileSystemConfig' => [ 'base' => '

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystemConfigs$member' => NULL, ], ], 'CustomFileSystemConfigs' => [ 'base' => NULL, 'refs' => [ 'UserSettings$CustomFileSystemConfigs' => '

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

', ], ], 'CustomFileSystems' => [ 'base' => NULL, 'refs' => [ 'SpaceSettings$CustomFileSystems' => '

A file system, created by you, that you assign to a space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', ], ], 'CustomImage' => [ 'base' => '

A custom SageMaker image. For more information, see Bring your own SageMaker image.

', 'refs' => [ 'CustomImages$member' => NULL, ], ], 'CustomImageContainerArguments' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerArguments' => '

The arguments for the container when you\'re running the application.

', ], ], 'CustomImageContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerEntrypoint' => '

The entrypoint used to run the application in the container.

', ], ], 'CustomImageContainerEnvironmentVariables' => [ 'base' => NULL, 'refs' => [ 'ContainerConfig$ContainerEnvironmentVariables' => '

The environment variables to set in the container

', ], ], 'CustomImages' => [ 'base' => NULL, 'refs' => [ 'JupyterLabAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a JupyterLab app.

', 'KernelGatewayAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a KernelGateway app.

', 'RSessionAppSettings$CustomImages' => '

A list of custom SageMaker images that are configured to run as a RSession app.

', ], ], 'CustomPosixUserConfig' => [ 'base' => '

Details about the POSIX identity that is used for file system operations.

', 'refs' => [ 'UserSettings$CustomPosixUserConfig' => '

Details about the POSIX identity that is used for file system operations.

', ], ], 'CustomerMetadataKey' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataKeyList$member' => NULL, 'CustomerMetadataMap$key' => NULL, ], ], 'CustomerMetadataKeyList' => [ 'base' => NULL, 'refs' => [ 'UpdateModelPackageInput$CustomerMetadataPropertiesToRemove' => '

The metadata properties associated with the model package versions to remove.

', ], ], 'CustomerMetadataMap' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', 'DescribeModelPackageOutput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', 'ModelPackage$CustomerMetadataProperties' => '

The metadata properties for the model package.

', 'UpdateModelPackageInput$CustomerMetadataProperties' => '

The metadata properties associated with the model package versions.

', ], ], 'CustomerMetadataValue' => [ 'base' => NULL, 'refs' => [ 'CustomerMetadataMap$value' => NULL, ], ], 'CustomizedMetricSpecification' => [ 'base' => '

A customized metric.

', 'refs' => [ 'MetricSpecification$Customized' => '

Information about a customized metric.

', ], ], 'DataCaptureConfig' => [ 'base' => '

Configuration to control how SageMaker captures inference data.

', 'refs' => [ 'CreateEndpointConfigInput$DataCaptureConfig' => NULL, 'DescribeEndpointConfigOutput$DataCaptureConfig' => NULL, ], ], 'DataCaptureConfigSummary' => [ 'base' => '

The currently active data capture configuration used by your Endpoint.

', 'refs' => [ 'DescribeEndpointOutput$DataCaptureConfig' => NULL, 'Endpoint$DataCaptureConfig' => NULL, ], ], 'DataCatalogConfig' => [ 'base' => '

The meta data of the Glue table which serves as data catalog for the OfflineStore.

', 'refs' => [ 'OfflineStoreConfig$DataCatalogConfig' => '

The meta data of the Glue table that is autogenerated when an OfflineStore is created.

', ], ], 'DataDistributionType' => [ 'base' => NULL, 'refs' => [ 'DatasetDefinition$DataDistributionType' => '

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

', ], ], 'DataExplorationNotebookLocation' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobArtifacts$DataExplorationNotebookLocation' => '

The URL of the notebook location.

', ], ], 'DataInputConfig' => [ 'base' => NULL, 'refs' => [ 'DerivedInformation$DerivedDataInputConfig' => '

The data input configuration that SageMaker Neo automatically derived for the model. When SageMaker Neo derives this information, you don\'t need to specify the data input configuration when you create a compilation job.

', 'InputConfig$DataInputConfig' => '

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are Framework specific.

  • TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"input":[1,1024,1024,3]}

      • If using the CLI, {\\"input\\":[1,1024,1024,3]}

    • Examples for two inputs:

      • If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}

      • If using the CLI, {\\"data1\\": [1,28,28,1], \\"data2\\":[1,28,28,1]}

  • KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"input_1":[1,3,224,224]}

      • If using the CLI, {\\"input_1\\":[1,3,224,224]}

    • Examples for two inputs:

      • If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]}

      • If using the CLI, {\\"input_1\\": [1,3,224,224], \\"input_2\\":[1,3,224,224]}

  • MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"data":[1,3,1024,1024]}

      • If using the CLI, {\\"data\\":[1,3,1024,1024]}

    • Examples for two inputs:

      • If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}

      • If using the CLI, {\\"var1\\": [1,1,28,28], \\"var2\\":[1,1,28,28]}

  • PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

    • Examples for one input in dictionary format:

      • If using the console, {"input0":[1,3,224,224]}

      • If using the CLI, {\\"input0\\":[1,3,224,224]}

    • Example for one input in list format: [[1,3,224,224]]

    • Examples for two inputs in dictionary format:

      • If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}

      • If using the CLI, {\\"input0\\":[1,3,224,224], \\"input1\\":[1,3,224,224]}

    • Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

  • XGBOOST: input data name and shape are not needed.

DataInputConfig supports the following parameters for CoreML TargetDevice (ML Model format):

  • shape: Input shape, for example {"input_1": {"shape": [1,224,224,3]}}. In addition to static input shapes, CoreML converter supports Flexible input shapes:

    • Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {"input_1": {"shape": ["1..10", 224, 224, 3]}}

    • Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}}

  • default_shape: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, 3]}}

  • type: Input type. Allowed values: Image and Tensor. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale.

  • bias: If the input type is an Image, you need to provide the bias vector.

  • scale: If the input type is an Image, you need to provide a scale factor.

CoreML ClassifierConfig parameters can be specified using OutputConfig CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

  • Tensor type input:

    • "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3]}}

  • Tensor type input without input name (PyTorch):

    • "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224]}]

  • Image type input:

    • "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}}

    • "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

  • Image type input without input name (PyTorch):

    • "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}]

    • "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

  • For TensorFlow models saved in the SavedModel format, specify the input names from signature_def_key and the input model shapes for DataInputConfig. Specify the signature_def_key in OutputConfig:CompilerOptions if the model does not use TensorFlow\'s default signature def key. For example:

    • "DataInputConfig": {"inputs": [1, 224, 224, 3]}

    • "CompilerOptions": {"signature_def_key": "serving_custom"}

  • For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes in DataInputConfig and the output tensor names for output_names in OutputConfig:CompilerOptions . For example:

    • "DataInputConfig": {"input_tensor:0": [1, 224, 224, 3]}

    • "CompilerOptions": {"output_names": ["output_tensor:0"]}

', 'ModelInput$DataInputConfig' => '

The input configuration object for the model.

', ], ], 'DataProcessing' => [ 'base' => '

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

', 'refs' => [ 'CreateTransformJobRequest$DataProcessing' => '

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

', 'DescribeTransformJobResponse$DataProcessing' => NULL, 'TransformJob$DataProcessing' => NULL, ], ], 'DataQualityAppSpecification' => [ 'base' => '

Information about the container that a data quality monitoring job runs.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityAppSpecification' => '

Specifies the container that runs the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityAppSpecification' => '

Information about the container that runs the data quality monitoring job.

', ], ], 'DataQualityBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityBaselineConfig' => '

Configures the constraints and baselines for the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityBaselineConfig' => '

The constraints and baselines for the data quality monitoring job definition.

', ], ], 'DataQualityJobInput' => [ 'base' => '

The input for the data quality monitoring job. Currently endpoints are supported for input.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobInput' => '

A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.

', 'DescribeDataQualityJobDefinitionResponse$DataQualityJobInput' => '

The list of inputs for the data quality monitoring job. Currently endpoints are supported.

', ], ], 'DataSource' => [ 'base' => '

Describes the location of the channel data.

', 'refs' => [ 'Channel$DataSource' => '

The location of the channel data.

', ], ], 'DataSourceName' => [ 'base' => NULL, 'refs' => [ 'IdentityProviderOAuthSetting$DataSourceName' => '

The name of the data source that you\'re connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

', ], ], 'Database' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$Database' => '

The name of the Glue table database.

', ], ], 'DatasetDefinition' => [ 'base' => '

Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

', 'refs' => [ 'ProcessingInput$DatasetDefinition' => '

Configuration for a Dataset Definition input.

', ], ], 'DebugHookConfig' => [ 'base' => '

Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'refs' => [ 'CreateTrainingJobRequest$DebugHookConfig' => NULL, 'DescribeTrainingJobResponse$DebugHookConfig' => NULL, 'TrainingJob$DebugHookConfig' => NULL, ], ], 'DebugRuleConfiguration' => [ 'base' => '

Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'refs' => [ 'DebugRuleConfigurations$member' => NULL, ], ], 'DebugRuleConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$DebugRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

', 'DescribeTrainingJobResponse$DebugRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

', 'TrainingJob$DebugRuleConfigurations' => '

Information about the debug rule configuration.

', ], ], 'DebugRuleEvaluationStatus' => [ 'base' => '

Information about the status of the rule evaluation.

', 'refs' => [ 'DebugRuleEvaluationStatuses$member' => NULL, ], ], 'DebugRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$DebugRuleEvaluationStatuses' => '

Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

', 'TrainingJob$DebugRuleEvaluationStatuses' => '

Information about the evaluation status of the rules for the training job.

', ], ], 'DefaultEbsStorageSettings' => [ 'base' => '

A collection of default EBS storage settings that applies to private spaces created within a domain or user profile.

', 'refs' => [ 'DefaultSpaceStorageSettings$DefaultEbsStorageSettings' => '

The default EBS storage settings for a private space.

', ], ], 'DefaultGid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultGid' => '

The default POSIX group ID (GID). If not specified, defaults to 100.

', ], ], 'DefaultSpaceSettings' => [ 'base' => '

A collection of settings that apply to spaces created in the Domain.

', 'refs' => [ 'CreateDomainRequest$DefaultSpaceSettings' => '

The default settings used to create a space.

', 'DescribeDomainResponse$DefaultSpaceSettings' => '

The default settings used to create a space.

', 'UpdateDomainRequest$DefaultSpaceSettings' => '

The default settings used to create a space within the Domain.

', ], ], 'DefaultSpaceStorageSettings' => [ 'base' => '

The default storage settings for a private space.

', 'refs' => [ 'UserSettings$SpaceStorageSettings' => '

The storage settings for a private space.

', ], ], 'DefaultUid' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$DefaultUid' => '

The default POSIX user ID (UID). If not specified, defaults to 1000.

', ], ], 'DeleteActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'DependencyCopyPath' => [ 'base' => NULL, 'refs' => [ 'HubContentDependency$DependencyCopyPath' => '

The hub content dependency copy path.

', ], ], 'DependencyOriginPath' => [ 'base' => NULL, 'refs' => [ 'HubContentDependency$DependencyOriginPath' => '

The hub content dependency origin path.

', ], ], 'DeployedImage' => [ 'base' => '

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

', 'refs' => [ 'DeployedImages$member' => NULL, 'InferenceComponentContainerSpecificationSummary$DeployedImage' => NULL, ], ], 'DeployedImages' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$DeployedImages' => '

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

', 'ProductionVariantSummary$DeployedImages' => '

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

', ], ], 'DeploymentConfig' => [ 'base' => '

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

', 'refs' => [ 'CreateEndpointInput$DeploymentConfig' => NULL, 'DescribeEndpointOutput$LastDeploymentConfig' => '

The most recent deployment configuration for the endpoint.

', 'UpdateEndpointInput$DeploymentConfig' => '

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

', ], ], 'DeploymentRecommendation' => [ 'base' => '

A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.

', 'refs' => [ 'DescribeModelOutput$DeploymentRecommendation' => '

A set of recommended deployment configurations for the model.

', 'Model$DeploymentRecommendation' => '

A set of recommended deployment configurations for the model.

', ], ], 'DeploymentStage' => [ 'base' => '

Contains information about a stage in an edge deployment plan.

', 'refs' => [ 'DeploymentStages$member' => NULL, ], ], 'DeploymentStageMaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanRequest$MaxResults' => '

The maximum number of results to select (50 by default).

', ], ], 'DeploymentStageStatusSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgeDeploymentPlanResponse$Stages' => '

List of stages in the edge deployment plan.

', ], ], 'DeploymentStageStatusSummary' => [ 'base' => '

Contains information summarizing the deployment stage results.

', 'refs' => [ 'DeploymentStageStatusSummaries$member' => NULL, ], ], 'DeploymentStages' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$Stages' => '

List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.

', 'CreateEdgeDeploymentStageRequest$Stages' => '

List of stages to be added to the edge deployment plan.

', ], ], 'DeregisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DerivedInformation' => [ 'base' => '

Information that SageMaker Neo automatically derived about the model.

', 'refs' => [ 'DescribeCompilationJobResponse$DerivedInformation' => '

Information that SageMaker Neo automatically derived about the model.

', ], ], 'DescribeActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAlgorithmOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Request' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAutoMLJobV2Response' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterNodeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterNodeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCompilationJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDataQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceFleetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgeDeploymentPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEdgePackagingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFeatureMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHumanTaskUiResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInferenceRecommendationsJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLabelingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLineageGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelBiasJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelExplainabilityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeModelQualityJobDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineDefinitionForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProcessingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioLifecycleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSubscribedWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTransformJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$Description' => '

A free-form description of a FeatureGroup.

', 'DescribeFeatureGroupResponse$Description' => '

A free form description of the feature group.

', 'FeatureGroup$Description' => '

A free form description of a FeatureGroup.

', ], ], 'DesiredWeightAndCapacity' => [ 'base' => '

Specifies weight and capacity values for a production variant.

', 'refs' => [ 'DesiredWeightAndCapacityList$member' => NULL, ], ], 'DesiredWeightAndCapacityList' => [ 'base' => NULL, 'refs' => [ 'UpdateEndpointWeightsAndCapacitiesInput$DesiredWeightsAndCapacities' => '

An object that provides new capacity and weight values for a variant.

', ], ], 'DestinationS3Uri' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$S3OutputPath' => '

The Amazon S3 location to upload inference responses to.

', 'AsyncInferenceOutputConfig$S3FailurePath' => '

The Amazon S3 location to upload failure inference responses to.

', 'BatchTransformInput$DataCapturedDestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'DataCaptureConfig$DestinationS3Uri' => '

The Amazon S3 location used to capture the data.

', 'DataCaptureConfigSummary$DestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'InferenceExperimentDataStorageConfig$Destination' => '

The Amazon S3 bucket where the inference request and response data is stored.

', 'ProductionVariantCoreDumpConfig$DestinationS3Uri' => '

The Amazon S3 bucket to send the core dump to.

', ], ], 'DetailedAlgorithmStatus' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$Status' => '

The current status.

', ], ], 'DetailedModelPackageStatus' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusItem$Status' => '

The current status.

', ], ], 'Device' => [ 'base' => '

Information of a particular device.

', 'refs' => [ 'Devices$member' => NULL, ], ], 'DeviceArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$DeviceArn' => '

The Amazon Resource Name (ARN) of the device.

', 'DeviceDeploymentSummary$DeviceArn' => '

The ARN of the device.

', 'DeviceSummary$DeviceArn' => '

Amazon Resource Name (ARN) of the device.

', ], ], 'DeviceDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'DeviceDeploymentSummary$DeviceDeploymentStatus' => '

The deployment status of the device.

', ], ], 'DeviceDeploymentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStageDevicesResponse$DeviceDeploymentSummaries' => '

List of summaries of devices allocated to the stage.

', ], ], 'DeviceDeploymentSummary' => [ 'base' => '

Contains information summarizing device details and deployment status.

', 'refs' => [ 'DeviceDeploymentSummaries$member' => NULL, ], ], 'DeviceDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Description' => '

A description of the device.

', 'Device$Description' => '

Description of the device.

', 'DeviceDeploymentSummary$Description' => '

The description of the device.

', 'DeviceSummary$Description' => '

A description of the device.

', ], ], 'DeviceFleetArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$DeviceFleetArn' => '

The The Amazon Resource Name (ARN) of the fleet.

', 'DeviceFleetSummary$DeviceFleetArn' => '

Amazon Resource Name (ARN) of the device fleet.

', 'GetDeviceFleetReportResponse$DeviceFleetArn' => '

The Amazon Resource Name (ARN) of the device.

', ], ], 'DeviceFleetDescription' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$Description' => '

A description of the fleet.

', 'DescribeDeviceFleetResponse$Description' => '

A description of the fleet.

', 'GetDeviceFleetReportResponse$Description' => '

Description of the fleet.

', 'UpdateDeviceFleetRequest$Description' => '

Description of the fleet.

', ], ], 'DeviceFleetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsResponse$DeviceFleetSummaries' => '

Summary of the device fleet.

', ], ], 'DeviceFleetSummary' => [ 'base' => '

Summary of the device fleet.

', 'refs' => [ 'DeviceFleetSummaries$member' => NULL, ], ], 'DeviceName' => [ 'base' => NULL, 'refs' => [ 'Device$DeviceName' => '

The name of the device.

', 'DeviceDeploymentSummary$DeviceName' => '

The name of the device.

', 'DeviceNames$member' => NULL, 'DeviceSelectionConfig$DeviceNameContains' => '

A filter to select devices with names containing this name.

', ], ], 'DeviceNames' => [ 'base' => NULL, 'refs' => [ 'DeregisterDevicesRequest$DeviceNames' => '

The unique IDs of the devices.

', 'DeviceSelectionConfig$DeviceNames' => '

List of devices chosen to deploy.

', ], ], 'DeviceSelectionConfig' => [ 'base' => '

Contains information about the configurations of selected devices.

', 'refs' => [ 'DeploymentStage$DeviceSelectionConfig' => '

Configuration of the devices in the stage.

', 'DeploymentStageStatusSummary$DeviceSelectionConfig' => '

Configuration of the devices in the stage.

', ], ], 'DeviceStats' => [ 'base' => '

Status of devices.

', 'refs' => [ 'GetDeviceFleetReportResponse$DeviceStats' => '

Status of devices.

', ], ], 'DeviceSubsetType' => [ 'base' => NULL, 'refs' => [ 'DeviceSelectionConfig$DeviceSubsetType' => '

Type of device subsets to deploy to the current stage.

', ], ], 'DeviceSummaries' => [ 'base' => NULL, 'refs' => [ 'ListDevicesResponse$DeviceSummaries' => '

Summary of devices.

', ], ], 'DeviceSummary' => [ 'base' => '

Summary of the device.

', 'refs' => [ 'DeviceSummaries$member' => NULL, ], ], 'Devices' => [ 'base' => NULL, 'refs' => [ 'RegisterDevicesRequest$Devices' => '

A list of devices to register with SageMaker Edge Manager.

', 'UpdateDevicesRequest$Devices' => '

List of devices to register with Edge Manager agent.

', ], ], 'Dimension' => [ 'base' => NULL, 'refs' => [ 'VectorConfig$Dimension' => '

The number of elements in your vector.

', ], ], 'DirectDeploySettings' => [ 'base' => '

The model deployment settings for the SageMaker Canvas application.

In order to enable model deployment for Canvas, the SageMaker Domain\'s or user profile\'s Amazon Web Services IAM execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also turn on model deployment permissions through the SageMaker Domain\'s or user profile\'s settings in the SageMaker console.

', 'refs' => [ 'CanvasAppSettings$DirectDeploySettings' => '

The model deployment settings for the SageMaker Canvas application.

', ], ], 'DirectInternetAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$DirectInternetAccess' => '

Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC.

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

', 'DescribeNotebookInstanceOutput$DirectInternetAccess' => '

Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

', ], ], 'Direction' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$Direction' => '

Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.

', ], ], 'DirectoryPath' => [ 'base' => NULL, 'refs' => [ 'CheckpointConfig$LocalPath' => '

(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

', 'DebugHookConfig$LocalPath' => '

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

', 'DebugRuleConfiguration$LocalPath' => '

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

', 'FileSystemDataSource$DirectoryPath' => '

The full path to the directory to associate with the channel.

', 'ProfilerRuleConfiguration$LocalPath' => '

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

', 'TensorBoardOutputConfig$LocalPath' => '

Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.

', ], ], 'DisableProfiler' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$DisableProfiler' => '

Configuration to turn off Amazon SageMaker Debugger\'s system monitoring and profiling functionality. To turn it off, set to True.

', 'ProfilerConfigForUpdate$DisableProfiler' => '

To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.

', ], ], 'DisableSagemakerServicecatalogPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DisableSagemakerServicecatalogPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateAdditionalCodeRepositories' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateAdditionalCodeRepositories' => '

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateDefaultCodeRepository' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateDefaultCodeRepository' => '

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateNotebookInstanceAcceleratorTypes' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateAcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateNotebookInstanceLifecycleConfig' => [ 'base' => NULL, 'refs' => [ 'UpdateNotebookInstanceInput$DisassociateLifecycleConfig' => '

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

', ], ], 'DisassociateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DockerSettings' => [ 'base' => '

A collection of settings that configure the domain\'s Docker interaction.

', 'refs' => [ 'DomainSettings$DockerSettings' => '

A collection of settings that configure the domain\'s Docker interaction.

', 'DomainSettingsForUpdate$DockerSettings' => '

A collection of settings that configure the domain\'s Docker interaction.

', ], ], 'DocumentSchemaVersion' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$DocumentSchemaVersion' => '

The document schema version for the hub content.

', 'HubContentInfo$DocumentSchemaVersion' => '

The version of the hub content document schema.

', 'ImportHubContentRequest$DocumentSchemaVersion' => '

The version of the hub content schema to import.

', 'ListHubContentVersionsRequest$MaxSchemaVersion' => '

The upper bound of the hub content schema version.

', 'ListHubContentsRequest$MaxSchemaVersion' => '

The upper bound of the hub content schema verion.

', ], ], 'Dollars' => [ 'base' => NULL, 'refs' => [ 'USD$Dollars' => '

The whole number of dollars in the amount.

', ], ], 'DomainArn' => [ 'base' => NULL, 'refs' => [ 'CreateDomainResponse$DomainArn' => '

The Amazon Resource Name (ARN) of the created domain.

', 'DescribeDomainResponse$DomainArn' => '

The domain\'s Amazon Resource Name (ARN).

', 'DomainDetails$DomainArn' => '

The domain\'s Amazon Resource Name (ARN).

', 'UpdateDomainResponse$DomainArn' => '

The Amazon Resource Name (ARN) of the domain.

', ], ], 'DomainDetails' => [ 'base' => '

The domain\'s details.

', 'refs' => [ 'DomainList$member' => NULL, ], ], 'DomainId' => [ 'base' => NULL, 'refs' => [ 'AppDetails$DomainId' => '

The domain ID.

', 'CreateAppRequest$DomainId' => '

The domain ID.

', 'CreatePresignedDomainUrlRequest$DomainId' => '

The domain ID.

', 'CreateSpaceRequest$DomainId' => '

The ID of the associated Domain.

', 'CreateUserProfileRequest$DomainId' => '

The ID of the associated Domain.

', 'DeleteAppRequest$DomainId' => '

The domain ID.

', 'DeleteDomainRequest$DomainId' => '

The domain ID.

', 'DeleteSpaceRequest$DomainId' => '

The ID of the associated Domain.

', 'DeleteUserProfileRequest$DomainId' => '

The domain ID.

', 'DescribeAppRequest$DomainId' => '

The domain ID.

', 'DescribeAppResponse$DomainId' => '

The domain ID.

', 'DescribeDomainRequest$DomainId' => '

The domain ID.

', 'DescribeDomainResponse$DomainId' => '

The domain ID.

', 'DescribeSpaceRequest$DomainId' => '

The ID of the associated Domain.

', 'DescribeSpaceResponse$DomainId' => '

The ID of the associated Domain.

', 'DescribeUserProfileRequest$DomainId' => '

The domain ID.

', 'DescribeUserProfileResponse$DomainId' => '

The ID of the domain that contains the profile.

', 'DomainDetails$DomainId' => '

The domain ID.

', 'ListAppsRequest$DomainIdEquals' => '

A parameter to search for the domain ID.

', 'ListSpacesRequest$DomainIdEquals' => '

A parameter to search for the Domain ID.

', 'ListUserProfilesRequest$DomainIdEquals' => '

A parameter by which to filter the results.

', 'SpaceDetails$DomainId' => '

The ID of the associated Domain.

', 'UpdateDomainRequest$DomainId' => '

The ID of the domain to be updated.

', 'UpdateSpaceRequest$DomainId' => '

The ID of the associated Domain.

', 'UpdateUserProfileRequest$DomainId' => '

The domain ID.

', 'UserProfileDetails$DomainId' => '

The domain ID.

', ], ], 'DomainList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsResponse$Domains' => '

The list of domains.

', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$DomainName' => '

A name for the domain.

', 'DescribeDomainResponse$DomainName' => '

The domain name.

', 'DomainDetails$DomainName' => '

The domain name.

', ], ], 'DomainSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$SecurityGroupIds' => '

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

', 'DomainSettingsForUpdate$SecurityGroupIds' => '

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

', ], ], 'DomainSettings' => [ 'base' => '

A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.

', 'refs' => [ 'CreateDomainRequest$DomainSettings' => '

A collection of Domain settings.

', 'DescribeDomainResponse$DomainSettings' => '

A collection of Domain settings.

', ], ], 'DomainSettingsForUpdate' => [ 'base' => '

A collection of Domain configuration settings to update.

', 'refs' => [ 'UpdateDomainRequest$DomainSettingsForUpdate' => '

A collection of DomainSettings configuration values to update.

', ], ], 'DomainStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$Status' => '

The status.

', 'DomainDetails$Status' => '

The status.

', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'TargetTrackingScalingPolicyConfiguration$TargetValue' => '

The recommended target value to specify for the metric when creating a scaling policy.

', ], ], 'DoubleParameterValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentParameterValue$NumberValue' => '

The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can\'t specify the StringValue parameter.

', ], ], 'DriftCheckBaselines' => [ 'base' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'CreateModelPackageInput$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

', 'DescribeModelPackageOutput$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

', 'ModelPackage$DriftCheckBaselines' => '

Represents the drift check baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckBias' => [ 'base' => '

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$Bias' => '

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckExplainability' => [ 'base' => '

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$Explainability' => '

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckModelDataQuality' => [ 'base' => '

Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$ModelDataQuality' => '

Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.

', ], ], 'DriftCheckModelQuality' => [ 'base' => '

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

', 'refs' => [ 'DriftCheckBaselines$ModelQuality' => '

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

', ], ], 'DynamicScalingConfiguration' => [ 'base' => '

An object with the recommended values for you to specify when creating an autoscaling policy.

', 'refs' => [ 'GetScalingConfigurationRecommendationResponse$DynamicScalingConfiguration' => '

An object with the recommended values for you to specify when creating an autoscaling policy.

', ], ], 'EFSFileSystem' => [ 'base' => '

A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.

', 'refs' => [ 'CustomFileSystem$EFSFileSystem' => '

A custom file system in Amazon EFS.

', ], ], 'EFSFileSystemConfig' => [ 'base' => '

The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker Domain.

', 'refs' => [ 'CustomFileSystemConfig$EFSFileSystemConfig' => '

The settings for a custom Amazon EFS file system.

', ], ], 'EMRStepMetadata' => [ 'base' => '

The configurations and outcomes of an Amazon EMR step execution.

', 'refs' => [ 'PipelineExecutionStepMetadata$EMR' => '

The configurations and outcomes of an Amazon EMR step execution.

', ], ], 'EbsStorageSettings' => [ 'base' => '

A collection of EBS storage settings that applies to private spaces.

', 'refs' => [ 'SpaceStorageSettings$EbsStorageSettings' => '

A collection of EBS storage settings for a private space.

', ], ], 'Edge' => [ 'base' => '

A directed edge connecting two lineage entities.

', 'refs' => [ 'Edges$member' => NULL, ], ], 'EdgeDeploymentConfig' => [ 'base' => '

Contains information about the configuration of a deployment.

', 'refs' => [ 'DeploymentStage$DeploymentConfig' => '

Configuration of the deployment details.

', 'DeploymentStageStatusSummary$DeploymentConfig' => '

Configuration of the deployment details.

', ], ], 'EdgeDeploymentModelConfig' => [ 'base' => '

Contains information about the configuration of a model in a deployment.

', 'refs' => [ 'EdgeDeploymentModelConfigs$member' => NULL, ], ], 'EdgeDeploymentModelConfigs' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanRequest$ModelConfigs' => '

List of models associated with the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$ModelConfigs' => '

List of models associated with the edge deployment plan.

', ], ], 'EdgeDeploymentPlanArn' => [ 'base' => NULL, 'refs' => [ 'CreateEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn' => '

The ARN of edge deployment plan.

', 'DeviceDeploymentSummary$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanArn' => '

The ARN of the edge deployment plan.

', ], ], 'EdgeDeploymentPlanSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansResponse$EdgeDeploymentPlanSummaries' => '

List of summaries of edge deployment plans.

', ], ], 'EdgeDeploymentPlanSummary' => [ 'base' => '

Contains information summarizing an edge deployment plan.

', 'refs' => [ 'EdgeDeploymentPlanSummaries$member' => NULL, ], ], 'EdgeDeploymentStatus' => [ 'base' => '

Contains information summarizing the deployment stage results.

', 'refs' => [ 'DeploymentStageStatusSummary$DeploymentStatus' => '

General status of the current state.

', ], ], 'EdgeModel' => [ 'base' => '

The model on the edge device.

', 'refs' => [ 'EdgeModels$member' => NULL, ], ], 'EdgeModelStat' => [ 'base' => '

Status of edge devices with this model.

', 'refs' => [ 'EdgeModelStats$member' => NULL, ], ], 'EdgeModelStats' => [ 'base' => NULL, 'refs' => [ 'GetDeviceFleetReportResponse$ModelStats' => '

Status of model on device.

', ], ], 'EdgeModelSummaries' => [ 'base' => NULL, 'refs' => [ 'DeviceSummary$Models' => '

Models on the device.

', ], ], 'EdgeModelSummary' => [ 'base' => '

Summary of model on edge device.

', 'refs' => [ 'EdgeModelSummaries$member' => NULL, ], ], 'EdgeModels' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$Models' => '

Models on the device.

', ], ], 'EdgeOutputConfig' => [ 'base' => '

The output configuration.

', 'refs' => [ 'CreateDeviceFleetRequest$OutputConfig' => '

The output configuration for storing sample data collected by the fleet.

', 'CreateEdgePackagingJobRequest$OutputConfig' => '

Provides information about the output location for the packaged model.

', 'DescribeDeviceFleetResponse$OutputConfig' => '

The output configuration for storing sampled data.

', 'DescribeEdgePackagingJobResponse$OutputConfig' => '

The output configuration for the edge packaging job.

', 'GetDeviceFleetReportResponse$OutputConfig' => '

The output configuration for storing sample data collected by the fleet.

', 'UpdateDeviceFleetRequest$OutputConfig' => '

Output configuration for storing sample data collected by the fleet.

', ], ], 'EdgePackagingJobArn' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobArn' => '

The Amazon Resource Name (ARN) of the edge packaging job.

', 'EdgePackagingJobSummary$EdgePackagingJobArn' => '

The Amazon Resource Name (ARN) of the edge packaging job.

', ], ], 'EdgePackagingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatus' => '

The current status of the packaging job.

', 'EdgePackagingJobSummary$EdgePackagingJobStatus' => '

The status of the edge packaging job.

', 'ListEdgePackagingJobsRequest$StatusEquals' => '

The job status to filter for.

', ], ], 'EdgePackagingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEdgePackagingJobsResponse$EdgePackagingJobSummaries' => '

Summaries of edge packaging jobs.

', ], ], 'EdgePackagingJobSummary' => [ 'base' => '

Summary of edge packaging job.

', 'refs' => [ 'EdgePackagingJobSummaries$member' => NULL, ], ], 'EdgePresetDeploymentArtifact' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Artifact' => '

The Amazon Resource Name (ARN) of the generated deployable resource.

', ], ], 'EdgePresetDeploymentOutput' => [ 'base' => '

The output of a SageMaker Edge Manager deployable resource.

', 'refs' => [ 'DescribeEdgePackagingJobResponse$PresetDeploymentOutput' => '

The output of a SageMaker Edge Manager deployable resource.

', ], ], 'EdgePresetDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'EdgePresetDeploymentOutput$Status' => '

The status of the deployable resource.

', ], ], 'EdgePresetDeploymentType' => [ 'base' => NULL, 'refs' => [ 'EdgeOutputConfig$PresetDeploymentType' => '

The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

', 'EdgePresetDeploymentOutput$Type' => '

The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

', ], ], 'EdgeVersion' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$Version' => '

Version of the agent.

', 'CreateEdgePackagingJobRequest$ModelVersion' => '

The version of the model.

', 'DescribeDeviceResponse$AgentVersion' => '

Edge Manager agent version.

', 'DescribeEdgePackagingJobResponse$ModelVersion' => '

The version of the model.

', 'DeviceSummary$AgentVersion' => '

Edge Manager agent version.

', 'EdgeModel$ModelVersion' => '

The model version.

', 'EdgeModelStat$ModelVersion' => '

The model version.

', 'EdgeModelSummary$ModelVersion' => '

The version model.

', 'EdgePackagingJobSummary$ModelVersion' => '

The version of the model.

', ], ], 'Edges' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Edges' => '

A list of edges that connect vertices in the response.

', ], ], 'EfsUid' => [ 'base' => NULL, 'refs' => [ 'DescribeSpaceResponse$HomeEfsFileSystemUid' => '

The ID of the space\'s profile in the Amazon Elastic File System volume.

', 'DescribeUserProfileResponse$HomeEfsFileSystemUid' => '

The ID of the user\'s profile in the Amazon Elastic File System (EFS) volume.

', ], ], 'EnableCapture' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$EnableCapture' => '

Whether data capture should be enabled or disabled (defaults to enabled).

', 'DataCaptureConfigSummary$EnableCapture' => '

Whether data capture is enabled or disabled.

', ], ], 'EnableInfraCheck' => [ 'base' => NULL, 'refs' => [ 'InfraCheckConfig$EnableInfraCheck' => '

Enables an infrastructure health check.

', ], ], 'EnableIotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceFleetRequest$EnableIotRoleAlias' => '

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

', 'UpdateDeviceFleetRequest$EnableIotRoleAlias' => '

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

', ], ], 'EnableRemoteDebug' => [ 'base' => NULL, 'refs' => [ 'RemoteDebugConfig$EnableRemoteDebug' => '

If set to True, enables remote debugging.

', 'RemoteDebugConfigForUpdate$EnableRemoteDebug' => '

If set to True, enables remote debugging.

', ], ], 'EnableSagemakerServicecatalogPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'EnableSagemakerServicecatalogPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'Endpoint' => [ 'base' => '

A hosted endpoint for real-time inference.

', 'refs' => [ 'SearchRecord$Endpoint' => NULL, ], ], 'EndpointArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'DescribeEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'DescribeInferenceComponentOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

', 'Endpoint$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'EndpointSummary$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'InferenceComponentSummary$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

', 'ModelDashboardEndpoint$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'UpdateEndpointOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the endpoint.

', 'UpdateEndpointWeightsAndCapacitiesOutput$EndpointArn' => '

The Amazon Resource Name (ARN) of the updated endpoint.

', ], ], 'EndpointConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigOutput$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', 'DescribeEndpointConfigOutput$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', 'EndpointConfigSummary$EndpointConfigArn' => '

The Amazon Resource Name (ARN) of the endpoint configuration.

', ], ], 'EndpointConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

', 'CreateEndpointInput$EndpointConfigName' => '

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

', 'DeleteEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration that you want to delete.

', 'DescribeEndpointConfigInput$EndpointConfigName' => '

The name of the endpoint configuration.

', 'DescribeEndpointConfigOutput$EndpointConfigName' => '

Name of the SageMaker endpoint configuration.

', 'DescribeEndpointOutput$EndpointConfigName' => '

The name of the endpoint configuration associated with this endpoint.

', 'Endpoint$EndpointConfigName' => '

The endpoint configuration associated with the endpoint.

', 'EndpointConfigSummary$EndpointConfigName' => '

The name of the endpoint configuration.

', 'EndpointMetadata$EndpointConfigName' => '

The name of the endpoint configuration.

', 'PendingDeploymentSummary$EndpointConfigName' => '

The name of the endpoint configuration used in the deployment.

', 'UpdateEndpointInput$EndpointConfigName' => '

The name of the new endpoint configuration.

', ], ], 'EndpointConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NameContains' => '

A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.

', ], ], 'EndpointConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'EndpointConfigSummary' => [ 'base' => '

Provides summary information for an endpoint configuration.

', 'refs' => [ 'EndpointConfigSummaryList$member' => NULL, ], ], 'EndpointConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsOutput$EndpointConfigs' => '

An array of endpoint configurations.

', ], ], 'EndpointInfo' => [ 'base' => '

Details about a customer endpoint that was compared in an Inference Recommender job.

', 'refs' => [ 'EndpointPerformance$EndpointInfo' => NULL, 'Endpoints$member' => NULL, ], ], 'EndpointInput' => [ 'base' => '

Input object for the endpoint

', 'refs' => [ 'DataQualityJobInput$EndpointInput' => NULL, 'ModelBiasJobInput$EndpointInput' => NULL, 'ModelExplainabilityJobInput$EndpointInput' => NULL, 'ModelQualityJobInput$EndpointInput' => NULL, 'MonitoringInput$EndpointInput' => '

The endpoint for a monitoring job.

', ], ], 'EndpointInputConfiguration' => [ 'base' => '

The endpoint configuration for the load test.

', 'refs' => [ 'EndpointInputConfigurations$member' => NULL, ], ], 'EndpointInputConfigurations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$EndpointConfigurations' => '

Specifies the endpoint configuration to use for a job.

', ], ], 'EndpointMetadata' => [ 'base' => '

The metadata of the endpoint.

', 'refs' => [ 'DescribeInferenceExperimentResponse$EndpointMetadata' => '

The metadata of the endpoint on which the inference experiment ran.

', ], ], 'EndpointName' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointInput$EndpointName' => '

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.

', 'CreateInferenceComponentInput$EndpointName' => '

The name of an existing endpoint where you host the inference component.

', 'CreateInferenceExperimentRequest$EndpointName' => '

The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.

', 'DeleteEndpointInput$EndpointName' => '

The name of the endpoint that you want to delete.

', 'DescribeEndpointInput$EndpointName' => '

The name of the endpoint.

', 'DescribeEndpointOutput$EndpointName' => '

Name of the endpoint.

', 'DescribeInferenceComponentOutput$EndpointName' => '

The name of the endpoint that hosts the inference component.

', 'DescribeMonitoringScheduleResponse$EndpointName' => '

The name of the endpoint for the monitoring job.

', 'Endpoint$EndpointName' => '

The name of the endpoint.

', 'EndpointInfo$EndpointName' => '

The name of a customer\'s endpoint.

', 'EndpointInput$EndpointName' => '

An endpoint in customer\'s account which has enabled DataCaptureConfig enabled.

', 'EndpointMetadata$EndpointName' => '

The name of the endpoint.

', 'EndpointSummary$EndpointName' => '

The name of the endpoint.

', 'GetScalingConfigurationRecommendationRequest$EndpointName' => '

The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the RecommendationId field.

', 'GetScalingConfigurationRecommendationResponse$EndpointName' => '

The name of an endpoint benchmarked during a previously completed Inference Recommender job.

', 'InferenceComponentSummary$EndpointName' => '

The name of the endpoint that hosts the inference component.

', 'ListDataQualityJobDefinitionsRequest$EndpointName' => '

A filter that lists the data quality job definitions associated with the specified endpoint.

', 'ListInferenceComponentsInput$EndpointNameEquals' => '

An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

', 'ListModelBiasJobDefinitionsRequest$EndpointName' => '

Name of the endpoint to monitor for model bias.

', 'ListModelExplainabilityJobDefinitionsRequest$EndpointName' => '

Name of the endpoint to monitor for model explainability.

', 'ListModelQualityJobDefinitionsRequest$EndpointName' => '

A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.

', 'ListMonitoringExecutionsRequest$EndpointName' => '

Name of a specific endpoint to fetch jobs for.

', 'ListMonitoringSchedulesRequest$EndpointName' => '

Name of a specific endpoint to fetch schedules for.

', 'ModelDashboardEndpoint$EndpointName' => '

The endpoint name.

', 'ModelDashboardMonitoringSchedule$EndpointName' => '

The endpoint which is monitored.

', 'ModelDeployConfig$EndpointName' => '

Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.

Specify the EndpointName if and only if you set AutoGenerateEndpointName to False; otherwise a 400 error is thrown.

', 'ModelDeployResult$EndpointName' => '

The name of the endpoint to which the model has been deployed.

If model deployment fails, this field is omitted from the response.

', 'MonitoringExecutionSummary$EndpointName' => '

The name of the endpoint used to run the monitoring job.

', 'MonitoringJobDefinitionSummary$EndpointName' => '

The name of the endpoint that the job monitors.

', 'MonitoringSchedule$EndpointName' => '

The endpoint that hosts the model being monitored.

', 'MonitoringScheduleSummary$EndpointName' => '

The name of the endpoint using the monitoring schedule.

', 'UpdateEndpointInput$EndpointName' => '

The name of the endpoint whose configuration you want to update.

', 'UpdateEndpointWeightsAndCapacitiesInput$EndpointName' => '

The name of an existing SageMaker endpoint.

', ], ], 'EndpointNameContains' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$NameContains' => '

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

', ], ], 'EndpointOutputConfiguration' => [ 'base' => '

The endpoint configuration made by Inference Recommender during a recommendation job.

', 'refs' => [ 'InferenceRecommendation$EndpointConfiguration' => '

Defines the endpoint configuration parameters.

', 'RecommendationJobInferenceBenchmark$EndpointConfiguration' => NULL, ], ], 'EndpointPerformance' => [ 'base' => '

The performance results from running an Inference Recommender job on an existing endpoint.

', 'refs' => [ 'EndpointPerformances$member' => NULL, ], ], 'EndpointPerformances' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$EndpointPerformances' => '

The performance results from running an Inference Recommender job on an existing endpoint.

', ], ], 'EndpointSortKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'EndpointStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeEndpointOutput$EndpointStatus' => '

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

  • UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint\'s status to InService, see Rolling Deployments.

', 'Endpoint$EndpointStatus' => '

The status of the endpoint.

', 'EndpointMetadata$EndpointStatus' => '

The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.

', 'EndpointSummary$EndpointStatus' => '

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints.

', 'ListEndpointsInput$StatusEquals' => '

A filter that returns only endpoints with the specified status.

', 'ModelDashboardEndpoint$EndpointStatus' => '

The endpoint status.

', ], ], 'EndpointSummary' => [ 'base' => '

Provides summary information for an endpoint.

', 'refs' => [ 'EndpointSummaryList$member' => NULL, ], ], 'EndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsOutput$Endpoints' => '

An array or endpoint objects.

', ], ], 'Endpoints' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$Endpoints' => '

Existing customer endpoints on which to run an Inference Recommender job.

', ], ], 'EntityDescription' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Description' => '

A description of the additional Inference specification

', 'AlgorithmSummary$AlgorithmDescription' => '

A brief description of the algorithm.

', 'BatchDescribeModelPackageSummary$ModelPackageDescription' => '

The description of the model package.

', 'ChannelSpecification$Description' => '

A brief description of the channel.

', 'CreateAlgorithmInput$AlgorithmDescription' => '

A description of the algorithm.

', 'CreateModelPackageGroupInput$ModelPackageGroupDescription' => '

A description for the model group.

', 'CreateModelPackageInput$ModelPackageDescription' => '

A description of the model package.

', 'CreateProjectInput$ProjectDescription' => '

A description for the project.

', 'DescribeAlgorithmOutput$AlgorithmDescription' => '

A brief summary about the algorithm.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupDescription' => '

A description of the model group.

', 'DescribeModelPackageOutput$ModelPackageDescription' => '

A brief summary of the model package.

', 'DescribeProjectOutput$ProjectDescription' => '

The description of the project.

', 'HyperParameterSpecification$Description' => '

A brief description of the hyperparameter.

', 'ModelPackage$ModelPackageDescription' => '

The description of the model package.

', 'ModelPackageGroup$ModelPackageGroupDescription' => '

The description for the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupDescription' => '

A description of the model group.

', 'ModelPackageSummary$ModelPackageDescription' => '

A brief description of the model package.

', 'Project$ProjectDescription' => '

The description of the project.

', 'ProjectSummary$ProjectDescription' => '

The description of the project.

', 'UpdateProjectInput$ProjectDescription' => '

The description for the project.

', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Name' => '

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

', 'AlgorithmStatusItem$Name' => '

The name of the algorithm for which the overall status is being reported.

', 'AlgorithmSummary$AlgorithmName' => '

The name of the algorithm that is described by the summary.

', 'AlgorithmValidationProfile$ProfileName' => '

The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'BatchDescribeModelPackageSummary$ModelPackageGroupName' => '

The group name for the model package

', 'CodeRepositorySummary$CodeRepositoryName' => '

The name of the Git repository.

', 'CompilationJobSummary$CompilationJobName' => '

The name of the model compilation job that you want a summary for.

', 'CreateAlgorithmInput$AlgorithmName' => '

The name of the algorithm.

', 'CreateCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'CreateCompilationJobRequest$CompilationJobName' => '

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

', 'CreateDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet that the device belongs to.

', 'CreateEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'CreateEdgeDeploymentPlanRequest$DeviceFleetName' => '

The device fleet used for this edge deployment plan.

', 'CreateEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'CreateEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'CreateEdgePackagingJobRequest$CompilationJobName' => '

The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.

', 'CreateEdgePackagingJobRequest$ModelName' => '

The name of the model.

', 'CreateModelCardExportJobRequest$ModelCardExportJobName' => '

The name of the model card export job.

', 'CreateModelCardRequest$ModelCardName' => '

The unique name of the model card.

', 'CreateModelPackageGroupInput$ModelPackageGroupName' => '

The name of the model group.

', 'CreateModelPackageInput$ModelPackageName' => '

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

This parameter is required for unversioned models. It is not applicable to versioned models.

', 'DeleteAlgorithmInput$AlgorithmName' => '

The name of the algorithm to delete.

', 'DeleteCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to delete.

', 'DeleteCompilationJobRequest$CompilationJobName' => '

The name of the compilation job to delete.

', 'DeleteDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet to delete.

', 'DeleteEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to delete.

', 'DeleteEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan from which the stage will be deleted.

', 'DeleteEdgeDeploymentStageRequest$StageName' => '

The name of the stage.

', 'DeleteModelCardRequest$ModelCardName' => '

The name of the model card to delete.

', 'DeleteModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group for which to delete the policy.

', 'DeploymentStage$StageName' => '

The name of the stage.

', 'DeploymentStageStatusSummary$StageName' => '

The name of the stage.

', 'DeregisterDevicesRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', 'DescribeAlgorithmOutput$AlgorithmName' => '

The name of the algorithm being described.

', 'DescribeCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to describe.

', 'DescribeCodeRepositoryOutput$CodeRepositoryName' => '

The name of the Git repository.

', 'DescribeCompilationJobRequest$CompilationJobName' => '

The name of the model compilation job that you want information about.

', 'DescribeCompilationJobResponse$CompilationJobName' => '

The name of the model compilation job.

', 'DescribeDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet.

', 'DescribeDeviceFleetResponse$DeviceFleetName' => '

The name of the fleet.

', 'DescribeDeviceRequest$DeviceName' => '

The unique ID of the device.

', 'DescribeDeviceRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', 'DescribeDeviceResponse$DeviceName' => '

The unique identifier of the device.

', 'DescribeDeviceResponse$DeviceFleetName' => '

The name of the fleet the device belongs to.

', 'DescribeEdgeDeploymentPlanRequest$EdgeDeploymentPlanName' => '

The name of the deployment plan to describe.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'DescribeEdgeDeploymentPlanResponse$DeviceFleetName' => '

The device fleet used for this edge deployment plan.

', 'DescribeEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'DescribeEdgePackagingJobResponse$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'DescribeEdgePackagingJobResponse$CompilationJobName' => '

The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

', 'DescribeEdgePackagingJobResponse$ModelName' => '

The name of the model.

', 'DescribeModelCardExportJobResponse$ModelCardExportJobName' => '

The name of the model card export job to describe.

', 'DescribeModelCardExportJobResponse$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card that the model export job exports.

', 'DescribeModelCardResponse$ModelCardName' => '

The name of the model card.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupName' => '

The name of the model group.

', 'DescribeModelPackageOutput$ModelPackageName' => '

The name of the model package being described.

', 'DescribeModelPackageOutput$ModelPackageGroupName' => '

If the model is a versioned model, the name of the model group that the versioned model belongs to.

', 'DeviceDeploymentSummary$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'DeviceDeploymentSummary$StageName' => '

The name of the stage in the edge deployment plan.

', 'DeviceDeploymentSummary$DeployedStageName' => '

The name of the deployed stage.

', 'DeviceDeploymentSummary$DeviceFleetName' => '

The name of the fleet to which the device belongs to.

', 'DeviceFleetSummary$DeviceFleetName' => '

Name of the device fleet.

', 'DeviceSummary$DeviceName' => '

The unique identifier of the device.

', 'DeviceSummary$DeviceFleetName' => '

The name of the fleet the device belongs to.

', 'EdgeDeploymentModelConfig$ModelHandle' => '

The name the device application uses to reference this model.

', 'EdgeDeploymentModelConfig$EdgePackagingJobName' => '

The edge packaging job associated with this deployment.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'EdgeDeploymentPlanSummary$DeviceFleetName' => '

The name of the device fleet used for the deployment.

', 'EdgeModel$ModelName' => '

The name of the model.

', 'EdgeModelStat$ModelName' => '

The name of the model.

', 'EdgeModelSummary$ModelName' => '

The name of the model.

', 'EdgePackagingJobSummary$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'EdgePackagingJobSummary$CompilationJobName' => '

The name of the SageMaker Neo compilation job.

', 'EdgePackagingJobSummary$ModelName' => '

The name of the model.

', 'GetDeviceFleetReportRequest$DeviceFleetName' => '

The name of the fleet.

', 'GetDeviceFleetReportResponse$DeviceFleetName' => '

The name of the fleet.

', 'GetModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group for which to get the resource policy.

', 'ListDevicesRequest$ModelName' => '

A filter that searches devices that contains this name in any of their models.

', 'ListDevicesRequest$DeviceFleetName' => '

Filter for fleets containing this name in their device fleet name.

', 'ListModelCardExportJobsRequest$ModelCardName' => '

List export jobs for the model card with the specified name.

', 'ListModelCardExportJobsRequest$ModelCardExportJobNameContains' => '

Only list model card export jobs with names that contain the specified string.

', 'ListModelCardsRequest$NameContains' => '

Only list model cards with names that contain the specified string.

', 'ListStageDevicesRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan.

', 'ListStageDevicesRequest$StageName' => '

The name of the stage in the deployment.

', 'ModelCard$ModelCardName' => '

The unique name of the model card.

', 'ModelCardExportJobSummary$ModelCardExportJobName' => '

The name of the model card export job.

', 'ModelCardExportJobSummary$ModelCardName' => '

The name of the model card that the export job exports.

', 'ModelCardSummary$ModelCardName' => '

The name of the model card.

', 'ModelCardVersionSummary$ModelCardName' => '

The name of the model card.

', 'ModelDashboardModelCard$ModelCardName' => '

The name of a model card.

', 'ModelPackage$ModelPackageName' => '

The name of the model.

', 'ModelPackage$ModelPackageGroupName' => '

The model group to which the model belongs.

', 'ModelPackageGroup$ModelPackageGroupName' => '

The name of the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupName' => '

The name of the model group.

', 'ModelPackageStatusItem$Name' => '

The name of the model package for which the overall status is being reported.

', 'ModelPackageSummary$ModelPackageName' => '

The name of the model package.

', 'ModelPackageSummary$ModelPackageGroupName' => '

If the model package is a versioned model, the model group that the versioned model belongs to.

', 'ModelPackageValidationProfile$ProfileName' => '

The name of the profile for the model package.

', 'PutModelPackageGroupPolicyInput$ModelPackageGroupName' => '

The name of the model group to add a resource policy to.

', 'RegisterDevicesRequest$DeviceFleetName' => '

The name of the fleet.

', 'StartEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to start.

', 'StartEdgeDeploymentStageRequest$StageName' => '

The name of the stage to start.

', 'StopCompilationJobRequest$CompilationJobName' => '

The name of the model compilation job to stop.

', 'StopEdgeDeploymentStageRequest$EdgeDeploymentPlanName' => '

The name of the edge deployment plan to stop.

', 'StopEdgeDeploymentStageRequest$StageName' => '

The name of the stage to stop.

', 'StopEdgePackagingJobRequest$EdgePackagingJobName' => '

The name of the edge packaging job.

', 'UpdateCodeRepositoryInput$CodeRepositoryName' => '

The name of the Git repository to update.

', 'UpdateDeviceFleetRequest$DeviceFleetName' => '

The name of the fleet.

', 'UpdateDevicesRequest$DeviceFleetName' => '

The name of the fleet the devices belong to.

', ], ], 'EnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$key' => NULL, ], ], 'EnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$Environment' => '

The environment variables to set in the container. For more information, see ContainerDefinition.

', 'ContainerDefinition$Environment' => '

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

', 'InferenceComponentContainerSpecification$Environment' => '

The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.

', 'InferenceComponentContainerSpecificationSummary$Environment' => '

The environment variables to set in the Docker container.

', 'ModelPackageContainerDefinition$Environment' => '

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

', 'RealTimeInferenceRecommendation$Environment' => '

The recommended environment variables to set in the model container for Real-Time Inference.

', ], ], 'EnvironmentParameter' => [ 'base' => '

A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

', 'refs' => [ 'EnvironmentParameters$member' => NULL, ], ], 'EnvironmentParameterRanges' => [ 'base' => '

Specifies the range of environment parameters

', 'refs' => [ 'EndpointInputConfiguration$EnvironmentParameterRanges' => '

The parameter you want to benchmark against.

', ], ], 'EnvironmentParameters' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$EnvironmentParameters' => '

Defines the environment parameters that includes key, value types, and values.

', ], ], 'EnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'EnvironmentMap$value' => NULL, ], ], 'ExcludeFeaturesAttribute' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$ExcludeFeaturesAttribute' => '

The attributes of the input data to exclude from the analysis.

', 'EndpointInput$ExcludeFeaturesAttribute' => '

The attributes of the input data to exclude from the analysis.

', ], ], 'ExecutionRoleIdentityConfig' => [ 'base' => NULL, 'refs' => [ 'DomainSettings$ExecutionRoleIdentityConfig' => '

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

', 'DomainSettingsForUpdate$ExecutionRoleIdentityConfig' => '

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

', ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsRequest$StatusEquals' => '

A filter that retrieves only jobs with a specific status.

', 'MonitoringExecutionSummary$MonitoringExecutionStatus' => '

The status of the monitoring job.

', ], ], 'ExitMessage' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ExitMessage' => '

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', 'ProcessingJob$ExitMessage' => '

A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', 'ProcessingJobSummary$ExitMessage' => '

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

', ], ], 'Experiment' => [ 'base' => '

The properties of an experiment as returned by the Search API.

', 'refs' => [ 'SearchRecord$Experiment' => '

The properties of an experiment.

', ], ], 'ExperimentArn' => [ 'base' => NULL, 'refs' => [ 'CreateExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'DeleteExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment that is being deleted.

', 'DescribeExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'Experiment$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'ExperimentSummary$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', 'UpdateExperimentResponse$ExperimentArn' => '

The Amazon Resource Name (ARN) of the experiment.

', ], ], 'ExperimentConfig' => [ 'base' => '

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

', 'refs' => [ 'CreateProcessingJobRequest$ExperimentConfig' => NULL, 'CreateTrainingJobRequest$ExperimentConfig' => NULL, 'CreateTransformJobRequest$ExperimentConfig' => NULL, 'DescribeProcessingJobResponse$ExperimentConfig' => '

The configuration information used to create an experiment.

', 'DescribeTrainingJobResponse$ExperimentConfig' => NULL, 'DescribeTransformJobResponse$ExperimentConfig' => NULL, 'ProcessingJob$ExperimentConfig' => NULL, 'TrainingJob$ExperimentConfig' => NULL, 'TransformJob$ExperimentConfig' => NULL, ], ], 'ExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateActionRequest$Description' => '

The description of the action.

', 'CreateContextRequest$Description' => '

The description of the context.

', 'CreateExperimentRequest$Description' => '

The description of the experiment.

', 'DescribeActionResponse$Description' => '

The description of the action.

', 'DescribeContextResponse$Description' => '

The description of the context.

', 'DescribeExperimentResponse$Description' => '

The description of the experiment.

', 'DescribeLineageGroupResponse$Description' => '

The description of the lineage group.

', 'Experiment$Description' => '

The description of the experiment.

', 'UpdateActionRequest$Description' => '

The new description for the action.

', 'UpdateContextRequest$Description' => '

The new description for the context.

', 'UpdateExperimentRequest$Description' => '

The description of the experiment.

', ], ], 'ExperimentEntityName' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionName' => '

The name of the action.

', 'ArtifactSummary$ArtifactName' => '

The name of the artifact.

', 'AssociateTrialComponentRequest$TrialComponentName' => '

The name of the component to associated with the trial.

', 'AssociateTrialComponentRequest$TrialName' => '

The name of the trial to associate with.

', 'AssociationSummary$SourceName' => '

The name of the source.

', 'AssociationSummary$DestinationName' => '

The name of the destination.

', 'CreateActionRequest$ActionName' => '

The name of the action. Must be unique to your account in an Amazon Web Services Region.

', 'CreateArtifactRequest$ArtifactName' => '

The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

', 'CreateExperimentRequest$ExperimentName' => '

The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateExperimentRequest$DisplayName' => '

The name of the experiment as displayed. The name doesn\'t need to be unique. If you don\'t specify DisplayName, the value in ExperimentName is displayed.

', 'CreateTrialComponentRequest$TrialComponentName' => '

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateTrialComponentRequest$DisplayName' => '

The name of the component as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'CreateTrialRequest$TrialName' => '

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

', 'CreateTrialRequest$DisplayName' => '

The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.

', 'CreateTrialRequest$ExperimentName' => '

The name of the experiment to associate the trial with.

', 'DeleteActionRequest$ActionName' => '

The name of the action to delete.

', 'DeleteExperimentRequest$ExperimentName' => '

The name of the experiment to delete.

', 'DeleteTrialComponentRequest$TrialComponentName' => '

The name of the component to delete.

', 'DeleteTrialRequest$TrialName' => '

The name of the trial to delete.

', 'DescribeExperimentRequest$ExperimentName' => '

The name of the experiment to describe.

', 'DescribeExperimentResponse$ExperimentName' => '

The name of the experiment.

', 'DescribeExperimentResponse$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'DescribeLineageGroupRequest$LineageGroupName' => '

The name of the lineage group.

', 'DescribeLineageGroupResponse$LineageGroupName' => '

The name of the lineage group.

', 'DescribeLineageGroupResponse$DisplayName' => '

The display name of the lineage group.

', 'DescribeTrialComponentResponse$TrialComponentName' => '

The name of the trial component.

', 'DescribeTrialComponentResponse$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'DescribeTrialRequest$TrialName' => '

The name of the trial to describe.

', 'DescribeTrialResponse$TrialName' => '

The name of the trial.

', 'DescribeTrialResponse$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'DescribeTrialResponse$ExperimentName' => '

The name of the experiment the trial is part of.

', 'DisassociateTrialComponentRequest$TrialComponentName' => '

The name of the component to disassociate from the trial.

', 'DisassociateTrialComponentRequest$TrialName' => '

The name of the trial to disassociate from.

', 'Experiment$ExperimentName' => '

The name of the experiment.

', 'Experiment$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'ExperimentConfig$ExperimentName' => '

The name of an existing experiment to associate with the trial component.

', 'ExperimentConfig$TrialName' => '

The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

', 'ExperimentConfig$TrialComponentDisplayName' => '

The display name for the trial component. If this key isn\'t specified, the display name is the trial component name.

', 'ExperimentConfig$RunName' => '

The name of the experiment run to associate with the trial component.

', 'ExperimentSummary$ExperimentName' => '

The name of the experiment.

', 'ExperimentSummary$DisplayName' => '

The name of the experiment as displayed. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'LineageGroupSummary$LineageGroupName' => '

The name or Amazon Resource Name (ARN) of the lineage group.

', 'LineageGroupSummary$DisplayName' => '

The display name of the lineage group summary.

', 'ListTrialComponentsRequest$ExperimentName' => '

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can\'t filter by SourceArn or TrialName.

', 'ListTrialComponentsRequest$TrialName' => '

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can\'t filter by ExperimentName or SourceArn.

', 'ListTrialsRequest$ExperimentName' => '

A filter that returns only trials that are part of the specified experiment.

', 'ListTrialsRequest$TrialComponentName' => '

A filter that returns only trials that are associated with the specified trial component.

', 'Parent$TrialName' => '

The name of the trial.

', 'Parent$ExperimentName' => '

The name of the experiment.

', 'PipelineExperimentConfig$ExperimentName' => '

The name of the experiment.

', 'PipelineExperimentConfig$TrialName' => '

The name of the trial.

', 'Trial$TrialName' => '

The name of the trial.

', 'Trial$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'Trial$ExperimentName' => '

The name of the experiment the trial is part of.

', 'TrialComponent$TrialComponentName' => '

The name of the trial component.

', 'TrialComponent$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'TrialComponent$RunName' => '

The name of the experiment run.

', 'TrialComponentSimpleSummary$TrialComponentName' => '

The name of the trial component.

', 'TrialComponentSummary$TrialComponentName' => '

The name of the trial component.

', 'TrialComponentSummary$DisplayName' => '

The name of the component as displayed. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'TrialSummary$TrialName' => '

The name of the trial.

', 'TrialSummary$DisplayName' => '

The name of the trial as displayed. If DisplayName isn\'t specified, TrialName is displayed.

', 'UpdateActionRequest$ActionName' => '

The name of the action to update.

', 'UpdateArtifactRequest$ArtifactName' => '

The new name for the artifact.

', 'UpdateExperimentRequest$ExperimentName' => '

The name of the experiment to update.

', 'UpdateExperimentRequest$DisplayName' => '

The name of the experiment as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, ExperimentName is displayed.

', 'UpdateTrialComponentRequest$TrialComponentName' => '

The name of the component to update.

', 'UpdateTrialComponentRequest$DisplayName' => '

The name of the component as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialComponentName is displayed.

', 'UpdateTrialRequest$TrialName' => '

The name of the trial to update.

', 'UpdateTrialRequest$DisplayName' => '

The name of the trial as displayed. The name doesn\'t need to be unique. If DisplayName isn\'t specified, TrialName is displayed.

', ], ], 'ExperimentEntityNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeActionRequest$ActionName' => '

The name of the action to describe.

', 'DescribeActionResponse$ActionName' => '

The name of the action.

', 'DescribeArtifactResponse$ArtifactName' => '

The name of the artifact.

', 'DescribeTrialComponentRequest$TrialComponentName' => '

The name of the trial component to describe.

', ], ], 'ExperimentSource' => [ 'base' => '

The source of the experiment.

', 'refs' => [ 'DescribeExperimentResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the type.

', 'Experiment$Source' => NULL, 'ExperimentSummary$ExperimentSource' => NULL, ], ], 'ExperimentSourceArn' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'ExperimentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListExperimentsResponse$ExperimentSummaries' => '

A list of the summaries of your experiments.

', ], ], 'ExperimentSummary' => [ 'base' => '

A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.

', 'refs' => [ 'ExperimentSummaries$member' => NULL, ], ], 'ExpiresInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$ExpiresInSeconds' => '

The number of seconds until the pre-signed URL expires. This value defaults to 300.

', ], ], 'Explainability' => [ 'base' => '

Contains explainability metrics for a model.

', 'refs' => [ 'ModelMetrics$Explainability' => '

Metrics that help explain a model.

', ], ], 'ExplainabilityLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$Explainability' => '

The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.

', ], ], 'ExplainerConfig' => [ 'base' => '

A parameter to activate explainers.

', 'refs' => [ 'CreateEndpointConfigInput$ExplainerConfig' => '

A member of CreateEndpointConfig that enables explainers.

', 'DescribeEndpointConfigOutput$ExplainerConfig' => '

The configuration parameters for an explainer.

', 'DescribeEndpointOutput$ExplainerConfig' => '

The configuration parameters for an explainer.

', ], ], 'FailStepMetadata' => [ 'base' => '

The container for the metadata for Fail step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Fail' => '

The configurations and outcomes of a Fail step execution.

', ], ], 'FailureHandlingPolicy' => [ 'base' => NULL, 'refs' => [ 'EdgeDeploymentConfig$FailureHandlingPolicy' => '

Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.

', ], ], 'FailureReason' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Message' => NULL, 'DescribeAppResponse$FailureReason' => '

The failure reason.

', 'DescribeCompilationJobResponse$FailureReason' => '

If a model compilation job failed, the reason it failed.

', 'DescribeDomainResponse$FailureReason' => '

The failure reason.

', 'DescribeEndpointOutput$FailureReason' => '

If the status of the endpoint is Failed, the reason why it failed.

', 'DescribeFeatureGroupResponse$FailureReason' => '

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:

  • The FeatureGroup could not be created in the OfflineStore.

  • The FeatureGroup could not be deleted from the OfflineStore.

', 'DescribeFlowDefinitionResponse$FailureReason' => '

The reason your flow definition failed.

', 'DescribeHubContentResponse$FailureReason' => '

The failure reason if importing hub content failed.

', 'DescribeHubResponse$FailureReason' => '

The failure reason if importing hub content failed.

', 'DescribeHyperParameterTuningJobResponse$FailureReason' => '

If the tuning job failed, the reason it failed.

', 'DescribeImageResponse$FailureReason' => '

When a create, update, or delete operation fails, the reason for the failure.

', 'DescribeImageVersionResponse$FailureReason' => '

When a create or delete operation fails, the reason for the failure.

', 'DescribeInferenceComponentOutput$FailureReason' => '

If the inference component status is Failed, the reason for the failure.

', 'DescribeInferenceRecommendationsJobResponse$FailureReason' => '

If the job fails, provides information why the job failed.

', 'DescribeLabelingJobResponse$FailureReason' => '

If the job failed, the reason that it failed.

', 'DescribeModelCardExportJobResponse$FailureReason' => '

The failure reason if the model export job fails.

', 'DescribeMonitoringScheduleResponse$FailureReason' => '

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

', 'DescribeNotebookInstanceOutput$FailureReason' => '

If status is Failed, the reason it failed.

', 'DescribeProcessingJobResponse$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'DescribeSpaceResponse$FailureReason' => '

The failure reason.

', 'DescribeTrainingJobResponse$FailureReason' => '

If the training job failed, the reason it failed.

', 'DescribeTransformJobResponse$FailureReason' => '

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

', 'DescribeUserProfileResponse$FailureReason' => '

The failure reason.

', 'Endpoint$FailureReason' => '

If the endpoint failed, the reason it failed.

', 'EndpointMetadata$FailureReason' => '

If the status of the endpoint is Failed, or the status is InService but update operation fails, this provides the reason why it failed.

', 'FeatureGroup$FailureReason' => '

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

', 'FlowDefinitionSummary$FailureReason' => '

The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

', 'HyperParameterTrainingJobSummary$FailureReason' => '

The reason that the training job failed.

', 'HyperParameterTuningJobSearchEntity$FailureReason' => '

The error that was created when a hyperparameter tuning job failed.

', 'Image$FailureReason' => '

When a create, update, or delete operation fails, the reason for the failure.

', 'ImageVersion$FailureReason' => '

When a create or delete operation fails, the reason for the failure.

', 'InferenceRecommendationsJob$FailureReason' => '

If the job fails, provides information why the job failed.

', 'LabelingJobSummary$FailureReason' => '

If the LabelingJobStatus field is Failed, this field contains a description of the error.

', 'LastUpdateStatus$FailureReason' => '

If the update wasn\'t successful, indicates the reason why it failed.

', 'ModelDashboardMonitoringSchedule$FailureReason' => '

If a monitoring job failed, provides the reason.

', 'MonitoringExecutionSummary$FailureReason' => '

Contains the reason a monitoring job failed, if it failed.

', 'MonitoringSchedule$FailureReason' => '

If the monitoring schedule failed, the reason it failed.

', 'PipelineExecutionStep$FailureReason' => '

The reason why the step failed execution. This is only returned if the step failed its execution.

', 'ProcessingJob$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'ProcessingJobSummary$FailureReason' => '

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

', 'ResourceInUse$Message' => NULL, 'ResourceLimitExceeded$Message' => NULL, 'ResourceNotFound$Message' => NULL, 'TrainingJob$FailureReason' => '

If the training job failed, the reason it failed.

', 'TransformJob$FailureReason' => '

If the transform job failed, the reason it failed.

', 'TransformJobSummary$FailureReason' => '

If the transform job failed, the reason it failed.

', ], ], 'FeatureAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureGroupRequest$FeatureAdditions' => '

Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you\'ve made a valid request. It takes some time after you\'ve made a valid request for Feature Store to update the feature group.

', ], ], 'FeatureDefinition' => [ 'base' => '

A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.

', 'refs' => [ 'FeatureAdditions$member' => NULL, 'FeatureDefinitions$member' => NULL, ], ], 'FeatureDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$FeatureDefinitions' => '

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

', 'DescribeFeatureGroupResponse$FeatureDefinitions' => '

A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

', 'FeatureGroup$FeatureDefinitions' => '

A list of Features. Each Feature must include a FeatureName and a FeatureType.

Valid FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

', ], ], 'FeatureDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$Description' => '

The description you added to describe the feature.

', 'FeatureMetadata$Description' => '

An optional description that you specify to better describe the feature.

', 'UpdateFeatureMetadataRequest$Description' => '

A description that you can write to better describe the feature.

', ], ], 'FeatureGroup' => [ 'base' => '

Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.

', 'refs' => [ 'SearchRecord$FeatureGroup' => NULL, ], ], 'FeatureGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.

', 'DescribeFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of the FeatureGroup.

', 'DescribeFeatureMetadataResponse$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group that contains the feature.

', 'FeatureGroup$FeatureGroupArn' => '

The Amazon Resource Name (ARN) of a FeatureGroup.

', 'FeatureGroupSummary$FeatureGroupArn' => '

Unique identifier for the FeatureGroup.

', 'FeatureMetadata$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group.

', 'UpdateFeatureGroupResponse$FeatureGroupArn' => '

The Amazon Resource Number (ARN) of the feature group that you\'re updating.

', ], ], 'FeatureGroupMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$MaxResults' => '

The maximum number of results returned by ListFeatureGroups.

', ], ], 'FeatureGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$FeatureGroupName' => '

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. The name:

  • Must start and end with an alphanumeric character.

  • Can only contain alphanumeric character and hyphens. Spaces are not allowed.

', 'DeleteFeatureGroupRequest$FeatureGroupName' => '

The name of the FeatureGroup you want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeFeatureGroupResponse$FeatureGroupName' => '

he name of the FeatureGroup.

', 'DescribeFeatureMetadataResponse$FeatureGroupName' => '

The name of the feature group that you\'ve specified.

', 'FeatureGroup$FeatureGroupName' => '

The name of the FeatureGroup.

', 'FeatureGroupSummary$FeatureGroupName' => '

The name of FeatureGroup.

', 'FeatureMetadata$FeatureGroupName' => '

The name of the feature group containing the feature.

', 'ProcessingFeatureStoreOutput$FeatureGroupName' => '

The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.

', ], ], 'FeatureGroupNameContains' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$NameContains' => '

A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.

', ], ], 'FeatureGroupNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.

', 'DescribeFeatureMetadataRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group containing the feature.

', 'UpdateFeatureGroupRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group that you\'re updating.

', 'UpdateFeatureMetadataRequest$FeatureGroupName' => '

The name or Amazon Resource Name (ARN) of the feature group containing the feature that you\'re updating.

', ], ], 'FeatureGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortBy' => '

The value on which the feature group list is sorted.

', ], ], 'FeatureGroupSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$SortOrder' => '

The order in which feature groups are listed.

', ], ], 'FeatureGroupStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupResponse$FeatureGroupStatus' => '

The status of the feature group.

', 'FeatureGroup$FeatureGroupStatus' => '

A FeatureGroup status.

', 'FeatureGroupSummary$FeatureGroupStatus' => '

The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.

', 'ListFeatureGroupsRequest$FeatureGroupStatusEquals' => '

A FeatureGroup status. Filters by FeatureGroup status.

', ], ], 'FeatureGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsResponse$FeatureGroupSummaries' => '

A summary of feature groups.

', ], ], 'FeatureGroupSummary' => [ 'base' => '

The name, ARN, CreationTime, FeatureGroup values, LastUpdatedTime and EnableOnlineStorage status of a FeatureGroup.

', 'refs' => [ 'FeatureGroupSummaries$member' => NULL, ], ], 'FeatureMetadata' => [ 'base' => '

The metadata for a feature. It can either be metadata that you specify, or metadata that is updated automatically.

', 'refs' => [ 'SearchRecord$FeatureMetadata' => '

The feature metadata used to search through the features.

', ], ], 'FeatureName' => [ 'base' => NULL, 'refs' => [ 'CreateFeatureGroupRequest$RecordIdentifierFeatureName' => '

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions\' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

  • Must start and end with an alphanumeric character.

  • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

', 'CreateFeatureGroupRequest$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

An EventTime can be a String or Fractional.

  • Fractional: EventTime feature values must be a Unix timestamp in seconds.

  • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd\'T\'HH:mm:ssZ and yyyy-MM-dd\'T\'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. \'T\' and Z are constants.

', 'DescribeFeatureGroupResponse$RecordIdentifierFeatureName' => '

The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

', 'DescribeFeatureGroupResponse$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.

', 'DescribeFeatureMetadataRequest$FeatureName' => '

The name of the feature.

', 'DescribeFeatureMetadataResponse$FeatureName' => '

The name of the feature that you\'ve specified.

', 'FeatureDefinition$FeatureName' => '

The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

', 'FeatureGroup$RecordIdentifierFeatureName' => '

The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

', 'FeatureGroup$EventTimeFeatureName' => '

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

', 'FeatureMetadata$FeatureName' => '

The name of feature.

', 'UpdateFeatureMetadataRequest$FeatureName' => '

The name of the feature that you\'re updating.

', ], ], 'FeatureParameter' => [ 'base' => '

A key-value pair that you specify to describe the feature.

', 'refs' => [ 'FeatureParameterAdditions$member' => NULL, 'FeatureParameters$member' => NULL, ], ], 'FeatureParameterAdditions' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterAdditions' => '

A list of key-value pairs that you can add to better describe the feature.

', ], ], 'FeatureParameterKey' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Key' => '

A key that must contain a value to describe the feature.

', 'FeatureParameterRemovals$member' => NULL, ], ], 'FeatureParameterRemovals' => [ 'base' => NULL, 'refs' => [ 'UpdateFeatureMetadataRequest$ParameterRemovals' => '

A list of parameter keys that you can specify to remove parameters that describe your feature.

', ], ], 'FeatureParameterValue' => [ 'base' => NULL, 'refs' => [ 'FeatureParameter$Value' => '

The value that belongs to a key.

', ], ], 'FeatureParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$Parameters' => '

The key-value pairs that you added to describe the feature.

', 'FeatureMetadata$Parameters' => '

Optional key-value pairs that you specify to better describe the feature.

', ], ], 'FeatureStatus' => [ 'base' => NULL, 'refs' => [ 'DirectDeploySettings$Status' => '

Describes whether model deployment permissions are enabled or disabled in the Canvas application.

', 'DockerSettings$EnableDockerAccess' => '

Indicates whether the domain can access Docker.

', 'IdentityProviderOAuthSetting$Status' => '

Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

', 'KendraSettings$Status' => '

Describes whether the document querying feature is enabled or disabled in the Canvas application.

', 'ModelRegisterSettings$Status' => '

Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

', 'TimeSeriesForecastingSettings$Status' => '

Describes whether time series forecasting is enabled or disabled in the Canvas application.

', ], ], 'FeatureType' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureMetadataResponse$FeatureType' => '

The data type of the feature.

', 'FeatureDefinition$FeatureType' => '

The value type of a feature. Valid values are Integral, Fractional, or String.

', 'FeatureMetadata$FeatureType' => '

The data type of the feature.

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

Contains details regarding the file source.

', 'refs' => [ 'DriftCheckBias$ConfigFile' => '

The bias config file for a model.

', 'DriftCheckExplainability$ConfigFile' => '

The explainability config file for the model.

', ], ], 'FileSystemAccessMode' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemAccessMode' => '

The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

', ], ], 'FileSystemConfig' => [ 'base' => '

The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

', 'refs' => [ 'JupyterLabAppImageConfig$FileSystemConfig' => NULL, 'KernelGatewayImageConfig$FileSystemConfig' => '

The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

', ], ], 'FileSystemDataSource' => [ 'base' => '

Specifies a file system data source for a channel.

', 'refs' => [ 'DataSource$FileSystemDataSource' => '

The file system that is associated with a channel.

', ], ], 'FileSystemId' => [ 'base' => NULL, 'refs' => [ 'EFSFileSystem$FileSystemId' => '

The ID of your Amazon EFS file system.

', 'EFSFileSystemConfig$FileSystemId' => '

The ID of your Amazon EFS file system.

', 'FileSystemDataSource$FileSystemId' => '

The file system id.

', ], ], 'FileSystemPath' => [ 'base' => NULL, 'refs' => [ 'EFSFileSystemConfig$FileSystemPath' => '

The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

', ], ], 'FileSystemType' => [ 'base' => NULL, 'refs' => [ 'FileSystemDataSource$FileSystemType' => '

The file system type.

', ], ], 'FillingTransformationMap' => [ 'base' => NULL, 'refs' => [ 'FillingTransformations$value' => NULL, ], ], 'FillingTransformationValue' => [ 'base' => NULL, 'refs' => [ 'FillingTransformationMap$value' => NULL, ], ], 'FillingTransformations' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesTransformations$Filling' => '

A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.

The supported filling methods and their corresponding options are:

  • frontfill: none (Supported only for target column)

  • middlefill: zero, value, median, mean, min, max

  • backfill: zero, value, median, mean, min, max

  • futurefill: zero, value, median, mean, min, max

To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example "backfill" : "value"), and define the filling value in an additional parameter prefixed with "_value". For example, to set backfill to a value of 2, you must include two parameters: "backfill": "value" and "backfill_value":"2".

', ], ], 'FillingType' => [ 'base' => NULL, 'refs' => [ 'FillingTransformationMap$key' => NULL, ], ], 'Filter' => [ 'base' => '

A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.

If you specify a Value, but not an Operator, SageMaker uses the equals operator.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form "Metrics.<name>", where <name> is a metric name. For example, the following filter searches for training jobs with an "accuracy" metric greater than "0.9":

{

"Name": "Metrics.accuracy",

"Operator": "GreaterThan",

"Value": "0.9"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form "HyperParameters.<name>". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a "learning_rate" hyperparameter that is less than "0.5":

{

"Name": "HyperParameters.learning_rate",

"Operator": "LessThan",

"Value": "0.5"

}

Tags

To define a tag filter, enter a value with the form Tags.<key>.

', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'NestedFilters$Filters' => '

A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

', 'SearchExpression$Filters' => '

A list of filter objects.

', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'Filter$Value' => '

A value used with Name and Operator to determine which resources satisfy the filter\'s condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd\'T\'HH:MM:SS.

', ], ], 'FinalAutoMLJobObjectiveMetric' => [ 'base' => '

The best candidate result from an AutoML training job.

', 'refs' => [ 'AutoMLCandidate$FinalAutoMLJobObjectiveMetric' => NULL, ], ], 'FinalHyperParameterTuningJobObjectiveMetric' => [ 'base' => '

Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

', 'refs' => [ 'HyperParameterTrainingJobSummary$FinalHyperParameterTuningJobObjectiveMetric' => '

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

', ], ], 'FinalMetricDataList' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$FinalMetricDataList' => '

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

', 'TrainingJob$FinalMetricDataList' => '

A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

', ], ], 'FlatInvocations' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$FlatInvocations' => '

Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.

', ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'MetricData$Value' => '

The value of the metric.

', 'MetricDatum$Value' => '

The value of the metric.

', 'RecommendationMetrics$CostPerHour' => '

Defines the cost per hour for the instance.

', 'RecommendationMetrics$CostPerInference' => '

Defines the cost per inference for the instance .

', ], ], 'FlowDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionResponse$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow definition you create.

', 'DescribeFlowDefinitionResponse$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow defintion.

', 'FlowDefinitionSummary$FlowDefinitionArn' => '

The Amazon Resource Name (ARN) of the flow definition.

', ], ], 'FlowDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateFlowDefinitionRequest$FlowDefinitionName' => '

The name of your flow definition.

', 'DeleteFlowDefinitionRequest$FlowDefinitionName' => '

The name of the flow definition you are deleting.

', 'DescribeFlowDefinitionRequest$FlowDefinitionName' => '

The name of the flow definition.

', 'DescribeFlowDefinitionResponse$FlowDefinitionName' => '

The Amazon Resource Name (ARN) of the flow definition.

', 'FlowDefinitionSummary$FlowDefinitionName' => '

The name of the flow definition.

', ], ], 'FlowDefinitionOutputConfig' => [ 'base' => '

Contains information about where human output will be stored.

', 'refs' => [ 'CreateFlowDefinitionRequest$OutputConfig' => '

An object containing information about where the human review results will be uploaded.

', 'DescribeFlowDefinitionResponse$OutputConfig' => '

An object containing information about the output file.

', ], ], 'FlowDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowDefinitionResponse$FlowDefinitionStatus' => '

The status of the flow definition. Valid values are listed below.

', 'FlowDefinitionSummary$FlowDefinitionStatus' => '

The status of the flow definition. Valid values:

', ], ], 'FlowDefinitionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListFlowDefinitionsResponse$FlowDefinitionSummaries' => '

An array of objects describing the flow definitions.

', ], ], 'FlowDefinitionSummary' => [ 'base' => '

Contains summary information about the flow definition.

', 'refs' => [ 'FlowDefinitionSummaries$member' => NULL, ], ], 'FlowDefinitionTaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskAvailabilityLifetimeInSeconds' => '

The length of time that a task remains available for review by human workers.

', ], ], 'FlowDefinitionTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskCount' => '

The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

', ], ], 'FlowDefinitionTaskDescription' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskDescription' => '

A description for the human worker task.

', ], ], 'FlowDefinitionTaskKeyword' => [ 'base' => NULL, 'refs' => [ 'FlowDefinitionTaskKeywords$member' => NULL, ], ], 'FlowDefinitionTaskKeywords' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskKeywords' => '

Keywords used to describe the task so that workers can discover the task.

', ], ], 'FlowDefinitionTaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTimeLimitInSeconds' => '

The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

', ], ], 'FlowDefinitionTaskTitle' => [ 'base' => NULL, 'refs' => [ 'HumanLoopConfig$TaskTitle' => '

A title for the human worker task.

', ], ], 'ForecastFrequency' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastFrequency' => '

The frequency of predictions in a forecast.

Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, 1D indicates every day and 15min indicates every 15 minutes. The value of a frequency must not overlap with the next larger frequency. For example, you must use a frequency of 1H instead of 60min.

The valid values for each frequency are the following:

  • Minute - 1-59

  • Hour - 1-23

  • Day - 1-6

  • Week - 1-4

  • Month - 1-11

  • Year - 1

', ], ], 'ForecastHorizon' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastHorizon' => '

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.

', ], ], 'ForecastQuantile' => [ 'base' => NULL, 'refs' => [ 'ForecastQuantiles$member' => NULL, ], ], 'ForecastQuantiles' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$ForecastQuantiles' => '

The quantiles used to train the model for forecasts at a specified quantile. You can specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of 0.01 or higher. Up to five forecast quantiles can be specified. When ForecastQuantiles is not provided, the AutoML job uses the quantiles p10, p50, and p90 as default.

', ], ], 'Framework' => [ 'base' => NULL, 'refs' => [ 'InputConfig$Framework' => '

Identifies the framework in which the model was trained. For example: TENSORFLOW.

', ], ], 'FrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'InputConfig$FrameworkVersion' => '

Specifies the framework version to use. This API field is only supported for the MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.

For information about framework versions supported for cloud targets and edge devices, see Cloud Supported Instance Types and Frameworks and Edge Supported Frameworks.

', ], ], 'GenerateCandidateDefinitionsOnly' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$GenerateCandidateDefinitionsOnly' => '

Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

', 'DescribeAutoMLJobResponse$GenerateCandidateDefinitionsOnly' => '

Indicates whether the output for an AutoML job generates candidate definitions only.

', 'TabularJobConfig$GenerateCandidateDefinitionsOnly' => '

Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

', ], ], 'GetDeviceFleetReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDeviceFleetReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLineageGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'GetModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSagemakerServicecatalogPortfolioStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetScalingConfigurationRecommendationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetScalingConfigurationRecommendationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSearchSuggestionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Gid' => [ 'base' => NULL, 'refs' => [ 'CustomPosixUserConfig$Gid' => '

The POSIX group ID.

', ], ], 'GitConfig' => [ 'base' => '

Specifies configuration details for a Git repository in your Amazon Web Services account.

', 'refs' => [ 'CodeRepositorySummary$GitConfig' => '

Configuration details for the Git repository, including the URL where it is located and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', 'CreateCodeRepositoryInput$GitConfig' => '

Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.

', 'DescribeCodeRepositoryOutput$GitConfig' => '

Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

', ], ], 'GitConfigForUpdate' => [ 'base' => '

Specifies configuration details for a Git repository when the repository is updated.

', 'refs' => [ 'UpdateCodeRepositoryInput$GitConfig' => '

The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', ], ], 'GitConfigUrl' => [ 'base' => NULL, 'refs' => [ 'GitConfig$RepositoryUrl' => '

The URL where the Git repository is located.

', ], ], 'Group' => [ 'base' => NULL, 'refs' => [ 'Groups$member' => NULL, ], ], 'GroupingAttributeName' => [ 'base' => NULL, 'refs' => [ 'GroupingAttributeNames$member' => NULL, ], ], 'GroupingAttributeNames' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$GroupingAttributeNames' => '

A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.

', ], ], 'Groups' => [ 'base' => NULL, 'refs' => [ 'OidcMemberDefinition$Groups' => '

A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.

', ], ], 'HolidayConfig' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesForecastingJobConfig$HolidayConfig' => '

The collection of holiday featurization attributes used to incorporate national holiday information into your forecasting model.

', ], ], 'HolidayConfigAttributes' => [ 'base' => '

Stores the holiday featurization attributes applicable to each item of time-series datasets during the training of a forecasting model. This allows the model to identify patterns associated with specific holidays.

', 'refs' => [ 'HolidayConfig$member' => NULL, ], ], 'HookParameters' => [ 'base' => NULL, 'refs' => [ 'DebugHookConfig$HookParameters' => '

Configuration information for the Amazon SageMaker Debugger hook parameters.

', ], ], 'Horovod' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Horovod' => '

Indicates Horovod compatibility.

', 'DescribeImageVersionResponse$Horovod' => '

Indicates Horovod compatibility.

', 'UpdateImageVersionRequest$Horovod' => '

Indicates Horovod compatibility.

', ], ], 'HubArn' => [ 'base' => NULL, 'refs' => [ 'CreateHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'DescribeHubContentResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub that contains the content.

', 'DescribeHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'HubInfo$HubArn' => '

The Amazon Resource Name (ARN) of the hub.

', 'ImportHubContentResponse$HubArn' => '

The ARN of the hub that the content was imported into.

', 'UpdateHubResponse$HubArn' => '

The Amazon Resource Name (ARN) of the updated hub.

', ], ], 'HubContentArn' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentArn' => '

The Amazon Resource Name (ARN) of the hub content.

', 'HubContentInfo$HubContentArn' => '

The Amazon Resource Name (ARN) of the hub content.

', 'ImportHubContentResponse$HubContentArn' => '

The ARN of the hub content that was imported.

', ], ], 'HubContentDependency' => [ 'base' => '

Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

', 'refs' => [ 'HubContentDependencyList$member' => NULL, ], ], 'HubContentDependencyList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDependencies' => '

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

', ], ], 'HubContentDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDescription' => '

A description of the hub content.

', 'HubContentInfo$HubContentDescription' => '

A description of the hub content.

', 'ImportHubContentRequest$HubContentDescription' => '

A description of the hub content to import.

', ], ], 'HubContentDisplayName' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDisplayName' => '

The display name of the hub content.

', 'HubContentInfo$HubContentDisplayName' => '

The display name of the hub content.

', 'ImportHubContentRequest$HubContentDisplayName' => '

The display name of the hub content to import.

', ], ], 'HubContentDocument' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentDocument' => '

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

', 'ImportHubContentRequest$HubContentDocument' => '

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

', ], ], 'HubContentInfo' => [ 'base' => '

Information about hub content.

', 'refs' => [ 'HubContentInfoList$member' => NULL, ], ], 'HubContentInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsResponse$HubContentSummaries' => '

The summaries of the listed hub content versions.

', 'ListHubContentsResponse$HubContentSummaries' => '

The summaries of the listed hub content.

', ], ], 'HubContentMarkdown' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentMarkdown' => '

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

', 'ImportHubContentRequest$HubContentMarkdown' => '

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

', ], ], 'HubContentName' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentName' => '

The name of the content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentName' => '

The name of the content to describe.

', 'DescribeHubContentResponse$HubContentName' => '

The name of the hub content.

', 'HubContentInfo$HubContentName' => '

The name of the hub content.

', 'ImportHubContentRequest$HubContentName' => '

The name of the hub content to import.

', 'ListHubContentVersionsRequest$HubContentName' => '

The name of the hub content.

', ], ], 'HubContentSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentSearchKeywords' => '

The searchable keywords for the hub content.

', 'HubContentInfo$HubContentSearchKeywords' => '

The searchable keywords for the hub content.

', 'ImportHubContentRequest$HubContentSearchKeywords' => '

The searchable keywords of the hub content.

', ], ], 'HubContentSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubContentVersionsRequest$SortBy' => '

Sort hub content versions by either name or creation time.

', 'ListHubContentsRequest$SortBy' => '

Sort hub content versions by either name or creation time.

', ], ], 'HubContentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubContentResponse$HubContentStatus' => '

The status of the hub content.

', 'HubContentInfo$HubContentStatus' => '

The status of the hub content.

', ], ], 'HubContentType' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentType' => '

The type of content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentType' => '

The type of content in the hub.

', 'DescribeHubContentResponse$HubContentType' => '

The type of hub content.

', 'HubContentInfo$HubContentType' => '

The type of hub content.

', 'ImportHubContentRequest$HubContentType' => '

The type of hub content to import.

', 'ListHubContentVersionsRequest$HubContentType' => '

The type of hub content to list versions of.

', 'ListHubContentsRequest$HubContentType' => '

The type of hub content to list.

', ], ], 'HubContentVersion' => [ 'base' => NULL, 'refs' => [ 'DeleteHubContentRequest$HubContentVersion' => '

The version of the content that you want to delete from a hub.

', 'DescribeHubContentRequest$HubContentVersion' => '

The version of the content to describe.

', 'DescribeHubContentResponse$HubContentVersion' => '

The version of the hub content.

', 'HubContentInfo$HubContentVersion' => '

The version of the hub content.

', 'ImportHubContentRequest$HubContentVersion' => '

The version of the hub content to import.

', 'ListHubContentVersionsRequest$MinVersion' => '

The lower bound of the hub content versions to list.

', ], ], 'HubDescription' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDescription' => '

A description of the hub.

', 'DescribeHubResponse$HubDescription' => '

A description of the hub.

', 'HubInfo$HubDescription' => '

A description of the hub.

', 'UpdateHubRequest$HubDescription' => '

A description of the updated hub.

', ], ], 'HubDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubDisplayName' => '

The display name of the hub.

', 'DescribeHubResponse$HubDisplayName' => '

The display name of the hub.

', 'HubInfo$HubDisplayName' => '

The display name of the hub.

', 'UpdateHubRequest$HubDisplayName' => '

The display name of the hub.

', ], ], 'HubInfo' => [ 'base' => '

Information about a hub.

', 'refs' => [ 'HubInfoList$member' => NULL, ], ], 'HubInfoList' => [ 'base' => NULL, 'refs' => [ 'ListHubsResponse$HubSummaries' => '

The summaries of the listed hubs.

', ], ], 'HubName' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubName' => '

The name of the hub to create.

', 'DeleteHubContentRequest$HubName' => '

The name of the hub that you want to delete content in.

', 'DeleteHubRequest$HubName' => '

The name of the hub to delete.

', 'DescribeHubContentRequest$HubName' => '

The name of the hub that contains the content to describe.

', 'DescribeHubContentResponse$HubName' => '

The name of the hub that contains the content.

', 'DescribeHubRequest$HubName' => '

The name of the hub to describe.

', 'DescribeHubResponse$HubName' => '

The name of the hub.

', 'HubInfo$HubName' => '

The name of the hub.

', 'ImportHubContentRequest$HubName' => '

The name of the hub to import content into.

', 'ListHubContentVersionsRequest$HubName' => '

The name of the hub to list the content versions of.

', 'ListHubContentsRequest$HubName' => '

The name of the hub to list the contents of.

', 'UpdateHubRequest$HubName' => '

The name of the hub to update.

', ], ], 'HubS3StorageConfig' => [ 'base' => '

The Amazon S3 storage configuration of a hub.

', 'refs' => [ 'CreateHubRequest$S3StorageConfig' => '

The Amazon S3 storage configuration for the hub.

', 'DescribeHubResponse$S3StorageConfig' => '

The Amazon S3 storage configuration for the hub.

', ], ], 'HubSearchKeyword' => [ 'base' => NULL, 'refs' => [ 'HubContentSearchKeywordList$member' => NULL, 'HubSearchKeywordList$member' => NULL, ], ], 'HubSearchKeywordList' => [ 'base' => NULL, 'refs' => [ 'CreateHubRequest$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'DescribeHubResponse$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'HubInfo$HubSearchKeywords' => '

The searchable keywords for the hub.

', 'UpdateHubRequest$HubSearchKeywords' => '

The searchable keywords for the hub.

', ], ], 'HubSortBy' => [ 'base' => NULL, 'refs' => [ 'ListHubsRequest$SortBy' => '

Sort hubs by either name or creation time.

', ], ], 'HubStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHubResponse$HubStatus' => '

The status of the hub.

', 'HubInfo$HubStatus' => '

The status of the hub.

', ], ], 'HumanLoopActivationConditions' => [ 'base' => NULL, 'refs' => [ 'HumanLoopActivationConditionsConfig$HumanLoopActivationConditions' => '

JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.

', ], ], 'HumanLoopActivationConditionsConfig' => [ 'base' => '

Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.

', 'refs' => [ 'HumanLoopActivationConfig$HumanLoopActivationConditionsConfig' => '

Container structure for defining under what conditions SageMaker creates a human loop.

', ], ], 'HumanLoopActivationConfig' => [ 'base' => '

Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopActivationConfig' => '

An object containing information about the events that trigger a human workflow.

', 'DescribeFlowDefinitionResponse$HumanLoopActivationConfig' => '

An object containing information about what triggers a human review workflow.

', ], ], 'HumanLoopConfig' => [ 'base' => '

Describes the work to be performed by human workers.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopConfig' => '

An object containing information about the tasks the human reviewers will perform.

', 'DescribeFlowDefinitionResponse$HumanLoopConfig' => '

An object containing information about who works on the task, the workforce task price, and other task details.

', ], ], 'HumanLoopRequestSource' => [ 'base' => '

Container for configuring the source of human task requests.

', 'refs' => [ 'CreateFlowDefinitionRequest$HumanLoopRequestSource' => '

Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

', 'DescribeFlowDefinitionResponse$HumanLoopRequestSource' => '

Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

', ], ], 'HumanTaskConfig' => [ 'base' => '

Information required for human workers to complete a labeling task.

', 'refs' => [ 'CreateLabelingJobRequest$HumanTaskConfig' => '

Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

', 'DescribeLabelingJobResponse$HumanTaskConfig' => '

Configuration information required for human workers to complete a labeling task.

', ], ], 'HumanTaskUiArn' => [ 'base' => NULL, 'refs' => [ 'CreateHumanTaskUiResponse$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human review workflow user interface you create.

', 'DescribeHumanTaskUiResponse$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

', 'HumanLoopConfig$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface.

You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

To learn how to create a custom HTML template, see Create Custom Worker Task Template.

To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

', 'HumanTaskUiSummary$HumanTaskUiArn' => '

The Amazon Resource Name (ARN) of the human task user interface.

', 'RenderUiTemplateRequest$HumanTaskUiArn' => '

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

', 'UiConfig$HumanTaskUiArn' => '

The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).

Named Entity Recognition

Use the following HumanTaskUiArn for named entity recognition labeling jobs:

arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition

3D Point Cloud HumanTaskUiArns

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation

Video Frame HumanTaskUiArns

Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.

  • arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection

Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking

', ], ], 'HumanTaskUiName' => [ 'base' => NULL, 'refs' => [ 'CreateHumanTaskUiRequest$HumanTaskUiName' => '

The name of the user interface you are creating.

', 'DeleteHumanTaskUiRequest$HumanTaskUiName' => '

The name of the human task user interface (work task template) you want to delete.

', 'DescribeHumanTaskUiRequest$HumanTaskUiName' => '

The name of the human task user interface (worker task template) you want information about.

', 'DescribeHumanTaskUiResponse$HumanTaskUiName' => '

The name of the human task user interface (worker task template).

', 'HumanTaskUiSummary$HumanTaskUiName' => '

The name of the human task user interface.

', ], ], 'HumanTaskUiStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHumanTaskUiResponse$HumanTaskUiStatus' => '

The status of the human task user interface (worker task template). Valid values are listed below.

', ], ], 'HumanTaskUiSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHumanTaskUisResponse$HumanTaskUiSummaries' => '

An array of objects describing the human task user interfaces.

', ], ], 'HumanTaskUiSummary' => [ 'base' => '

Container for human task user interface information.

', 'refs' => [ 'HumanTaskUiSummaries$member' => NULL, ], ], 'HyperParameterAlgorithmSpecification' => [ 'base' => '

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$AlgorithmSpecification' => '

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

', ], ], 'HyperParameterKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameters$key' => NULL, ], ], 'HyperParameterScalingType' => [ 'base' => NULL, 'refs' => [ 'ContinuousParameterRange$ScalingType' => '

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

', 'IntegerParameterRange$ScalingType' => '

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

', ], ], 'HyperParameterSpecification' => [ 'base' => '

Defines a hyperparameter to be used by an algorithm.

', 'refs' => [ 'HyperParameterSpecifications$member' => NULL, ], ], 'HyperParameterSpecifications' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedHyperParameters' => '

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

', ], ], 'HyperParameterTrainingJobDefinition' => [ 'base' => '

Defines the training jobs launched by a hyperparameter tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinition' => '

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinition' => '

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

', 'HyperParameterTrainingJobDefinitions$member' => NULL, 'HyperParameterTuningJobSearchEntity$TrainingJobDefinition' => NULL, ], ], 'HyperParameterTrainingJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$DefinitionName' => '

The job definition name.

', 'HyperParameterTrainingJobSummary$TrainingJobDefinitionName' => '

The training job definition name.

', ], ], 'HyperParameterTrainingJobDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$TrainingJobDefinitions' => '

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

', 'DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions' => '

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

', 'HyperParameterTuningJobSearchEntity$TrainingJobDefinitions' => '

The job definitions included in a hyperparameter tuning job.

', ], ], 'HyperParameterTrainingJobEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobEnvironmentMap$key' => NULL, ], ], 'HyperParameterTrainingJobEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobDefinition$Environment' => '

An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.

The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can\'t exceed the maximum number specified.

', ], ], 'HyperParameterTrainingJobEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTrainingJobEnvironmentMap$value' => NULL, ], ], 'HyperParameterTrainingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsForHyperParameterTuningJobResponse$TrainingJobSummaries' => '

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

', ], ], 'HyperParameterTrainingJobSummary' => [ 'base' => '

The container for the summary information about a training job.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$BestTrainingJob' => '

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

', 'DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob' => '

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

', 'HyperParameterTrainingJobSummaries$member' => NULL, 'HyperParameterTuningJobSearchEntity$BestTrainingJob' => NULL, 'HyperParameterTuningJobSearchEntity$OverallBestTrainingJob' => NULL, ], ], 'HyperParameterTuningAllocationStrategy' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningResourceConfig$AllocationStrategy' => '

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

', ], ], 'HyperParameterTuningInstanceConfig' => [ 'base' => '

The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).

', 'refs' => [ 'HyperParameterTuningInstanceConfigs$member' => NULL, ], ], 'HyperParameterTuningInstanceConfigs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningResourceConfig$InstanceConfigs' => '

A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.

If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.

', ], ], 'HyperParameterTuningJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobResponse$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job.

', 'DescribeTrainingJobResponse$TuningJobArn' => '

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobArn' => '

The Amazon Resource Name (ARN) of the tuning job.

', 'TrainingJob$TuningJobArn' => '

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

', 'TuningJobStepMetaData$Arn' => '

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

', ], ], 'HyperParameterTuningJobCompletionDetails' => [ 'base' => '

A structure that contains runtime information about both current and completed hyperparameter tuning jobs.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TuningJobCompletionDetails' => '

Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

', 'HyperParameterTuningJobSearchEntity$TuningJobCompletionDetails' => '

Information about either a current or completed hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobConfig' => [ 'base' => '

Configures a hyperparameter tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobConfig' => '

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig' => '

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobConfig' => NULL, ], ], 'HyperParameterTuningJobConsumedResources' => [ 'base' => '

The total resources consumed by your hyperparameter tuning job.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ConsumedResources' => NULL, 'HyperParameterTuningJobSearchEntity$ConsumedResources' => '

The total amount of resources consumed by a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobName' => [ 'base' => NULL, 'refs' => [ 'CreateHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

', 'DescribeHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobName' => '

The name of the hyperparameter tuning job.

', 'HyperParameterTrainingJobSummary$TuningJobName' => '

The HyperParameter tuning job that launched the training job.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobName' => '

The name of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobName' => '

The name of the tuning job.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job whose training jobs you want to list.

', 'ParentHyperParameterTuningJob$HyperParameterTuningJobName' => '

The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

', 'StopHyperParameterTuningJobRequest$HyperParameterTuningJobName' => '

The name of the tuning job to stop.

', ], ], 'HyperParameterTuningJobObjective' => [ 'base' => '

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$TuningObjective' => NULL, 'HyperParameterTuningJobConfig$HyperParameterTuningJobObjective' => '

The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.

', 'HyperParameterTuningJobObjectives$member' => NULL, ], ], 'HyperParameterTuningJobObjectiveType' => [ 'base' => NULL, 'refs' => [ 'FinalHyperParameterTuningJobObjectiveMetric$Type' => '

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

', 'HyperParameterTuningJobObjective$Type' => '

Whether to minimize or maximize the objective metric.

', ], ], 'HyperParameterTuningJobObjectives' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedTuningJobObjectiveMetrics' => '

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobSearchEntity' => [ 'base' => '

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

', 'refs' => [ 'SearchRecord$HyperParameterTuningJob' => '

The properties of a hyperparameter tuning job.

', ], ], 'HyperParameterTuningJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsRequest$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'HyperParameterTuningJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobStatus' => '

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningJobStatus' => '

The status of a hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$HyperParameterTuningJobStatus' => '

The status of the tuning job.

', 'ListHyperParameterTuningJobsRequest$StatusEquals' => '

A filter that returns only tuning jobs with the specified status.

', ], ], 'HyperParameterTuningJobStrategyConfig' => [ 'base' => '

The configuration for a training job launched by a hyperparameter tuning job. Choose Bayesian for Bayesian optimization, and Random for random search optimization. For more advanced use cases, use Hyperband, which evaluates objective metrics for training jobs after every epoch. For more information about strategies, see How Hyperparameter Tuning Works.

', 'refs' => [ 'HyperParameterTuningJobConfig$StrategyConfig' => '

The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.

', ], ], 'HyperParameterTuningJobStrategyType' => [ 'base' => '

The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model.

', 'refs' => [ 'HyperParameterTuningJobConfig$Strategy' => '

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

', 'HyperParameterTuningJobSummary$Strategy' => '

Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

', ], ], 'HyperParameterTuningJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHyperParameterTuningJobsResponse$HyperParameterTuningJobSummaries' => '

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

', ], ], 'HyperParameterTuningJobSummary' => [ 'base' => '

Provides summary information about a hyperparameter tuning job.

', 'refs' => [ 'HyperParameterTuningJobSummaries$member' => NULL, ], ], 'HyperParameterTuningJobWarmStartConfig' => [ 'base' => '

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

', 'refs' => [ 'CreateHyperParameterTuningJobRequest$WarmStartConfig' => '

Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

', 'DescribeHyperParameterTuningJobResponse$WarmStartConfig' => '

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

', 'HyperParameterTuningJobSearchEntity$WarmStartConfig' => NULL, ], ], 'HyperParameterTuningJobWarmStartType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$WarmStartType' => '

Specifies one of the following:

IDENTICAL_DATA_AND_ALGORITHM

The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

TRANSFER_LEARNING

The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

', ], ], 'HyperParameterTuningMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxRuntimeInSeconds' => '

The maximum time in seconds that a hyperparameter tuning job can run.

', ], ], 'HyperParameterTuningResourceConfig' => [ 'base' => '

The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. HyperParameterTuningResourceConfig is similar to ResourceConfig, but has the additional InstanceConfigs and AllocationStrategy fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.

HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig with the exception of KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$HyperParameterTuningResourceConfig' => '

The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).

', ], ], 'HyperParameterValue' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$DefaultValue' => '

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

', 'HyperParameters$value' => NULL, ], ], 'HyperParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$HyperParameters' => '

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

', 'DescribeTrainingJobResponse$HyperParameters' => '

Algorithm-specific parameters.

', 'HyperParameterTrainingJobDefinition$StaticHyperParameters' => '

Specifies the values of hyperparameters that do not change for the tuning job.

', 'HyperParameterTrainingJobSummary$TunedHyperParameters' => '

A list of the hyperparameters for which you specified ranges to search.

', 'TrainingJob$HyperParameters' => '

Algorithm-specific parameters.

', 'TrainingJobDefinition$HyperParameters' => '

The hyperparameters used for the training job.

', ], ], 'HyperbandStrategyConfig' => [ 'base' => '

The configuration for Hyperband, a multi-fidelity based hyperparameter tuning strategy. Hyperband uses the final and intermediate results of a training job to dynamically allocate resources to utilized hyperparameter configurations while automatically stopping under-performing configurations. This parameter should be provided only if Hyperband is selected as the StrategyConfig under the HyperParameterTuningJobConfig API.

', 'refs' => [ 'HyperParameterTuningJobStrategyConfig$HyperbandStrategyConfig' => '

The configuration for the object that specifies the Hyperband strategy. This parameter is only supported for the Hyperband selection for Strategy within the HyperParameterTuningJobConfig API.

', ], ], 'HyperbandStrategyMaxResource' => [ 'base' => NULL, 'refs' => [ 'HyperbandStrategyConfig$MaxResource' => '

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTrainingJ attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:

  • epochs

  • numepochs

  • n-epochs

  • n_epochs

  • num_epochs

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributive training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

', ], ], 'HyperbandStrategyMinResource' => [ 'base' => NULL, 'refs' => [ 'HyperbandStrategyConfig$MinResource' => '

The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job is not stopped by Hyperband.

', ], ], 'IamIdentity' => [ 'base' => '

The IAM Identity details associated with the user. These details are associated with model package groups, model packages and project entities only.

', 'refs' => [ 'UserContext$IamIdentity' => '

The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

', ], ], 'IdempotencyToken' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'DeletePipelineRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'RetryPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', 'SendPipelineExecutionStepFailureRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'SendPipelineExecutionStepSuccessRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

', 'StartPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', 'StopPipelineExecutionRequest$ClientRequestToken' => '

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

', ], ], 'IdentityProviderOAuthSetting' => [ 'base' => '

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

', 'refs' => [ 'IdentityProviderOAuthSettings$member' => NULL, ], ], 'IdentityProviderOAuthSettings' => [ 'base' => NULL, 'refs' => [ 'CanvasAppSettings$IdentityProviderOAuthSettings' => '

The settings for connecting to an external data source with OAuth.

', ], ], 'Image' => [ 'base' => '

A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.

', 'refs' => [ 'Images$member' => NULL, ], ], 'ImageArn' => [ 'base' => NULL, 'refs' => [ 'CreateImageResponse$ImageArn' => '

The ARN of the image.

', 'DescribeImageResponse$ImageArn' => '

The ARN of the image.

', 'DescribeImageVersionResponse$ImageArn' => '

The ARN of the image the version is based on.

', 'Image$ImageArn' => '

The ARN of the image.

', 'ImageVersion$ImageArn' => '

The ARN of the image the version is based on.

', 'ResourceSpec$SageMakerImageArn' => '

The ARN of the SageMaker image that the image version belongs to.

', 'UpdateImageResponse$ImageArn' => '

The ARN of the image.

', ], ], 'ImageBaseImage' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$BaseImage' => '

The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

', 'DescribeImageVersionResponse$BaseImage' => '

The registry path of the container image on which this image version is based.

', ], ], 'ImageClassificationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the image classification problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$ImageClassificationJobConfig' => '

Settings used to configure an AutoML job V2 for the image classification problem type.

', ], ], 'ImageConfig' => [ 'base' => '

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).

', 'refs' => [ 'ContainerDefinition$ImageConfig' => '

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

', ], ], 'ImageContainerImage' => [ 'base' => NULL, 'refs' => [ 'DescribeImageVersionResponse$ContainerImage' => '

The registry path of the container image that contains this image version.

', ], ], 'ImageDeleteProperty' => [ 'base' => NULL, 'refs' => [ 'ImageDeletePropertyList$member' => NULL, ], ], 'ImageDeletePropertyList' => [ 'base' => NULL, 'refs' => [ 'UpdateImageRequest$DeleteProperties' => '

A list of properties to delete. Only the Description and DisplayName properties can be deleted.

', ], ], 'ImageDescription' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$Description' => '

The description of the image.

', 'DescribeImageResponse$Description' => '

The description of the image.

', 'Image$Description' => '

The description of the image.

', 'UpdateImageRequest$Description' => '

The new description for the image.

', ], ], 'ImageDigest' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$ImageDigest' => '

An MD5 hash of the training algorithm that identifies the Docker image used for training.

', 'TrainingSpecification$TrainingImageDigest' => '

An MD5 hash of the training algorithm that identifies the Docker image used for training.

', ], ], 'ImageDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$DisplayName' => '

The display name of the image. If not provided, ImageName is displayed.

', 'DescribeImageResponse$DisplayName' => '

The name of the image as displayed.

', 'Image$DisplayName' => '

The name of the image as displayed.

', 'UpdateImageRequest$DisplayName' => '

The new display name for the image.

', ], ], 'ImageName' => [ 'base' => NULL, 'refs' => [ 'CreateImageRequest$ImageName' => '

The name of the image. Must be unique to your account.

', 'CreateImageVersionRequest$ImageName' => '

The ImageName of the Image to create a version of.

', 'CustomImage$ImageName' => '

The name of the CustomImage. Must be unique to your account.

', 'DeleteImageRequest$ImageName' => '

The name of the image to delete.

', 'DeleteImageVersionRequest$ImageName' => '

The name of the image to delete.

', 'DescribeImageRequest$ImageName' => '

The name of the image to describe.

', 'DescribeImageResponse$ImageName' => '

The name of the image.

', 'DescribeImageVersionRequest$ImageName' => '

The name of the image.

', 'Image$ImageName' => '

The name of the image.

', 'ListAliasesRequest$ImageName' => '

The name of the image.

', 'ListImageVersionsRequest$ImageName' => '

The name of the image to list the versions of.

', 'UpdateImageRequest$ImageName' => '

The name of the image to update.

', 'UpdateImageVersionRequest$ImageName' => '

The name of the image.

', ], ], 'ImageNameContains' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$NameContains' => '

A filter that returns only images whose name contains the specified string.

', ], ], 'ImageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$SortBy' => '

The property used to sort results. The default value is CREATION_TIME.

', ], ], 'ImageSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListImagesRequest$SortOrder' => '

The sort order. The default value is DESCENDING.

', ], ], 'ImageStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeImageResponse$ImageStatus' => '

The status of the image.

', 'Image$ImageStatus' => '

The status of the image.

', ], ], 'ImageUri' => [ 'base' => NULL, 'refs' => [ 'AppSpecification$ImageUri' => '

The container image to be run by the processing job.

', 'DataQualityAppSpecification$ImageUri' => '

The container image that the data quality monitoring job runs.

', 'ModelBiasAppSpecification$ImageUri' => '

The container image to be run by the model bias job.

', 'ModelExplainabilityAppSpecification$ImageUri' => '

The container image to be run by the model explainability job.

', 'ModelQualityAppSpecification$ImageUri' => '

The address of the container image that the monitoring job runs.

', 'MonitoringAppSpecification$ImageUri' => '

The container image to be run by the monitoring job.

', ], ], 'ImageVersion' => [ 'base' => '

A version of a SageMaker Image. A version represents an existing container image.

', 'refs' => [ 'ImageVersions$member' => NULL, ], ], 'ImageVersionAlias' => [ 'base' => NULL, 'refs' => [ 'ResourceSpec$SageMakerImageVersionAlias' => '

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

', ], ], 'ImageVersionArn' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionResponse$ImageVersionArn' => '

The ARN of the image version.

', 'DescribeImageVersionResponse$ImageVersionArn' => '

The ARN of the version.

', 'ImageVersion$ImageVersionArn' => '

The ARN of the version.

', 'ResourceSpec$SageMakerImageVersionArn' => '

The ARN of the image version created on the instance.

', 'UpdateImageVersionResponse$ImageVersionArn' => '

The ARN of the image version.

', ], ], 'ImageVersionNumber' => [ 'base' => NULL, 'refs' => [ 'CustomImage$ImageVersionNumber' => '

The version number of the CustomImage.

', 'DeleteImageVersionRequest$Version' => '

The version to delete.

', 'DescribeImageVersionRequest$Version' => '

The version of the image. If not specified, the latest version is described.

', 'DescribeImageVersionResponse$Version' => '

The version number.

', 'ImageVersion$Version' => '

The version number.

', 'ListAliasesRequest$Version' => '

The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

', 'UpdateImageVersionRequest$Version' => '

The version of the image.

', ], ], 'ImageVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsRequest$SortBy' => '

The property used to sort results. The default value is CREATION_TIME.

', ], ], 'ImageVersionSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsRequest$SortOrder' => '

The sort order. The default value is DESCENDING.

', ], ], 'ImageVersionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeImageVersionResponse$ImageVersionStatus' => '

The status of the version.

', 'ImageVersion$ImageVersionStatus' => '

The status of the version.

', ], ], 'ImageVersions' => [ 'base' => NULL, 'refs' => [ 'ListImageVersionsResponse$ImageVersions' => '

A list of versions and their properties.

', ], ], 'Images' => [ 'base' => NULL, 'refs' => [ 'ListImagesResponse$Images' => '

A list of images and their properties.

', ], ], 'ImportHubContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportHubContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'InferenceComponentArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'DescribeInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'InferenceComponentSummary$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'UpdateInferenceComponentOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', 'UpdateInferenceComponentRuntimeConfigOutput$InferenceComponentArn' => '

The Amazon Resource Name (ARN) of the inference component.

', ], ], 'InferenceComponentComputeResourceRequirements' => [ 'base' => '

Defines the compute resources to allocate to run a model that you assign to an inference component. These resources include CPU cores, accelerators, and memory.

', 'refs' => [ 'InferenceComponentSpecification$ComputeResourceRequirements' => '

The compute resources allocated to run the model assigned to the inference component.

', 'InferenceComponentSpecificationSummary$ComputeResourceRequirements' => '

The compute resources allocated to run the model assigned to the inference component.

', ], ], 'InferenceComponentContainerSpecification' => [ 'base' => '

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

', 'refs' => [ 'InferenceComponentSpecification$Container' => '

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

', ], ], 'InferenceComponentContainerSpecificationSummary' => [ 'base' => '

Details about the resources that are deployed with this inference component.

', 'refs' => [ 'InferenceComponentSpecificationSummary$Container' => '

Details about the container that provides the runtime environment for the model that is deployed with the inference component.

', ], ], 'InferenceComponentCopyCount' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentRuntimeConfig$CopyCount' => '

The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.

', 'InferenceComponentRuntimeConfigSummary$DesiredCopyCount' => '

The number of runtime copies of the model container that you requested to deploy with the inference component.

', 'InferenceComponentRuntimeConfigSummary$CurrentCopyCount' => '

The number of runtime copies of the model container that are currently deployed.

', ], ], 'InferenceComponentName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentInput$InferenceComponentName' => '

A unique name to assign to the inference component.

', 'DeleteInferenceComponentInput$InferenceComponentName' => '

The name of the inference component to delete.

', 'DescribeInferenceComponentInput$InferenceComponentName' => '

The name of the inference component.

', 'DescribeInferenceComponentOutput$InferenceComponentName' => '

The name of the inference component.

', 'InferenceComponentSummary$InferenceComponentName' => '

The name of the inference component.

', 'UpdateInferenceComponentInput$InferenceComponentName' => '

The name of the inference component.

', 'UpdateInferenceComponentRuntimeConfigInput$InferenceComponentName' => '

The name of the inference component to update.

', ], ], 'InferenceComponentNameContains' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsInput$NameContains' => '

Filters the results to only those inference components with a name that contains the specified string.

', ], ], 'InferenceComponentRuntimeConfig' => [ 'base' => '

Runtime settings for a model that is deployed with an inference component.

', 'refs' => [ 'CreateInferenceComponentInput$RuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceComponentInput$RuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', 'UpdateInferenceComponentRuntimeConfigInput$DesiredRuntimeConfig' => '

Runtime settings for a model that is deployed with an inference component.

', ], ], 'InferenceComponentRuntimeConfigSummary' => [ 'base' => '

Details about the runtime settings for the model that is deployed with the inference component.

', 'refs' => [ 'DescribeInferenceComponentOutput$RuntimeConfig' => '

Details about the runtime settings for the model that is deployed with the inference component.

', ], ], 'InferenceComponentSortKey' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsInput$SortBy' => '

The field by which to sort the inference components in the response. The default is CreationTime.

', ], ], 'InferenceComponentSpecification' => [ 'base' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', 'refs' => [ 'CreateInferenceComponentInput$Specification' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', 'UpdateInferenceComponentInput$Specification' => '

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

', ], ], 'InferenceComponentSpecificationSummary' => [ 'base' => '

Details about the resources that are deployed with this inference component.

', 'refs' => [ 'DescribeInferenceComponentOutput$Specification' => '

Details about the resources that are deployed with this inference component.

', ], ], 'InferenceComponentStartupParameters' => [ 'base' => '

Settings that take effect while the model container starts up.

', 'refs' => [ 'InferenceComponentSpecification$StartupParameters' => '

Settings that take effect while the model container starts up.

', 'InferenceComponentSpecificationSummary$StartupParameters' => '

Settings that take effect while the model container starts up.

', ], ], 'InferenceComponentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceComponentOutput$InferenceComponentStatus' => '

The status of the inference component.

', 'InferenceComponentSummary$InferenceComponentStatus' => '

The status of the inference component.

', 'ListInferenceComponentsInput$StatusEquals' => '

Filters the results to only those inference components with the specified status.

', ], ], 'InferenceComponentSummary' => [ 'base' => '

A summary of the properties of an inference component.

', 'refs' => [ 'InferenceComponentSummaryList$member' => NULL, ], ], 'InferenceComponentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListInferenceComponentsOutput$InferenceComponents' => '

A list of inference components and their properties that matches any of the filters you specified in the request.

', ], ], 'InferenceExecutionConfig' => [ 'base' => '

Specifies details about how containers in a multi-container endpoint are run.

', 'refs' => [ 'CreateModelInput$InferenceExecutionConfig' => '

Specifies details of how containers in a multi-container endpoint are called.

', 'DescribeModelOutput$InferenceExecutionConfig' => '

Specifies details of how containers in a multi-container endpoint are called.

', 'Model$InferenceExecutionConfig' => NULL, ], ], 'InferenceExecutionMode' => [ 'base' => NULL, 'refs' => [ 'InferenceExecutionConfig$Mode' => '

How containers in a multi-container are run. The following values are valid.

  • SERIAL - Containers run as a serial pipeline.

  • DIRECT - Only the individual container that you specify is run.

', ], ], 'InferenceExperimentArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN for your inference experiment.

', 'DeleteInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the deleted inference experiment.

', 'DescribeInferenceExperimentResponse$Arn' => '

The ARN of the inference experiment being described.

', 'StartInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the started inference experiment to start.

', 'StopInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the stopped inference experiment.

', 'UpdateInferenceExperimentResponse$InferenceExperimentArn' => '

The ARN of the updated inference experiment.

', ], ], 'InferenceExperimentDataStorageConfig' => [ 'base' => '

The Amazon S3 location and configuration for storing inference request and response data.

', 'refs' => [ 'CreateInferenceExperimentRequest$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

This is an optional parameter that you can use for data capture. For more information, see Capture data.

', 'DescribeInferenceExperimentResponse$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

', 'UpdateInferenceExperimentRequest$DataStorageConfig' => '

The Amazon S3 location and configuration for storing inference request and response data.

', ], ], 'InferenceExperimentDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Description' => '

A description for the inference experiment.

', 'DescribeInferenceExperimentResponse$Description' => '

The description of the inference experiment.

', 'InferenceExperimentSummary$Description' => '

The description of the inference experiment.

', 'UpdateInferenceExperimentRequest$Description' => '

The description of the inference experiment.

', ], ], 'InferenceExperimentList' => [ 'base' => NULL, 'refs' => [ 'ListInferenceExperimentsResponse$InferenceExperiments' => '

List of inference experiments.

', ], ], 'InferenceExperimentName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Name' => '

The name for the inference experiment.

', 'DeleteInferenceExperimentRequest$Name' => '

The name of the inference experiment you want to delete.

', 'DescribeInferenceExperimentRequest$Name' => '

The name of the inference experiment to describe.

', 'DescribeInferenceExperimentResponse$Name' => '

The name of the inference experiment.

', 'InferenceExperimentSummary$Name' => '

The name of the inference experiment.

', 'StartInferenceExperimentRequest$Name' => '

The name of the inference experiment to start.

', 'StopInferenceExperimentRequest$Name' => '

The name of the inference experiment to stop.

', 'UpdateInferenceExperimentRequest$Name' => '

The name of the inference experiment to be updated.

', ], ], 'InferenceExperimentSchedule' => [ 'base' => '

The start and end times of an inference experiment.

The maximum duration that you can set for an inference experiment is 30 days.

', 'refs' => [ 'CreateInferenceExperimentRequest$Schedule' => '

The duration for which you want the inference experiment to run. If you don\'t specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.

', 'DescribeInferenceExperimentResponse$Schedule' => '

The duration for which the inference experiment ran or will run.

', 'InferenceExperimentSummary$Schedule' => '

The duration for which the inference experiment ran or will run.

The maximum duration that you can set for an inference experiment is 30 days.

', 'UpdateInferenceExperimentRequest$Schedule' => '

The duration for which the inference experiment will run. If the status of the inference experiment is Created, then you can update both the start and end dates. If the status of the inference experiment is Running, then you can update only the end date.

', ], ], 'InferenceExperimentStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$Status' => '

The status of the inference experiment. The following are the possible statuses for an inference experiment:

  • Creating - Amazon SageMaker is creating your experiment.

  • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

  • Updating - When you make changes to your experiment, your experiment shows as updating.

  • Starting - Amazon SageMaker is beginning your experiment.

  • Running - Your experiment is in progress.

  • Stopping - Amazon SageMaker is stopping your experiment.

  • Completed - Your experiment has completed.

  • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

', 'InferenceExperimentSummary$Status' => '

The status of the inference experiment.

', 'ListInferenceExperimentsRequest$StatusEquals' => '

Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.

', ], ], 'InferenceExperimentStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$StatusReason' => '

The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

', 'InferenceExperimentSummary$StatusReason' => '

The error message for the inference experiment status result.

', 'StopInferenceExperimentRequest$Reason' => '

The reason for stopping the experiment.

', ], ], 'InferenceExperimentStopDesiredState' => [ 'base' => NULL, 'refs' => [ 'StopInferenceExperimentRequest$DesiredState' => '

The desired state of the experiment after stopping. The possible states are the following:

  • Completed: The experiment completed successfully

  • Cancelled: The experiment was canceled

', ], ], 'InferenceExperimentSummary' => [ 'base' => '

Lists a summary of properties of an inference experiment.

', 'refs' => [ 'InferenceExperimentList$member' => NULL, ], ], 'InferenceExperimentType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$Type' => '

The type of the inference experiment that you want to run. The following types of experiments are possible:

  • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

', 'DescribeInferenceExperimentResponse$Type' => '

The type of the inference experiment.

', 'InferenceExperimentSummary$Type' => '

The type of the inference experiment.

', 'ListInferenceExperimentsRequest$Type' => '

Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.

', ], ], 'InferenceImage' => [ 'base' => NULL, 'refs' => [ 'DescribeCompilationJobResponse$InferenceImage' => '

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

', ], ], 'InferenceMetrics' => [ 'base' => '

The metrics for an existing endpoint compared in an Inference Recommender job.

', 'refs' => [ 'EndpointPerformance$Metrics' => '

The metrics for an existing endpoint.

', 'RecommendationJobInferenceBenchmark$EndpointMetrics' => NULL, ], ], 'InferenceRecommendation' => [ 'base' => '

A list of recommendations made by Amazon SageMaker Inference Recommender.

', 'refs' => [ 'InferenceRecommendations$member' => NULL, ], ], 'InferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$InferenceRecommendations' => '

The recommendations made by Inference Recommender.

', ], ], 'InferenceRecommendationsJob' => [ 'base' => '

A structure that contains a list of recommendation jobs.

', 'refs' => [ 'InferenceRecommendationsJobs$member' => NULL, ], ], 'InferenceRecommendationsJobStep' => [ 'base' => '

A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.

', 'refs' => [ 'InferenceRecommendationsJobSteps$member' => NULL, ], ], 'InferenceRecommendationsJobSteps' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobStepsResponse$Steps' => '

A list of all subtask details in Inference Recommender.

', ], ], 'InferenceRecommendationsJobs' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsResponse$InferenceRecommendationsJobs' => '

The recommendations created from the Amazon SageMaker Inference Recommender job.

', ], ], 'InferenceSpecification' => [ 'base' => '

Defines how to perform inference generation after a training job is run.

', 'refs' => [ 'BatchDescribeModelPackageSummary$InferenceSpecification' => NULL, 'CreateAlgorithmInput$InferenceSpecification' => '

Specifies details about inference jobs that the algorithm runs, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the algorithm supports for inference.

', 'CreateModelPackageInput$InferenceSpecification' => '

Specifies details about inference jobs that can be run with models based on this model package, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

', 'DescribeAlgorithmOutput$InferenceSpecification' => '

Details about inference jobs that the algorithm runs.

', 'DescribeModelPackageOutput$InferenceSpecification' => '

Details about inference jobs that can be run with models based on this model package.

', 'ModelPackage$InferenceSpecification' => '

Defines how to perform inference generation after a training job is run.

', ], ], 'InferenceSpecificationName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$InferenceSpecificationName' => '

The inference specification name in the model package version.

', 'EndpointInputConfiguration$InferenceSpecificationName' => '

The inference specification name in the model package version.

', 'ModelConfiguration$InferenceSpecificationName' => '

The inference specification name in the model package version.

', ], ], 'InfraCheckConfig' => [ 'base' => '

Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network connectivity.

', 'refs' => [ 'CreateTrainingJobRequest$InfraCheckConfig' => '

Contains information about the infrastructure health check configuration for the training job.

', 'DescribeTrainingJobResponse$InfraCheckConfig' => '

Contains information about the infrastructure health check configuration for the training job.

', ], ], 'InitialInstanceCount' => [ 'base' => NULL, 'refs' => [ 'EndpointOutputConfiguration$InitialInstanceCount' => '

The number of instances recommended to launch initially.

', ], ], 'InitialNumberOfUsers' => [ 'base' => NULL, 'refs' => [ 'Phase$InitialNumberOfUsers' => '

Specifies how many concurrent users to start with. The value should be between 1 and 3.

', ], ], 'InitialTaskCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$InitialInstanceCount' => '

Number of instances to launch initially.

', ], ], 'InputConfig' => [ 'base' => '

Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', 'refs' => [ 'CreateCompilationJobRequest$InputConfig' => '

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', 'DescribeCompilationJobResponse$InputConfig' => '

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

', ], ], 'InputDataConfig' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$InputDataConfig' => '

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.

Your input must be in the same Amazon Web Services region as your training job.

', 'DescribeTrainingJobResponse$InputDataConfig' => '

An array of Channel objects that describes each data input channel.

', 'HyperParameterTrainingJobDefinition$InputDataConfig' => '

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

', 'TrainingJob$InputDataConfig' => '

An array of Channel objects that describes each data input channel.

Your input must be in the same Amazon Web Services region as your training job.

', 'TrainingJobDefinition$InputDataConfig' => '

An array of Channel objects, each of which specifies an input source.

', ], ], 'InputMode' => [ 'base' => NULL, 'refs' => [ 'DatasetDefinition$InputMode' => '

Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

', ], ], 'InputModes' => [ 'base' => NULL, 'refs' => [ 'ChannelSpecification$SupportedInputModes' => '

The allowed input mode, either FILE or PIPE.

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

', ], ], 'InstanceGroup' => [ 'base' => '

Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .

', 'refs' => [ 'InstanceGroups$member' => NULL, ], ], 'InstanceGroupName' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$InstanceGroupName' => '

Specifies the name of the instance group.

', 'InstanceGroupNames$member' => NULL, ], ], 'InstanceGroupNames' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$InstanceGroupNames' => '

A list of names of instance groups that get data from the S3 data source.

', ], ], 'InstanceGroups' => [ 'base' => NULL, 'refs' => [ 'ResourceConfig$InstanceGroups' => '

The configuration of a heterogeneous cluster in JSON format.

', ], ], 'InstanceMetadataServiceConfiguration' => [ 'base' => '

Information on the IMDS configuration of the notebook instance

', 'refs' => [ 'CreateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', 'DescribeNotebookInstanceOutput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', 'UpdateNotebookInstanceInput$InstanceMetadataServiceConfiguration' => '

Information on the IMDS configuration of the notebook instance

', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$InstanceType' => '

The type of ML compute instance to launch for the notebook instance.

', 'DescribeNotebookInstanceOutput$InstanceType' => '

The type of ML compute instance running on the notebook instance.

', 'NotebookInstanceSummary$InstanceType' => '

The type of ML compute instance that the notebook instance is running on.

', 'RealTimeInferenceConfig$InstanceType' => '

The instance type the model is deployed to.

', 'UpdateNotebookInstanceInput$InstanceType' => '

The Amazon ML compute instance type.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobRequest$ModelCardVersion' => '

The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

', 'DescribeDeviceResponse$MaxModels' => '

The maximum number of models.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentSuccess' => '

The number of edge devices with the successful deployment.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPending' => '

The number of edge devices yet to pick up deployment, or in progress.

', 'DescribeEdgeDeploymentPlanResponse$EdgeDeploymentFailed' => '

The number of edge devices that failed the deployment.

', 'DescribeModelCardExportJobResponse$ModelCardVersion' => '

The version of the model card that the model export job exports.

', 'DescribeModelCardRequest$ModelCardVersion' => '

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

', 'DescribeModelCardResponse$ModelCardVersion' => '

The version of the model card.

', 'DynamicScalingConfiguration$MinCapacity' => '

The recommended minimum capacity to specify for your autoscaling policy.

', 'DynamicScalingConfiguration$MaxCapacity' => '

The recommended maximum capacity to specify for your autoscaling policy.

', 'DynamicScalingConfiguration$ScaleInCooldown' => '

The recommended scale in cooldown time for your autoscaling policy.

', 'DynamicScalingConfiguration$ScaleOutCooldown' => '

The recommended scale out cooldown time for your autoscaling policy.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentSuccess' => '

The number of edge devices with the successful deployment.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentPending' => '

The number of edge devices yet to pick up the deployment, or in progress.

', 'EdgeDeploymentPlanSummary$EdgeDeploymentFailed' => '

The number of edge devices that failed the deployment.

', 'EdgeDeploymentStatus$EdgeDeploymentSuccessInStage' => '

The number of edge devices with the successful deployment in the current stage.

', 'EdgeDeploymentStatus$EdgeDeploymentPendingInStage' => '

The number of edge devices yet to pick up the deployment in current stage, or in progress.

', 'EdgeDeploymentStatus$EdgeDeploymentFailedInStage' => '

The number of edge devices that failed the deployment in current stage.

', 'HyperParameterTuningJobCompletionDetails$NumberOfTrainingJobsObjectiveNotImproving' => '

The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.

', 'HyperParameterTuningJobConsumedResources$RuntimeInSeconds' => '

The wall clock runtime in seconds used by your hyperparameter tuning job.

', 'InferenceMetrics$MaxInvocations' => '

The expected maximum number of requests per minute for the instance.

', 'InferenceMetrics$ModelLatency' => '

The expected model latency at maximum invocations per minute for the instance.

', 'ListModelCardExportJobsRequest$ModelCardVersion' => '

List export jobs for the model card with the specified version.

', 'ModelCard$ModelCardVersion' => '

The version of the model card.

', 'ModelCardExportJobSummary$ModelCardVersion' => '

The version of the model card that the export job exports.

', 'ModelCardVersionSummary$ModelCardVersion' => '

A version of the model card.

', 'ModelDashboardModelCard$ModelCardVersion' => '

The model card version.

', 'ModelLatencyThreshold$ValueInMilliseconds' => '

The model latency percentile value in milliseconds.

', 'PipelineExecutionStep$AttemptCount' => '

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

', 'RecommendationJobStoppingConditions$MaxInvocations' => '

The maximum number of requests per minute expected for the endpoint.

', 'RecommendationMetrics$MaxInvocations' => '

The expected maximum number of requests per minute for the instance.

', 'RecommendationMetrics$ModelLatency' => '

The expected model latency at maximum invocation per minute for the instance.

', 'ScalingPolicyMetric$InvocationsPerInstance' => '

The number of invocations sent to a model, normalized by InstanceCount in each ProductionVariant. 1/numberOfInstances is sent as the value on each request, where numberOfInstances is the number of active instances for the ProductionVariant behind the endpoint at the time of the request.

', 'ScalingPolicyMetric$ModelLatency' => '

The interval of time taken by a model to respond as viewed from SageMaker. This interval includes the local communication times taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

', 'ScalingPolicyObjective$MinInvocationsPerMinute' => '

The minimum number of expected requests to your endpoint per minute.

', 'ScalingPolicyObjective$MaxInvocationsPerMinute' => '

The maximum number of expected requests to your endpoint per minute.

', ], ], 'IntegerParameterRange' => [ 'base' => '

For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.

', 'refs' => [ 'IntegerParameterRanges$member' => NULL, ], ], 'IntegerParameterRangeSpecification' => [ 'base' => '

Defines the possible values for an integer hyperparameter.

', 'refs' => [ 'ParameterRange$IntegerParameterRangeSpecification' => '

A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

', ], ], 'IntegerParameterRanges' => [ 'base' => NULL, 'refs' => [ 'ParameterRanges$IntegerParameterRanges' => '

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

', ], ], 'InvocationEndTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationEndTime' => '

A timestamp that shows when the benchmark completed.

', 'RecommendationJobInferenceBenchmark$InvocationEndTime' => '

A timestamp that shows when the benchmark completed.

', ], ], 'InvocationStartTime' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendation$InvocationStartTime' => '

A timestamp that shows when the benchmark started.

', 'RecommendationJobInferenceBenchmark$InvocationStartTime' => '

A timestamp that shows when the benchmark started.

', ], ], 'InvocationsMaxRetries' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsMaxRetries' => '

The maximum number of retries when invocation requests are failing. The default value is 3.

', ], ], 'InvocationsTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'ModelClientConfig$InvocationsTimeoutInSeconds' => '

The timeout value in seconds for an invocation request. The default value is 600.

', ], ], 'IotRoleAlias' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceFleetResponse$IotRoleAlias' => '

The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

', ], ], 'ItemIdentifierAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$ItemIdentifierAttributeName' => '

The name of the column that represents the set of item identifiers for which you want to predict the target value.

', ], ], 'JobDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInputConfig$JobDurationInSeconds' => '

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

', ], ], 'JobReferenceCode' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$JobReferenceCode' => '

A unique identifier for work done as part of a labeling job.

', 'LabelingJobForWorkteamSummary$JobReferenceCode' => '

A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

', ], ], 'JobReferenceCodeContains' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$JobReferenceCodeContains' => '

A filter the limits jobs to only the ones whose job reference code contains the specified string.

', ], ], 'JobType' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', 'DescribeImageVersionResponse$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', 'UpdateImageVersionRequest$JobType' => '

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

', ], ], 'JoinSource' => [ 'base' => NULL, 'refs' => [ 'DataProcessing$JoinSource' => '

Specifies the source of the data to join with the transformed data. The valid values are None and Input. The default value is None, which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input. You can specify OutputFilter as an additional filter to select a portion of the joined dataset and store it in the output file.

For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with the input by appending each transformed row to the end of the input. The joined data has the original input data followed by the transformed data and the output is a CSV file.

For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

', ], ], 'JsonContentType' => [ 'base' => NULL, 'refs' => [ 'JsonContentTypes$member' => NULL, ], ], 'JsonContentTypes' => [ 'base' => NULL, 'refs' => [ 'CaptureContentTypeHeader$JsonContentTypes' => '

The list of all content type headers that SageMaker will treat as JSON and capture accordingly.

', ], ], 'JsonPath' => [ 'base' => NULL, 'refs' => [ 'DataProcessing$InputFilter' => '

A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

Examples: "$", "$[1:]", "$.features"

', 'DataProcessing$OutputFilter' => '

A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren\'t within the dimension size of the joined dataset, you get an error.

Examples: "$", "$[0,5:]", "$[\'id\',\'SageMakerOutput\']"

', ], ], 'JupyterLabAppImageConfig' => [ 'base' => '

The configuration for the file system and kernels in a SageMaker image running as a JupyterLab app.

', 'refs' => [ 'AppImageConfigDetails$JupyterLabAppImageConfig' => '

The configuration for the file system and the runtime, such as the environment variables and entry point.

', 'CreateAppImageConfigRequest$JupyterLabAppImageConfig' => '

The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.

', 'DescribeAppImageConfigResponse$JupyterLabAppImageConfig' => '

The configuration of the JupyterLab app.

', 'UpdateAppImageConfigRequest$JupyterLabAppImageConfig' => '

The JupyterLab app running on the image.

', ], ], 'JupyterLabAppSettings' => [ 'base' => '

The settings for the JupyterLab application.

', 'refs' => [ 'UserSettings$JupyterLabAppSettings' => '

The settings for the JupyterLab application.

', ], ], 'JupyterServerAppSettings' => [ 'base' => '

The JupyterServer app settings.

', 'refs' => [ 'DefaultSpaceSettings$JupyterServerAppSettings' => NULL, 'SpaceSettings$JupyterServerAppSettings' => NULL, 'UserSettings$JupyterServerAppSettings' => '

The Jupyter server\'s app settings.

', ], ], 'KeepAlivePeriodInSeconds' => [ 'base' => 'Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.', 'refs' => [ 'ResourceConfig$KeepAlivePeriodInSeconds' => '

The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.

', 'ResourceConfigForUpdate$KeepAlivePeriodInSeconds' => '

The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.

', ], ], 'KendraSettings' => [ 'base' => '

The Amazon SageMaker Canvas application setting where you configure document querying.

', 'refs' => [ 'CanvasAppSettings$KendraSettings' => '

The settings for document querying.

', ], ], 'KernelDisplayName' => [ 'base' => NULL, 'refs' => [ 'KernelSpec$DisplayName' => '

The display name of the kernel.

', ], ], 'KernelGatewayAppSettings' => [ 'base' => '

The KernelGateway app settings.

', 'refs' => [ 'DefaultSpaceSettings$KernelGatewayAppSettings' => NULL, 'SpaceSettings$KernelGatewayAppSettings' => NULL, 'UserSettings$KernelGatewayAppSettings' => '

The kernel gateway app settings.

', ], ], 'KernelGatewayImageConfig' => [ 'base' => '

The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.

', 'refs' => [ 'AppImageConfigDetails$KernelGatewayImageConfig' => '

The configuration for the file system and kernels in the SageMaker image.

', 'CreateAppImageConfigRequest$KernelGatewayImageConfig' => '

The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.

', 'DescribeAppImageConfigResponse$KernelGatewayImageConfig' => '

The configuration of a KernelGateway app.

', 'UpdateAppImageConfigRequest$KernelGatewayImageConfig' => '

The new KernelGateway app to run on the image.

', ], ], 'KernelName' => [ 'base' => NULL, 'refs' => [ 'KernelSpec$Name' => '

The name of the Jupyter kernel in the image. This value is case sensitive.

', ], ], 'KernelSpec' => [ 'base' => '

The specification of a Jupyter kernel.

', 'refs' => [ 'KernelSpecs$member' => NULL, ], ], 'KernelSpecs' => [ 'base' => NULL, 'refs' => [ 'KernelGatewayImageConfig$KernelSpecs' => '

The specification of the Jupyter kernels in the image.

', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$ObjectKey' => '

The object key (or key name) uniquely identifies the object in an S3 bucket.

', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

', 'AthenaDatasetDefinition$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

', 'AutoMLOutputDataConfig$KmsKeyId' => '

The Key Management Service (KMS) encryption key ID.

', 'AutoMLSecurityConfig$VolumeKmsKeyId' => '

The key used to encrypt stored data.

', 'BatchDataCaptureConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'CreateDomainRequest$HomeEfsFileSystemKmsKeyId' => '

Use KmsKeyId.

', 'CreateDomainRequest$KmsKeyId' => '

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

', 'CreateEdgePackagingJobRequest$ResourceKey' => '

The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.

', 'CreateEndpointConfigInput$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

', 'CreateInferenceExperimentRequest$KmsKey' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:

  • KMS key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS key Alias

    "alias/ExampleAlias"

  • Amazon Resource Name (ARN) of a KMS key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'CreateNotebookInstanceInput$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.

', 'DataCaptureConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'DataCaptureConfigSummary$KmsKeyId' => '

The KMS key being used to encrypt the data in Amazon S3.

', 'DescribeDomainResponse$HomeEfsFileSystemKmsKeyId' => '

Use KmsKeyId.

', 'DescribeDomainResponse$KmsKeyId' => '

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

', 'DescribeEdgePackagingJobResponse$ResourceKey' => '

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

', 'DescribeEndpointConfigOutput$KmsKeyId' => '

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

', 'DescribeInferenceExperimentResponse$KmsKey' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.

', 'DescribeNotebookInstanceOutput$KmsKeyId' => '

The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

', 'EdgeOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account.

', 'FlowDefinitionOutputConfig$KmsKeyId' => '

The Amazon Key Management Service (KMS) key ID for server-side encryption.

', 'HyperParameterTuningResourceConfig$VolumeKmsKeyId' => '

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.

KMS Key ID:

"1234abcd-12ab-34cd-56ef-1234567890ab"

Amazon Resource Name (ARN) of a KMS key:

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.

', 'InferenceExperimentDataStorageConfig$KmsKey' => '

The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.

', 'LabelingJobOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don\'t provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role\'s account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

', 'LabelingJobResourceConfig$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling.

You can only specify a VolumeKmsKeyId when you create a labeling job with automated data labeling enabled using the API operation CreateLabelingJob. You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see Output Data and Storage Volume Encryption.

The VolumeKmsKeyId can be any of the following formats:

  • KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

', 'ModelCardSecurityConfig$KmsKeyId' => '

A Key Management Service key ID to use for encrypting a model card.

', 'MonitoringClusterConfig$VolumeKmsKeyId' => '

The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

', 'MonitoringOutputConfig$KmsKeyId' => '

The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

', 'OnlineStoreSecurityConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:

  • "kms:Encrypt"

  • "kms:Decrypt"

  • "kms:DescribeKey"

  • "kms:CreateGrant"

  • "kms:RetireGrant"

  • "kms:ReEncryptFrom"

  • "kms:ReEncryptTo"

  • "kms:GenerateDataKey"

  • "kms:ListAliases"

  • "kms:ListGrants"

  • "kms:RevokeGrant"

The caller (either user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:

  • "kms:Decrypt"

', 'OutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'OutputDataConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'ProcessingClusterConfig$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

', 'ProcessingOutputConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.

', 'ProductionVariantCoreDumpConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don\'t provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role\'s account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'RecommendationJobInputConfig$VolumeKmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

', 'RecommendationJobOutputConfig$KmsKeyId' => '

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

', 'RedshiftDatasetDefinition$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.

', 'ResourceConfig$VolumeKmsKeyId' => '

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be in any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

', 'S3StorageConfig$KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:

  • "kms:GenerateDataKey"

', 'SharingSettings$S3KmsKeyId' => '

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

', 'TransformOutput$KmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

If you don\'t provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role\'s account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'TransformResources$VolumeKmsKeyId' => '

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can\'t request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

', 'WorkspaceSettings$S3KmsKeyId' => '

The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

', ], ], 'LabelAttributeName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelAttributeName' => '

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.

  • The name can\'t end with "-metadata".

  • If you are using one of the following built-in task types, the attribute name must end with "-ref". If the task type you are using is not listed below, the attribute name must not end with "-ref".

    • Image semantic segmentation (SemanticSegmentation), and adjustment (AdjustmentSemanticSegmentation) and verification (VerificationSemanticSegmentation) labeling jobs for this task type.

    • Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.

    • Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.

    • 3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.

    • 3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.

If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.

', 'DescribeLabelingJobResponse$LabelAttributeName' => '

The attribute used as the label in the output manifest file.

', ], ], 'LabelCounter' => [ 'base' => NULL, 'refs' => [ 'LabelCounters$TotalLabeled' => '

The total number of objects labeled.

', 'LabelCounters$HumanLabeled' => '

The total number of objects labeled by a human worker.

', 'LabelCounters$MachineLabeled' => '

The total number of objects labeled by automated data labeling.

', 'LabelCounters$FailedNonRetryableError' => '

The total number of objects that could not be labeled due to an error.

', 'LabelCounters$Unlabeled' => '

The total number of objects not yet labeled.

', 'LabelCountersForWorkteam$HumanLabeled' => '

The total number of data objects labeled by a human worker.

', 'LabelCountersForWorkteam$PendingHuman' => '

The total number of data objects that need to be labeled by a human worker.

', 'LabelCountersForWorkteam$Total' => '

The total number of tasks in the labeling job.

', ], ], 'LabelCounters' => [ 'base' => '

Provides a breakdown of the number of objects labeled.

', 'refs' => [ 'DescribeLabelingJobResponse$LabelCounters' => '

Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn\'t be labeled, and the total number of objects labeled.

', 'LabelingJobSummary$LabelCounters' => '

Counts showing the progress of the labeling job.

', ], ], 'LabelCountersForWorkteam' => [ 'base' => '

Provides counts for human-labeled tasks in the labeling job.

', 'refs' => [ 'LabelingJobForWorkteamSummary$LabelCounters' => '

Provides information about the progress of a labeling job.

', ], ], 'LabelingJobAlgorithmSpecificationArn' => [ 'base' => NULL, 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobAlgorithmSpecificationArn' => '

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

  • Image classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

  • Text classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

  • Object detection

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

  • Semantic Segmentation

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

', ], ], 'LabelingJobAlgorithmsConfig' => [ 'base' => '

Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.

', 'refs' => [ 'CreateLabelingJobRequest$LabelingJobAlgorithmsConfig' => '

Configures the information required to perform automated data labeling.

', 'DescribeLabelingJobResponse$LabelingJobAlgorithmsConfig' => '

Configuration information for automated data labeling.

', ], ], 'LabelingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

', 'DescribeLabelingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job.

', 'DescribeTrainingJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.

', 'DescribeTransformJobResponse$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

', 'LabelingJobSummary$LabelingJobArn' => '

The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

', 'TrainingJob$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job.

', 'TransformJob$LabelingJobArn' => '

The Amazon Resource Name (ARN) of the labeling job that created the transform job.

', ], ], 'LabelingJobDataAttributes' => [ 'base' => '

Attributes of the data specified by the customer. Use these to describe the data to be labeled.

', 'refs' => [ 'LabelingJobInputConfig$DataAttributes' => '

Attributes of the data specified by the customer.

', ], ], 'LabelingJobDataSource' => [ 'base' => '

Provides information about the location of input data.

You must specify at least one of the following: S3DataSource or SnsDataSource.

Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job.

Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

', 'refs' => [ 'LabelingJobInputConfig$DataSource' => '

The location of the input data.

', ], ], 'LabelingJobForWorkteamSummary' => [ 'base' => '

Provides summary information for a work team.

', 'refs' => [ 'LabelingJobForWorkteamSummaryList$member' => NULL, ], ], 'LabelingJobForWorkteamSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamResponse$LabelingJobSummaryList' => '

An array of LabelingJobSummary objects, each describing a labeling job.

', ], ], 'LabelingJobInputConfig' => [ 'base' => '

Input configuration information for a labeling job.

', 'refs' => [ 'CreateLabelingJobRequest$InputConfig' => '

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

You must specify at least one of the following: S3DataSource or SnsDataSource.

  • Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.

  • Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use ContentClassifiers to specify that your data is free of personally identifiable information and adult content.

', 'DescribeLabelingJobResponse$InputConfig' => '

Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

', 'LabelingJobSummary$InputConfig' => '

Input configuration for the labeling job.

', ], ], 'LabelingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateLabelingJobRequest$LabelingJobName' => '

The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. LabelingJobName is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.

', 'DescribeLabelingJobRequest$LabelingJobName' => '

The name of the labeling job to return information for.

', 'DescribeLabelingJobResponse$LabelingJobName' => '

The name assigned to the labeling job when it was created.

', 'LabelingJobForWorkteamSummary$LabelingJobName' => '

The name of the labeling job that the work team is assigned to.

', 'LabelingJobSummary$LabelingJobName' => '

The name of the labeling job.

', 'StopLabelingJobRequest$LabelingJobName' => '

The name of the labeling job to stop.

', ], ], 'LabelingJobOutput' => [ 'base' => '

Specifies the location of the output produced by the labeling job.

', 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobOutput' => '

The location of the output produced by the labeling job.

', 'LabelingJobSummary$LabelingJobOutput' => '

The location of the output produced by the labeling job.

', ], ], 'LabelingJobOutputConfig' => [ 'base' => '

Output configuration information for a labeling job.

', 'refs' => [ 'CreateLabelingJobRequest$OutputConfig' => '

The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

', 'DescribeLabelingJobResponse$OutputConfig' => '

The location of the job\'s output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

', ], ], 'LabelingJobResourceConfig' => [ 'base' => '

Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.

', 'refs' => [ 'LabelingJobAlgorithmsConfig$LabelingJobResourceConfig' => '

Provides configuration information for a labeling job.

', ], ], 'LabelingJobS3DataSource' => [ 'base' => '

The Amazon S3 location of the input data objects.

', 'refs' => [ 'LabelingJobDataSource$S3DataSource' => '

The Amazon S3 location of the input data objects.

', ], ], 'LabelingJobSnsDataSource' => [ 'base' => '

An Amazon SNS data source used for streaming labeling jobs.

', 'refs' => [ 'LabelingJobDataSource$SnsDataSource' => '

An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.

', ], ], 'LabelingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeLabelingJobResponse$LabelingJobStatus' => '

The processing status of the labeling job.

', 'LabelingJobSummary$LabelingJobStatus' => '

The current status of the labeling job.

', 'ListLabelingJobsRequest$StatusEquals' => '

A filter that retrieves only labeling jobs with a specific status.

', ], ], 'LabelingJobStoppingConditions' => [ 'base' => '

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Labeling jobs fail after 30 days with an appropriate client error message.

', 'refs' => [ 'CreateLabelingJobRequest$StoppingConditions' => '

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

', 'DescribeLabelingJobResponse$StoppingConditions' => '

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

', ], ], 'LabelingJobSummary' => [ 'base' => '

Provides summary information about a labeling job.

', 'refs' => [ 'LabelingJobSummaryList$member' => NULL, ], ], 'LabelingJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsResponse$LabelingJobSummaryList' => '

An array of LabelingJobSummary objects, each describing a labeling job.

', ], ], 'LambdaFunctionArn' => [ 'base' => NULL, 'refs' => [ 'AnnotationConsolidationConfig$AnnotationConsolidationLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

This parameter is required for all labeling jobs. For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Semantic Segmentation Adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

Semantic Segmentation Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding Box Adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

Bounding Box Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking

3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection

3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation

', 'HumanTaskConfig$PreHumanTaskLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking

3D Point Cloud Modalities

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking

3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation

', 'LabelingJobSummary$PreHumanTaskLambdaArn' => '

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.

', 'LabelingJobSummary$AnnotationConsolidationLambdaArn' => '

The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.

', ], ], 'LambdaStepMetadata' => [ 'base' => '

Metadata for a Lambda step.

', 'refs' => [ 'PipelineExecutionStepMetadata$Lambda' => '

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

', ], ], 'LandingUri' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$LandingUri' => '

The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

  • studio::relative/path: Directs users to the relative path in Studio.

  • app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

  • app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

  • app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

  • app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

  • app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

', 'UserSettings$DefaultLandingUri' => '

The default experience that the user is directed to when accessing the domain. The supported values are:

  • studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

  • app:JupyterServer:: Indicates that Studio Classic is the default experience.

', ], ], 'LastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'CodeRepositorySummary$LastModifiedTime' => '

The date and time that the Git repository was last modified.

', 'CompilationJobSummary$LastModifiedTime' => '

The time when the model compilation job was last modified.

', 'DescribeCodeRepositoryOutput$LastModifiedTime' => '

The date and time that the repository was last changed.

', 'DescribeCompilationJobResponse$LastModifiedTime' => '

The time that the status of the model compilation job was last modified.

', 'DescribeDomainResponse$LastModifiedTime' => '

The last modified time.

', 'DescribeFeatureGroupResponse$LastModifiedTime' => '

A timestamp indicating when the feature group was last updated.

', 'DescribeFeatureMetadataResponse$LastModifiedTime' => '

A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you

', 'DescribeInferenceRecommendationsJobResponse$LastModifiedTime' => '

A timestamp that shows when the job was last modified.

', 'DescribeNotebookInstanceLifecycleConfigOutput$LastModifiedTime' => '

A timestamp that tells when the lifecycle configuration was last modified.

', 'DescribeNotebookInstanceOutput$LastModifiedTime' => '

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

', 'DescribeSpaceResponse$LastModifiedTime' => '

The last modified time.

', 'DescribeUserProfileResponse$LastModifiedTime' => '

The last modified time.

', 'DomainDetails$LastModifiedTime' => '

The last modified time.

', 'FeatureGroup$LastModifiedTime' => '

A timestamp indicating the last time you updated the feature group.

', 'FeatureMetadata$LastModifiedTime' => '

A timestamp indicating when the feature was last modified.

', 'InferenceRecommendationsJob$LastModifiedTime' => '

A timestamp that shows when the job was last modified.

', 'ListCompilationJobsRequest$LastModifiedTimeAfter' => '

A filter that returns the model compilation jobs that were modified after a specified time.

', 'ListCompilationJobsRequest$LastModifiedTimeBefore' => '

A filter that returns the model compilation jobs that were modified before a specified time.

', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only jobs that were last modified after the specified time (timestamp).

', 'ListInferenceRecommendationsJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only jobs that were last modified before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeBefore' => '

A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

', 'ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeAfter' => '

A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

', 'ListNotebookInstancesInput$LastModifiedTimeBefore' => '

A filter that returns only notebook instances that were modified before the specified time (timestamp).

', 'ListNotebookInstancesInput$LastModifiedTimeAfter' => '

A filter that returns only notebook instances that were modified after the specified time (timestamp).

', 'NotebookInstanceLifecycleConfigSummary$LastModifiedTime' => '

A timestamp that tells when the lifecycle configuration was last modified.

', 'NotebookInstanceSummary$LastModifiedTime' => '

A timestamp that shows when the notebook instance was last modified.

', 'SpaceDetails$LastModifiedTime' => '

The last modified time.

', 'UserProfileDetails$LastModifiedTime' => '

The last modified time.

', ], ], 'LastUpdateStatus' => [ 'base' => '

A value that indicates whether the update was successful.

', 'refs' => [ 'DescribeFeatureGroupResponse$LastUpdateStatus' => '

A value indicating whether the update made to the feature group was successful.

', 'FeatureGroup$LastUpdateStatus' => '

A value that indicates whether the feature group was updated successfully.

', ], ], 'LastUpdateStatusValue' => [ 'base' => NULL, 'refs' => [ 'LastUpdateStatus$Status' => '

A value that indicates whether the update was made successful.

', ], ], 'LifecycleConfigArns' => [ 'base' => NULL, 'refs' => [ 'CodeEditorAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

', 'JupyterLabAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

', 'JupyterServerAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

', 'KernelGatewayAppSettings$LifecycleConfigArns' => '

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

', ], ], 'LineageEntityParameters' => [ 'base' => NULL, 'refs' => [ 'CreateActionRequest$Properties' => '

A list of properties to add to the action.

', 'CreateContextRequest$Properties' => '

A list of properties to add to the context.

', 'DescribeActionResponse$Properties' => '

A list of the action\'s properties.

', 'DescribeArtifactResponse$Properties' => '

A list of the artifact\'s properties.

', 'DescribeContextResponse$Properties' => '

A list of the context\'s properties.

', 'UpdateActionRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', 'UpdateContextRequest$Properties' => '

The new list of properties. Overwrites the current property list.

', ], ], 'LineageGroupArn' => [ 'base' => NULL, 'refs' => [ 'DescribeActionResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeArtifactResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeContextResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeLineageGroupResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'DescribeTrialComponentResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'GetLineageGroupPolicyResponse$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group.

', 'LineageGroupSummary$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group resource.

', 'TrialComponent$LineageGroupArn' => '

The Amazon Resource Name (ARN) of the lineage group resource.

', ], ], 'LineageGroupNameOrArn' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyRequest$LineageGroupName' => '

The name or Amazon Resource Name (ARN) of the lineage group.

', ], ], 'LineageGroupSummaries' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsResponse$LineageGroupSummaries' => '

A list of lineage groups and their properties.

', ], ], 'LineageGroupSummary' => [ 'base' => '

Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.

', 'refs' => [ 'LineageGroupSummaries$member' => NULL, ], ], 'LineageType' => [ 'base' => NULL, 'refs' => [ 'QueryLineageTypes$member' => NULL, 'Vertex$LineageType' => '

The type of resource of the lineage entity.

', ], ], 'ListActionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListActionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListAlgorithmsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppImageConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListArtifactsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAutoMLJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCandidatesForAutoMLJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClusterNodesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClusterNodesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListCodeRepositoriesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCompilationJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListCompilationJobsRequest$SortBy' => '

The field by which to sort results. The default is CreationTime.

', ], ], 'ListContextsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContextsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceFleetsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsRequest$SortBy' => '

The column to sort by.

', ], ], 'ListDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgeDeploymentPlansSortBy' => [ 'base' => NULL, 'refs' => [ 'ListEdgeDeploymentPlansRequest$SortBy' => '

The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.

', ], ], 'ListEdgePackagingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgePackagingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEdgePackagingJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListEdgePackagingJobsRequest$SortBy' => '

Use to specify what column to sort by.

', ], ], 'ListEndpointConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListEndpointsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFeatureGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubContentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHubsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHumanTaskUisResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHyperParameterTuningJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImageVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImagesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceComponentsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceComponentsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceExperimentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInferenceRecommendationsJobsSortBy' => [ 'base' => NULL, 'refs' => [ 'ListInferenceRecommendationsJobsRequest$SortBy' => '

The parameter by which to sort the results.

', ], ], 'ListLabelingJobsForWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsForWorkteamSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsForWorkteamRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'ListLabelingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLabelingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLineageEntityParameterKey' => [ 'base' => NULL, 'refs' => [ 'UpdateActionRequest$PropertiesToRemove' => '

A list of properties to remove.

', 'UpdateArtifactRequest$PropertiesToRemove' => '

A list of properties to remove.

', 'UpdateContextRequest$PropertiesToRemove' => '

A list of properties to remove.

', ], ], 'ListLineageGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLineageGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListDeviceFleetsRequest$MaxResults' => '

The maximum number of results to select.

', 'ListDevicesRequest$MaxResults' => '

Maximum number of results to select.

', 'ListEdgeDeploymentPlansRequest$MaxResults' => '

The maximum number of results to select (50 by default).

', 'ListEdgePackagingJobsRequest$MaxResults' => '

Maximum number of results to select.

', 'ListStageDevicesRequest$MaxResults' => '

The maximum number of requests to select.

', ], ], 'ListModelBiasJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelBiasJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelCardsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelExplainabilityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackageGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelPackagesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListModelQualityJobDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListModelsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringAlertsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMonitoringSchedulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstanceLifecycleConfigsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookInstancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionStepsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineParametersForExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListProcessingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceCatalogsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSpacesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStageDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioLifecycleConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSubscribedWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListTagsInput$MaxResults' => '

Maximum number of tags to return.

', ], ], 'ListTagsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsForHyperParameterTuningJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrainingJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTransformJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'UpdateTrialComponentRequest$ParametersToRemove' => '

The hyperparameters to remove from the component.

', 'UpdateTrialComponentRequest$InputArtifactsToRemove' => '

The input artifacts to remove from the component.

', 'UpdateTrialComponentRequest$OutputArtifactsToRemove' => '

The output artifacts to remove from the component.

', ], ], 'ListTrialComponentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialComponentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrialsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkforcesSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesRequest$SortBy' => '

Sort workforces using the workforce name or creation date.

', ], ], 'ListWorkteamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkteamsSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AgentVersion$AgentCount' => '

The number of Edge Manager agents.

', 'DeviceStats$ConnectedDeviceCount' => '

The number of devices connected with a heartbeat.

', 'DeviceStats$RegisteredDeviceCount' => '

The number of registered devices.

', 'EdgeModelStat$OfflineDeviceCount' => '

The number of devices that have this model version and do not have a heart beat.

', 'EdgeModelStat$ConnectedDeviceCount' => '

The number of devices that have this model version and have a heart beat.

', 'EdgeModelStat$ActiveDeviceCount' => '

The number of devices that have this model version, a heart beat, and are currently running.

', 'EdgeModelStat$SamplingDeviceCount' => '

The number of devices with this model version and are producing sample data.

', ], ], 'MLFramework' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$MLFramework' => '

The machine learning framework vended in the image version.

', 'DescribeImageVersionResponse$MLFramework' => '

The machine learning framework vended in the image version.

', 'UpdateImageVersionRequest$MLFramework' => '

The machine learning framework vended in the image version.

', ], ], 'ManagedInstanceScalingMaxInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$MaxInstanceCount' => '

The maximum number of instances that the endpoint can provision when it scales up to accommodate an increase in traffic.

', ], ], 'ManagedInstanceScalingMinInstanceCount' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$MinInstanceCount' => '

The minimum number of instances that the endpoint must retain when it scales down to accommodate a decrease in traffic.

', ], ], 'ManagedInstanceScalingStatus' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantManagedInstanceScaling$Status' => '

Indicates whether managed instance scaling is enabled.

', ], ], 'MaxAutoMLJobRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxAutoMLJobRuntimeInSeconds' => '

The maximum runtime, in seconds, an AutoML job has to complete.

If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.

', ], ], 'MaxCandidates' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxCandidates' => '

The maximum number of times a training job is allowed to run.

For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.

', ], ], 'MaxConcurrentInvocationsPerInstance' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceClientConfig$MaxConcurrentInvocationsPerInstance' => '

The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.

', ], ], 'MaxConcurrentTaskCount' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$MaxConcurrentTaskCount' => '

Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.

', ], ], 'MaxConcurrentTransforms' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don\'t need to set a value for MaxConcurrentTransforms.

', 'DescribeTransformJobResponse$MaxConcurrentTransforms' => '

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

', 'TransformJob$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don\'t need to set a value for MaxConcurrentTransforms.

', 'TransformJobDefinition$MaxConcurrentTransforms' => '

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

', ], ], 'MaxHumanLabeledObjectCount' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxHumanLabeledObjectCount' => '

The maximum number of objects that can be labeled by human workers.

', ], ], 'MaxNumberOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxNumberOfTests' => '

Defines the maximum number of load tests.

', ], ], 'MaxNumberOfTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxNumberOfTrainingJobs' => '

The maximum number of training jobs that a hyperparameter tuning job can launch.

', ], ], 'MaxNumberOfTrainingJobsNotImproving' => [ 'base' => NULL, 'refs' => [ 'BestObjectiveNotImproving$MaxNumberOfTrainingJobsNotImproving' => '

The number of training jobs that have failed to improve model performance by 1% or greater over prior training jobs as evaluated against an objective function.

', ], ], 'MaxParallelExecutionSteps' => [ 'base' => NULL, 'refs' => [ 'ParallelismConfiguration$MaxParallelExecutionSteps' => '

The max number of steps that can be executed in parallel.

', ], ], 'MaxParallelOfTests' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobResourceLimit$MaxParallelOfTests' => '

Defines the maximum number of parallel load tests.

', ], ], 'MaxParallelTrainingJobs' => [ 'base' => NULL, 'refs' => [ 'ResourceLimits$MaxParallelTrainingJobs' => '

The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

', ], ], 'MaxPayloadInMB' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$MaxPayloadInMB' => '

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

', 'DescribeTransformJobResponse$MaxPayloadInMB' => '

The maximum payload size, in MB, used in the transform job.

', 'TransformJob$MaxPayloadInMB' => '

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.

', 'TransformJobDefinition$MaxPayloadInMB' => '

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

', ], ], 'MaxPendingTimeInSeconds' => [ 'base' => 'Maximum job scheduler pending time in seconds.', 'refs' => [ 'StoppingCondition$MaxPendingTimeInSeconds' => '

The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.

', ], ], 'MaxPercentageOfInputDatasetLabeled' => [ 'base' => NULL, 'refs' => [ 'LabelingJobStoppingConditions$MaxPercentageOfInputDatasetLabeled' => '

The maximum number of input data objects that should be labeled.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$MaxResults' => '

The maximum number of actions to return in the response. The default value is 10.

', 'ListAlgorithmsInput$MaxResults' => '

The maximum number of algorithms to return in the response.

', 'ListAliasesRequest$MaxResults' => '

The maximum number of aliases to return.

', 'ListAppImageConfigsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListAppsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListArtifactsRequest$MaxResults' => '

The maximum number of artifacts to return in the response. The default value is 10.

', 'ListAssociationsRequest$MaxResults' => '

The maximum number of associations to return in the response. The default value is 10.

', 'ListClusterNodesRequest$MaxResults' => '

The maximum number of nodes to return in the response.

', 'ListClustersRequest$MaxResults' => '

Set the maximum number of SageMaker HyperPod clusters to list.

', 'ListCodeRepositoriesInput$MaxResults' => '

The maximum number of Git repositories to return in the response.

', 'ListCompilationJobsRequest$MaxResults' => '

The maximum number of model compilation jobs to return in the response.

', 'ListContextsRequest$MaxResults' => '

The maximum number of contexts to return in the response. The default value is 10.

', 'ListDataQualityJobDefinitionsRequest$MaxResults' => '

The maximum number of data quality monitoring job definitions to return in the response.

', 'ListDomainsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListEndpointConfigsInput$MaxResults' => '

The maximum number of training jobs to return in the response.

', 'ListEndpointsInput$MaxResults' => '

The maximum number of endpoints to return in the response. This value defaults to 10.

', 'ListExperimentsRequest$MaxResults' => '

The maximum number of experiments to return in the response. The default value is 10.

', 'ListFlowDefinitionsRequest$MaxResults' => '

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

', 'ListHubContentVersionsRequest$MaxResults' => '

The maximum number of hub content versions to list.

', 'ListHubContentsRequest$MaxResults' => '

The maximum amount of hub content to list.

', 'ListHubsRequest$MaxResults' => '

The maximum number of hubs to list.

', 'ListHumanTaskUisRequest$MaxResults' => '

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

', 'ListHyperParameterTuningJobsRequest$MaxResults' => '

The maximum number of tuning jobs to return. The default value is 10.

', 'ListImageVersionsRequest$MaxResults' => '

The maximum number of versions to return in the response. The default value is 10.

', 'ListImagesRequest$MaxResults' => '

The maximum number of images to return in the response. The default value is 10.

', 'ListInferenceComponentsInput$MaxResults' => '

The maximum number of inference components to return in the response. This value defaults to 10.

', 'ListInferenceExperimentsRequest$MaxResults' => '

The maximum number of results to select.

', 'ListInferenceRecommendationsJobStepsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListInferenceRecommendationsJobsRequest$MaxResults' => '

The maximum number of recommendations to return in the response.

', 'ListLabelingJobsForWorkteamRequest$MaxResults' => '

The maximum number of labeling jobs to return in each page of the response.

', 'ListLabelingJobsRequest$MaxResults' => '

The maximum number of labeling jobs to return in each page of the response.

', 'ListLineageGroupsRequest$MaxResults' => '

The maximum number of endpoints to return in the response. This value defaults to 10.

', 'ListModelBiasJobDefinitionsRequest$MaxResults' => '

The maximum number of model bias jobs to return in the response. The default value is 10.

', 'ListModelCardExportJobsRequest$MaxResults' => '

The maximum number of model card export jobs to list.

', 'ListModelCardVersionsRequest$MaxResults' => '

The maximum number of model card versions to list.

', 'ListModelCardsRequest$MaxResults' => '

The maximum number of model cards to list.

', 'ListModelExplainabilityJobDefinitionsRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListModelMetadataRequest$MaxResults' => '

The maximum number of models to return in the response.

', 'ListModelPackageGroupsInput$MaxResults' => '

The maximum number of results to return in the response.

', 'ListModelPackagesInput$MaxResults' => '

The maximum number of model packages to return in the response.

', 'ListModelQualityJobDefinitionsRequest$MaxResults' => '

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

', 'ListModelsInput$MaxResults' => '

The maximum number of models to return in the response.

', 'ListMonitoringAlertHistoryRequest$MaxResults' => '

The maximum number of results to display. The default is 100.

', 'ListMonitoringAlertsRequest$MaxResults' => '

The maximum number of results to display. The default is 100.

', 'ListMonitoringExecutionsRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListMonitoringSchedulesRequest$MaxResults' => '

The maximum number of jobs to return in the response. The default value is 10.

', 'ListNotebookInstanceLifecycleConfigsInput$MaxResults' => '

The maximum number of lifecycle configurations to return in the response.

', 'ListNotebookInstancesInput$MaxResults' => '

The maximum number of notebook instances to return.

', 'ListPipelineExecutionStepsRequest$MaxResults' => '

The maximum number of pipeline execution steps to return in the response.

', 'ListPipelineExecutionsRequest$MaxResults' => '

The maximum number of pipeline executions to return in the response.

', 'ListPipelineParametersForExecutionRequest$MaxResults' => '

The maximum number of parameters to return in the response.

', 'ListPipelinesRequest$MaxResults' => '

The maximum number of pipelines to return in the response.

', 'ListProcessingJobsRequest$MaxResults' => '

The maximum number of processing jobs to return in the response.

', 'ListProjectsInput$MaxResults' => '

The maximum number of projects to return in the response.

', 'ListResourceCatalogsRequest$MaxResults' => '

The maximum number of results returned by ListResourceCatalogs.

', 'ListSpacesRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListStudioLifecycleConfigsRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListSubscribedWorkteamsRequest$MaxResults' => '

The maximum number of work teams to return in each page of the response.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$MaxResults' => '

The maximum number of training jobs to return. The default value is 10.

', 'ListTrainingJobsRequest$MaxResults' => '

The maximum number of training jobs to return in the response.

', 'ListTransformJobsRequest$MaxResults' => '

The maximum number of transform jobs to return in the response. The default value is 10.

', 'ListTrialComponentsRequest$MaxResults' => '

The maximum number of components to return in the response. The default value is 10.

', 'ListTrialsRequest$MaxResults' => '

The maximum number of trials to return in the response. The default value is 10.

', 'ListUserProfilesRequest$MaxResults' => '

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

', 'ListWorkforcesRequest$MaxResults' => '

The maximum number of workforces returned in the response.

', 'ListWorkteamsRequest$MaxResults' => '

The maximum number of work teams to return in each page of the response.

', 'SearchRequest$MaxResults' => '

The maximum number of results to return.

', ], ], 'MaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'StoppingCondition$MaxRuntimeInSeconds' => '

The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.

For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.

', ], ], 'MaxRuntimePerTrainingJobInSeconds' => [ 'base' => NULL, 'refs' => [ 'AutoMLJobCompletionCriteria$MaxRuntimePerTrainingJobInSeconds' => '

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).

', ], ], 'MaxWaitTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'StoppingCondition$MaxWaitTimeInSeconds' => '

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

', ], ], 'MaximumExecutionTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'BlueGreenUpdatePolicy$MaximumExecutionTimeoutInSeconds' => '

Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

', 'RollingUpdatePolicy$MaximumExecutionTimeoutInSeconds' => '

The time limit for the total deployment. Exceeding this limit causes a timeout.

', ], ], 'MaximumRetryAttempts' => [ 'base' => NULL, 'refs' => [ 'RetryStrategy$MaximumRetryAttempts' => '

The number of times to retry the job. When the job is retried, it\'s SecondaryStatus is changed to STARTING.

', ], ], 'MediaType' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifact$MediaType' => '

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

', ], ], 'MemberDefinition' => [ 'base' => '

Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

', 'refs' => [ 'MemberDefinitions$member' => NULL, ], ], 'MemberDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

', 'UpdateWorkteamRequest$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

', 'Workteam$MemberDefinitions' => '

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.

', ], ], 'MemoryInMb' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$MinMemoryRequiredInMb' => '

The minimum MB of memory to allocate to run a model that you assign to an inference component.

', 'InferenceComponentComputeResourceRequirements$MaxMemoryRequiredInMb' => '

The maximum MB of memory to allocate to run a model that you assign to an inference component.

', ], ], 'MetadataProperties' => [ 'base' => '

Metadata properties of the tracking entity, trial, or trial component.

', 'refs' => [ 'CreateActionRequest$MetadataProperties' => NULL, 'CreateArtifactRequest$MetadataProperties' => NULL, 'CreateModelPackageInput$MetadataProperties' => NULL, 'CreateTrialComponentRequest$MetadataProperties' => NULL, 'CreateTrialRequest$MetadataProperties' => NULL, 'DescribeActionResponse$MetadataProperties' => NULL, 'DescribeArtifactResponse$MetadataProperties' => NULL, 'DescribeModelPackageOutput$MetadataProperties' => NULL, 'DescribeTrialComponentResponse$MetadataProperties' => NULL, 'DescribeTrialResponse$MetadataProperties' => NULL, 'ModelPackage$MetadataProperties' => '

Metadata properties of the tracking entity, trial, or trial component.

', 'Trial$MetadataProperties' => NULL, 'TrialComponent$MetadataProperties' => NULL, ], ], 'MetadataPropertyValue' => [ 'base' => NULL, 'refs' => [ 'MetadataProperties$CommitId' => '

The commit ID.

', 'MetadataProperties$Repository' => '

The repository.

', 'MetadataProperties$GeneratedBy' => '

The entity this entity was generated by.

', 'MetadataProperties$ProjectId' => '

The project ID.

', ], ], 'MetricData' => [ 'base' => '

The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

', 'refs' => [ 'FinalMetricDataList$member' => NULL, ], ], 'MetricDataList' => [ 'base' => NULL, 'refs' => [ 'CandidateProperties$CandidateMetrics' => '

Information about the candidate metrics for an AutoML job.

', ], ], 'MetricDatum' => [ 'base' => '

Information about the metric for a candidate produced by an AutoML job.

', 'refs' => [ 'MetricDataList$member' => NULL, ], ], 'MetricDefinition' => [ 'base' => '

Specifies a metric that the training algorithm writes to stderr or stdout. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in the HyperParameterTrainingJobDefinition API to evaluate job performance during hyperparameter tuning.

', 'refs' => [ 'MetricDefinitionList$member' => NULL, ], ], 'MetricDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$MetricDefinitions' => '

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

', 'HyperParameterAlgorithmSpecification$MetricDefinitions' => '

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

', 'TrainingSpecification$MetricDefinitions' => '

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

', ], ], 'MetricName' => [ 'base' => NULL, 'refs' => [ 'FinalHyperParameterTuningJobObjectiveMetric$MetricName' => '

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

', 'HyperParameterTuningJobObjective$MetricName' => '

The name of the metric to use for the objective metric.

', 'MetricData$MetricName' => '

The name of the metric.

', 'MetricDefinition$Name' => '

The name of the metric.

', 'TrialComponentMetricSummary$MetricName' => '

The name of the metric.

', ], ], 'MetricRegex' => [ 'base' => NULL, 'refs' => [ 'MetricDefinition$Regex' => '

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.

', ], ], 'MetricSetSource' => [ 'base' => NULL, 'refs' => [ 'MetricDatum$Set' => '

The dataset split from which the AutoML job produced the metric.

', ], ], 'MetricSpecification' => [ 'base' => '

An object containing information about a metric.

', 'refs' => [ 'TargetTrackingScalingPolicyConfiguration$MetricSpecification' => '

An object containing information about a metric.

', ], ], 'MetricValue' => [ 'base' => NULL, 'refs' => [ 'FinalAutoMLJobObjectiveMetric$Value' => '

The value of the metric with the best result.

', 'FinalHyperParameterTuningJobObjectiveMetric$Value' => '

The value of the objective metric.

', ], ], 'MetricsSource' => [ 'base' => '

Details about the metrics source.

', 'refs' => [ 'Bias$Report' => '

The bias report for a model

', 'Bias$PreTrainingReport' => '

The pre-training bias report for a model.

', 'Bias$PostTrainingReport' => '

The post-training bias report for a model.

', 'DriftCheckBias$PreTrainingConstraints' => '

The pre-training constraints.

', 'DriftCheckBias$PostTrainingConstraints' => '

The post-training constraints.

', 'DriftCheckExplainability$Constraints' => '

The drift check explainability constraints.

', 'DriftCheckModelDataQuality$Statistics' => '

The drift check model data quality statistics.

', 'DriftCheckModelDataQuality$Constraints' => '

The drift check model data quality constraints.

', 'DriftCheckModelQuality$Statistics' => '

The drift check model quality statistics.

', 'DriftCheckModelQuality$Constraints' => '

The drift check model quality constraints.

', 'Explainability$Report' => '

The explainability report for a model.

', 'ModelDataQuality$Statistics' => '

Data quality statistics for a model.

', 'ModelDataQuality$Constraints' => '

Data quality constraints for a model.

', 'ModelQuality$Statistics' => '

Model quality statistics.

', 'ModelQuality$Constraints' => '

Model quality constraints.

', ], ], 'MinimumInstanceMetadataServiceVersion' => [ 'base' => NULL, 'refs' => [ 'InstanceMetadataServiceConfiguration$MinimumInstanceMetadataServiceVersion' => '

Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

', ], ], 'Model' => [ 'base' => '

The properties of a model as returned by the Search API.

', 'refs' => [ 'ModelDashboardModel$Model' => '

A model displayed in the Model Dashboard.

', ], ], 'ModelAccessConfig' => [ 'base' => '

The access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig. For more information, see End-user license agreements.

', 'refs' => [ 'S3ModelDataSource$ModelAccessConfig' => '

Specifies the access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

', 'TextGenerationJobConfig$ModelAccessConfig' => NULL, ], ], 'ModelApprovalStatus' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelApprovalStatus' => '

The approval status of the model.

', 'CreateModelPackageInput$ModelApprovalStatus' => '

Whether the model is approved for deployment.

This parameter is optional for versioned models, and does not apply to unversioned models.

For versioned models, the value of this parameter must be set to Approved to deploy the model.

', 'DescribeModelPackageOutput$ModelApprovalStatus' => '

The approval status of the model package.

', 'ListModelPackagesInput$ModelApprovalStatus' => '

A filter that returns only the model packages with the specified approval status.

', 'ModelPackage$ModelApprovalStatus' => '

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

', 'ModelPackageSummary$ModelApprovalStatus' => '

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

', 'UpdateModelPackageInput$ModelApprovalStatus' => '

The approval status of the model.

', ], ], 'ModelArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelOutput$ModelArn' => '

The ARN of the model created in SageMaker.

', 'DescribeModelOutput$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', 'LabelingJobAlgorithmsConfig$InitialActiveLearningModelArn' => '

At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

', 'LabelingJobOutput$FinalActiveLearningModelArn' => '

The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.

', 'Model$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', 'ModelSummary$ModelArn' => '

The Amazon Resource Name (ARN) of the model.

', ], ], 'ModelArtifacts' => [ 'base' => '

Provides information about the location that is configured for storing model artifacts.

Model artifacts are the output that results from training a model, and typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata.

', 'refs' => [ 'DescribeCompilationJobResponse$ModelArtifacts' => '

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

', 'DescribeTrainingJobResponse$ModelArtifacts' => '

Information about the Amazon S3 location that is configured for storing model artifacts.

', 'TrainingJob$ModelArtifacts' => '

Information about the Amazon S3 location that is configured for storing model artifacts.

', ], ], 'ModelBiasAppSpecification' => [ 'base' => '

Docker container image configuration object for the model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasAppSpecification' => '

Configures the model bias job to run a specified Docker container image.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasAppSpecification' => '

Configures the model bias job to run a specified Docker container image.

', ], ], 'ModelBiasBaselineConfig' => [ 'base' => '

The configuration for a baseline model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasBaselineConfig' => '

The baseline configuration for a model bias job.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasBaselineConfig' => '

The baseline configuration for a model bias job.

', ], ], 'ModelBiasJobInput' => [ 'base' => '

Inputs for the model bias job.

', 'refs' => [ 'CreateModelBiasJobDefinitionRequest$ModelBiasJobInput' => '

Inputs for the model bias job.

', 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobInput' => '

Inputs for the model bias job.

', ], ], 'ModelCacheSetting' => [ 'base' => NULL, 'refs' => [ 'MultiModelConfig$ModelCacheSetting' => '

Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.

', ], ], 'ModelCard' => [ 'base' => '

An Amazon SageMaker Model Card.

', 'refs' => [ 'SearchRecord$ModelCard' => '

An Amazon SageMaker Model Card that documents details about a machine learning model.

', ], ], 'ModelCardArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the successfully created model card.

', 'DescribeModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCard$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCardSummary$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelCardVersionSummary$ModelCardArn' => '

The Amazon Resource Name (ARN) of the model card.

', 'ModelDashboardModelCard$ModelCardArn' => '

The Amazon Resource Name (ARN) for a model card.

', 'UpdateModelCardResponse$ModelCardArn' => '

The Amazon Resource Name (ARN) of the updated model card.

', ], ], 'ModelCardContent' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$Content' => '

The content of the model card. Content must be in model card JSON schema and provided as a string.

', 'DescribeModelCardResponse$Content' => '

The content of the model card.

', 'ModelCard$Content' => '

The content of the model card. Content uses the model card JSON schema and provided as a string.

', 'UpdateModelCardRequest$Content' => '

The updated model card content. Content must be in model card JSON schema and provided as a string.

When updating model card content, be sure to include the full content and not just updated content.

', ], ], 'ModelCardExportArtifacts' => [ 'base' => '

The artifacts of the model card export job.

', 'refs' => [ 'DescribeModelCardExportJobResponse$ExportArtifacts' => '

The exported model card artifacts.

', ], ], 'ModelCardExportJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobResponse$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', 'DescribeModelCardExportJobRequest$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job to describe.

', 'DescribeModelCardExportJobResponse$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', 'ModelCardExportJobSummary$ModelCardExportJobArn' => '

The Amazon Resource Name (ARN) of the model card export job.

', ], ], 'ModelCardExportJobSortBy' => [ 'base' => 'Attribute by which to sort returned export jobs.', 'refs' => [ 'ListModelCardExportJobsRequest$SortBy' => '

Sort model card export jobs by either name or creation time. Sorts by creation time by default.

', ], ], 'ModelCardExportJobSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsRequest$SortOrder' => '

Sort model card export jobs by ascending or descending order.

', ], ], 'ModelCardExportJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardExportJobResponse$Status' => '

The completion status of the model card export job.

  • InProgress: The model card export job is in progress.

  • Completed: The model card export job is complete.

  • Failed: The model card export job failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeModelCardExportJob call.

', 'ListModelCardExportJobsRequest$StatusEquals' => '

Only list model card export jobs with the specified status.

', 'ModelCardExportJobSummary$Status' => '

The completion status of the model card export job.

', ], ], 'ModelCardExportJobSummary' => [ 'base' => '

The summary of the Amazon SageMaker Model Card export job.

', 'refs' => [ 'ModelCardExportJobSummaryList$member' => NULL, ], ], 'ModelCardExportJobSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardExportJobsResponse$ModelCardExportJobSummaries' => '

The summaries of the listed model card export jobs.

', ], ], 'ModelCardExportOutputConfig' => [ 'base' => '

Configure the export output details for an Amazon SageMaker Model Card.

', 'refs' => [ 'CreateModelCardExportJobRequest$OutputConfig' => '

The model card output configuration that specifies the Amazon S3 path for exporting.

', 'DescribeModelCardExportJobResponse$OutputConfig' => '

The export output details for the model card.

', ], ], 'ModelCardNameOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardExportJobRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to export.

', 'DescribeModelCardRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to describe.

', 'ListModelCardVersionsRequest$ModelCardName' => '

List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

', 'UpdateModelCardRequest$ModelCardName' => '

The name or Amazon Resource Name (ARN) of the model card to update.

', ], ], 'ModelCardProcessingStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelCardResponse$ModelCardProcessingStatus' => '

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

  • DeletePending: Model card deletion request received.

  • DeleteInProgress: Model card deletion is in progress.

  • ContentDeleted: Deleted model card content.

  • ExportJobsDeleted: Deleted all export jobs associated with the model card.

  • DeleteCompleted: Successfully deleted the model card.

  • DeleteFailed: The model card failed to delete.

', ], ], 'ModelCardSecurityConfig' => [ 'base' => '

Configure the security settings to protect model card data.

', 'refs' => [ 'CreateModelCardRequest$SecurityConfig' => '

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

', 'DescribeModelCardResponse$SecurityConfig' => '

The security configuration used to protect model card content.

', 'ModelCard$SecurityConfig' => '

The security configuration used to protect model card data.

', 'ModelDashboardModelCard$SecurityConfig' => '

The KMS Key ID (KMSKeyId) for encryption of model card information.

', ], ], 'ModelCardSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelCardsRequest$SortBy' => '

Sort model cards by either name or creation time. Sorts by creation time by default.

', ], ], 'ModelCardSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortOrder' => '

Sort model card versions by ascending or descending order.

', 'ListModelCardsRequest$SortOrder' => '

Sort model cards by ascending or descending order.

', ], ], 'ModelCardStatus' => [ 'base' => NULL, 'refs' => [ 'CreateModelCardRequest$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'DescribeModelCardResponse$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ListModelCardVersionsRequest$ModelCardStatus' => '

Only list model card versions with the specified approval status.

', 'ListModelCardsRequest$ModelCardStatus' => '

Only list model cards with the specified approval status.

', 'ModelCard$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelCardSummary$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelCardVersionSummary$ModelCardStatus' => '

The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', 'ModelDashboardModelCard$ModelCardStatus' => '

The model card status.

', 'UpdateModelCardRequest$ModelCardStatus' => '

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

', ], ], 'ModelCardSummary' => [ 'base' => '

A summary of the model card.

', 'refs' => [ 'ModelCardSummaryList$member' => NULL, ], ], 'ModelCardSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardsResponse$ModelCardSummaries' => '

The summaries of the listed model cards.

', ], ], 'ModelCardVersionSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsRequest$SortBy' => '

Sort listed model card versions by version. Sorts by version by default.

', ], ], 'ModelCardVersionSummary' => [ 'base' => '

A summary of a specific version of the model card.

', 'refs' => [ 'ModelCardVersionSummaryList$member' => NULL, ], ], 'ModelCardVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelCardVersionsResponse$ModelCardVersionSummaryList' => '

The summaries of the listed versions of the model card.

', ], ], 'ModelClientConfig' => [ 'base' => '

Configures the timeout and maximum number of retries for processing a transform job invocation.

', 'refs' => [ 'CreateTransformJobRequest$ModelClientConfig' => '

Configures the timeout and maximum number of retries for processing a transform job invocation.

', 'DescribeTransformJobResponse$ModelClientConfig' => '

The timeout and maximum number of retries for processing a transform job invocation.

', 'TransformJob$ModelClientConfig' => NULL, ], ], 'ModelCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$CompressionType' => '

Specifies how the ML model data is prepared.

If you choose Gzip and choose S3Object as the value of S3DataType, S3Uri identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment.

If you choose None and chooose S3Object as the value of S3DataType, S3Uri identifies an object that represents an uncompressed ML model to deploy.

If you choose None and choose S3Prefix as the value of S3DataType, S3Uri identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy.

If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code:

  • If you choose S3Object as the value of S3DataType, then SageMaker will split the key of the S3 object referenced by S3Uri by slash (/), and use the last part as the filename of the file holding the content of the S3 object.

  • If you choose S3Prefix as the value of S3DataType, then for each S3 object under the key name pefix referenced by S3Uri, SageMaker will trim its key by the prefix, and use the remainder as the path (relative to /opt/ml/model) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object.

  • Do not use any of the following as file names or directory names:

    • An empty or blank string

    • A string which contains null bytes

    • A string longer than 255 bytes

    • A single dot (.)

    • A double dot (..)

  • Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects s3://mybucket/model/weights and s3://mybucket/model/weights/part1 and you specify s3://mybucket/model/ as the value of S3Uri and S3Prefix as the value of S3DataType, then it will result in name clash between /opt/ml/model/weights (a regular file) and /opt/ml/model/weights/ (a directory).

  • Do not organize the model artifacts in S3 console using folders. When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure.

', ], ], 'ModelConfiguration' => [ 'base' => '

Defines the model configuration. Includes the specification name and environment parameters.

', 'refs' => [ 'InferenceRecommendation$ModelConfiguration' => '

Defines the model configuration.

', 'RecommendationJobInferenceBenchmark$ModelConfiguration' => NULL, ], ], 'ModelDashboardEndpoint' => [ 'base' => '

An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardEndpoints$member' => NULL, ], ], 'ModelDashboardEndpoints' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$Endpoints' => '

The endpoints that host a model.

', ], ], 'ModelDashboardIndicatorAction' => [ 'base' => '

An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.

', 'refs' => [ 'MonitoringAlertActions$ModelDashboardIndicator' => '

An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.

', ], ], 'ModelDashboardModel' => [ 'base' => '

A model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'SearchRecord$Model' => NULL, ], ], 'ModelDashboardModelCard' => [ 'base' => '

The model card for a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardModel$ModelCard' => '

The model card for a model.

', ], ], 'ModelDashboardMonitoringSchedule' => [ 'base' => '

A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.

', 'refs' => [ 'ModelDashboardMonitoringSchedules$member' => NULL, ], ], 'ModelDashboardMonitoringSchedules' => [ 'base' => NULL, 'refs' => [ 'ModelDashboardModel$MonitoringSchedules' => '

The monitoring schedules for a model.

', ], ], 'ModelDataQuality' => [ 'base' => '

Data quality constraints and statistics for a model.

', 'refs' => [ 'ModelMetrics$ModelDataQuality' => '

Metrics that measure the quality of the input data for a model.

', ], ], 'ModelDataSource' => [ 'base' => '

Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.

', 'refs' => [ 'ContainerDefinition$ModelDataSource' => '

Specifies the location of ML model data to deploy.

Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace.

', ], ], 'ModelDeployConfig' => [ 'base' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'refs' => [ 'CreateAutoMLJobRequest$ModelDeployConfig' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'CreateAutoMLJobV2Request$ModelDeployConfig' => '

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

', 'DescribeAutoMLJobResponse$ModelDeployConfig' => '

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

', 'DescribeAutoMLJobV2Response$ModelDeployConfig' => '

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

', ], ], 'ModelDeployResult' => [ 'base' => '

Provides information about the endpoint of the model deployment.

', 'refs' => [ 'DescribeAutoMLJobResponse$ModelDeployResult' => '

Provides information about endpoint for the model deployment.

', 'DescribeAutoMLJobV2Response$ModelDeployResult' => '

Provides information about endpoint for the model deployment.

', ], ], 'ModelDigests' => [ 'base' => '

Provides information to verify the integrity of stored model artifacts.

', 'refs' => [ 'DescribeCompilationJobResponse$ModelDigests' => '

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

', ], ], 'ModelExplainabilityAppSpecification' => [ 'base' => '

Docker container image configuration object for the model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityAppSpecification' => '

Configures the model explainability job to run a specified Docker container image.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityAppSpecification' => '

Configures the model explainability job to run a specified Docker container image.

', ], ], 'ModelExplainabilityBaselineConfig' => [ 'base' => '

The configuration for a baseline model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityBaselineConfig' => '

The baseline configuration for a model explainability job.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityBaselineConfig' => '

The baseline configuration for a model explainability job.

', ], ], 'ModelExplainabilityJobInput' => [ 'base' => '

Inputs for the model explainability job.

', 'refs' => [ 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobInput' => '

Inputs for the model explainability job.

', 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobInput' => '

Inputs for the model explainability job.

', ], ], 'ModelInfrastructureConfig' => [ 'base' => '

The configuration for the infrastructure that the model will be deployed to.

', 'refs' => [ 'ModelVariantConfig$InfrastructureConfig' => '

The configuration for the infrastructure that the model will be deployed to.

', 'ModelVariantConfigSummary$InfrastructureConfig' => '

The configuration of the infrastructure that the model has been deployed to.

', ], ], 'ModelInfrastructureType' => [ 'base' => NULL, 'refs' => [ 'ModelInfrastructureConfig$InfrastructureType' => '

The inference option to which to deploy your model. Possible values are the following:

  • RealTime: Deploy to real-time inference.

', ], ], 'ModelInput' => [ 'base' => '

Input object for the model.

', 'refs' => [ 'ModelPackageContainerDefinition$ModelInput' => '

A structure with Model Input details.

', ], ], 'ModelInsightsLocation' => [ 'base' => NULL, 'refs' => [ 'CandidateArtifactLocations$ModelInsights' => '

The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.

', ], ], 'ModelLatencyThreshold' => [ 'base' => '

The model latency threshold.

', 'refs' => [ 'ModelLatencyThresholds$member' => NULL, ], ], 'ModelLatencyThresholds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobStoppingConditions$ModelLatencyThresholds' => '

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

', ], ], 'ModelMetadataFilter' => [ 'base' => '

Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).

', 'refs' => [ 'ModelMetadataFilters$member' => NULL, ], ], 'ModelMetadataFilterType' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataFilter$Name' => '

The name of the of the model to filter by.

', ], ], 'ModelMetadataFilters' => [ 'base' => NULL, 'refs' => [ 'ModelMetadataSearchExpression$Filters' => '

A list of filter objects.

', ], ], 'ModelMetadataSearchExpression' => [ 'base' => '

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results

', 'refs' => [ 'ListModelMetadataRequest$SearchExpression' => '

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

', ], ], 'ModelMetadataSummaries' => [ 'base' => NULL, 'refs' => [ 'ListModelMetadataResponse$ModelMetadataSummaries' => '

A structure that holds model metadata.

', ], ], 'ModelMetadataSummary' => [ 'base' => '

A summary of the model metadata.

', 'refs' => [ 'ModelMetadataSummaries$member' => NULL, ], ], 'ModelMetrics' => [ 'base' => '

Contains metrics captured from a model.

', 'refs' => [ 'CreateModelPackageInput$ModelMetrics' => '

A structure that contains model metrics reports.

', 'DescribeModelPackageOutput$ModelMetrics' => '

Metrics for the model.

', 'ModelPackage$ModelMetrics' => '

Metrics for the model.

', ], ], 'ModelName' => [ 'base' => NULL, 'refs' => [ 'CreateModelInput$ModelName' => '

The name of the new model.

', 'CreateTransformJobRequest$ModelName' => '

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.

', 'DeleteModelInput$ModelName' => '

The name of the model to delete.

', 'DescribeModelInput$ModelName' => '

The name of the model.

', 'DescribeModelOutput$ModelName' => '

Name of the SageMaker model.

', 'DescribeTransformJobResponse$ModelName' => '

The name of the model used in the transform job.

', 'InferenceComponentSpecification$ModelName' => '

The name of an existing SageMaker model object in your account that you want to deploy with the inference component.

', 'InferenceComponentSpecificationSummary$ModelName' => '

The name of the SageMaker model object that is deployed with the inference component.

', 'InferenceRecommendationsJob$ModelName' => '

The name of the created model.

', 'ListInferenceRecommendationsJobsRequest$ModelNameEquals' => '

A filter that returns only jobs that were created for this model.

', 'Model$ModelName' => '

The name of the model.

', 'ModelSummary$ModelName' => '

The name of the model that you want a summary for.

', 'ModelVariantConfig$ModelName' => '

The name of the Amazon SageMaker Model entity.

', 'ModelVariantConfigSummary$ModelName' => '

The name of the Amazon SageMaker Model entity.

', 'ProductionVariant$ModelName' => '

The name of the model that you want to host. This is the name that you specified when creating the model.

', 'RecommendationJobInputConfig$ModelName' => '

The name of the created model.

', 'TransformJob$ModelName' => '

The name of the model associated with the transform job.

', ], ], 'ModelNameContains' => [ 'base' => NULL, 'refs' => [ 'ListModelsInput$NameContains' => '

A string in the model name. This filter returns only models whose name contains the specified string.

', ], ], 'ModelPackage' => [ 'base' => '

A versioned model that can be deployed for SageMaker inference.

', 'refs' => [ 'SearchRecord$ModelPackage' => NULL, ], ], 'ModelPackageArn' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageErrorMap$key' => NULL, 'BatchDescribeModelPackageSummary$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'CreateCompilationJobRequest$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

', 'CreateModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the new model package.

', 'DescribeCompilationJobResponse$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

', 'DescribeModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'InferenceRecommendationsJob$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package.

', 'ListInferenceRecommendationsJobsRequest$ModelPackageVersionArnEquals' => '

A filter that returns only jobs that were created for this versioned model package.

', 'ModelPackage$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'ModelPackageArnList$member' => NULL, 'ModelPackageSummaries$key' => NULL, 'ModelPackageSummary$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'RecommendationJobInputConfig$ModelPackageVersionArn' => '

The Amazon Resource Name (ARN) of a versioned model package.

', 'UpdateModelPackageInput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model package.

', 'UpdateModelPackageOutput$ModelPackageArn' => '

The Amazon Resource Name (ARN) of the model.

', ], ], 'ModelPackageArnList' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageInput$ModelPackageArnList' => '

The list of Amazon Resource Name (ARN) of the model package groups.

', ], ], 'ModelPackageContainerDefinition' => [ 'base' => '

Describes the Docker container for the model package.

', 'refs' => [ 'ModelPackageContainerDefinitionList$member' => NULL, ], ], 'ModelPackageContainerDefinitionList' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$Containers' => '

The Amazon ECR registry path of the Docker image that contains the inference code.

', 'InferenceSpecification$Containers' => '

The Amazon ECR registry path of the Docker image that contains the inference code.

', ], ], 'ModelPackageFrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'ModelPackageContainerDefinition$FrameworkVersion' => '

The framework version of the Model Package Container Image.

', ], ], 'ModelPackageGroup' => [ 'base' => '

A group of versioned models in the model registry.

', 'refs' => [ 'SearchRecord$ModelPackageGroup' => NULL, ], ], 'ModelPackageGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageGroupOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'DescribeModelPackageGroupOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'ModelPackageGroup$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model group.

', 'PutModelPackageGroupPolicyOutput$ModelPackageGroupArn' => '

The Amazon Resource Name (ARN) of the model package group.

', ], ], 'ModelPackageGroupSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsInput$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'ModelPackageGroupStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeModelPackageGroupOutput$ModelPackageGroupStatus' => '

The status of the model group.

', 'ModelPackageGroup$ModelPackageGroupStatus' => '

The status of the model group. This can be one of the following values.

  • PENDING - The model group is pending being created.

  • IN_PROGRESS - The model group is in the process of being created.

  • COMPLETED - The model group was successfully created.

  • FAILED - The model group failed.

  • DELETING - The model group is in the process of being deleted.

  • DELETE_FAILED - SageMaker failed to delete the model group.

', 'ModelPackageGroupSummary$ModelPackageGroupStatus' => '

The status of the model group.

', ], ], 'ModelPackageGroupSummary' => [ 'base' => '

Summary information about a model group.

', 'refs' => [ 'ModelPackageGroupSummaryList$member' => NULL, ], ], 'ModelPackageGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackageGroupsOutput$ModelPackageGroupSummaryList' => '

A list of summaries of the model groups in your Amazon Web Services account.

', ], ], 'ModelPackageSortBy' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesInput$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'ModelPackageStatus' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelPackageStatus' => '

The status of the mortgage package.

', 'DescribeModelPackageOutput$ModelPackageStatus' => '

The current status of the model package.

', 'ModelPackage$ModelPackageStatus' => '

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.

  • IN_PROGRESS - The model package is in the process of being created.

  • COMPLETED - The model package was successfully created.

  • FAILED - The model package failed.

  • DELETING - The model package is in the process of being deleted.

', 'ModelPackageSummary$ModelPackageStatus' => '

The overall status of the model package.

', ], ], 'ModelPackageStatusDetails' => [ 'base' => '

Specifies the validation and image scan statuses of the model package.

', 'refs' => [ 'DescribeModelPackageOutput$ModelPackageStatusDetails' => '

Details about the current status of the model package.

', 'ModelPackage$ModelPackageStatusDetails' => '

Specifies the validation and image scan statuses of the model package.

', ], ], 'ModelPackageStatusItem' => [ 'base' => '

Represents the overall status of a model package.

', 'refs' => [ 'ModelPackageStatusItemList$member' => NULL, ], ], 'ModelPackageStatusItemList' => [ 'base' => NULL, 'refs' => [ 'ModelPackageStatusDetails$ValidationStatuses' => '

The validation status of the model package.

', 'ModelPackageStatusDetails$ImageScanStatuses' => '

The status of the scan of the Docker image container for the model package.

', ], ], 'ModelPackageSummaries' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageOutput$ModelPackageSummaries' => '

The summaries for the model package versions

', ], ], 'ModelPackageSummary' => [ 'base' => '

Provides summary information about a model package.

', 'refs' => [ 'ModelPackageSummaryList$member' => NULL, ], ], 'ModelPackageSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesOutput$ModelPackageSummaryList' => '

An array of ModelPackageSummary objects, each of which lists a model package.

', ], ], 'ModelPackageType' => [ 'base' => NULL, 'refs' => [ 'ListModelPackagesInput$ModelPackageType' => '

A filter that returns only the model packages of the specified type. This can be one of the following values.

  • UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

  • VERSIONED - List only versioned models.

  • BOTH - List both versioned and unversioned models.

', ], ], 'ModelPackageValidationProfile' => [ 'base' => '

Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

', 'refs' => [ 'ModelPackageValidationProfiles$member' => NULL, ], ], 'ModelPackageValidationProfiles' => [ 'base' => NULL, 'refs' => [ 'ModelPackageValidationSpecification$ValidationProfiles' => '

An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.

', ], ], 'ModelPackageValidationSpecification' => [ 'base' => '

Specifies batch transform jobs that SageMaker runs to validate your model package.

', 'refs' => [ 'CreateModelPackageInput$ValidationSpecification' => '

Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.

', 'DescribeModelPackageOutput$ValidationSpecification' => '

Configurations for one or more transform jobs that SageMaker runs to test the model package.

', 'ModelPackage$ValidationSpecification' => '

Specifies batch transform jobs that SageMaker runs to validate your model package.

', ], ], 'ModelPackageVersion' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeModelPackageSummary$ModelPackageVersion' => '

The version number of a versioned model.

', 'DescribeModelPackageOutput$ModelPackageVersion' => '

The version of the model package.

', 'ModelPackage$ModelPackageVersion' => '

The version number of a versioned model.

', 'ModelPackageSummary$ModelPackageVersion' => '

If the model package is a versioned model, the version of the model.

', ], ], 'ModelQuality' => [ 'base' => '

Model quality statistics and constraints.

', 'refs' => [ 'ModelMetrics$ModelQuality' => '

Metrics that measure the quality of a model.

', ], ], 'ModelQualityAppSpecification' => [ 'base' => '

Container image configuration object for the monitoring job.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityAppSpecification' => '

The container that runs the monitoring job.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityAppSpecification' => '

Configures the model quality job to run a specified Docker container image.

', ], ], 'ModelQualityBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityBaselineConfig' => '

Specifies the constraints and baselines for the monitoring job.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityBaselineConfig' => '

The baseline configuration for a model quality job.

', ], ], 'ModelQualityJobInput' => [ 'base' => '

The input for the model quality monitoring job. Currently endpoints are supported for input for model quality monitoring jobs.

', 'refs' => [ 'CreateModelQualityJobDefinitionRequest$ModelQualityJobInput' => '

A list of the inputs that are monitored. Currently endpoints are supported.

', 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobInput' => '

Inputs for the model quality job.

', ], ], 'ModelRegisterSettings' => [ 'base' => '

The model registry settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$ModelRegisterSettings' => '

The model registry settings for the SageMaker Canvas application.

', ], ], 'ModelSetupTime' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$ModelSetupTime' => '

The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the model size, how long it takes to download the model, and the start-up time of the container.

NaN indicates that the value is not available.

', ], ], 'ModelSortKey' => [ 'base' => NULL, 'refs' => [ 'ListModelsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'ModelStepMetadata' => [ 'base' => '

Metadata for Model steps.

', 'refs' => [ 'PipelineExecutionStepMetadata$Model' => '

The Amazon Resource Name (ARN) of the model that was created by this step execution.

', ], ], 'ModelSummary' => [ 'base' => '

Provides summary information about a model.

', 'refs' => [ 'ModelSummaryList$member' => NULL, ], ], 'ModelSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListModelsOutput$Models' => '

An array of ModelSummary objects, each of which lists a model.

', ], ], 'ModelVariantAction' => [ 'base' => NULL, 'refs' => [ 'ModelVariantActionMap$value' => NULL, ], ], 'ModelVariantActionMap' => [ 'base' => NULL, 'refs' => [ 'StopInferenceExperimentRequest$ModelVariantActions' => '

Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

  • Promote - Promote the shadow variant to a production variant

  • Remove - Delete the variant

  • Retain - Keep the variant as it is

', ], ], 'ModelVariantConfig' => [ 'base' => '

Contains information about the deployment options of a model.

', 'refs' => [ 'ModelVariantConfigList$member' => NULL, ], ], 'ModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceExperimentRequest$ModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.

', 'StopInferenceExperimentRequest$DesiredModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

', 'UpdateInferenceExperimentRequest$ModelVariants' => '

An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.

', ], ], 'ModelVariantConfigSummary' => [ 'base' => '

Summary of the deployment configuration of a model.

', 'refs' => [ 'ModelVariantConfigSummaryList$member' => NULL, ], ], 'ModelVariantConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceExperimentResponse$ModelVariants' => '

An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

', ], ], 'ModelVariantName' => [ 'base' => NULL, 'refs' => [ 'ModelVariantActionMap$key' => NULL, 'ModelVariantConfig$VariantName' => '

The name of the variant.

', 'ModelVariantConfigSummary$VariantName' => '

The name of the variant.

', 'ShadowModeConfig$SourceModelVariantName' => '

The name of the production variant, which takes all the inference requests.

', 'ShadowModelVariantConfig$ShadowModelVariantName' => '

The name of the shadow variant.

', ], ], 'ModelVariantStatus' => [ 'base' => NULL, 'refs' => [ 'ModelVariantConfigSummary$Status' => '

The status of deployment for the model variant on the hosted inference endpoint.

  • Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.

  • InService - The model variant is running on the hosted inference endpoint.

  • Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.

  • Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.

  • Deleted - The model variant has been deleted on the hosted inference endpoint. This can only happen after stopping the experiment.

', ], ], 'MonitoringAlertActions' => [ 'base' => '

A list of alert actions taken in response to an alert going into InAlert status.

', 'refs' => [ 'MonitoringAlertSummary$Actions' => '

A list of alert actions taken in response to an alert going into InAlert status.

', ], ], 'MonitoringAlertHistoryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryResponse$MonitoringAlertHistory' => '

An alert history for a model monitoring schedule.

', ], ], 'MonitoringAlertHistorySortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$SortBy' => '

The field used to sort results. The default is CreationTime.

', ], ], 'MonitoringAlertHistorySummary' => [ 'base' => '

Provides summary information of an alert\'s history.

', 'refs' => [ 'MonitoringAlertHistoryList$member' => NULL, ], ], 'MonitoringAlertName' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$MonitoringAlertName' => '

The name of a monitoring alert.

', 'MonitoringAlertHistorySummary$MonitoringAlertName' => '

The name of a monitoring alert.

', 'MonitoringAlertSummary$MonitoringAlertName' => '

The name of a monitoring alert.

', 'UpdateMonitoringAlertRequest$MonitoringAlertName' => '

The name of a monitoring alert.

', 'UpdateMonitoringAlertResponse$MonitoringAlertName' => '

The name of a monitoring alert.

', ], ], 'MonitoringAlertStatus' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertHistoryRequest$StatusEquals' => '

A filter that retrieves only alerts with a specific status.

', 'MonitoringAlertHistorySummary$AlertStatus' => '

The current alert status of an alert.

', 'MonitoringAlertSummary$AlertStatus' => '

The current status of an alert.

', ], ], 'MonitoringAlertSummary' => [ 'base' => '

Provides summary information about a monitor alert.

', 'refs' => [ 'MonitoringAlertSummaryList$member' => NULL, ], ], 'MonitoringAlertSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringAlertsResponse$MonitoringAlertSummaries' => '

A JSON array where each element is a summary for a monitoring alert.

', 'ModelDashboardMonitoringSchedule$MonitoringAlertSummaries' => '

A JSON array where each element is a summary for a monitoring alert.

', ], ], 'MonitoringAppSpecification' => [ 'base' => '

Container image configuration object for the monitoring job.

', 'refs' => [ 'MonitoringJobDefinition$MonitoringAppSpecification' => '

Configures the monitoring job to run a specified Docker container image.

', ], ], 'MonitoringBaselineConfig' => [ 'base' => '

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

', 'refs' => [ 'MonitoringJobDefinition$BaselineConfig' => '

Baseline configuration used to validate that the data conforms to the specified constraints and statistics

', ], ], 'MonitoringClusterConfig' => [ 'base' => '

Configuration for the cluster used to run model monitoring jobs.

', 'refs' => [ 'MonitoringResources$ClusterConfig' => '

The configuration for the cluster resources used to run the processing job.

', ], ], 'MonitoringConstraintsResource' => [ 'base' => '

The constraints resource for a monitoring job.

', 'refs' => [ 'DataQualityBaselineConfig$ConstraintsResource' => NULL, 'ModelBiasBaselineConfig$ConstraintsResource' => NULL, 'ModelExplainabilityBaselineConfig$ConstraintsResource' => NULL, 'ModelQualityBaselineConfig$ConstraintsResource' => NULL, 'MonitoringBaselineConfig$ConstraintsResource' => '

The baseline constraint file in Amazon S3 that the current monitoring job should validated against.

', ], ], 'MonitoringContainerArguments' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$ContainerArguments' => '

The arguments to send to the container that the monitoring job runs.

', 'ModelQualityAppSpecification$ContainerArguments' => '

An array of arguments for the container used to run the monitoring job.

', 'MonitoringAppSpecification$ContainerArguments' => '

An array of arguments for the container used to run the monitoring job.

', ], ], 'MonitoringCsvDatasetFormat' => [ 'base' => '

Represents the CSV dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Csv' => '

The CSV dataset used in the monitoring job.

', ], ], 'MonitoringDatapointsToAlert' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$DatapointsToAlert' => '

Within EvaluationPeriod, how many execution failures will raise an alert.

', 'UpdateMonitoringAlertRequest$DatapointsToAlert' => '

Within EvaluationPeriod, how many execution failures will raise an alert.

', ], ], 'MonitoringDatasetFormat' => [ 'base' => '

Represents the dataset format used when running a monitoring job.

', 'refs' => [ 'BatchTransformInput$DatasetFormat' => '

The dataset format for your batch transform job.

', ], ], 'MonitoringEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'DataQualityAppSpecification$Environment' => '

Sets the environment variables in the container that the monitoring job runs.

', 'ModelBiasAppSpecification$Environment' => '

Sets the environment variables in the Docker container.

', 'ModelExplainabilityAppSpecification$Environment' => '

Sets the environment variables in the Docker container.

', 'ModelQualityAppSpecification$Environment' => '

Sets the environment variables in the container that the monitoring job runs.

', 'MonitoringJobDefinition$Environment' => '

Sets the environment variables in the Docker container.

', ], ], 'MonitoringEvaluationPeriod' => [ 'base' => NULL, 'refs' => [ 'MonitoringAlertSummary$EvaluationPeriod' => '

The number of most recent monitoring executions to consider when evaluating alert status.

', 'UpdateMonitoringAlertRequest$EvaluationPeriod' => '

The number of most recent monitoring executions to consider when evaluating alert status.

', ], ], 'MonitoringExecutionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsRequest$SortBy' => '

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

', ], ], 'MonitoringExecutionSummary' => [ 'base' => '

Summary of information about the last monitoring job to run.

', 'refs' => [ 'DescribeMonitoringScheduleResponse$LastMonitoringExecutionSummary' => '

Describes metadata on the last execution to run, if there was one.

', 'ModelDashboardMonitoringSchedule$LastMonitoringExecutionSummary' => NULL, 'MonitoringExecutionSummaryList$member' => NULL, 'MonitoringSchedule$LastMonitoringExecutionSummary' => NULL, ], ], 'MonitoringExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringExecutionsResponse$MonitoringExecutionSummaries' => '

A JSON array in which each element is a summary for a monitoring execution.

', ], ], 'MonitoringGroundTruthS3Input' => [ 'base' => '

The ground truth labels for the dataset used for the monitoring job.

', 'refs' => [ 'ModelBiasJobInput$GroundTruthS3Input' => '

Location of ground truth labels to use in model bias job.

', 'ModelQualityJobInput$GroundTruthS3Input' => '

The ground truth label provided for the model.

', ], ], 'MonitoringInput' => [ 'base' => '

The inputs for a monitoring job.

', 'refs' => [ 'MonitoringInputs$member' => NULL, ], ], 'MonitoringInputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringJobDefinition$MonitoringInputs' => '

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

', ], ], 'MonitoringJobDefinition' => [ 'base' => '

Defines the monitoring job.

', 'refs' => [ 'MonitoringScheduleConfig$MonitoringJobDefinition' => '

Defines the monitoring job.

', ], ], 'MonitoringJobDefinitionArn' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the job definition.

', 'CreateModelBiasJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model bias job.

', 'CreateModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model explainability job.

', 'CreateModelQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model quality monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the data quality monitoring job definition.

', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model bias job.

', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model explainability job.

', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionArn' => '

The Amazon Resource Name (ARN) of the model quality job.

', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionArn' => '

The Amazon Resource Name (ARN) of the monitoring job.

', ], ], 'MonitoringJobDefinitionName' => [ 'base' => NULL, 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name for the monitoring job definition.

', 'CreateModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'CreateModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'CreateModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the monitoring job definition.

', 'DeleteDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the data quality monitoring job definition to delete.

', 'DeleteModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the model bias job definition to delete.

', 'DeleteModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition to delete.

', 'DeleteModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the model quality monitoring job definition to delete.

', 'DescribeDataQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the data quality monitoring job definition to describe.

', 'DescribeDataQualityJobDefinitionResponse$JobDefinitionName' => '

The name of the data quality monitoring job definition.

', 'DescribeModelBiasJobDefinitionRequest$JobDefinitionName' => '

The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelBiasJobDefinitionResponse$JobDefinitionName' => '

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelExplainabilityJobDefinitionRequest$JobDefinitionName' => '

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionName' => '

The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelQualityJobDefinitionRequest$JobDefinitionName' => '

The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeModelQualityJobDefinitionResponse$JobDefinitionName' => '

The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'ListMonitoringExecutionsRequest$MonitoringJobDefinitionName' => '

Gets a list of the monitoring job runs of the specified monitoring job definitions.

', 'ListMonitoringSchedulesRequest$MonitoringJobDefinitionName' => '

Gets a list of the monitoring schedules for the specified monitoring job definition.

', 'MonitoringExecutionSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job.

', 'MonitoringJobDefinitionSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job.

', 'MonitoringScheduleConfig$MonitoringJobDefinitionName' => '

The name of the monitoring job definition to schedule.

', 'MonitoringScheduleSummary$MonitoringJobDefinitionName' => '

The name of the monitoring job definition that the schedule is for.

', ], ], 'MonitoringJobDefinitionSortKey' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListModelBiasJobDefinitionsRequest$SortBy' => '

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

', 'ListModelExplainabilityJobDefinitionsRequest$SortBy' => '

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

', 'ListModelQualityJobDefinitionsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'MonitoringJobDefinitionSummary' => [ 'base' => '

Summary information about a monitoring job.

', 'refs' => [ 'MonitoringJobDefinitionSummaryList$member' => NULL, ], ], 'MonitoringJobDefinitionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityJobDefinitionsResponse$JobDefinitionSummaries' => '

A list of data quality monitoring job definitions.

', 'ListModelBiasJobDefinitionsResponse$JobDefinitionSummaries' => '

A JSON array in which each element is a summary for a model bias jobs.

', 'ListModelExplainabilityJobDefinitionsResponse$JobDefinitionSummaries' => '

A JSON array in which each element is a summary for a explainability bias jobs.

', 'ListModelQualityJobDefinitionsResponse$JobDefinitionSummaries' => '

A list of summaries of model quality monitoring job definitions.

', ], ], 'MonitoringJsonDatasetFormat' => [ 'base' => '

Represents the JSON dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Json' => '

The JSON dataset used in the monitoring job

', ], ], 'MonitoringMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'MonitoringStoppingCondition$MaxRuntimeInSeconds' => '

The maximum runtime allowed in seconds.

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.

', ], ], 'MonitoringNetworkConfig' => [ 'base' => '

The networking configuration for the monitoring job.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$NetworkConfig' => '

Specifies networking configuration for the monitoring job.

', 'CreateModelBiasJobDefinitionRequest$NetworkConfig' => '

Networking options for a model bias job.

', 'CreateModelExplainabilityJobDefinitionRequest$NetworkConfig' => '

Networking options for a model explainability job.

', 'CreateModelQualityJobDefinitionRequest$NetworkConfig' => '

Specifies the network configuration for the monitoring job.

', 'DescribeDataQualityJobDefinitionResponse$NetworkConfig' => '

The networking configuration for the data quality monitoring job.

', 'DescribeModelBiasJobDefinitionResponse$NetworkConfig' => '

Networking options for a model bias job.

', 'DescribeModelExplainabilityJobDefinitionResponse$NetworkConfig' => '

Networking options for a model explainability job.

', 'DescribeModelQualityJobDefinitionResponse$NetworkConfig' => '

Networking options for a model quality job.

', ], ], 'MonitoringOutput' => [ 'base' => '

The output object for a monitoring job.

', 'refs' => [ 'MonitoringOutputs$member' => NULL, ], ], 'MonitoringOutputConfig' => [ 'base' => '

The output configuration for monitoring jobs.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$DataQualityJobOutputConfig' => NULL, 'CreateModelBiasJobDefinitionRequest$ModelBiasJobOutputConfig' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobOutputConfig' => NULL, 'CreateModelQualityJobDefinitionRequest$ModelQualityJobOutputConfig' => NULL, 'DescribeDataQualityJobDefinitionResponse$DataQualityJobOutputConfig' => NULL, 'DescribeModelBiasJobDefinitionResponse$ModelBiasJobOutputConfig' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobOutputConfig' => NULL, 'DescribeModelQualityJobDefinitionResponse$ModelQualityJobOutputConfig' => NULL, 'MonitoringJobDefinition$MonitoringOutputConfig' => '

The array of outputs from the monitoring job to be uploaded to Amazon S3.

', ], ], 'MonitoringOutputs' => [ 'base' => NULL, 'refs' => [ 'MonitoringOutputConfig$MonitoringOutputs' => '

Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.

', ], ], 'MonitoringParquetDatasetFormat' => [ 'base' => '

Represents the Parquet dataset format used when running a monitoring job.

', 'refs' => [ 'MonitoringDatasetFormat$Parquet' => '

The Parquet dataset used in the monitoring job

', ], ], 'MonitoringProblemType' => [ 'base' => NULL, 'refs' => [ 'ModelQualityAppSpecification$ProblemType' => '

The machine learning problem type of the model that the monitoring job monitors.

', ], ], 'MonitoringResources' => [ 'base' => '

Identifies the resources to deploy for a monitoring job.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$JobResources' => NULL, 'CreateModelBiasJobDefinitionRequest$JobResources' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$JobResources' => NULL, 'CreateModelQualityJobDefinitionRequest$JobResources' => NULL, 'DescribeDataQualityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelBiasJobDefinitionResponse$JobResources' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$JobResources' => NULL, 'DescribeModelQualityJobDefinitionResponse$JobResources' => NULL, 'MonitoringJobDefinition$MonitoringResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

', ], ], 'MonitoringS3Output' => [ 'base' => '

Information about where and how you want to store the results of a monitoring job.

', 'refs' => [ 'MonitoringOutput$S3Output' => '

The Amazon S3 storage location where the results of a monitoring job are saved.

', ], ], 'MonitoringS3Uri' => [ 'base' => NULL, 'refs' => [ 'MonitoringGroundTruthS3Input$S3Uri' => '

The address of the Amazon S3 location of the ground truth labels.

', 'MonitoringS3Output$S3Uri' => '

A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.

', ], ], 'MonitoringSchedule' => [ 'base' => '

A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.

', 'refs' => [ 'MonitoringScheduleList$member' => NULL, ], ], 'MonitoringScheduleArn' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'DescribeProcessingJobResponse$MonitoringScheduleArn' => '

The ARN of a monitoring schedule for an endpoint associated with this processing job.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of a monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'MonitoringScheduleSummary$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'ProcessingJob$MonitoringScheduleArn' => '

The ARN of a monitoring schedule for an endpoint associated with this processing job.

', 'UpdateMonitoringAlertResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', 'UpdateMonitoringScheduleResponse$MonitoringScheduleArn' => '

The Amazon Resource Name (ARN) of the monitoring schedule.

', ], ], 'MonitoringScheduleConfig' => [ 'base' => '

Configures the monitoring schedule and defines the monitoring job.

', 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleConfig' => NULL, 'MonitoringSchedule$MonitoringScheduleConfig' => NULL, 'UpdateMonitoringScheduleRequest$MonitoringScheduleConfig' => '

The configuration object that specifies the monitoring schedule and defines the monitoring job.

', ], ], 'MonitoringScheduleList' => [ 'base' => NULL, 'refs' => [ 'Endpoint$MonitoringSchedules' => '

A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.

', ], ], 'MonitoringScheduleName' => [ 'base' => NULL, 'refs' => [ 'CreateMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

', 'DeleteMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule to delete.

', 'DescribeMonitoringScheduleRequest$MonitoringScheduleName' => '

Name of a previously created monitoring schedule.

', 'DescribeMonitoringScheduleResponse$MonitoringScheduleName' => '

Name of the monitoring schedule.

', 'ListMonitoringAlertHistoryRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'ListMonitoringAlertsRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'ListMonitoringExecutionsRequest$MonitoringScheduleName' => '

Name of a specific schedule to fetch jobs for.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'MonitoringAlertHistorySummary$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'MonitoringExecutionSummary$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'MonitoringScheduleSummary$MonitoringScheduleName' => '

The name of the monitoring schedule.

', 'StartMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the schedule to start.

', 'StopMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the schedule to stop.

', 'UpdateMonitoringAlertRequest$MonitoringScheduleName' => '

The name of a monitoring schedule.

', 'UpdateMonitoringScheduleRequest$MonitoringScheduleName' => '

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

', ], ], 'MonitoringScheduleSortKey' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesRequest$SortBy' => '

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

', ], ], 'MonitoringScheduleSummary' => [ 'base' => '

Summarizes the monitoring schedule.

', 'refs' => [ 'MonitoringScheduleSummaryList$member' => NULL, ], ], 'MonitoringScheduleSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListMonitoringSchedulesResponse$MonitoringScheduleSummaries' => '

A JSON array in which each element is a summary for a monitoring schedule.

', ], ], 'MonitoringStatisticsResource' => [ 'base' => '

The statistics resource for a monitoring job.

', 'refs' => [ 'DataQualityBaselineConfig$StatisticsResource' => NULL, 'MonitoringBaselineConfig$StatisticsResource' => '

The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.

', ], ], 'MonitoringStoppingCondition' => [ 'base' => '

A time limit for how long the monitoring job is allowed to run before stopping.

', 'refs' => [ 'CreateDataQualityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelBiasJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelExplainabilityJobDefinitionRequest$StoppingCondition' => NULL, 'CreateModelQualityJobDefinitionRequest$StoppingCondition' => NULL, 'DescribeDataQualityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelBiasJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelExplainabilityJobDefinitionResponse$StoppingCondition' => NULL, 'DescribeModelQualityJobDefinitionResponse$StoppingCondition' => NULL, 'MonitoringJobDefinition$StoppingCondition' => '

Specifies a time limit for how long the monitoring job is allowed to run.

', ], ], 'MonitoringTimeOffsetString' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$StartTimeOffset' => '

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'BatchTransformInput$EndTimeOffset' => '

If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'EndpointInput$StartTimeOffset' => '

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', 'EndpointInput$EndTimeOffset' => '

If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

', ], ], 'MonitoringType' => [ 'base' => NULL, 'refs' => [ 'DescribeMonitoringScheduleResponse$MonitoringType' => '

The type of the monitoring job that this schedule runs. This is one of the following values.

  • DATA_QUALITY - The schedule is for a data quality monitoring job.

  • MODEL_QUALITY - The schedule is for a model quality monitoring job.

  • MODEL_BIAS - The schedule is for a bias monitoring job.

  • MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

', 'ListMonitoringExecutionsRequest$MonitoringTypeEquals' => '

A filter that returns only the monitoring job runs of the specified monitoring type.

', 'ListMonitoringSchedulesRequest$MonitoringTypeEquals' => '

A filter that returns only the monitoring schedules for the specified monitoring type.

', 'ModelDashboardMonitoringSchedule$MonitoringType' => '

The monitor type of a model monitor.

', 'MonitoringExecutionSummary$MonitoringType' => '

The type of the monitoring job.

', 'MonitoringSchedule$MonitoringType' => '

The type of the monitoring job definition to schedule.

', 'MonitoringScheduleConfig$MonitoringType' => '

The type of the monitoring job definition to schedule.

', 'MonitoringScheduleSummary$MonitoringType' => '

The type of the monitoring job definition that the schedule is for.

', ], ], 'MountPath' => [ 'base' => NULL, 'refs' => [ 'FileSystemConfig$MountPath' => '

The path within the image to mount the user\'s EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

', ], ], 'MultiModelConfig' => [ 'base' => '

Specifies additional configuration for hosting multi-model endpoints.

', 'refs' => [ 'ContainerDefinition$MultiModelConfig' => '

Specifies additional configuration for multi-model endpoints.

', ], ], 'NameContains' => [ 'base' => NULL, 'refs' => [ 'ListAlgorithmsInput$NameContains' => '

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

', 'ListClustersRequest$NameContains' => '

Set the maximum number of instances to print in the list.

', 'ListCompilationJobsRequest$NameContains' => '

A filter that returns the model compilation jobs whose name contains a specified string.

', 'ListDataQualityJobDefinitionsRequest$NameContains' => '

A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.

', 'ListDeviceFleetsRequest$NameContains' => '

Filter for fleets containing this name in their fleet device name.

', 'ListEdgeDeploymentPlansRequest$NameContains' => '

Selects edge deployment plans with names containing this name.

', 'ListEdgeDeploymentPlansRequest$DeviceFleetNameContains' => '

Selects edge deployment plans with a device fleet name containing this name.

', 'ListEdgePackagingJobsRequest$NameContains' => '

Filter for jobs containing this name in their packaging job name.

', 'ListEdgePackagingJobsRequest$ModelNameContains' => '

Filter for jobs where the model name contains this string.

', 'ListHubContentsRequest$NameContains' => '

Only list hub content if the name contains the specified string.

', 'ListHubsRequest$NameContains' => '

Only list hubs with names that contain the specified string.

', 'ListHyperParameterTuningJobsRequest$NameContains' => '

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

', 'ListInferenceExperimentsRequest$NameContains' => '

Selects inference experiments whose names contain this name.

', 'ListInferenceRecommendationsJobsRequest$NameContains' => '

A string in the job name. This filter returns only recommendations whose name contains the specified string.

', 'ListLabelingJobsRequest$NameContains' => '

A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

', 'ListModelBiasJobDefinitionsRequest$NameContains' => '

Filter for model bias jobs whose name contains a specified string.

', 'ListModelExplainabilityJobDefinitionsRequest$NameContains' => '

Filter for model explainability jobs whose name contains a specified string.

', 'ListModelPackageGroupsInput$NameContains' => '

A string in the model group name. This filter returns only model groups whose name contains the specified string.

', 'ListModelPackagesInput$NameContains' => '

A string in the model package name. This filter returns only model packages whose name contains the specified string.

', 'ListModelQualityJobDefinitionsRequest$NameContains' => '

A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.

', 'ListMonitoringSchedulesRequest$NameContains' => '

Filter for monitoring schedules whose name contains a specified string.

', 'ListTrainingJobsRequest$NameContains' => '

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

', 'ListTransformJobsRequest$NameContains' => '

A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

', ], ], 'NeoVpcConfig' => [ 'base' => '

The VpcConfig configuration object that specifies the VPC that you want the compilation jobs to connect to. For more information on controlling access to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker Compilation Jobs Access to Resources in Your Amazon VPC.

', 'refs' => [ 'CreateCompilationJobRequest$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

', 'DescribeCompilationJobResponse$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

', ], ], 'NeoVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'NeoVpcSecurityGroupIds$member' => NULL, ], ], 'NeoVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'NeoVpcConfig$SecurityGroupIds' => '

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'NeoVpcSubnetId' => [ 'base' => NULL, 'refs' => [ 'NeoVpcSubnets$member' => NULL, ], ], 'NeoVpcSubnets' => [ 'base' => NULL, 'refs' => [ 'NeoVpcConfig$Subnets' => '

The ID of the subnets in the VPC that you want to connect the compilation job to for accessing the model in Amazon S3.

', ], ], 'NestedFilters' => [ 'base' => '

A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.

For example, to filter on a training job\'s InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:

  • \'{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"}\',

  • \'{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains", "Value":"mybucket/catdata"}\'

', 'refs' => [ 'NestedFiltersList$member' => NULL, ], ], 'NestedFiltersList' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$NestedFilters' => '

A list of nested filter objects.

', ], ], 'NetworkConfig' => [ 'base' => '

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

', 'refs' => [ 'CreateProcessingJobRequest$NetworkConfig' => '

Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.

', 'DescribeProcessingJobResponse$NetworkConfig' => '

Networking options for a processing job.

', 'MonitoringJobDefinition$NetworkConfig' => '

Specifies networking options for an monitoring job.

', 'ProcessingJob$NetworkConfig' => NULL, ], ], 'NetworkInterfaceId' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NetworkInterfaceId' => '

The network interface IDs that SageMaker created at the time of creating the instance.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceRequest$NextToken' => '

Next token of device description.

', 'DescribeDeviceResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'DescribeEdgeDeploymentPlanRequest$NextToken' => '

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

', 'DescribeEdgeDeploymentPlanResponse$NextToken' => '

Token to use when calling the next set of stages in the edge deployment plan.

', 'DescribeFeatureGroupRequest$NextToken' => '

A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.

', 'DescribeFeatureGroupResponse$NextToken' => '

A token to resume pagination of the list of Features (FeatureDefinitions).

', 'ListActionsRequest$NextToken' => '

If the previous call to ListActions didn\'t return the full set of actions, the call returns a token for getting the next set of actions.

', 'ListActionsResponse$NextToken' => '

A token for getting the next set of actions, if there are any.

', 'ListAlgorithmsInput$NextToken' => '

If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

', 'ListAlgorithmsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListAliasesRequest$NextToken' => '

If the previous call to ListAliases didn\'t return the full set of aliases, the call returns a token for retrieving the next set of aliases.

', 'ListAliasesResponse$NextToken' => '

A token for getting the next set of aliases, if more aliases exist.

', 'ListAppImageConfigsRequest$NextToken' => '

If the previous call to ListImages didn\'t return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

', 'ListAppImageConfigsResponse$NextToken' => '

A token for getting the next set of AppImageConfigs, if there are any.

', 'ListAppsRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListAppsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListArtifactsRequest$NextToken' => '

If the previous call to ListArtifacts didn\'t return the full set of artifacts, the call returns a token for getting the next set of artifacts.

', 'ListArtifactsResponse$NextToken' => '

A token for getting the next set of artifacts, if there are any.

', 'ListAssociationsRequest$NextToken' => '

If the previous call to ListAssociations didn\'t return the full set of associations, the call returns a token for getting the next set of associations.

', 'ListAssociationsResponse$NextToken' => '

A token for getting the next set of associations, if there are any.

', 'ListAutoMLJobsRequest$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListAutoMLJobsResponse$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListCandidatesForAutoMLJobRequest$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListCandidatesForAutoMLJobResponse$NextToken' => '

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

', 'ListClusterNodesRequest$NextToken' => '

If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.

', 'ListClusterNodesResponse$NextToken' => '

The next token specified for listing instances in a SageMaker HyperPod cluster.

', 'ListClustersRequest$NextToken' => '

Set the next token to retrieve the list of SageMaker HyperPod clusters.

', 'ListClustersResponse$NextToken' => '

If the result of the previous ListClusters request was truncated, the response includes a NextToken. To retrieve the next set of clusters, use the token in the next request.

', 'ListCodeRepositoriesInput$NextToken' => '

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

', 'ListCodeRepositoriesOutput$NextToken' => '

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

', 'ListCompilationJobsRequest$NextToken' => '

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

', 'ListCompilationJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.

', 'ListContextsRequest$NextToken' => '

If the previous call to ListContexts didn\'t return the full set of contexts, the call returns a token for getting the next set of contexts.

', 'ListContextsResponse$NextToken' => '

A token for getting the next set of contexts, if there are any.

', 'ListDataQualityJobDefinitionsRequest$NextToken' => '

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.>

', 'ListDataQualityJobDefinitionsResponse$NextToken' => '

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next request.

', 'ListDeviceFleetsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDeviceFleetsResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDevicesRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDevicesResponse$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListDomainsRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListDomainsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListEdgeDeploymentPlansRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListEdgeDeploymentPlansResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListEdgePackagingJobsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListEdgePackagingJobsResponse$NextToken' => '

Token to use when calling the next page of results.

', 'ListExperimentsRequest$NextToken' => '

If the previous call to ListExperiments didn\'t return the full set of experiments, the call returns a token for getting the next set of experiments.

', 'ListExperimentsResponse$NextToken' => '

A token for getting the next set of experiments, if there are any.

', 'ListFeatureGroupsRequest$NextToken' => '

A token to resume pagination of ListFeatureGroups results.

', 'ListFeatureGroupsResponse$NextToken' => '

A token to resume pagination of ListFeatureGroups results.

', 'ListFlowDefinitionsRequest$NextToken' => '

A token to resume pagination.

', 'ListFlowDefinitionsResponse$NextToken' => '

A token to resume pagination.

', 'ListHubContentVersionsRequest$NextToken' => '

If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.

', 'ListHubContentVersionsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.

', 'ListHubContentsRequest$NextToken' => '

If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.

', 'ListHubContentsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

', 'ListHubsRequest$NextToken' => '

If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

', 'ListHubsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

', 'ListHumanTaskUisRequest$NextToken' => '

A token to resume pagination.

', 'ListHumanTaskUisResponse$NextToken' => '

A token to resume pagination.

', 'ListHyperParameterTuningJobsRequest$NextToken' => '

If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

', 'ListHyperParameterTuningJobsResponse$NextToken' => '

If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

', 'ListImageVersionsRequest$NextToken' => '

If the previous call to ListImageVersions didn\'t return the full set of versions, the call returns a token for getting the next set of versions.

', 'ListImageVersionsResponse$NextToken' => '

A token for getting the next set of versions, if there are any.

', 'ListImagesRequest$NextToken' => '

If the previous call to ListImages didn\'t return the full set of images, the call returns a token for getting the next set of images.

', 'ListImagesResponse$NextToken' => '

A token for getting the next set of images, if there are any.

', 'ListInferenceExperimentsRequest$NextToken' => '

The response from the last list when returning a list large enough to need tokening.

', 'ListInferenceExperimentsResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListInferenceRecommendationsJobStepsRequest$NextToken' => '

A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

', 'ListInferenceRecommendationsJobStepsResponse$NextToken' => '

A token that you can specify in your next request to return more results from the list.

', 'ListInferenceRecommendationsJobsRequest$NextToken' => '

If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

', 'ListInferenceRecommendationsJobsResponse$NextToken' => '

A token for getting the next set of recommendations, if there are any.

', 'ListLabelingJobsForWorkteamRequest$NextToken' => '

If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListLabelingJobsForWorkteamResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

', 'ListLabelingJobsRequest$NextToken' => '

If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListLabelingJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

', 'ListLineageGroupsRequest$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListLineageGroupsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

', 'ListModelBiasJobDefinitionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelBiasJobDefinitionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelCardExportJobsRequest$NextToken' => '

If the response to a previous ListModelCardExportJobs request was truncated, the response includes a NextToken. To retrieve the next set of model card export jobs, use the token in the next request.

', 'ListModelCardExportJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card export jobs, use it in the subsequent request.

', 'ListModelCardVersionsRequest$NextToken' => '

If the response to a previous ListModelCardVersions request was truncated, the response includes a NextToken. To retrieve the next set of model card versions, use the token in the next request.

', 'ListModelCardVersionsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.

', 'ListModelCardsRequest$NextToken' => '

If the response to a previous ListModelCards request was truncated, the response includes a NextToken. To retrieve the next set of model cards, use the token in the next request.

', 'ListModelCardsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.

', 'ListModelExplainabilityJobDefinitionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelExplainabilityJobDefinitionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListModelMetadataRequest$NextToken' => '

If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.

', 'ListModelMetadataResponse$NextToken' => '

A token for getting the next set of recommendations, if there are any.

', 'ListModelPackageGroupsInput$NextToken' => '

If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

', 'ListModelPackageGroupsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.

', 'ListModelPackagesInput$NextToken' => '

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

', 'ListModelPackagesOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

', 'ListModelQualityJobDefinitionsRequest$NextToken' => '

If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request.

', 'ListModelQualityJobDefinitionsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.

', 'ListMonitoringAlertHistoryRequest$NextToken' => '

If the result of the previous ListMonitoringAlertHistory request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

', 'ListMonitoringAlertHistoryResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

', 'ListMonitoringAlertsRequest$NextToken' => '

If the result of the previous ListMonitoringAlerts request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

', 'ListMonitoringAlertsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

', 'ListMonitoringExecutionsRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringExecutionsResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringSchedulesRequest$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListMonitoringSchedulesResponse$NextToken' => '

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

', 'ListNotebookInstanceLifecycleConfigsInput$NextToken' => '

If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.

', 'ListNotebookInstanceLifecycleConfigsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.

', 'ListNotebookInstancesInput$NextToken' => '

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

', 'ListNotebookInstancesOutput$NextToken' => '

If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

', 'ListPipelineExecutionStepsRequest$NextToken' => '

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

', 'ListPipelineExecutionStepsResponse$NextToken' => '

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

', 'ListPipelineExecutionsRequest$NextToken' => '

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

', 'ListPipelineExecutionsResponse$NextToken' => '

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

', 'ListPipelineParametersForExecutionRequest$NextToken' => '

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

', 'ListPipelineParametersForExecutionResponse$NextToken' => '

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

', 'ListPipelinesRequest$NextToken' => '

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

', 'ListPipelinesResponse$NextToken' => '

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

', 'ListProcessingJobsRequest$NextToken' => '

If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.

', 'ListProcessingJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.

', 'ListProjectsInput$NextToken' => '

If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

', 'ListProjectsOutput$NextToken' => '

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

', 'ListResourceCatalogsRequest$NextToken' => '

A token to resume pagination of ListResourceCatalogs results.

', 'ListResourceCatalogsResponse$NextToken' => '

A token to resume pagination of ListResourceCatalogs results.

', 'ListSpacesRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListSpacesResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListStageDevicesRequest$NextToken' => '

The response from the last list when returning a list large enough to neeed tokening.

', 'ListStageDevicesResponse$NextToken' => '

The token to use when calling the next page of results.

', 'ListStudioLifecycleConfigsRequest$NextToken' => '

If the previous call to ListStudioLifecycleConfigs didn\'t return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

', 'ListStudioLifecycleConfigsResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListSubscribedWorkteamsRequest$NextToken' => '

If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListSubscribedWorkteamsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

', 'ListTagsInput$NextToken' => '

If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

', 'ListTagsOutput$NextToken' => '

If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$NextToken' => '

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsForHyperParameterTuningJobResponse$NextToken' => '

If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsRequest$NextToken' => '

If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

', 'ListTrainingJobsResponse$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

', 'ListTransformJobsRequest$NextToken' => '

If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

', 'ListTransformJobsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

', 'ListTrialComponentsRequest$NextToken' => '

If the previous call to ListTrialComponents didn\'t return the full set of components, the call returns a token for getting the next set of components.

', 'ListTrialComponentsResponse$NextToken' => '

A token for getting the next set of components, if there are any.

', 'ListTrialsRequest$NextToken' => '

If the previous call to ListTrials didn\'t return the full set of trials, the call returns a token for getting the next set of trials.

', 'ListTrialsResponse$NextToken' => '

A token for getting the next set of trials, if there are any.

', 'ListUserProfilesRequest$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListUserProfilesResponse$NextToken' => '

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

', 'ListWorkforcesRequest$NextToken' => '

A token to resume pagination.

', 'ListWorkforcesResponse$NextToken' => '

A token to resume pagination.

', 'ListWorkteamsRequest$NextToken' => '

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

', 'ListWorkteamsResponse$NextToken' => '

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

', 'SearchRequest$NextToken' => '

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

', 'SearchResponse$NextToken' => '

If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

', ], ], 'NonEmptyString256' => [ 'base' => NULL, 'refs' => [ 'CustomImageContainerEntrypoint$member' => NULL, 'CustomImageContainerEnvironmentVariables$key' => NULL, ], ], 'NonEmptyString64' => [ 'base' => NULL, 'refs' => [ 'CreateSpaceRequest$SpaceDisplayName' => '

The name of the space that appears in the SageMaker Studio UI.

', 'CustomImageContainerArguments$member' => NULL, 'DescribeSpaceResponse$SpaceDisplayName' => '

The name of the space that appears in the Amazon SageMaker Studio UI.

', 'SpaceDetails$SpaceDisplayName' => '

The name of the space that appears in the Studio UI.

', 'UpdateSpaceRequest$SpaceDisplayName' => '

The name of the space that appears in the Amazon SageMaker Studio UI.

', ], ], 'NotebookInstanceAcceleratorType' => [ 'base' => NULL, 'refs' => [ 'NotebookInstanceAcceleratorTypes$member' => NULL, ], ], 'NotebookInstanceAcceleratorTypes' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$AcceleratorTypes' => '

A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'DescribeNotebookInstanceOutput$AcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'UpdateNotebookInstanceInput$AcceleratorTypes' => '

A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

', ], ], 'NotebookInstanceArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceOutput$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', 'DescribeNotebookInstanceOutput$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', 'NotebookInstanceSummary$NotebookInstanceArn' => '

The Amazon Resource Name (ARN) of the notebook instance.

', ], ], 'NotebookInstanceLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'NotebookInstanceLifecycleHook$Content' => '

A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceLifecycleConfigInput$OnCreate' => '

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

', 'CreateNotebookInstanceLifecycleConfigInput$OnStart' => '

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

', 'DescribeNotebookInstanceLifecycleConfigOutput$OnCreate' => '

The shell script that runs only once, when you create a notebook instance.

', 'DescribeNotebookInstanceLifecycleConfigOutput$OnStart' => '

The shell script that runs every time you start a notebook instance, including when you create the notebook instance.

', 'UpdateNotebookInstanceLifecycleConfigInput$OnCreate' => '

The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

', 'UpdateNotebookInstanceLifecycleConfigInput$OnStart' => '

The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

', ], ], 'NotebookInstanceLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$LifecycleConfigName' => '

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'CreateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'DeleteNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration to delete.

', 'DescribeNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration to describe.

', 'DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'DescribeNotebookInstanceOutput$NotebookInstanceLifecycleConfigName' => '

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

', 'ListNotebookInstancesInput$NotebookInstanceLifecycleConfigNameContains' => '

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

', 'NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', 'NotebookInstanceSummary$NotebookInstanceLifecycleConfigName' => '

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'UpdateNotebookInstanceInput$LifecycleConfigName' => '

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'UpdateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName' => '

The name of the lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleConfigNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$NameContains' => '

A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.

', ], ], 'NotebookInstanceLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$SortBy' => '

Sorts the list of results. The default is CreationTime.

', ], ], 'NotebookInstanceLifecycleConfigSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsInput$SortOrder' => '

The sort order for results.

', ], ], 'NotebookInstanceLifecycleConfigSummary' => [ 'base' => '

Provides a summary of a notebook instance lifecycle configuration.

', 'refs' => [ 'NotebookInstanceLifecycleConfigSummaryList$member' => NULL, ], ], 'NotebookInstanceLifecycleConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstanceLifecycleConfigsOutput$NotebookInstanceLifecycleConfigs' => '

An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.

', ], ], 'NotebookInstanceLifecycleHook' => [ 'base' => '

Contains the notebook instance lifecycle configuration script.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

', 'refs' => [ 'NotebookInstanceLifecycleConfigList$member' => NULL, ], ], 'NotebookInstanceName' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$NotebookInstanceName' => '

The name of the new notebook instance.

', 'CreatePresignedNotebookInstanceUrlInput$NotebookInstanceName' => '

The name of the notebook instance.

', 'DeleteNotebookInstanceInput$NotebookInstanceName' => '

The name of the SageMaker notebook instance to delete.

', 'DescribeNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance that you want information about.

', 'DescribeNotebookInstanceOutput$NotebookInstanceName' => '

The name of the SageMaker notebook instance.

', 'NotebookInstanceSummary$NotebookInstanceName' => '

The name of the notebook instance that you want a summary for.

', 'StartNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to start.

', 'StopNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to terminate.

', 'UpdateNotebookInstanceInput$NotebookInstanceName' => '

The name of the notebook instance to update.

', ], ], 'NotebookInstanceNameContains' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$NameContains' => '

A string in the notebook instances\' name. This filter returns only notebook instances whose name contains the specified string.

', ], ], 'NotebookInstanceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$SortBy' => '

The field to sort results by. The default is Name.

', ], ], 'NotebookInstanceSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesInput$SortOrder' => '

The sort order for results.

', ], ], 'NotebookInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeNotebookInstanceOutput$NotebookInstanceStatus' => '

The status of the notebook instance.

', 'ListNotebookInstancesInput$StatusEquals' => '

A filter that returns only notebook instances with the specified status.

', 'NotebookInstanceSummary$NotebookInstanceStatus' => '

The status of the notebook instance.

', ], ], 'NotebookInstanceSummary' => [ 'base' => '

Provides summary information for an SageMaker notebook instance.

', 'refs' => [ 'NotebookInstanceSummaryList$member' => NULL, ], ], 'NotebookInstanceSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookInstancesOutput$NotebookInstances' => '

An array of NotebookInstanceSummary objects, one for each notebook instance.

', ], ], 'NotebookInstanceUrl' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedNotebookInstanceUrlOutput$AuthorizedUrl' => '

A JSON object that contains the URL string.

', 'DescribeNotebookInstanceOutput$Url' => '

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

', 'NotebookInstanceSummary$Url' => '

The URL that you use to connect to the Jupyter notebook running in your notebook instance.

', ], ], 'NotebookInstanceVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

', 'DescribeNotebookInstanceOutput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the notebook instance.

', 'UpdateNotebookInstanceInput$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can\'t determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can\'t decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

', ], ], 'NotebookOutputOption' => [ 'base' => NULL, 'refs' => [ 'SharingSettings$NotebookOutputOption' => '

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

', ], ], 'NotificationConfiguration' => [ 'base' => '

Configures Amazon SNS notifications of available or expiring work items for work teams.

', 'refs' => [ 'CreateWorkteamRequest$NotificationConfiguration' => '

Configures notification of workers regarding available or expiring work items.

', 'UpdateWorkteamRequest$NotificationConfiguration' => '

Configures SNS topic notifications for available or expiring work items

', 'Workteam$NotificationConfiguration' => '

Configures SNS notifications of available or expiring work items for work teams.

', ], ], 'NotificationTopicArn' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$NotificationTopicArn' => '

The ARN for the Amazon SNS topic to which notifications should be published.

', ], ], 'NumberOfAcceleratorDevices' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$NumberOfAcceleratorDevicesRequired' => '

The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.

', ], ], 'NumberOfCpuCores' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentComputeResourceRequirements$NumberOfCpuCoresRequired' => '

The number of CPU cores to allocate to run a model that you assign to an inference component.

', ], ], 'NumberOfHumanWorkersPerDataObject' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$NumberOfHumanWorkersPerDataObject' => '

The number of human workers that will label an object.

', 'LabelingJobForWorkteamSummary$NumberOfHumanWorkersPerDataObject' => '

The configured number of workers per data object.

', ], ], 'NumberOfSteps' => [ 'base' => NULL, 'refs' => [ 'Stairs$NumberOfSteps' => '

Specifies how many steps to perform during traffic.

', ], ], 'ObjectiveStatus' => [ 'base' => NULL, 'refs' => [ 'AutoMLCandidate$ObjectiveStatus' => '

The objective\'s status.

', 'HyperParameterTrainingJobSummary$ObjectiveStatus' => '

The status of the objective metric for the training job:

  • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

  • Pending: The training job is in progress and evaluation of its final objective metric is pending.

  • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

', ], ], 'ObjectiveStatusCounter' => [ 'base' => NULL, 'refs' => [ 'ObjectiveStatusCounters$Succeeded' => '

The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

', 'ObjectiveStatusCounters$Pending' => '

The number of training jobs that are in progress and pending evaluation of their final objective metric.

', 'ObjectiveStatusCounters$Failed' => '

The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

', ], ], 'ObjectiveStatusCounters' => [ 'base' => '

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$ObjectiveStatusCounters' => '

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

', 'HyperParameterTuningJobSearchEntity$ObjectiveStatusCounters' => NULL, 'HyperParameterTuningJobSummary$ObjectiveStatusCounters' => '

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

', ], ], 'OfflineStoreConfig' => [ 'base' => '

The configuration of an OfflineStore.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

', 'refs' => [ 'CreateFeatureGroupRequest$OfflineStoreConfig' => '

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

  • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

  • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

  • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

  • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

', 'DescribeFeatureGroupResponse$OfflineStoreConfig' => '

The configuration of the offline store. It includes the following configurations:

  • Amazon S3 location of the offline store.

  • Configuration of the Glue data catalog.

  • Table format of the offline store.

  • Option to disable the automatic creation of a Glue table for the offline store.

  • Encryption configuration.

', 'FeatureGroup$OfflineStoreConfig' => NULL, ], ], 'OfflineStoreStatus' => [ 'base' => '

The status of OfflineStore.

', 'refs' => [ 'DescribeFeatureGroupResponse$OfflineStoreStatus' => '

The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

', 'FeatureGroup$OfflineStoreStatus' => NULL, 'FeatureGroupSummary$OfflineStoreStatus' => '

Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.

', ], ], 'OfflineStoreStatusValue' => [ 'base' => NULL, 'refs' => [ 'ListFeatureGroupsRequest$OfflineStoreStatusEquals' => '

An OfflineStore status. Filters by OfflineStore status.

', 'OfflineStoreStatus$Status' => '

An OfflineStore status.

', ], ], 'OidcConfig' => [ 'base' => '

Use this parameter to configure your OIDC Identity Provider (IdP).

', 'refs' => [ 'CreateWorkforceRequest$OidcConfig' => '

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

', 'UpdateWorkforceRequest$OidcConfig' => '

Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.

', ], ], 'OidcConfigForResponse' => [ 'base' => '

Your OIDC IdP workforce configuration.

', 'refs' => [ 'Workforce$OidcConfig' => '

The configuration of an OIDC Identity Provider (IdP) private workforce.

', ], ], 'OidcEndpoint' => [ 'base' => NULL, 'refs' => [ 'OidcConfig$Issuer' => '

The OIDC IdP issuer used to configure your private workforce.

', 'OidcConfig$AuthorizationEndpoint' => '

The OIDC IdP authorization endpoint used to configure your private workforce.

', 'OidcConfig$TokenEndpoint' => '

The OIDC IdP token endpoint used to configure your private workforce.

', 'OidcConfig$UserInfoEndpoint' => '

The OIDC IdP user information endpoint used to configure your private workforce.

', 'OidcConfig$LogoutEndpoint' => '

The OIDC IdP logout endpoint used to configure your private workforce.

', 'OidcConfig$JwksUri' => '

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

', 'OidcConfigForResponse$Issuer' => '

The OIDC IdP issuer used to configure your private workforce.

', 'OidcConfigForResponse$AuthorizationEndpoint' => '

The OIDC IdP authorization endpoint used to configure your private workforce.

', 'OidcConfigForResponse$TokenEndpoint' => '

The OIDC IdP token endpoint used to configure your private workforce.

', 'OidcConfigForResponse$UserInfoEndpoint' => '

The OIDC IdP user information endpoint used to configure your private workforce.

', 'OidcConfigForResponse$LogoutEndpoint' => '

The OIDC IdP logout endpoint used to configure your private workforce.

', 'OidcConfigForResponse$JwksUri' => '

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

', ], ], 'OidcMemberDefinition' => [ 'base' => '

A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

', 'refs' => [ 'MemberDefinition$OidcMemberDefinition' => '

A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

', ], ], 'OnlineStoreConfig' => [ 'base' => '

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.

The default value is False.

', 'refs' => [ 'CreateFeatureGroupRequest$OnlineStoreConfig' => '

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

', 'DescribeFeatureGroupResponse$OnlineStoreConfig' => '

The configuration for the OnlineStore.

', 'FeatureGroup$OnlineStoreConfig' => NULL, ], ], 'OnlineStoreConfigUpdate' => [ 'base' => '

Updates the feature group online store configuration.

', 'refs' => [ 'UpdateFeatureGroupRequest$OnlineStoreConfig' => '

Updates the feature group online store configuration.

', ], ], 'OnlineStoreSecurityConfig' => [ 'base' => '

The security configuration for OnlineStore.

', 'refs' => [ 'OnlineStoreConfig$SecurityConfig' => '

Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.

', ], ], 'OnlineStoreTotalSizeBytes' => [ 'base' => NULL, 'refs' => [ 'DescribeFeatureGroupResponse$OnlineStoreTotalSizeBytes' => '

The size of the OnlineStore in bytes.

', ], ], 'Operator' => [ 'base' => NULL, 'refs' => [ 'Filter$Operator' => '

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn\'t equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "\'CONTAINS\' operator usage limit of 1 exceeded."

', ], ], 'OptionalDouble' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$Max' => '

The maximum value of the metric.

', 'TrialComponentMetricSummary$Min' => '

The minimum value of the metric.

', 'TrialComponentMetricSummary$Last' => '

The most recent value of the metric.

', 'TrialComponentMetricSummary$Avg' => '

The average value of the metric.

', 'TrialComponentMetricSummary$StdDev' => '

The standard deviation of the metric.

', ], ], 'OptionalInteger' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$Count' => '

The number of samples used to generate the metric.

', ], ], 'OptionalVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the processing instance.

', 'HyperParameterTuningResourceConfig$VolumeSizeInGB' => '

The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.

Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.

SageMaker supports only the General Purpose SSD (gp2) storage volume type.

', 'ProfilerRuleConfiguration$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to the processing instance.

', ], ], 'OrderKey' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListEndpointsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListInferenceComponentsInput$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListModelsInput$SortOrder' => '

The sort order for results. The default is Descending.

', ], ], 'OutputCompressionType' => [ 'base' => NULL, 'refs' => [ 'OutputDataConfig$CompressionType' => '

The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.

', ], ], 'OutputConfig' => [ 'base' => '

Contains information about the output location for the compiled model and the target device that the model runs on. TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.

', 'refs' => [ 'CreateCompilationJobRequest$OutputConfig' => '

Provides information about the output location for the compiled model and the target device the model runs on.

', 'DescribeCompilationJobResponse$OutputConfig' => '

Information about the output location for the compiled model and the target device that the model runs on.

', ], ], 'OutputDataConfig' => [ 'base' => '

Provides information about how to store model training results (model artifacts).

', 'refs' => [ 'CreateTrainingJobRequest$OutputDataConfig' => '

Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

', 'DescribeTrainingJobResponse$OutputDataConfig' => '

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

', 'HyperParameterTrainingJobDefinition$OutputDataConfig' => '

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

', 'TrainingJob$OutputDataConfig' => '

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

', 'TrainingJobDefinition$OutputDataConfig' => '

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

', ], ], 'OutputParameter' => [ 'base' => '

An output parameter of a pipeline step.

', 'refs' => [ 'OutputParameterList$member' => NULL, ], ], 'OutputParameterList' => [ 'base' => NULL, 'refs' => [ 'CallbackStepMetadata$OutputParameters' => '

A list of the output parameters of the callback step.

', 'LambdaStepMetadata$OutputParameters' => '

A list of the output parameters of the Lambda step.

', 'SendPipelineExecutionStepSuccessRequest$OutputParameters' => '

A list of the output parameters of the callback step.

', ], ], 'OwnershipSettings' => [ 'base' => '

The collection of ownership settings for a space.

', 'refs' => [ 'CreateSpaceRequest$OwnershipSettings' => '

A collection of ownership settings.

', 'DescribeSpaceResponse$OwnershipSettings' => '

The collection of ownership settings for a space.

', ], ], 'OwnershipSettingsSummary' => [ 'base' => '

Specifies summary information about the ownership settings.

', 'refs' => [ 'SpaceDetails$OwnershipSettingsSummary' => '

Specifies summary information about the ownership settings.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListEndpointConfigsInput$NextToken' => '

If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.

', 'ListEndpointConfigsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

', 'ListEndpointsInput$NextToken' => '

If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

', 'ListEndpointsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

', 'ListInferenceComponentsInput$NextToken' => '

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

', 'ListInferenceComponentsOutput$NextToken' => '

The token to use in a subsequent request to get the next set of results following a truncated response.

', 'ListModelsInput$NextToken' => '

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

', 'ListModelsOutput$NextToken' => '

If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

', ], ], 'ParallelismConfiguration' => [ 'base' => '

Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.

', 'refs' => [ 'CreatePipelineRequest$ParallelismConfiguration' => '

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

', 'DescribePipelineExecutionResponse$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline.

', 'DescribePipelineResponse$ParallelismConfiguration' => '

Lists the parallelism configuration applied to the pipeline.

', 'Pipeline$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline.

', 'PipelineExecution$ParallelismConfiguration' => '

The parallelism configuration applied to the pipeline execution.

', 'RetryPipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline.

', 'StartPipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

', 'UpdatePipelineExecutionRequest$ParallelismConfiguration' => '

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

', 'UpdatePipelineRequest$ParallelismConfiguration' => '

If specified, it applies to all executions of this pipeline by default.

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

Assigns a value to a named Pipeline parameter.

', 'refs' => [ 'ParameterList$member' => NULL, ], ], 'ParameterKey' => [ 'base' => NULL, 'refs' => [ 'AutoParameter$Name' => '

The name of the hyperparameter to optimize using Autotune.

', 'CategoricalParameterRange$Name' => '

The name of the categorical hyperparameter to tune.

', 'ContinuousParameterRange$Name' => '

The name of the continuous hyperparameter to tune.

', 'IntegerParameterRange$Name' => '

The name of the hyperparameter to search.

', ], ], 'ParameterList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineParametersForExecutionResponse$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', 'PipelineExecution$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', 'StartPipelineExecutionRequest$PipelineParameters' => '

Contains a list of pipeline parameters. This list can be empty.

', ], ], 'ParameterName' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Name' => '

The name of this hyperparameter. The name must be unique.

', ], ], 'ParameterRange' => [ 'base' => '

Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.

', 'refs' => [ 'HyperParameterSpecification$Range' => '

The allowed range for this hyperparameter.

', ], ], 'ParameterRanges' => [ 'base' => '

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can\'t exceed the maximum number specified.

', 'refs' => [ 'HyperParameterTrainingJobDefinition$HyperParameterRanges' => NULL, 'HyperParameterTuningJobConfig$ParameterRanges' => '

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.

', ], ], 'ParameterType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterSpecification$Type' => '

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

', ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'AutoParameter$ValueHint' => '

An example value of the hyperparameter to optimize using Autotune.

', 'ContinuousParameterRange$MinValue' => '

The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

', 'ContinuousParameterRange$MaxValue' => '

The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

', 'ContinuousParameterRangeSpecification$MinValue' => '

The minimum floating-point value allowed.

', 'ContinuousParameterRangeSpecification$MaxValue' => '

The maximum floating-point value allowed.

', 'IntegerParameterRange$MinValue' => '

The minimum value of the hyperparameter to search.

', 'IntegerParameterRange$MaxValue' => '

The maximum value of the hyperparameter to search.

', 'IntegerParameterRangeSpecification$MinValue' => '

The minimum integer value allowed.

', 'IntegerParameterRangeSpecification$MaxValue' => '

The maximum integer value allowed.

', 'ParameterValues$member' => NULL, ], ], 'ParameterValues' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRange$Values' => '

A list of the categories for the hyperparameter.

', 'CategoricalParameterRangeSpecification$Values' => '

The allowed categories for the hyperparameter.

', ], ], 'Parent' => [ 'base' => '

The trial that a trial component is associated with and the experiment the trial is part of. A component might not be associated with a trial. A component can be associated with multiple trials.

', 'refs' => [ 'Parents$member' => NULL, ], ], 'ParentHyperParameterTuningJob' => [ 'base' => '

A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

', 'refs' => [ 'ParentHyperParameterTuningJobs$member' => NULL, ], ], 'ParentHyperParameterTuningJobs' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobWarmStartConfig$ParentHyperParameterTuningJobs' => '

An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

', ], ], 'Parents' => [ 'base' => NULL, 'refs' => [ 'TrialComponent$Parents' => '

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

', ], ], 'PendingDeploymentSummary' => [ 'base' => '

The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.

', 'refs' => [ 'DescribeEndpointOutput$PendingDeploymentSummary' => '

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

', ], ], 'PendingProductionVariantSummary' => [ 'base' => '

The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.

', 'refs' => [ 'PendingProductionVariantSummaryList$member' => NULL, ], ], 'PendingProductionVariantSummaryList' => [ 'base' => NULL, 'refs' => [ 'PendingDeploymentSummary$ProductionVariants' => '

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.

', 'PendingDeploymentSummary$ShadowProductionVariants' => '

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants for the in-progress deployment.

', ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'DeviceSelectionConfig$Percentage' => '

Percentage of devices in the fleet to deploy to the current stage.

', 'ShadowModelVariantConfig$SamplingPercentage' => '

The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.

', ], ], 'Phase' => [ 'base' => '

Defines the traffic pattern.

', 'refs' => [ 'Phases$member' => NULL, ], ], 'Phases' => [ 'base' => NULL, 'refs' => [ 'TrafficPattern$Phases' => '

Defines the phases traffic specification.

', ], ], 'Pipeline' => [ 'base' => '

A SageMaker Model Building Pipeline instance.

', 'refs' => [ 'SearchRecord$Pipeline' => NULL, ], ], 'PipelineArn' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the created pipeline.

', 'DeletePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline to delete.

', 'DescribePipelineExecutionResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'DescribePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'Pipeline$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'PipelineExecution$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline that was executed.

', 'PipelineSummary$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'UpdatePipelineResponse$PipelineArn' => '

The Amazon Resource Name (ARN) of the updated pipeline.

', ], ], 'PipelineDefinition' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDefinition' => '

The JSON pipeline definition of the pipeline.

', 'DescribePipelineDefinitionForExecutionResponse$PipelineDefinition' => '

The JSON pipeline definition.

', 'DescribePipelineResponse$PipelineDefinition' => '

The JSON pipeline definition.

', 'UpdatePipelineRequest$PipelineDefinition' => '

The JSON pipeline definition.

', ], ], 'PipelineDefinitionS3Location' => [ 'base' => '

The location of the pipeline definition stored in Amazon S3.

', 'refs' => [ 'CreatePipelineRequest$PipelineDefinitionS3Location' => '

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

', 'UpdatePipelineRequest$PipelineDefinitionS3Location' => '

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

', ], ], 'PipelineDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineDescription' => '

A description of the pipeline.

', 'DescribePipelineResponse$PipelineDescription' => '

The description of the pipeline.

', 'Pipeline$PipelineDescription' => '

The description of the pipeline.

', 'PipelineSummary$PipelineDescription' => '

The description of the pipeline.

', 'UpdatePipelineRequest$PipelineDescription' => '

The description of the pipeline.

', ], ], 'PipelineExecution' => [ 'base' => '

An execution of a pipeline.

', 'refs' => [ 'SearchRecord$PipelineExecution' => NULL, ], ], 'PipelineExecutionArn' => [ 'base' => NULL, 'refs' => [ 'CacheHitResult$SourcePipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineDefinitionForExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'DescribePipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'ListPipelineExecutionStepsRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'ListPipelineParametersForExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'PipelineExecution$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'RetryPipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'RetryPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'SelectiveExecutionConfig$SourcePipelineExecutionArn' => '

The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.

This field is required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.

', 'SelectiveExecutionResult$SourcePipelineExecutionArn' => '

The ARN from an execution of the current pipeline.

', 'SendPipelineExecutionStepFailureResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'SendPipelineExecutionStepSuccessResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StartPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StopPipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'StopPipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the pipeline execution.

', 'UpdatePipelineExecutionResponse$PipelineExecutionArn' => '

The Amazon Resource Name (ARN) of the updated pipeline execution.

', ], ], 'PipelineExecutionDescription' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'PipelineExecution$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'StartPipelineExecutionRequest$PipelineExecutionDescription' => '

The description of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionDescription' => '

The description of the pipeline execution.

', ], ], 'PipelineExecutionFailureReason' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$FailureReason' => '

If the execution failed, a message describing why.

', 'PipelineExecution$FailureReason' => '

If the execution failed, a message describing why.

', ], ], 'PipelineExecutionName' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'PipelineExecution$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'PipelineExecutionSummary$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'StartPipelineExecutionRequest$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', 'UpdatePipelineExecutionRequest$PipelineExecutionDisplayName' => '

The display name of the pipeline execution.

', ], ], 'PipelineExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExecutionStatus' => '

The status of the pipeline execution.

', 'PipelineExecution$PipelineExecutionStatus' => '

The status of the pipeline status.

', 'PipelineExecutionSummary$PipelineExecutionStatus' => '

The status of the pipeline execution.

', ], ], 'PipelineExecutionStep' => [ 'base' => '

An execution of a step in a pipeline.

', 'refs' => [ 'PipelineExecutionStepList$member' => NULL, ], ], 'PipelineExecutionStepList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionStepsResponse$PipelineExecutionSteps' => '

A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.

', ], ], 'PipelineExecutionStepMetadata' => [ 'base' => '

Metadata for a step execution.

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

Metadata to run the pipeline step.

', ], ], 'PipelineExecutionSummary' => [ 'base' => '

A pipeline execution summary.

', 'refs' => [ 'PipelineExecutionSummaryList$member' => NULL, ], ], 'PipelineExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsResponse$PipelineExecutionSummaries' => '

Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.

', ], ], 'PipelineExperimentConfig' => [ 'base' => '

Specifies the names of the experiment and trial created by a pipeline.

', 'refs' => [ 'DescribePipelineExecutionResponse$PipelineExperimentConfig' => NULL, 'PipelineExecution$PipelineExperimentConfig' => NULL, ], ], 'PipelineName' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineName' => '

The name of the pipeline.

', 'CreatePipelineRequest$PipelineDisplayName' => '

The display name of the pipeline.

', 'DeletePipelineRequest$PipelineName' => '

The name of the pipeline to delete.

', 'DescribePipelineResponse$PipelineName' => '

The name of the pipeline.

', 'DescribePipelineResponse$PipelineDisplayName' => '

The display name of the pipeline.

', 'ListPipelinesRequest$PipelineNamePrefix' => '

The prefix of the pipeline name.

', 'Pipeline$PipelineName' => '

The name of the pipeline.

', 'Pipeline$PipelineDisplayName' => '

The display name of the pipeline.

', 'PipelineSummary$PipelineName' => '

The name of the pipeline.

', 'PipelineSummary$PipelineDisplayName' => '

The display name of the pipeline.

', 'UpdatePipelineRequest$PipelineName' => '

The name of the pipeline to update.

', 'UpdatePipelineRequest$PipelineDisplayName' => '

The display name of the pipeline.

', ], ], 'PipelineNameOrArn' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline to describe.

', 'ListPipelineExecutionsRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline.

', 'StartPipelineExecutionRequest$PipelineName' => '

The name or Amazon Resource Name (ARN) of the pipeline.

', ], ], 'PipelineParameterName' => [ 'base' => NULL, 'refs' => [ 'Parameter$Name' => '

The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

', ], ], 'PipelineStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePipelineResponse$PipelineStatus' => '

The status of the pipeline execution.

', 'Pipeline$PipelineStatus' => '

The status of the pipeline.

', ], ], 'PipelineSummary' => [ 'base' => '

A summary of a pipeline.

', 'refs' => [ 'PipelineSummaryList$member' => NULL, ], ], 'PipelineSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesResponse$PipelineSummaries' => '

Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

', ], ], 'PlatformIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$PlatformIdentifier' => '

The platform identifier of the notebook instance runtime environment.

', 'DescribeNotebookInstanceOutput$PlatformIdentifier' => '

The platform identifier of the notebook instance runtime environment.

', ], ], 'PolicyString' => [ 'base' => NULL, 'refs' => [ 'GetModelPackageGroupPolicyOutput$ResourcePolicy' => '

The resource policy for the model group.

', 'PutModelPackageGroupPolicyInput$ResourcePolicy' => '

The resource policy for the model group.

', ], ], 'PredefinedMetricSpecification' => [ 'base' => '

A specification for a predefined metric.

', 'refs' => [ 'MetricSpecification$Predefined' => '

Information about a predefined metric.

', ], ], 'PresignedDomainUrl' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlResponse$AuthorizedUrl' => '

The presigned URL.

', ], ], 'ProbabilityThresholdAttribute' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$ProbabilityThresholdAttribute' => '

The threshold for the class probability to be evaluated as a positive result.

', 'EndpointInput$ProbabilityThresholdAttribute' => '

The threshold for the class probability to be evaluated as a positive result.

', ], ], 'ProblemType' => [ 'base' => NULL, 'refs' => [ 'CreateAutoMLJobRequest$ProblemType' => '

Defines the type of supervised learning problem available for the candidates. For more information, see Amazon SageMaker Autopilot problem types.

', 'DescribeAutoMLJobResponse$ProblemType' => '

Returns the job\'s problem type.

', 'ResolvedAttributes$ProblemType' => '

The problem type.

', 'TabularJobConfig$ProblemType' => '

The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see Amazon SageMaker Autopilot problem types.

You must either specify the type of supervised learning problem in ProblemType and provide the AutoMLJobObjective metric, or none at all.

', 'TabularResolvedAttributes$ProblemType' => '

The type of supervised learning problem available for the model candidates of the AutoML job V2 (Binary Classification, Multiclass Classification, Regression). For more information, see Amazon SageMaker Autopilot problem types.

', ], ], 'ProcessingClusterConfig' => [ 'base' => '

Configuration for the cluster used to run a processing job.

', 'refs' => [ 'ProcessingResources$ClusterConfig' => '

The configuration for the resources in a cluster used to run the processing job.

', ], ], 'ProcessingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$key' => NULL, 'ProcessingEnvironmentMap$key' => NULL, ], ], 'ProcessingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$Environment' => '

The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.

', 'DescribeProcessingJobResponse$Environment' => '

The environment variables set in the Docker container.

', 'ProcessingJob$Environment' => '

Sets the environment variables in the Docker container.

', ], ], 'ProcessingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'MonitoringEnvironmentMap$value' => NULL, 'ProcessingEnvironmentMap$value' => NULL, ], ], 'ProcessingFeatureStoreOutput' => [ 'base' => '

Configuration for processing job outputs in Amazon SageMaker Feature Store.

', 'refs' => [ 'ProcessingOutput$FeatureStoreOutput' => '

Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.

', ], ], 'ProcessingInput' => [ 'base' => '

The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.

', 'refs' => [ 'ProcessingInputs$member' => NULL, ], ], 'ProcessingInputs' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$ProcessingInputs' => '

An array of inputs configuring the data to download into the processing container.

', 'DescribeProcessingJobResponse$ProcessingInputs' => '

The inputs for a processing job.

', 'ProcessingJob$ProcessingInputs' => '

List of input configurations for the processing job.

', ], ], 'ProcessingInstanceCount' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$InstanceCount' => '

The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

', 'ProcessingClusterConfig$InstanceCount' => '

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

', ], ], 'ProcessingInstanceType' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$InstanceType' => '

The instance type to deploy a custom rule for debugging a training job.

', 'MonitoringClusterConfig$InstanceType' => '

The ML compute instance type for the processing job.

', 'ProcessingClusterConfig$InstanceType' => '

The ML compute instance type for the processing job.

', 'ProfilerRuleConfiguration$InstanceType' => '

The instance type to deploy a custom rule for profiling a training job.

', ], ], 'ProcessingJob' => [ 'base' => '

An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.

', 'refs' => [ 'TrialComponentSourceDetail$ProcessingJob' => '

Information about a processing job that\'s the source of a trial component.

', ], ], 'ProcessingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobResponse$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'DebugRuleEvaluationStatus$RuleEvaluationJobArn' => '

The Amazon Resource Name (ARN) of the rule evaluation job.

', 'DescribeProcessingJobResponse$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'MonitoringExecutionSummary$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the monitoring job.

', 'ProcessingJob$ProcessingJobArn' => '

The ARN of the processing job.

', 'ProcessingJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the processing job.

', 'ProcessingJobSummary$ProcessingJobArn' => '

The Amazon Resource Name (ARN) of the processing job..

', 'ProfilerRuleEvaluationStatus$RuleEvaluationJobArn' => '

The Amazon Resource Name (ARN) of the rule evaluation job.

', ], ], 'ProcessingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateProcessingJobRequest$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DataQualityBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the data quality monitoring job.

', 'DescribeProcessingJobRequest$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeProcessingJobResponse$ProcessingJobName' => '

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'ModelBiasBaselineConfig$BaseliningJobName' => '

The name of the baseline model bias job.

', 'ModelExplainabilityBaselineConfig$BaseliningJobName' => '

The name of the baseline model explainability job.

', 'ModelQualityBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the monitoring job.

', 'MonitoringBaselineConfig$BaseliningJobName' => '

The name of the job that performs baselining for the monitoring job.

', 'ProcessingJob$ProcessingJobName' => '

The name of the processing job.

', 'ProcessingJobSummary$ProcessingJobName' => '

The name of the processing job.

', 'StopProcessingJobRequest$ProcessingJobName' => '

The name of the processing job to stop.

', ], ], 'ProcessingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeProcessingJobResponse$ProcessingJobStatus' => '

Provides the status of a processing job.

', 'ListProcessingJobsRequest$StatusEquals' => '

A filter that retrieves only processing jobs with a specific status.

', 'ProcessingJob$ProcessingJobStatus' => '

The status of the processing job.

', 'ProcessingJobSummary$ProcessingJobStatus' => '

The status of the processing job.

', ], ], 'ProcessingJobStepMetadata' => [ 'base' => '

Metadata for a processing job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$ProcessingJob' => '

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

', ], ], 'ProcessingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListProcessingJobsResponse$ProcessingJobSummaries' => '

An array of ProcessingJobSummary objects, each listing a processing job.

', ], ], 'ProcessingJobSummary' => [ 'base' => '

Summary of information about a processing job.

', 'refs' => [ 'ProcessingJobSummaries$member' => NULL, ], ], 'ProcessingLocalPath' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$LocalPath' => '

Path to the filesystem where the batch transform data is available to the container.

', 'DatasetDefinition$LocalPath' => '

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

', 'EndpointInput$LocalPath' => '

Path to the filesystem where the endpoint data is available to the container.

', 'MonitoringS3Output$LocalPath' => '

The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.

', 'ProcessingS3Input$LocalPath' => '

The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).

', 'ProcessingS3Output$LocalPath' => '

The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container\'s entrypoint is invoked.

', ], ], 'ProcessingMaxRuntimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'ProcessingStoppingCondition$MaxRuntimeInSeconds' => '

Specifies the maximum runtime in seconds.

', ], ], 'ProcessingOutput' => [ 'base' => '

Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.

', 'refs' => [ 'ProcessingOutputs$member' => NULL, ], ], 'ProcessingOutputConfig' => [ 'base' => '

Configuration for uploading output from the processing container.

', 'refs' => [ 'CreateProcessingJobRequest$ProcessingOutputConfig' => '

Output configuration for the processing job.

', 'DescribeProcessingJobResponse$ProcessingOutputConfig' => '

Output configuration for the processing job.

', 'ProcessingJob$ProcessingOutputConfig' => NULL, ], ], 'ProcessingOutputs' => [ 'base' => NULL, 'refs' => [ 'ProcessingOutputConfig$Outputs' => '

An array of outputs configuring the data to upload from the processing container.

', ], ], 'ProcessingResources' => [ 'base' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'refs' => [ 'CreateProcessingJobRequest$ProcessingResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'DescribeProcessingJobResponse$ProcessingResources' => '

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

', 'ProcessingJob$ProcessingResources' => NULL, ], ], 'ProcessingS3CompressionType' => [ 'base' => NULL, 'refs' => [ 'ProcessingS3Input$S3CompressionType' => '

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

', ], ], 'ProcessingS3DataDistributionType' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$S3DataDistributionType' => '

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

', 'EndpointInput$S3DataDistributionType' => '

Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to FullyReplicated

', 'ProcessingS3Input$S3DataDistributionType' => '

Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.

', ], ], 'ProcessingS3DataType' => [ 'base' => NULL, 'refs' => [ 'ProcessingS3Input$S3DataType' => '

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

', ], ], 'ProcessingS3Input' => [ 'base' => '

Configuration for downloading input data from Amazon S3 into the processing container.

', 'refs' => [ 'ProcessingInput$S3Input' => '

Configuration for downloading input data from Amazon S3 into the processing container.

', ], ], 'ProcessingS3InputMode' => [ 'base' => NULL, 'refs' => [ 'BatchTransformInput$S3InputMode' => '

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

', 'EndpointInput$S3InputMode' => '

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

', 'ProcessingS3Input$S3InputMode' => '

Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.

', ], ], 'ProcessingS3Output' => [ 'base' => '

Configuration for uploading output data to Amazon S3 from the processing container.

', 'refs' => [ 'ProcessingOutput$S3Output' => '

Configuration for processing job outputs in Amazon S3.

', ], ], 'ProcessingS3UploadMode' => [ 'base' => NULL, 'refs' => [ 'MonitoringS3Output$S3UploadMode' => '

Whether to upload the results of the monitoring job continuously or after the job completes.

', 'ProcessingS3Output$S3UploadMode' => '

Whether to upload the results of the processing job continuously or after the job completes.

', ], ], 'ProcessingStoppingCondition' => [ 'base' => '

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.

', 'refs' => [ 'CreateProcessingJobRequest$StoppingCondition' => '

The time limit for how long the processing job is allowed to run.

', 'DescribeProcessingJobResponse$StoppingCondition' => '

The time limit for how long the processing job is allowed to run.

', 'ProcessingJob$StoppingCondition' => NULL, ], ], 'ProcessingVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'MonitoringClusterConfig$VolumeSizeInGB' => '

The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.

', 'ProcessingClusterConfig$VolumeSizeInGB' => '

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can\'t request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

', ], ], 'Processor' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', 'DescribeImageVersionResponse$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', 'UpdateImageVersionRequest$Processor' => '

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

', ], ], 'ProductId' => [ 'base' => NULL, 'refs' => [ 'DescribeAlgorithmOutput$ProductId' => '

The product identifier of the algorithm.

', 'ModelPackageContainerDefinition$ProductId' => '

The Amazon Web Services Marketplace product ID of the model package.

', ], ], 'ProductListings' => [ 'base' => NULL, 'refs' => [ 'Workteam$ProductListingIds' => '

The Amazon Marketplace identifier for a vendor\'s work team.

', ], ], 'ProductionVariant' => [ 'base' => '

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.

', 'refs' => [ 'ProductionVariantList$member' => NULL, ], ], 'ProductionVariantAcceleratorType' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$AcceleratorType' => '

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

', 'ProductionVariant$AcceleratorType' => '

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

', ], ], 'ProductionVariantContainerStartupHealthCheckTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentStartupParameters$ContainerStartupHealthCheckTimeoutInSeconds' => '

The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

', 'ProductionVariant$ContainerStartupHealthCheckTimeoutInSeconds' => '

The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

', ], ], 'ProductionVariantCoreDumpConfig' => [ 'base' => '

Specifies configuration for a core dump from the model container when the process crashes.

', 'refs' => [ 'ProductionVariant$CoreDumpConfig' => '

Specifies configuration for a core dump from the model container when the process crashes.

', ], ], 'ProductionVariantInstanceType' => [ 'base' => NULL, 'refs' => [ 'EndpointInputConfiguration$InstanceType' => '

The instance types to use for the load test.

', 'EndpointOutputConfiguration$InstanceType' => '

The instance type recommended by Amazon SageMaker Inference Recommender.

', 'PendingProductionVariantSummary$InstanceType' => '

The type of instances associated with the variant.

', 'ProductionVariant$InstanceType' => '

The ML compute instance type.

', 'RealTimeInferenceRecommendation$InstanceType' => '

The recommended instance type for Real-Time Inference.

', 'RealtimeInferenceInstanceTypes$member' => NULL, ], ], 'ProductionVariantList' => [ 'base' => NULL, 'refs' => [ 'CreateEndpointConfigInput$ProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

', 'CreateEndpointConfigInput$ShadowProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

', 'DescribeEndpointConfigOutput$ProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

', 'DescribeEndpointConfigOutput$ShadowProductionVariants' => '

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

', ], ], 'ProductionVariantManagedInstanceScaling' => [ 'base' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'refs' => [ 'PendingProductionVariantSummary$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'ProductionVariant$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', 'ProductionVariantSummary$ManagedInstanceScaling' => '

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

', ], ], 'ProductionVariantModelDataDownloadTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'InferenceComponentStartupParameters$ModelDataDownloadTimeoutInSeconds' => '

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.

', 'ProductionVariant$ModelDataDownloadTimeoutInSeconds' => '

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

', ], ], 'ProductionVariantRoutingConfig' => [ 'base' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'refs' => [ 'PendingProductionVariantSummary$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'ProductionVariant$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', 'ProductionVariantSummary$RoutingConfig' => '

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

', ], ], 'ProductionVariantSSMAccess' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$EnableSSMAccess' => '

You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.

', ], ], 'ProductionVariantServerlessConfig' => [ 'base' => '

Specifies the serverless configuration for an endpoint variant.

', 'refs' => [ 'EndpointInputConfiguration$ServerlessConfig' => NULL, 'EndpointOutputConfiguration$ServerlessConfig' => NULL, 'PendingProductionVariantSummary$CurrentServerlessConfig' => '

The serverless configuration for the endpoint.

', 'PendingProductionVariantSummary$DesiredServerlessConfig' => '

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

', 'ProductionVariant$ServerlessConfig' => '

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

', 'ProductionVariantSummary$CurrentServerlessConfig' => '

The serverless configuration for the endpoint.

', 'ProductionVariantSummary$DesiredServerlessConfig' => '

The serverless configuration requested for the endpoint update.

', ], ], 'ProductionVariantServerlessUpdateConfig' => [ 'base' => '

Specifies the serverless update concurrency configuration for an endpoint variant.

', 'refs' => [ 'DesiredWeightAndCapacity$ServerlessUpdateConfig' => '

Specifies the serverless update concurrency configuration for an endpoint variant.

', ], ], 'ProductionVariantStatus' => [ 'base' => '

Describes the status of the production variant.

', 'refs' => [ 'ProductionVariantStatusList$member' => NULL, ], ], 'ProductionVariantStatusList' => [ 'base' => NULL, 'refs' => [ 'PendingProductionVariantSummary$VariantStatus' => '

The endpoint variant status which describes the current deployment stage status or operational status.

', 'ProductionVariantSummary$VariantStatus' => '

The endpoint variant status which describes the current deployment stage status or operational status.

', ], ], 'ProductionVariantSummary' => [ 'base' => '

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

', 'refs' => [ 'ProductionVariantSummaryList$member' => NULL, ], ], 'ProductionVariantSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeEndpointOutput$ProductionVariants' => '

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

', 'DescribeEndpointOutput$ShadowProductionVariants' => '

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

', 'Endpoint$ProductionVariants' => '

A list of the production variants hosted on the endpoint. Each production variant is a model.

', 'Endpoint$ShadowProductionVariants' => '

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.

', ], ], 'ProductionVariantVolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariant$VolumeSizeInGB' => '

The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.

', ], ], 'ProfilerConfig' => [ 'base' => '

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

', 'refs' => [ 'CreateTrainingJobRequest$ProfilerConfig' => NULL, 'DescribeTrainingJobResponse$ProfilerConfig' => NULL, 'TrainingJob$ProfilerConfig' => NULL, ], ], 'ProfilerConfigForUpdate' => [ 'base' => '

Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.

', 'refs' => [ 'UpdateTrainingJobRequest$ProfilerConfig' => '

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

', ], ], 'ProfilerRuleConfiguration' => [ 'base' => '

Configuration information for profiling rules.

', 'refs' => [ 'ProfilerRuleConfigurations$member' => NULL, ], ], 'ProfilerRuleConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', 'DescribeTrainingJobResponse$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', 'UpdateTrainingJobRequest$ProfilerRuleConfigurations' => '

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

', ], ], 'ProfilerRuleEvaluationStatus' => [ 'base' => '

Information about the status of the rule evaluation.

', 'refs' => [ 'ProfilerRuleEvaluationStatuses$member' => NULL, ], ], 'ProfilerRuleEvaluationStatuses' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$ProfilerRuleEvaluationStatuses' => '

Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

', ], ], 'ProfilingIntervalInMilliseconds' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingIntervalInMilliseconds' => '

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

', 'ProfilerConfigForUpdate$ProfilingIntervalInMilliseconds' => '

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

', ], ], 'ProfilingParameters' => [ 'base' => NULL, 'refs' => [ 'ProfilerConfig$ProfilingParameters' => '

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', 'ProfilerConfigForUpdate$ProfilingParameters' => '

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

', ], ], 'ProfilingStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$ProfilingStatus' => '

Profiling status of a training job.

', ], ], 'ProgrammingLang' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ProgrammingLang' => '

The supported programming language and its version.

', 'DescribeImageVersionResponse$ProgrammingLang' => '

The supported programming language and its version.

', 'UpdateImageVersionRequest$ProgrammingLang' => '

The supported programming language and its version.

', ], ], 'Project' => [ 'base' => '

The properties of a project as returned by the Search API.

', 'refs' => [ 'SearchRecord$Project' => '

The properties of a project.

', ], ], 'ProjectArn' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'DescribeProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'Project$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'ProjectSummary$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', 'UpdateProjectOutput$ProjectArn' => '

The Amazon Resource Name (ARN) of the project.

', ], ], 'ProjectEntityName' => [ 'base' => NULL, 'refs' => [ 'CreateProjectInput$ProjectName' => '

The name of the project.

', 'DeleteProjectInput$ProjectName' => '

The name of the project to delete.

', 'DescribeProjectInput$ProjectName' => '

The name of the project to describe.

', 'DescribeProjectOutput$ProjectName' => '

The name of the project.

', 'ListProjectsInput$NameContains' => '

A filter that returns the projects whose name contains a specified string.

', 'Project$ProjectName' => '

The name of the project.

', 'ProjectSummary$ProjectName' => '

The name of the project.

', 'UpdateProjectInput$ProjectName' => '

The name of the project.

', ], ], 'ProjectId' => [ 'base' => NULL, 'refs' => [ 'CreateProjectOutput$ProjectId' => '

The ID of the new project.

', 'DescribeProjectOutput$ProjectId' => '

The ID of the project.

', 'Project$ProjectId' => '

The ID of the project.

', 'ProjectSummary$ProjectId' => '

The ID of the project.

', ], ], 'ProjectSortBy' => [ 'base' => NULL, 'refs' => [ 'ListProjectsInput$SortBy' => '

The field by which to sort results. The default is CreationTime.

', ], ], 'ProjectSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListProjectsInput$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'ProjectStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeProjectOutput$ProjectStatus' => '

The status of the project.

', 'Project$ProjectStatus' => '

The status of the project.

', 'ProjectSummary$ProjectStatus' => '

The status of the project.

', ], ], 'ProjectSummary' => [ 'base' => '

Information about a project.

', 'refs' => [ 'ProjectSummaryList$member' => NULL, ], ], 'ProjectSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListProjectsOutput$ProjectSummaryList' => '

A list of summaries of projects.

', ], ], 'PropertyNameHint' => [ 'base' => NULL, 'refs' => [ 'PropertyNameQuery$PropertyNameHint' => '

Text that begins a property\'s name.

', ], ], 'PropertyNameQuery' => [ 'base' => '

Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.

', 'refs' => [ 'SuggestionQuery$PropertyNameQuery' => '

Defines a property name hint. Only property names that begin with the specified hint are included in the response.

', ], ], 'PropertyNameSuggestion' => [ 'base' => '

A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

', 'refs' => [ 'PropertyNameSuggestionList$member' => NULL, ], ], 'PropertyNameSuggestionList' => [ 'base' => NULL, 'refs' => [ 'GetSearchSuggestionsResponse$PropertyNameSuggestions' => '

A list of property names for a Resource that match a SuggestionQuery.

', ], ], 'ProvisionedProductStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisionedProductDetails$ProvisionedProductStatusMessage' => '

The current status of the product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

', ], ], 'ProvisioningParameter' => [ 'base' => '

A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'ProvisioningParameters$member' => NULL, ], ], 'ProvisioningParameterKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Key' => '

The key that identifies a provisioning parameter.

', ], ], 'ProvisioningParameterValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Value' => '

The value of the provisioning parameter.

', ], ], 'ProvisioningParameters' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisioningDetails$ProvisioningParameters' => '

A list of key value pairs that you specify when you provision a product.

', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningParameters' => '

A list of key value pairs that you specify when you provision a product.

', ], ], 'PublicWorkforceTaskPrice' => [ 'base' => '

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

  • 0.012

  • 0.024

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.

  • 2.400

  • 2.280

  • 2.160

  • 2.040

  • 1.920

  • 1.800

  • 1.680

  • 1.560

  • 1.440

  • 1.320

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

', 'refs' => [ 'HumanLoopConfig$PublicWorkforceTaskPrice' => NULL, 'HumanTaskConfig$PublicWorkforceTaskPrice' => '

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

', ], ], 'PutModelPackageGroupPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'PutModelPackageGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'QualityCheckStepMetadata' => [ 'base' => '

Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'PipelineExecutionStepMetadata$QualityCheck' => '

The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted.

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The Boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

', ], ], 'QueryFilters' => [ 'base' => '

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.

', 'refs' => [ 'QueryLineageRequest$Filters' => '

A set of filtering parameters that allow you to specify which entities should be returned.

  • Properties - Key-value pairs to match on the lineage entities\' properties.

  • LineageTypes - A set of lineage entity types to match on. For example: TrialComponent, Artifact, or Context.

  • CreatedBefore - Filter entities created before this date.

  • ModifiedBefore - Filter entities modified before this date.

  • ModifiedAfter - Filter entities modified after this date.

', ], ], 'QueryLineageMaxDepth' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$MaxDepth' => '

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

', ], ], 'QueryLineageMaxResults' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$MaxResults' => '

Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

', ], ], 'QueryLineageRequest' => [ 'base' => NULL, 'refs' => [], ], 'QueryLineageResponse' => [ 'base' => NULL, 'refs' => [], ], 'QueryLineageStartArns' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$StartArns' => '

A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

', ], ], 'QueryLineageTypes' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$LineageTypes' => '

Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.

', ], ], 'QueryProperties' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$Properties' => '

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

', ], ], 'QueryTypes' => [ 'base' => NULL, 'refs' => [ 'QueryFilters$Types' => '

Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.

', ], ], 'RSessionAppSettings' => [ 'base' => '

A collection of settings that apply to an RSessionGateway app.

', 'refs' => [ 'UserSettings$RSessionAppSettings' => '

A collection of settings that configure the RSessionGateway app.

', ], ], 'RStudioServerProAccessStatus' => [ 'base' => NULL, 'refs' => [ 'RStudioServerProAppSettings$AccessStatus' => '

Indicates whether the current user has access to the RStudioServerPro app.

', ], ], 'RStudioServerProAppSettings' => [ 'base' => '

A collection of settings that configure user interaction with the RStudioServerPro app.

', 'refs' => [ 'UserSettings$RStudioServerProAppSettings' => '

A collection of settings that configure user interaction with the RStudioServerPro app.

', ], ], 'RStudioServerProDomainSettings' => [ 'base' => '

A collection of settings that configure the RStudioServerPro Domain-level app.

', 'refs' => [ 'DomainSettings$RStudioServerProDomainSettings' => '

A collection of settings that configure the RStudioServerPro Domain-level app.

', ], ], 'RStudioServerProDomainSettingsForUpdate' => [ 'base' => '

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

', 'refs' => [ 'DomainSettingsForUpdate$RStudioServerProDomainSettingsForUpdate' => '

A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

', ], ], 'RStudioServerProUserGroup' => [ 'base' => NULL, 'refs' => [ 'RStudioServerProAppSettings$UserGroup' => '

The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.

', ], ], 'RandomSeed' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobConfig$RandomSeed' => '

A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.

', ], ], 'RealTimeInferenceConfig' => [ 'base' => '

The infrastructure configuration for deploying the model to a real-time inference endpoint.

', 'refs' => [ 'ModelInfrastructureConfig$RealTimeInferenceConfig' => '

The infrastructure configuration for deploying the model to real-time inference.

', ], ], 'RealTimeInferenceRecommendation' => [ 'base' => '

The recommended configuration to use for Real-Time Inference.

', 'refs' => [ 'RealTimeInferenceRecommendations$member' => NULL, ], ], 'RealTimeInferenceRecommendations' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RealTimeInferenceRecommendations' => '

A list of RealTimeInferenceRecommendation items.

', ], ], 'RealtimeInferenceInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedRealtimeInferenceInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

', 'InferenceSpecification$SupportedRealtimeInferenceInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

', ], ], 'RecommendationFailureReason' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobInferenceBenchmark$FailureReason' => '

The reason why a benchmark failed.

', ], ], 'RecommendationJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the recommendation job.

', 'DescribeInferenceRecommendationsJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'InferenceRecommendationsJob$JobArn' => '

The Amazon Resource Name (ARN) of the recommendation job.

', ], ], 'RecommendationJobCompilationJobName' => [ 'base' => NULL, 'refs' => [ 'ModelConfiguration$CompilationJobName' => '

The name of the compilation job used to create the recommended model artifacts.

', ], ], 'RecommendationJobCompiledOutputConfig' => [ 'base' => '

Provides information about the output configuration for the compiled model.

', 'refs' => [ 'RecommendationJobOutputConfig$CompiledOutputConfig' => '

Provides information about the output configuration for the compiled model.

', ], ], 'RecommendationJobContainerConfig' => [ 'base' => '

Specifies mandatory fields for running an Inference Recommender job directly in the CreateInferenceRecommendationsJob API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use ContainerConfig if you want to specify these fields for the recommendation job but don\'t want to edit them in your model package.

', 'refs' => [ 'RecommendationJobInputConfig$ContainerConfig' => '

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

', ], ], 'RecommendationJobDataInputConfig' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$DataInputConfig' => '

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.

', ], ], 'RecommendationJobDescription' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobDescription' => '

Description of the recommendation job.

', 'DescribeInferenceRecommendationsJobResponse$JobDescription' => '

The job description that you provided when you initiated the job.

', 'InferenceRecommendationsJob$JobDescription' => '

The job description.

', ], ], 'RecommendationJobFrameworkVersion' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$FrameworkVersion' => '

The framework version of the container image.

', ], ], 'RecommendationJobInferenceBenchmark' => [ 'base' => '

The details for a specific benchmark from an Inference Recommender job.

', 'refs' => [ 'InferenceRecommendationsJobStep$InferenceBenchmark' => '

The details for a specific benchmark.

', ], ], 'RecommendationJobInputConfig' => [ 'base' => '

The input configuration of the recommendation job.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$InputConfig' => '

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

', 'DescribeInferenceRecommendationsJobResponse$InputConfig' => '

Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

', ], ], 'RecommendationJobName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobName' => '

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

', 'DescribeInferenceRecommendationsJobRequest$JobName' => '

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'DescribeInferenceRecommendationsJobResponse$JobName' => '

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

', 'GetScalingConfigurationRecommendationRequest$InferenceRecommendationsJobName' => '

The name of a previously completed Inference Recommender job.

', 'GetScalingConfigurationRecommendationResponse$InferenceRecommendationsJobName' => '

The name of a previously completed Inference Recommender job.

', 'InferenceRecommendationsJob$JobName' => '

The name of the job.

', 'InferenceRecommendationsJobStep$JobName' => '

The name of the Inference Recommender job.

', 'ListInferenceRecommendationsJobStepsRequest$JobName' => '

The name for the Inference Recommender job.

', 'StopInferenceRecommendationsJobRequest$JobName' => '

The name of the job you want to stop.

', ], ], 'RecommendationJobOutputConfig' => [ 'base' => '

Provides information about the output configuration for the compiled model.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$OutputConfig' => '

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

', ], ], 'RecommendationJobPayloadConfig' => [ 'base' => '

The configuration for the payload for a recommendation job.

', 'refs' => [ 'RecommendationJobContainerConfig$PayloadConfig' => '

Specifies the SamplePayloadUrl and all other sample payload-related fields.

', ], ], 'RecommendationJobResourceLimit' => [ 'base' => '

Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.

', 'refs' => [ 'RecommendationJobInputConfig$ResourceLimit' => '

Defines the resource limit of the job.

', ], ], 'RecommendationJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeInferenceRecommendationsJobResponse$Status' => '

The status of the job.

', 'InferenceRecommendationsJob$Status' => '

The status of the job.

', 'InferenceRecommendationsJobStep$Status' => '

The current status of the benchmark.

', 'ListInferenceRecommendationsJobStepsRequest$Status' => '

A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

', 'ListInferenceRecommendationsJobsRequest$StatusEquals' => '

A filter that retrieves only inference recommendations jobs with a specific status.

', ], ], 'RecommendationJobStoppingConditions' => [ 'base' => '

Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.

', 'refs' => [ 'CreateInferenceRecommendationsJobRequest$StoppingConditions' => '

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

', 'DescribeInferenceRecommendationsJobResponse$StoppingConditions' => '

The stopping conditions that you provided when you initiated the job.

', ], ], 'RecommendationJobSupportedContentType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobSupportedContentTypes$member' => NULL, ], ], 'RecommendationJobSupportedContentTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobPayloadConfig$SupportedContentTypes' => '

The supported MIME types for the input data.

', ], ], 'RecommendationJobSupportedEndpointType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedEndpointType' => '

The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.

', ], ], 'RecommendationJobSupportedInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedInstanceTypes' => '

A list of the instance types that are used to generate inferences in real-time.

', ], ], 'RecommendationJobSupportedResponseMIMEType' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobSupportedResponseMIMETypes$member' => NULL, ], ], 'RecommendationJobSupportedResponseMIMETypes' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobContainerConfig$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', ], ], 'RecommendationJobType' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceRecommendationsJobRequest$JobType' => '

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

', 'DescribeInferenceRecommendationsJobResponse$JobType' => '

The job type that you provided when you initiated the job.

', 'InferenceRecommendationsJob$JobType' => '

The recommendation job type.

', ], ], 'RecommendationJobVpcConfig' => [ 'base' => '

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

', 'refs' => [ 'RecommendationJobInputConfig$VpcConfig' => '

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

', ], ], 'RecommendationJobVpcSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcSecurityGroupIds$member' => NULL, ], ], 'RecommendationJobVpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcConfig$SecurityGroupIds' => '

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'RecommendationJobVpcSubnetId' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcSubnets$member' => NULL, ], ], 'RecommendationJobVpcSubnets' => [ 'base' => NULL, 'refs' => [ 'RecommendationJobVpcConfig$Subnets' => '

The ID of the subnets in the VPC to which you want to connect your model.

', ], ], 'RecommendationMetrics' => [ 'base' => '

The metrics of recommendations.

', 'refs' => [ 'InferenceRecommendation$Metrics' => '

The metrics used to decide what recommendation to make.

', 'RecommendationJobInferenceBenchmark$Metrics' => NULL, ], ], 'RecommendationStatus' => [ 'base' => NULL, 'refs' => [ 'DeploymentRecommendation$RecommendationStatus' => '

Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.

', ], ], 'RecommendationStepType' => [ 'base' => NULL, 'refs' => [ 'InferenceRecommendationsJobStep$StepType' => '

The type of the subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

', 'ListInferenceRecommendationsJobStepsRequest$StepType' => '

A filter to return details about the specified type of subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

', ], ], 'RecordWrapper' => [ 'base' => NULL, 'refs' => [ 'Channel$RecordWrapperType' => '

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don\'t need to set this attribute. For more information, see Create a Dataset Using RecordIO.

In File mode, leave this field unset or set it to None.

', ], ], 'RedshiftClusterId' => [ 'base' => '

The Redshift cluster Identifier.

', 'refs' => [ 'RedshiftDatasetDefinition$ClusterId' => NULL, ], ], 'RedshiftDatabase' => [ 'base' => '

The name of the Redshift database used in Redshift query execution.

', 'refs' => [ 'RedshiftDatasetDefinition$Database' => NULL, ], ], 'RedshiftDatasetDefinition' => [ 'base' => '

Configuration for Redshift Dataset Definition input.

', 'refs' => [ 'DatasetDefinition$RedshiftDatasetDefinition' => NULL, ], ], 'RedshiftQueryString' => [ 'base' => '

The SQL query statements to be executed.

', 'refs' => [ 'RedshiftDatasetDefinition$QueryString' => NULL, ], ], 'RedshiftResultCompressionType' => [ 'base' => '

The compression used for Redshift query results.

', 'refs' => [ 'RedshiftDatasetDefinition$OutputCompression' => NULL, ], ], 'RedshiftResultFormat' => [ 'base' => '

The data storage format for Redshift query results.

', 'refs' => [ 'RedshiftDatasetDefinition$OutputFormat' => NULL, ], ], 'RedshiftUserName' => [ 'base' => '

The database user name used in Redshift query execution.

', 'refs' => [ 'RedshiftDatasetDefinition$DbUser' => NULL, ], ], 'RegisterDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterModelStepMetadata' => [ 'base' => '

Metadata for a register model job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$RegisterModel' => '

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

', ], ], 'ReleaseNotes' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$ReleaseNotes' => '

The maintainer description of the image version.

', 'DescribeImageVersionResponse$ReleaseNotes' => '

The maintainer description of the image version.

', 'UpdateImageVersionRequest$ReleaseNotes' => '

The maintainer description of the image version.

', ], ], 'RemoteDebugConfig' => [ 'base' => '

Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'refs' => [ 'CreateTrainingJobRequest$RemoteDebugConfig' => '

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'DescribeTrainingJobResponse$RemoteDebugConfig' => '

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', ], ], 'RemoteDebugConfigForUpdate' => [ 'base' => '

Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', 'refs' => [ 'UpdateTrainingJobRequest$RemoteDebugConfig' => '

Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the SecondaryStatus of the job is Downloading or Training.To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

', ], ], 'RenderUiTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RenderUiTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenderableTask' => [ 'base' => '

Contains input values for a task.

', 'refs' => [ 'RenderUiTemplateRequest$Task' => '

A RenderableTask object containing a representative task to render.

', ], ], 'RenderingError' => [ 'base' => '

A description of an error that occurred while rendering the template.

', 'refs' => [ 'RenderingErrorList$member' => NULL, ], ], 'RenderingErrorList' => [ 'base' => NULL, 'refs' => [ 'RenderUiTemplateResponse$Errors' => '

A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

', ], ], 'RepositoryAccessMode' => [ 'base' => NULL, 'refs' => [ 'ImageConfig$RepositoryAccessMode' => '

Set this to one of the following values:

  • Platform - The model image is hosted in Amazon ECR.

  • Vpc - The model image is hosted in a private Docker registry in your VPC.

', ], ], 'RepositoryAuthConfig' => [ 'base' => '

Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field of the ImageConfig object that you passed to a call to CreateModel and the private Docker registry where the model image is hosted requires authentication.

', 'refs' => [ 'ImageConfig$RepositoryAuthConfig' => '

(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication.

', ], ], 'RepositoryCredentialsProviderArn' => [ 'base' => NULL, 'refs' => [ 'RepositoryAuthConfig$RepositoryCredentialsProviderArn' => '

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an Amazon Web Services Lambda function, see Create a Lambda function with the console in the Amazon Web Services Lambda Developer Guide.

', ], ], 'RepositoryUrl' => [ 'base' => NULL, 'refs' => [ 'CodeRepository$RepositoryUrl' => '

The URL of the Git repository.

', ], ], 'ResolvedAttributes' => [ 'base' => '

The resolved attributes.

', 'refs' => [ 'DescribeAutoMLJobResponse$ResolvedAttributes' => '

Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource that you want to tag.

', 'DeleteTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource whose tags you want to delete.

', 'ListTagsInput$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

', ], ], 'ResourceCatalog' => [ 'base' => '

A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.

', 'refs' => [ 'ResourceCatalogList$member' => NULL, ], ], 'ResourceCatalogArn' => [ 'base' => NULL, 'refs' => [ 'ResourceCatalog$ResourceCatalogArn' => '

The Amazon Resource Name (ARN) of the ResourceCatalog.

', ], ], 'ResourceCatalogDescription' => [ 'base' => NULL, 'refs' => [ 'ResourceCatalog$Description' => '

A free form description of the ResourceCatalog.

', ], ], 'ResourceCatalogList' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsResponse$ResourceCatalogs' => '

A list of the requested ResourceCatalogs.

', ], ], 'ResourceCatalogName' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$NameContains' => '

A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.

', 'ResourceCatalog$ResourceCatalogName' => '

The name of the ResourceCatalog.

', ], ], 'ResourceCatalogSortBy' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$SortBy' => '

The value on which the resource catalog list is sorted.

', ], ], 'ResourceCatalogSortOrder' => [ 'base' => NULL, 'refs' => [ 'ListResourceCatalogsRequest$SortOrder' => '

The order in which the resource catalogs are listed.

', ], ], 'ResourceConfig' => [ 'base' => '

Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.

', 'refs' => [ 'CreateTrainingJobRequest$ResourceConfig' => '

The resources, including the ML compute instances and ML storage volumes, to use for model training.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

', 'DescribeTrainingJobResponse$ResourceConfig' => '

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

', 'HyperParameterTrainingJobDefinition$ResourceConfig' => '

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

', 'TrainingJob$ResourceConfig' => '

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

', 'TrainingJobDefinition$ResourceConfig' => '

The resources, including the ML compute instances and ML storage volumes, to use for model training.

', ], ], 'ResourceConfigForUpdate' => [ 'base' => '

The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.

', 'refs' => [ 'UpdateTrainingJobRequest$ResourceConfig' => '

The training job ResourceConfig to update warm pool retention length.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$HomeEfsFileSystemId' => '

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

', ], ], 'ResourceInUse' => [ 'base' => '

Resource being accessed is in use.

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

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

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

Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.

', 'refs' => [ 'HyperParameterTuningJobConfig$ResourceLimits' => '

The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.

', 'HyperParameterTuningJobSummary$ResourceLimits' => '

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

', ], ], 'ResourceNotFound' => [ 'base' => '

Resource being access is not found.

', 'refs' => [], ], 'ResourcePolicyString' => [ 'base' => NULL, 'refs' => [ 'GetLineageGroupPolicyResponse$ResourcePolicy' => '

The resource policy that gives access to the lineage group in another account.

', ], ], 'ResourcePropertyName' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => '

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

', 'NestedFilters$NestedPropertyName' => '

The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.

', 'PropertyNameSuggestion$PropertyName' => '

A suggested property name based on what you entered in the search textbox in the SageMaker console.

', 'SearchRequest$SortBy' => '

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

', ], ], 'ResourceRetainedBillableTimeInSeconds' => [ 'base' => 'Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after resource reaches ResourceReused or ResourceReleased state.', 'refs' => [ 'WarmPoolStatus$ResourceRetainedBillableTimeInSeconds' => '

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

', ], ], 'ResourceSpec' => [ 'base' => '

Specifies the ARN\'s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

', 'refs' => [ 'AppDetails$ResourceSpec' => NULL, 'CodeEditorAppSettings$DefaultResourceSpec' => NULL, 'CreateAppRequest$ResourceSpec' => '

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

', 'DescribeAppResponse$ResourceSpec' => '

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

', 'JupyterLabAppSettings$DefaultResourceSpec' => NULL, 'JupyterServerAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

', 'KernelGatewayAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

', 'RSessionAppSettings$DefaultResourceSpec' => NULL, 'RStudioServerProDomainSettings$DefaultResourceSpec' => NULL, 'RStudioServerProDomainSettingsForUpdate$DefaultResourceSpec' => NULL, 'SpaceCodeEditorAppSettings$DefaultResourceSpec' => NULL, 'SpaceJupyterLabAppSettings$DefaultResourceSpec' => NULL, 'TensorBoardAppSettings$DefaultResourceSpec' => '

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'GetSearchSuggestionsRequest$Resource' => '

The name of the SageMaker resource to search for.

', 'SearchRequest$Resource' => '

The name of the SageMaker resource to search for.

', ], ], 'ResponseMIMEType' => [ 'base' => NULL, 'refs' => [ 'ResponseMIMETypes$member' => NULL, ], ], 'ResponseMIMETypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', 'InferenceSpecification$SupportedResponseMIMETypes' => '

The supported MIME types for the output data.

', ], ], 'RetentionPolicy' => [ 'base' => '

The retention policy for data stored on an Amazon Elastic File System (EFS) volume.

', 'refs' => [ 'DeleteDomainRequest$RetentionPolicy' => '

The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).

', ], ], 'RetentionType' => [ 'base' => NULL, 'refs' => [ 'RetentionPolicy$HomeEfsFileSystem' => '

The default is Retain, which specifies to keep the data stored on the EFS volume.

Specify Delete to delete the data stored on the EFS volume.

', ], ], 'RetryPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RetryPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetryStrategy' => [ 'base' => '

The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.

', 'refs' => [ 'CreateTrainingJobRequest$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'DescribeTrainingJobResponse$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'HyperParameterTrainingJobDefinition$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', 'TrainingJob$RetryStrategy' => '

The number of times to retry the job when the job fails due to an InternalServerError.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'AlgorithmValidationSpecification$ValidationRole' => '

The IAM roles that SageMaker uses to run the training jobs.

', 'ClusterInstanceGroupDetails$ExecutionRole' => '

The execution role for the instance group to assume.

', 'ClusterInstanceGroupSpecification$ExecutionRole' => '

Specifies an IAM execution role to be assumed by the instance group.

', 'CreateAutoMLJobRequest$RoleArn' => '

The ARN of the role that is used to access the data.

', 'CreateAutoMLJobV2Request$RoleArn' => '

The ARN of the role that is used to access the data.

', 'CreateCompilationJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model compilation, Amazon SageMaker needs your permission to:

  • Read input data from an S3 bucket

  • Write model artifacts to an S3 bucket

  • Write logs to Amazon CloudWatch Logs

  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

', 'CreateDataQualityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateDeviceFleetRequest$RoleArn' => '

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

', 'CreateEdgePackagingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.

', 'CreateEndpointConfigInput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this action must have the iam:PassRole permission.

', 'CreateFeatureGroupRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

', 'CreateFlowDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

', 'CreateImageRequest$RoleArn' => '

The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'CreateInferenceExperimentRequest$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'CreateInferenceRecommendationsJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'CreateLabelingJobRequest$RoleArn' => '

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

', 'CreateModelBiasJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateModelExplainabilityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateModelInput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'CreateModelQualityJobDefinitionRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateNotebookInstanceInput$RoleArn' => '

When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'CreatePipelineRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

', 'CreateProcessingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'CreateTrainingJobRequest$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.

During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'DefaultSpaceSettings$ExecutionRole' => '

The ARN of the execution role for the space.

', 'DescribeAutoMLJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeAutoMLJobV2Response$RoleArn' => '

The ARN of the Identity and Access Management role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeCompilationJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

', 'DescribeDataQualityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeDeviceFleetResponse$RoleArn' => '

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

', 'DescribeEdgePackagingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

', 'DescribeEndpointConfigOutput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.

', 'DescribeFeatureGroupResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

', 'DescribeFlowDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

', 'DescribeImageResponse$RoleArn' => '

The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'DescribeInferenceExperimentResponse$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'DescribeInferenceRecommendationsJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

', 'DescribeLabelingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.

', 'DescribeModelBiasJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeModelExplainabilityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

', 'DescribeModelOutput$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

', 'DescribeModelQualityJobDefinitionResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeNotebookInstanceOutput$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

', 'DescribePipelineResponse$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline uses to execute.

', 'DescribeProcessingJobResponse$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'DescribeTrainingJobResponse$RoleArn' => '

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

', 'FeatureGroup$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

', 'HyperParameterTrainingJobDefinition$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

', 'InferenceExperimentSummary$RoleArn' => '

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

', 'InferenceRecommendationsJob$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'Model$ExecutionRoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

', 'ModelPackageValidationSpecification$ValidationRole' => '

The IAM roles to be used for the validation of the model package.

', 'ModelRegisterSettings$CrossAccountModelRegisterRoleArn' => '

The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

', 'MonitoringJobDefinition$RoleArn' => '

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

', 'Pipeline$RoleArn' => '

The Amazon Resource Name (ARN) of the role that created the pipeline.

', 'PipelineSummary$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline used to execute.

', 'ProcessingJob$RoleArn' => '

The ARN of the role used to create the processing job.

', 'RStudioServerProDomainSettings$DomainExecutionRoleArn' => '

The ARN of the execution role for the RStudioServerPro Domain-level app.

', 'RStudioServerProDomainSettingsForUpdate$DomainExecutionRoleArn' => '

The execution role for the RStudioServerPro Domain-level app.

', 'RedshiftDatasetDefinition$ClusterRoleArn' => '

The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

', 'RenderUiTemplateRequest$RoleArn' => '

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

', 'TimeSeriesForecastingSettings$AmazonForecastRoleArn' => '

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

', 'TrainingJob$RoleArn' => '

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

', 'UpdateDeviceFleetRequest$RoleArn' => '

The Amazon Resource Name (ARN) of the device.

', 'UpdateImageRequest$RoleArn' => '

The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

', 'UpdateNotebookInstanceInput$RoleArn' => '

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

', 'UpdatePipelineRequest$RoleArn' => '

The Amazon Resource Name (ARN) that the pipeline uses to execute.

', 'UserSettings$ExecutionRole' => '

The execution role for the user.

', ], ], 'RollingUpdatePolicy' => [ 'base' => '

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

', 'refs' => [ 'DeploymentConfig$RollingUpdatePolicy' => '

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

', ], ], 'RootAccess' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

', 'DescribeNotebookInstanceOutput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

', 'UpdateNotebookInstanceInput$RootAccess' => '

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don\'t have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

', ], ], 'RoutingStrategy' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantRoutingConfig$RoutingStrategy' => '

Sets how the endpoint routes incoming traffic:

  • LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the specific instances that have more capacity to process them.

  • RANDOM: The endpoint routes each request to a randomly chosen instance.

', ], ], 'RuleConfigurationName' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$RuleConfigurationName' => '

The name of the rule configuration. It must be unique relative to other rule configuration names.

', 'DebugRuleEvaluationStatus$RuleConfigurationName' => '

The name of the rule configuration.

', 'ProfilerRuleConfiguration$RuleConfigurationName' => '

The name of the rule configuration. It must be unique relative to other rule configuration names.

', 'ProfilerRuleEvaluationStatus$RuleConfigurationName' => '

The name of the rule configuration.

', ], ], 'RuleEvaluationStatus' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$RuleEvaluationStatus' => '

Status of the rule evaluation.

', 'ProfilerRuleEvaluationStatus$RuleEvaluationStatus' => '

Status of the rule evaluation.

', ], ], 'RuleParameters' => [ 'base' => NULL, 'refs' => [ 'DebugRuleConfiguration$RuleParameters' => '

Runtime configuration for rule container.

', 'ProfilerRuleConfiguration$RuleParameters' => '

Runtime configuration for rule container.

', ], ], 'S3DataDistribution' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataDistributionType' => '

If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

If you want SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

Don\'t choose more ML compute instances for training than available S3 objects. If you do, some nodes won\'t get any data and you will pay for nodes that aren\'t getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

', ], ], 'S3DataSource' => [ 'base' => '

Describes the S3 data source.

Your input bucket must be in the same Amazon Web Services region as your training job.

', 'refs' => [ 'DataSource$S3DataSource' => '

The S3 location of the data source that is associated with a channel.

', ], ], 'S3DataType' => [ 'base' => NULL, 'refs' => [ 'S3DataSource$S3DataType' => '

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel\'s input mode is Pipe.

', 'TransformS3DataSource$S3DataType' => '

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

', ], ], 'S3ModelDataSource' => [ 'base' => '

Specifies the S3 location of ML model data to deploy.

', 'refs' => [ 'ModelDataSource$S3DataSource' => '

Specifies the S3 location of ML model data to deploy.

', ], ], 'S3ModelDataType' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$S3DataType' => '

Specifies the type of ML model data to deploy.

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/).

If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy.

', ], ], 'S3ModelUri' => [ 'base' => NULL, 'refs' => [ 'S3ModelDataSource$S3Uri' => '

Specifies the S3 path of ML model data to deploy.

', ], ], 'S3OutputPath' => [ 'base' => NULL, 'refs' => [ 'HubS3StorageConfig$S3OutputPath' => '

The Amazon S3 bucket prefix for hosting hub content.

', ], ], 'S3StorageConfig' => [ 'base' => '

The Amazon Simple Storage (Amazon S3) location and and security configuration for OfflineStore.

', 'refs' => [ 'OfflineStoreConfig$S3StorageConfig' => '

The Amazon Simple Storage (Amazon S3) location of OfflineStore.

', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'AdditionalS3DataSource$S3Uri' => '

The uniform resource identifier (URI) used to identify an additional data source used in inference or training.

', 'AthenaDatasetDefinition$OutputS3Uri' => '

The location in Amazon S3 where Athena query results are stored.

', 'AutoMLCandidateGenerationConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

', 'AutoMLOutputDataConfig$S3OutputPath' => '

The Amazon S3 output path. Must be 128 characters or less.

', 'AutoMLS3DataSource$S3Uri' => '

The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.

', 'BatchDataCaptureConfig$DestinationS3Uri' => '

The Amazon S3 location being used to capture the data.

', 'CheckpointConfig$S3Uri' => '

Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

', 'ClusterLifeCycleConfig$SourceS3Uri' => '

An Amazon S3 bucket path where your LifeCycle scripts are stored.

', 'CreateLabelingJobRequest$LabelCategoryConfigS3Uri' => '

The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.

For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

For named entity recognition jobs, in addition to "labels", you must provide worker instructions in the label category configuration file using the "instructions" parameter: "instructions": {"shortInstruction":"<h1>Add header</h1><p>Add Instructions</p>", "fullInstruction":"<p>Add additional instructions.</p>"}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .

For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.

{

"document-version": "2018-11-28",

"labels": [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]

}

Note the following about the label category configuration file:

  • For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.

  • Each label category must be unique, you cannot specify duplicate label categories.

  • If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include auditLabelAttributeName in the label category configuration. Use this parameter to enter the LabelAttributeName of the labeling job you want to adjust or verify annotations of.

', 'CreateModelPackageInput$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.

', 'DataQualityAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'DataQualityAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'DebugHookConfig$S3OutputPath' => '

Path to Amazon S3 storage location for metrics and tensors.

', 'DebugRuleConfiguration$S3OutputPath' => '

Path to Amazon S3 storage location for rules.

', 'DescribeEdgePackagingJobResponse$ModelArtifact' => '

The Amazon Simple Storage (S3) URI where model artifacts ares stored.

', 'DescribeLabelingJobResponse$LabelCategoryConfigS3Uri' => '

The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

  • Semantic segmentation labeling jobs using automated labeling: 20 labels

  • Box bounding labeling jobs (all): 10 labels

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

', 'EdgeOutputConfig$S3OutputLocation' => '

The Amazon Simple Storage (S3) bucker URI.

', 'FileSource$S3Uri' => '

The Amazon S3 URI for the file source.

', 'FlowDefinitionOutputConfig$S3OutputPath' => '

The Amazon S3 path where the object containing human output will be made available.

To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.

', 'InferenceRecommendationsJob$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'InputConfig$S3Uri' => '

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'LabelingJobOutput$OutputDatasetS3Uri' => '

The Amazon S3 bucket location of the manifest file for labeled data.

', 'LabelingJobOutputConfig$S3OutputPath' => '

The Amazon S3 location to write output data.

', 'LabelingJobS3DataSource$ManifestS3Uri' => '

The Amazon S3 location of the manifest file that describes the input data objects.

The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:

  • source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.

  • source: The source of the object is the value. Use this value when the object is a text value.

If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.

', 'MetricsSource$S3Uri' => '

The S3 URI for the metrics source.

', 'ModelArtifacts$S3ModelArtifacts' => '

The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

', 'ModelBiasAppSpecification$ConfigUri' => '

JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.

', 'ModelCardExportArtifacts$S3ExportArtifacts' => '

The Amazon S3 URI of the exported model artifacts.

', 'ModelCardExportOutputConfig$S3OutputPath' => '

The Amazon S3 output path to export your model card PDF.

', 'ModelExplainabilityAppSpecification$ConfigUri' => '

JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.

', 'ModelQualityAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'ModelQualityAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'MonitoringAppSpecification$RecordPreprocessorSourceUri' => '

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

', 'MonitoringAppSpecification$PostAnalyticsProcessorSourceUri' => '

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

', 'MonitoringConstraintsResource$S3Uri' => '

The Amazon S3 URI for the constraints resource.

', 'MonitoringStatisticsResource$S3Uri' => '

The Amazon S3 URI for the statistics resource.

', 'OutputConfig$S3OutputLocation' => '

Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

', 'OutputDataConfig$S3OutputPath' => '

Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

', 'ProcessingS3Input$S3Uri' => '

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

', 'ProcessingS3Output$S3Uri' => '

A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

', 'ProfilerConfig$S3OutputPath' => '

Path to Amazon S3 storage location for system and framework metrics.

', 'ProfilerConfigForUpdate$S3OutputPath' => '

Path to Amazon S3 storage location for system and framework metrics.

', 'ProfilerRuleConfiguration$S3OutputPath' => '

Path to Amazon S3 storage location for rules.

', 'RecommendationJobCompiledOutputConfig$S3OutputUri' => '

Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.

', 'RecommendationJobPayloadConfig$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'RedshiftDatasetDefinition$OutputS3Uri' => '

The location in Amazon S3 where the Redshift query results are stored.

', 'S3DataSource$S3Uri' => '

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix

  • A manifest might look like this: s3://bucketname/example.manifest

    A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.

    The following code example shows a valid manifest format:

    [ {"prefix": "s3://customer_bucket/some/prefix/"},

    "relative/path/to/custdata-1",

    "relative/path/custdata-2",

    ...

    "relative/path/custdata-N"

    ]

    This JSON is equivalent to the following S3Uri list:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.

Your input bucket must be located in same Amazon Web Services region as your training job.

', 'S3StorageConfig$S3Uri' => '

The S3 URI, or location in Amazon S3, of OfflineStore.

S3 URIs have a format similar to the following: s3://example-bucket/prefix/.

', 'S3StorageConfig$ResolvedOutputS3Uri' => '

The S3 path where offline records are written.

', 'SharingSettings$S3OutputPath' => '

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

', 'TabularJobConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job V2. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

', 'TensorBoardOutputConfig$S3OutputPath' => '

Path to Amazon S3 storage location for TensorBoard output.

', 'TimeSeriesForecastingJobConfig$FeatureSpecificationS3Uri' => '

A URL to the Amazon S3 data source containing additional selected features that complement the target, itemID, timestamp, and grouped columns set in TimeSeriesConfig. When not provided, the AutoML job V2 includes all the columns from the original dataset that are not already declared in TimeSeriesConfig. If provided, the AutoML job V2 only considers these additional columns as a complement to the ones declared in TimeSeriesConfig.

You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

Autopilot supports the following data types: numeric, categorical, text, and datetime.

These column keys must not include any column set in TimeSeriesConfig.

', 'TransformOutput$S3OutputPath' => '

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn\'t upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

', 'TransformS3DataSource$S3Uri' => '

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix.

  • A manifest might look like this: s3://bucketname/example.manifest

    The manifest is an S3 object which is a JSON file with the following format:

    [ {"prefix": "s3://customer_bucket/some/prefix/"},

    "relative/path/to/custdata-1",

    "relative/path/custdata-2",

    ...

    "relative/path/custdata-N"

    ]

    The preceding JSON matches the following S3Uris:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

', 'UiConfig$UiTemplateS3Uri' => '

The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

', 'WorkspaceSettings$S3ArtifactPath' => '

The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

', ], ], 'SageMakerImageVersionAlias' => [ 'base' => NULL, 'refs' => [ 'DeleteImageVersionRequest$Alias' => '

The alias of the image to delete.

', 'DescribeImageVersionRequest$Alias' => '

The alias of the image version.

', 'ListAliasesRequest$Alias' => '

The alias of the image version.

', 'SageMakerImageVersionAliases$member' => NULL, 'UpdateImageVersionRequest$Alias' => '

The alias of the image version.

', ], ], 'SageMakerImageVersionAliases' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$Aliases' => '

A list of aliases created with the image version.

', 'ListAliasesResponse$SageMakerImageVersionAliases' => '

A list of SageMaker image version aliases.

', 'UpdateImageVersionRequest$AliasesToAdd' => '

A list of aliases to add.

', 'UpdateImageVersionRequest$AliasesToDelete' => '

A list of aliases to delete.

', ], ], 'SagemakerServicecatalogStatus' => [ 'base' => NULL, 'refs' => [ 'GetSagemakerServicecatalogPortfolioStatusOutput$Status' => '

Whether Service Catalog is enabled or disabled in SageMaker.

', ], ], 'SampleWeightAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$SampleWeightAttributeName' => '

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

', 'TabularJobConfig$SampleWeightAttributeName' => '

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

', ], ], 'SamplingPercentage' => [ 'base' => NULL, 'refs' => [ 'DataCaptureConfig$InitialSamplingPercentage' => '

The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.

', 'DataCaptureConfigSummary$CurrentSamplingPercentage' => '

The percentage of requests being captured by your Endpoint.

', ], ], 'ScalingPolicies' => [ 'base' => NULL, 'refs' => [ 'DynamicScalingConfiguration$ScalingPolicies' => '

An object of the scaling policies for each metric.

', ], ], 'ScalingPolicy' => [ 'base' => '

An object containing a recommended scaling policy.

', 'refs' => [ 'ScalingPolicies$member' => NULL, ], ], 'ScalingPolicyMetric' => [ 'base' => '

The metric for a scaling policy.

', 'refs' => [ 'GetScalingConfigurationRecommendationResponse$Metric' => '

An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.

', ], ], 'ScalingPolicyObjective' => [ 'base' => '

An object where you specify the anticipated traffic pattern for an endpoint.

', 'refs' => [ 'GetScalingConfigurationRecommendationRequest$ScalingPolicyObjective' => '

An object where you specify the anticipated traffic pattern for an endpoint.

', 'GetScalingConfigurationRecommendationResponse$ScalingPolicyObjective' => '

An object representing the anticipated traffic pattern for an endpoint that you specified in the request.

', ], ], 'ScheduleConfig' => [ 'base' => '

Configuration details about the monitoring schedule.

', 'refs' => [ 'MonitoringScheduleConfig$ScheduleConfig' => '

Configures the monitoring schedule.

', ], ], 'ScheduleExpression' => [ 'base' => NULL, 'refs' => [ 'ScheduleConfig$ScheduleExpression' => '

A cron expression that describes details about the monitoring schedule.

The supported cron expressions are:

  • If you want to set the job to start every hour, use the following:

    Hourly: cron(0 * ? * * *)

  • If you want to start the job daily:

    cron(0 [00-23] ? * * *)

  • If you want to run the job one time, immediately, use the following keyword:

    NOW

For example, the following are valid cron expressions:

  • Daily at noon UTC: cron(0 12 ? * * *)

  • Daily at midnight UTC: cron(0 0 ? * * *)

To support running every 6, 12 hours, the following are also supported:

cron(0 [00-23]/[01-24] ? * * *)

For example, the following are valid cron expressions:

  • Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)

  • Every two hours starting at midnight: cron(0 0/2 ? * * *)

  • Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.

  • We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will pick a time for running every day.

You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.

', ], ], 'ScheduleStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeMonitoringScheduleResponse$MonitoringScheduleStatus' => '

The status of an monitoring job.

', 'ListMonitoringSchedulesRequest$StatusEquals' => '

A filter that returns only monitoring schedules modified before a specified time.

', 'ModelDashboardMonitoringSchedule$MonitoringScheduleStatus' => '

The status of the monitoring schedule.

', 'MonitoringSchedule$MonitoringScheduleStatus' => '

The status of the monitoring schedule. This can be one of the following values.

  • PENDING - The schedule is pending being created.

  • FAILED - The schedule failed.

  • SCHEDULED - The schedule was successfully created.

  • STOPPED - The schedule was stopped.

', 'MonitoringScheduleSummary$MonitoringScheduleStatus' => '

The status of the monitoring schedule.

', ], ], 'SearchExpression' => [ 'base' => '

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression\'s condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:

  • A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

  • A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

  • A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

  • A Boolean operator: And or Or.

', 'refs' => [ 'SearchExpressionList$member' => NULL, 'SearchRequest$SearchExpression' => '

A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

', ], ], 'SearchExpressionList' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$SubExpressions' => '

A list of search expression objects.

', ], ], 'SearchRecord' => [ 'base' => '

A single resource returned as part of the Search API response.

', 'refs' => [ 'SearchResultsList$member' => NULL, ], ], 'SearchRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchResultsList' => [ 'base' => NULL, 'refs' => [ 'SearchResponse$Results' => '

A list of SearchRecord objects.

', ], ], 'SearchSortOrder' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$SortOrder' => '

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

', ], ], 'SecondaryStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$SecondaryStatus' => '

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

', 'SecondaryStatusTransition$Status' => '

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

', 'TrainingJob$SecondaryStatus' => '

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

', ], ], 'SecondaryStatusTransition' => [ 'base' => '

An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job\'s secondary status.

', 'refs' => [ 'SecondaryStatusTransitions$member' => NULL, ], ], 'SecondaryStatusTransitions' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$SecondaryStatusTransitions' => '

A history of all of the secondary statuses that the training job has transitioned through.

', 'TrainingJob$SecondaryStatusTransitions' => '

A history of all of the secondary statuses that the training job has transitioned through.

', ], ], 'SecretArn' => [ 'base' => NULL, 'refs' => [ 'GitConfig$SecretArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', 'GitConfigForUpdate$SecretArn' => '

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

', 'IdentityProviderOAuthSetting$SecretArn' => '

The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$SecurityGroupIdForDomainBoundary' => '

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

', 'DomainSecurityGroupIds$member' => NULL, 'SecurityGroupIds$member' => NULL, 'VpcSecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', 'DefaultSpaceSettings$SecurityGroups' => '

The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

', 'DescribeNotebookInstanceOutput$SecurityGroups' => '

The IDs of the VPC security groups.

', 'UserSettings$SecurityGroups' => '

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

', ], ], 'Seed' => [ 'base' => NULL, 'refs' => [ 'ShuffleConfig$Seed' => '

Determines the shuffling order in ShuffleConfig value.

', ], ], 'SelectedStep' => [ 'base' => '

A step selected to run in selective execution mode.

', 'refs' => [ 'SelectedStepList$member' => NULL, ], ], 'SelectedStepList' => [ 'base' => NULL, 'refs' => [ 'SelectiveExecutionConfig$SelectedSteps' => '

A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.

', ], ], 'SelectiveExecutionConfig' => [ 'base' => '

The selective execution configuration applied to the pipeline run.

', 'refs' => [ 'DescribePipelineExecutionResponse$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', 'PipelineExecution$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', 'StartPipelineExecutionRequest$SelectiveExecutionConfig' => '

The selective execution configuration applied to the pipeline run.

', ], ], 'SelectiveExecutionResult' => [ 'base' => '

The ARN from an execution of the current pipeline.

', 'refs' => [ 'PipelineExecutionStep$SelectiveExecutionResult' => '

The ARN from an execution of the current pipeline from which results are reused for this step.

', ], ], 'SendPipelineExecutionStepFailureRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepFailureResponse' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendPipelineExecutionStepSuccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerlessMaxConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MaxConcurrency' => '

The maximum number of concurrent invocations your serverless endpoint can process.

', 'ProductionVariantServerlessUpdateConfig$MaxConcurrency' => '

The updated maximum number of concurrent invocations your serverless endpoint can process.

', ], ], 'ServerlessMemorySizeInMB' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$MemorySizeInMB' => '

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

', ], ], 'ServerlessProvisionedConcurrency' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantServerlessConfig$ProvisionedConcurrency' => '

The amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see CreateInferenceRecommendationsJobs.

', 'ProductionVariantServerlessUpdateConfig$ProvisionedConcurrency' => '

The updated amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

', ], ], 'ServiceCatalogEntityId' => [ 'base' => NULL, 'refs' => [ 'ServiceCatalogProvisionedProductDetails$ProvisionedProductId' => '

The ID of the provisioned product.

', 'ServiceCatalogProvisioningDetails$ProductId' => '

The ID of the product to provision.

', 'ServiceCatalogProvisioningDetails$ProvisioningArtifactId' => '

The ID of the provisioning artifact.

', 'ServiceCatalogProvisioningDetails$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

', 'ServiceCatalogProvisioningUpdateDetails$ProvisioningArtifactId' => '

The ID of the provisioning artifact.

', ], ], 'ServiceCatalogProvisionedProductDetails' => [ 'base' => '

Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'DescribeProjectOutput$ServiceCatalogProvisionedProductDetails' => '

Information about a provisioned service catalog product.

', 'Project$ServiceCatalogProvisionedProductDetails' => NULL, ], ], 'ServiceCatalogProvisioningDetails' => [ 'base' => '

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'CreateProjectInput$ServiceCatalogProvisioningDetails' => '

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don\'t provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

', 'DescribeProjectOutput$ServiceCatalogProvisioningDetails' => '

Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.

', 'Project$ServiceCatalogProvisioningDetails' => NULL, ], ], 'ServiceCatalogProvisioningUpdateDetails' => [ 'base' => '

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

', 'refs' => [ 'UpdateProjectInput$ServiceCatalogProvisioningUpdateDetails' => '

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don\'t provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

', ], ], 'SessionExpirationDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreatePresignedDomainUrlRequest$SessionExpirationDurationInSeconds' => '

The session expiration duration in seconds. This value defaults to 43200.

', 'CreatePresignedNotebookInstanceUrlInput$SessionExpirationDurationInSeconds' => '

The duration of the session, in seconds. The default is 12 hours.

', ], ], 'ShadowModeConfig' => [ 'base' => '

The configuration of ShadowMode inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.

', 'refs' => [ 'CreateInferenceExperimentRequest$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

', 'DescribeInferenceExperimentResponse$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

', 'UpdateInferenceExperimentRequest$ShadowModeConfig' => '

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

', ], ], 'ShadowModelVariantConfig' => [ 'base' => '

The name and sampling percentage of a shadow variant.

', 'refs' => [ 'ShadowModelVariantConfigList$member' => NULL, ], ], 'ShadowModelVariantConfigList' => [ 'base' => NULL, 'refs' => [ 'ShadowModeConfig$ShadowModelVariants' => '

List of shadow variant configurations.

', ], ], 'SharingSettings' => [ 'base' => '

Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn\'t allowed.

', 'refs' => [ 'UserSettings$SharingSettings' => '

Specifies options for sharing Amazon SageMaker Studio notebooks.

', ], ], 'SharingType' => [ 'base' => NULL, 'refs' => [ 'SpaceSharingSettings$SharingType' => '

Specifies the sharing type of the space.

', 'SpaceSharingSettingsSummary$SharingType' => '

Specifies the sharing type of the space.

', ], ], 'ShuffleConfig' => [ 'base' => '

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, when ShuffleConfig is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

', 'refs' => [ 'Channel$ShuffleConfig' => '

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

', ], ], 'SingleSignOnApplicationArn' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainResponse$SingleSignOnApplicationArn' => '

The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.

', ], ], 'SingleSignOnUserIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateUserProfileRequest$SingleSignOnUserIdentifier' => '

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain\'s AuthMode is IAM Identity Center, this field is required. If the Domain\'s AuthMode is not IAM Identity Center, this field cannot be specified.

', 'DescribeUserProfileResponse$SingleSignOnUserIdentifier' => '

The IAM Identity Center user identifier.

', ], ], 'SkipModelValidation' => [ 'base' => NULL, 'refs' => [ 'CreateModelPackageInput$SkipModelValidation' => '

Indicates if you want to skip model validation.

', 'DescribeModelPackageOutput$SkipModelValidation' => '

Indicates if you want to skip model validation.

', 'ModelPackage$SkipModelValidation' => '

Indicates if you want to skip model validation.

', ], ], 'SnsTopicArn' => [ 'base' => NULL, 'refs' => [ 'AsyncInferenceNotificationConfig$SuccessTopic' => '

Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.

', 'AsyncInferenceNotificationConfig$ErrorTopic' => '

Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.

', 'LabelingJobOutputConfig$SnsTopicArn' => '

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

', 'LabelingJobSnsDataSource$SnsTopicArn' => '

The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.

', ], ], 'SortActionsBy' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortArtifactsBy' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortAssociationsBy' => [ 'base' => NULL, 'refs' => [ 'ListAssociationsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortBy' => [ 'base' => NULL, 'refs' => [ 'ListLabelingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListProcessingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListTrainingJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', 'ListTransformJobsRequest$SortBy' => '

The field to sort results by. The default is CreationTime.

', ], ], 'SortContextsBy' => [ 'base' => NULL, 'refs' => [ 'ListContextsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortExperimentsBy' => [ 'base' => NULL, 'refs' => [ 'ListExperimentsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortInferenceExperimentsBy' => [ 'base' => NULL, 'refs' => [ 'ListInferenceExperimentsRequest$SortBy' => '

The column by which to sort the listed inference experiments.

', ], ], 'SortLineageGroupsBy' => [ 'base' => NULL, 'refs' => [ 'ListLineageGroupsRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListActionsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAlgorithmsInput$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListAppImageConfigsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAppsRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListArtifactsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListAssociationsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListClusterNodesRequest$SortOrder' => '

The sort order for results. The default value is Ascending.

', 'ListClustersRequest$SortOrder' => '

The sort order for results. The default value is Ascending.

', 'ListCompilationJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListContextsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListDataQualityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListDeviceFleetsRequest$SortOrder' => '

What direction to sort in.

', 'ListEdgeDeploymentPlansRequest$SortOrder' => '

The direction of the sorting (ascending or descending).

', 'ListEdgePackagingJobsRequest$SortOrder' => '

What direction to sort by.

', 'ListExperimentsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListFlowDefinitionsRequest$SortOrder' => '

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

', 'ListHubContentVersionsRequest$SortOrder' => '

Sort hub content versions by ascending or descending order.

', 'ListHubContentsRequest$SortOrder' => '

Sort hubs by ascending or descending order.

', 'ListHubsRequest$SortOrder' => '

Sort hubs by ascending or descending order.

', 'ListHumanTaskUisRequest$SortOrder' => '

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

', 'ListHyperParameterTuningJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListInferenceExperimentsRequest$SortOrder' => '

The direction of sorting (ascending or descending).

', 'ListInferenceRecommendationsJobsRequest$SortOrder' => '

The sort order for the results.

', 'ListLabelingJobsForWorkteamRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListLabelingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListLineageGroupsRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListModelBiasJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListModelExplainabilityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListModelPackageGroupsInput$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListModelPackagesInput$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListModelQualityJobDefinitionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListMonitoringAlertHistoryRequest$SortOrder' => '

The sort order, whether Ascending or Descending, of the alert history. The default is Descending.

', 'ListMonitoringExecutionsRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListMonitoringSchedulesRequest$SortOrder' => '

Whether to sort the results in Ascending or Descending order. The default is Descending.

', 'ListPipelineExecutionStepsRequest$SortOrder' => '

The field by which to sort results. The default is CreatedTime.

', 'ListPipelineExecutionsRequest$SortOrder' => '

The sort order for results.

', 'ListPipelinesRequest$SortOrder' => '

The sort order for results.

', 'ListProcessingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListSpacesRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListStudioLifecycleConfigsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListTrainingJobsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', 'ListTransformJobsRequest$SortOrder' => '

The sort order for results. The default is Descending.

', 'ListTrialComponentsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListTrialsRequest$SortOrder' => '

The sort order. The default value is Descending.

', 'ListUserProfilesRequest$SortOrder' => '

The sort order for the results. The default is Ascending.

', 'ListWorkforcesRequest$SortOrder' => '

Sort workforces in ascending or descending order.

', 'ListWorkteamsRequest$SortOrder' => '

The sort order for results. The default is Ascending.

', ], ], 'SortPipelineExecutionsBy' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsRequest$SortBy' => '

The field by which to sort results. The default is CreatedTime.

', ], ], 'SortPipelinesBy' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesRequest$SortBy' => '

The field by which to sort results. The default is CreatedTime.

', ], ], 'SortTrialComponentsBy' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SortTrialsBy' => [ 'base' => NULL, 'refs' => [ 'ListTrialsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'SourceAlgorithm' => [ 'base' => '

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

', 'refs' => [ 'SourceAlgorithmList$member' => NULL, ], ], 'SourceAlgorithmList' => [ 'base' => NULL, 'refs' => [ 'SourceAlgorithmSpecification$SourceAlgorithms' => '

A list of the algorithms that were used to create a model package.

', ], ], 'SourceAlgorithmSpecification' => [ 'base' => '

A list of algorithms that were used to create a model package.

', 'refs' => [ 'CreateModelPackageInput$SourceAlgorithmSpecification' => '

Details about the algorithm that was used to create the model package.

', 'DescribeModelPackageOutput$SourceAlgorithmSpecification' => '

Details about the algorithm that was used to create the model package.

', 'ModelPackage$SourceAlgorithmSpecification' => '

A list of algorithms that were used to create a model package.

', ], ], 'SourceIpConfig' => [ 'base' => '

A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an IP address within this range. By default, a workforce isn\'t restricted to specific IP addresses.

', 'refs' => [ 'CreateWorkforceRequest$SourceIpConfig' => NULL, 'UpdateWorkforceRequest$SourceIpConfig' => '

A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Ten CIDR values

', 'Workforce$SourceIpConfig' => '

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn\'t restricted to specific IP addresses.

', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'ExperimentSource$SourceType' => '

The source type.

', 'TrialComponentSource$SourceType' => '

The source job type.

', 'TrialSource$SourceType' => '

The source job type.

', ], ], 'SourceUri' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceUri' => '

The URI of the source.

', 'ArtifactSource$SourceUri' => '

The URI of the source.

', 'ContextSource$SourceUri' => '

The URI of the source.

', 'ListActionsRequest$SourceUri' => '

A filter that returns only actions with the specified source URI.

', 'ListArtifactsRequest$SourceUri' => '

A filter that returns only artifacts with the specified source URI.

', 'ListContextsRequest$SourceUri' => '

A filter that returns only contexts with the specified source URI.

', ], ], 'SpaceArn' => [ 'base' => NULL, 'refs' => [ 'CreateSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', 'DescribeSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', 'UpdateSpaceResponse$SpaceArn' => '

The space\'s Amazon Resource Name (ARN).

', ], ], 'SpaceCodeEditorAppSettings' => [ 'base' => '

The application settings for a Code Editor space.

', 'refs' => [ 'SpaceSettings$CodeEditorAppSettings' => '

The Code Editor application settings.

', ], ], 'SpaceDetails' => [ 'base' => '

The space\'s details.

', 'refs' => [ 'SpaceList$member' => NULL, ], ], 'SpaceEbsVolumeSizeInGb' => [ 'base' => NULL, 'refs' => [ 'DefaultEbsStorageSettings$DefaultEbsVolumeSizeInGb' => '

The default size of the EBS storage volume for a private space.

', 'DefaultEbsStorageSettings$MaximumEbsVolumeSizeInGb' => '

The maximum size of the EBS storage volume for a private space.

', 'EbsStorageSettings$EbsVolumeSizeInGb' => '

The size of an EBS storage volume for a private space.

', ], ], 'SpaceJupyterLabAppSettings' => [ 'base' => '

The settings for the JupyterLab application within a space.

', 'refs' => [ 'SpaceSettings$JupyterLabAppSettings' => '

The settings for the JupyterLab application.

', ], ], 'SpaceList' => [ 'base' => NULL, 'refs' => [ 'ListSpacesResponse$Spaces' => '

The list of spaces.

', ], ], 'SpaceName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$SpaceName' => '

The name of the space.

', 'CreateAppRequest$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'CreatePresignedDomainUrlRequest$SpaceName' => '

The name of the space.

', 'CreateSpaceRequest$SpaceName' => '

The name of the space.

', 'DeleteAppRequest$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'DeleteSpaceRequest$SpaceName' => '

The name of the space.

', 'DescribeAppRequest$SpaceName' => '

The name of the space.

', 'DescribeAppResponse$SpaceName' => '

The name of the space. If this value is not set, then UserProfileName must be set.

', 'DescribeSpaceRequest$SpaceName' => '

The name of the space.

', 'DescribeSpaceResponse$SpaceName' => '

The name of the space.

', 'ListAppsRequest$SpaceNameEquals' => '

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

', 'ListSpacesRequest$SpaceNameContains' => '

A parameter by which to filter the results.

', 'SpaceDetails$SpaceName' => '

The name of the space.

', 'UpdateSpaceRequest$SpaceName' => '

The name of the space.

', ], ], 'SpaceSettings' => [ 'base' => '

A collection of space settings.

', 'refs' => [ 'CreateSpaceRequest$SpaceSettings' => '

A collection of space settings.

', 'DescribeSpaceResponse$SpaceSettings' => '

A collection of space settings.

', 'UpdateSpaceRequest$SpaceSettings' => '

A collection of space settings.

', ], ], 'SpaceSettingsSummary' => [ 'base' => '

Specifies summary information about the space settings.

', 'refs' => [ 'SpaceDetails$SpaceSettingsSummary' => '

Specifies summary information about the space settings.

', ], ], 'SpaceSharingSettings' => [ 'base' => '

A collection of space sharing settings.

', 'refs' => [ 'CreateSpaceRequest$SpaceSharingSettings' => '

A collection of space sharing settings.

', 'DescribeSpaceResponse$SpaceSharingSettings' => '

The collection of space sharing settings for a space.

', ], ], 'SpaceSharingSettingsSummary' => [ 'base' => '

Specifies summary information about the space sharing settings.

', 'refs' => [ 'SpaceDetails$SpaceSharingSettingsSummary' => '

Specifies summary information about the space sharing settings.

', ], ], 'SpaceSortKey' => [ 'base' => NULL, 'refs' => [ 'ListSpacesRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'SpaceStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeSpaceResponse$Status' => '

The status.

', 'SpaceDetails$Status' => '

The status.

', ], ], 'SpaceStorageSettings' => [ 'base' => '

The storage settings for a private space.

', 'refs' => [ 'SpaceSettings$SpaceStorageSettings' => '

The storage settings for a private space.

', 'SpaceSettingsSummary$SpaceStorageSettings' => '

The storage settings for a private space.

', ], ], 'SpawnRate' => [ 'base' => NULL, 'refs' => [ 'Phase$SpawnRate' => '

Specified how many new users to spawn in a minute.

', ], ], 'SplitType' => [ 'base' => NULL, 'refs' => [ 'TransformInput$SplitType' => '

The method to use to split the transform job\'s data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:

  • RecordIO

  • TFRecord

When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.

For more information about RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

', ], ], 'StageStatus' => [ 'base' => NULL, 'refs' => [ 'EdgeDeploymentStatus$StageStatus' => '

The general status of the current stage.

', ], ], 'Stairs' => [ 'base' => '

Defines the stairs traffic pattern for an Inference Recommender load test. This pattern type consists of multiple steps where the number of users increases at each step.

Specify either the stairs or phases traffic pattern.

', 'refs' => [ 'TrafficPattern$Stairs' => '

Defines the stairs traffic pattern.

', ], ], 'StartEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistic' => [ 'base' => NULL, 'refs' => [ 'CustomizedMetricSpecification$Statistic' => '

The statistic of the customized metric.

', ], ], 'StatusDetails' => [ 'base' => NULL, 'refs' => [ 'DebugRuleEvaluationStatus$StatusDetails' => '

Details from the rule evaluation.

', 'ProfilerRuleEvaluationStatus$StatusDetails' => '

Details from the rule evaluation.

', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'SecondaryStatusTransition$StatusMessage' => '

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting

  • Starting the training job.

  • Launching requested ML instances.

  • Insufficient capacity error from EC2 while launching instances, retrying!

  • Launched instance was unhealthy, replacing it!

  • Preparing the instances for training.

Training

  • Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don\'t use status messages in if statements.

To have an overview of your training job\'s progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

  • TrainingJobStatus - InProgress

  • SecondaryStatus - Training

  • StatusMessage - Downloading the training image

', ], ], 'StepDescription' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepDescription' => '

The description of the step.

', ], ], 'StepDisplayName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepDisplayName' => '

The display name of the step.

', ], ], 'StepName' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepName' => '

The name of the step that is executed.

', ], ], 'StepStatus' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionStep$StepStatus' => '

The status of the step execution.

', ], ], 'StopAutoMLJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCompilationJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgeDeploymentStageRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopEdgePackagingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopHyperParameterTuningJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopInferenceRecommendationsJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopLabelingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopProcessingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTransformJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StoppingCondition' => [ 'base' => '

Specifies a limit to how long a model training job or model compilation job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

', 'refs' => [ 'CreateCompilationJobRequest$StoppingCondition' => '

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

', 'CreateTrainingJobRequest$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'DescribeCompilationJobResponse$StoppingCondition' => '

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

', 'DescribeTrainingJobResponse$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'HyperParameterTrainingJobDefinition$StoppingCondition' => '

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

', 'TrainingJob$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

', 'TrainingJobDefinition$StoppingCondition' => '

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

', ], ], 'StorageType' => [ 'base' => NULL, 'refs' => [ 'OnlineStoreConfig$StorageType' => '

Option for different tiers of low latency storage for real-time data retrieval.

  • Standard: A managed low latency data store for feature groups.

  • InMemory: A managed data store for feature groups that supports very low latency retrieval.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AlgorithmStatusItem$FailureReason' => '

if the overall status is Failed, the reason for the failure.

', 'BatchDescribeModelPackageError$ErrorCode' => '

', 'BatchDescribeModelPackageError$ErrorResponse' => '

', 'BatchTransformInput$FeaturesAttribute' => '

The attributes of the input data that are the input features.

', 'BatchTransformInput$InferenceAttribute' => '

The attribute of the input data that represents the ground truth label.

', 'BatchTransformInput$ProbabilityAttribute' => '

In a classification problem, the attribute that represents the class probability.

', 'ClusterInstanceStatusDetails$Message' => '

The message from an instance in a SageMaker HyperPod cluster.

', 'ClusterNodeDetails$InstanceId' => '

The ID of the instance.

', 'ClusterNodeSummary$InstanceId' => '

The ID of the instance.

', 'CreateModelPackageInput$Domain' => '

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

', 'CreateModelPackageInput$Task' => '

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".

Specify "OTHER" if none of the tasks listed fit your use case.

', 'CustomizedMetricSpecification$MetricName' => '

The name of the customized metric.

', 'CustomizedMetricSpecification$Namespace' => '

The namespace of the customized metric.

', 'DescribeClusterResponse$FailureMessage' => '

The failure message of the SageMaker HyperPod cluster.

', 'DescribeEdgePackagingJobResponse$EdgePackagingJobStatusMessage' => '

Returns a message describing the job status and error messages.

', 'DescribeEdgePackagingJobResponse$ModelSignature' => '

The signature document of files in the model artifact.

', 'DescribeModelPackageOutput$Domain' => '

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

', 'DescribeModelPackageOutput$Task' => '

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

', 'DescribeModelPackageOutput$SamplePayloadUrl' => '

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

', 'DeviceDeploymentSummary$DeviceDeploymentStatusMessage' => '

The detailed error message for the deployoment status result.

', 'EdgeDeploymentStatus$EdgeDeploymentStatusMessage' => '

A detailed message about deployment status in current stage.

', 'EdgeOutputConfig$PresetDeploymentConfig' => '

The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

  • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.

  • ComponentDescription (optional) - Description of the component.

  • ComponentVersion (optional) - The version of the component.

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

  • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

  • PlatformArchitecture (optional) - The processor architecture for the platform.

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

', 'EdgePresetDeploymentOutput$StatusMessage' => '

Returns a message describing the status of the deployed resource.

', 'EndpointInput$FeaturesAttribute' => '

The attributes of the input data that are the input features.

', 'EndpointInput$InferenceAttribute' => '

The attribute of the input data that represents the ground truth label.

', 'EndpointInput$ProbabilityAttribute' => '

In a classification problem, the attribute that represents the class probability.

', 'EndpointOutputConfiguration$EndpointName' => '

The name of the endpoint made during a recommendation job.

', 'EndpointOutputConfiguration$VariantName' => '

The name of the production variant (deployed model) made during a recommendation job.

', 'EnvironmentParameter$Key' => '

The environment key suggested by the Amazon SageMaker Inference Recommender.

', 'EnvironmentParameter$ValueType' => '

The value type suggested by the Amazon SageMaker Inference Recommender.

', 'EnvironmentParameter$Value' => '

The value suggested by the Amazon SageMaker Inference Recommender.

', 'GetScalingConfigurationRecommendationRequest$RecommendationId' => '

The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the EndpointName field.

', 'GetScalingConfigurationRecommendationResponse$RecommendationId' => '

The recommendation ID of a previously completed inference recommendation.

', 'IamIdentity$Arn' => '

The Amazon Resource Name (ARN) of the IAM identity.

', 'IamIdentity$PrincipalId' => '

The ID of the principal that assumes the IAM identity.

', 'IamIdentity$SourceIdentity' => '

The person or application which assumes the IAM identity.

', 'InferenceRecommendation$RecommendationId' => '

The recommendation ID which uniquely identifies each recommendation.

', 'ListProcessingJobsRequest$NameContains' => '

A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

', 'ModelCard$ModelId' => '

The unique name (ID) of the model.

', 'ModelCard$RiskRating' => '

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

', 'ModelCard$ModelPackageGroupName' => '

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.

', 'ModelDashboardModelCard$ModelId' => '

For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.

', 'ModelDashboardModelCard$RiskRating' => '

A model card\'s risk rating. Can be low, medium, or high.

', 'ModelMetadataSummary$Domain' => '

The machine learning domain of the model.

', 'ModelMetadataSummary$Framework' => '

The machine learning framework of the model.

', 'ModelMetadataSummary$Task' => '

The machine learning task of the model.

', 'ModelMetadataSummary$Model' => '

The name of the model.

', 'ModelMetadataSummary$FrameworkVersion' => '

The framework version of the model.

', 'ModelPackage$Domain' => '

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

', 'ModelPackage$Task' => '

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

', 'ModelPackage$SamplePayloadUrl' => '

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'ModelPackageContainerDefinition$Framework' => '

The machine learning framework of the model package container image.

', 'ModelPackageContainerDefinition$NearestModelName' => '

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.

', 'ModelPackageStatusItem$FailureReason' => '

if the overall status is Failed, the reason for the failure.

', 'PredefinedMetricSpecification$PredefinedMetricType' => '

The metric type. You can only apply SageMaker metric types to SageMaker endpoints.

', 'ProcessingInput$InputName' => '

The name for the processing job input.

', 'ProcessingOutput$OutputName' => '

The name for the processing job output.

', 'ProductListings$member' => NULL, 'RStudioServerProDomainSettings$RStudioConnectUrl' => '

A URL pointing to an RStudio Connect server.

', 'RStudioServerProDomainSettings$RStudioPackageManagerUrl' => '

A URL pointing to an RStudio Package Manager server.

', 'RStudioServerProDomainSettingsForUpdate$RStudioConnectUrl' => '

A URL pointing to an RStudio Connect server.

', 'RStudioServerProDomainSettingsForUpdate$RStudioPackageManagerUrl' => '

A URL pointing to an RStudio Package Manager server.

', 'RealTimeInferenceRecommendation$RecommendationId' => '

The recommendation ID which uniquely identifies each recommendation.

', 'RecommendationJobContainerConfig$Domain' => '

The machine learning domain of the model and its components.

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING

', 'RecommendationJobContainerConfig$Task' => '

The machine learning task that the model accomplishes.

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER

', 'RecommendationJobContainerConfig$Framework' => '

The machine learning framework of the container image.

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN

', 'RecommendationJobContainerConfig$NearestModelName' => '

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet

', 'RecommendationJobSupportedInstanceTypes$member' => NULL, 'RenderUiTemplateResponse$RenderedContent' => '

A Liquid template that renders the HTML for the worker UI.

', 'RenderingError$Code' => '

A unique identifier for a specific class of errors.

', 'RenderingError$Message' => '

A human-readable message describing the error.

', 'ScheduleConfig$DataAnalysisStartTime' => '

Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H".

The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

', 'ScheduleConfig$DataAnalysisEndTime' => '

Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H".

The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

', 'SubscribedWorkteam$SellerName' => '

The name of the vendor in the Amazon Marketplace.

', 'SubscribedWorkteam$ListingId' => '

Marketplace product listing ID.

', 'UserContext$UserProfileArn' => '

The Amazon Resource Name (ARN) of the user\'s profile.

', 'UserContext$UserProfileName' => '

The name of the user\'s profile.

', 'UserContext$DomainId' => '

The domain associated with the user.

', 'Workforce$SubDomain' => '

The subdomain for your OIDC Identity Provider.

', 'Workteam$SubDomain' => '

The URI of the labeling job\'s user interface. Workers open this URI to start labeling your data objects.

', ], ], 'String1024' => [ 'base' => NULL, 'refs' => [ 'ClarifyCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => '

The Amazon S3 URI of baseline constraints file to be used for the drift check.

', 'ClarifyCheckStepMetadata$CalculatedBaselineConstraints' => '

The Amazon S3 URI of the newly calculated baseline constraints file.

', 'ClarifyCheckStepMetadata$ViolationReport' => '

The Amazon S3 URI of the violation report if violations are detected.

', 'CreateDomainResponse$Url' => '

The URL to the created domain.

', 'DescribeDomainResponse$Url' => '

The domain\'s URL.

', 'DescribeSpaceResponse$Url' => '

Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

The following application types are supported:

  • Studio Classic: &redirect=JupyterServer

  • JupyterLab: &redirect=JupyterLab

  • Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

', 'DomainDetails$Url' => '

The domain\'s URL.

', 'EMRStepMetadata$LogFilePath' => '

The path to the log file where the cluster step\'s failure root cause is recorded.

', 'OutputParameter$Value' => '

The value of the output parameter.

', 'Parameter$Value' => '

The literal value for the parameter.

', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckStatistics' => '

The Amazon S3 URI of the baseline statistics file used for the drift check.

', 'QualityCheckStepMetadata$BaselineUsedForDriftCheckConstraints' => '

The Amazon S3 URI of the baseline constraints file used for the drift check.

', 'QualityCheckStepMetadata$CalculatedBaselineStatistics' => '

The Amazon S3 URI of the newly calculated baseline statistics file.

', 'QualityCheckStepMetadata$CalculatedBaselineConstraints' => '

The Amazon S3 URI of the newly calculated baseline constraints file.

', 'QualityCheckStepMetadata$ViolationReport' => '

The Amazon S3 URI of violation report if violations are detected.

', ], ], 'String128' => [ 'base' => NULL, 'refs' => [ 'CategoricalParameterRangeValues$member' => NULL, ], ], 'String200' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$Description' => '

A description of the work team.

', 'SubscribedWorkteam$MarketplaceTitle' => '

The title of the service provided by the vendor in the Amazon Marketplace.

', 'SubscribedWorkteam$MarketplaceDescription' => '

The description of the vendor from the Amazon Marketplace.

', 'UpdateWorkteamRequest$Description' => '

An updated description for the work team.

', 'Workteam$Description' => '

A description of the work team.

', ], ], 'String256' => [ 'base' => NULL, 'refs' => [ 'ActionSource$SourceType' => '

The type of the source.

', 'ActionSource$SourceId' => '

The ID of the source.

', 'ArtifactSourceType$Value' => '

The ID.

', 'ArtifactSummary$ArtifactType' => '

The type of the artifact.

', 'AssociationSummary$SourceType' => '

The source type.

', 'AssociationSummary$DestinationType' => '

The destination type.

', 'CallbackStepMetadata$SqsQueueUrl' => '

The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

', 'ClarifyCheckStepMetadata$CheckType' => '

The type of the Clarify Check step

', 'ClarifyCheckStepMetadata$ModelPackageGroupName' => '

The model package group name.

', 'ClarifyCheckStepMetadata$CheckJobArn' => '

The Amazon Resource Name (ARN) of the check processing job that was run by this step\'s execution.

', 'ContextSource$SourceType' => '

The type of the source.

', 'ContextSource$SourceId' => '

The ID of the source.

', 'ContextSummary$ContextType' => '

The type of the context.

', 'CreateActionRequest$ActionType' => '

The action type.

', 'CreateArtifactRequest$ArtifactType' => '

The artifact type.

', 'CreateContextRequest$ContextType' => '

The context type.

', 'CreateUserProfileRequest$SingleSignOnUserValue' => '

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain\'s AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain\'s AuthMode is not IAM Identity Center, this field cannot be specified.

', 'CustomImageContainerEnvironmentVariables$value' => NULL, 'DescribeActionResponse$ActionType' => '

The type of the action.

', 'DescribeArtifactResponse$ArtifactType' => '

The type of the artifact.

', 'DescribeContextResponse$ContextType' => '

The type of the context.

', 'DescribeDomainResponse$SingleSignOnManagedApplicationInstanceId' => '

The IAM Identity Center managed application instance ID.

', 'DescribeUserProfileResponse$SingleSignOnUserValue' => '

The IAM Identity Center user value.

', 'EMRStepMetadata$ClusterId' => '

The identifier of the EMR cluster.

', 'EMRStepMetadata$StepId' => '

The identifier of the EMR cluster step.

', 'EMRStepMetadata$StepName' => '

The name of the EMR cluster step.

', 'LambdaStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

', 'ListActionsRequest$ActionType' => '

A filter that returns only actions of the specified type.

', 'ListArtifactsRequest$ArtifactType' => '

A filter that returns only artifacts of the specified type.

', 'ListAssociationsRequest$SourceType' => '

A filter that returns only associations with the specified source type.

', 'ListAssociationsRequest$DestinationType' => '

A filter that returns only associations with the specified destination type.

', 'ListContextsRequest$ContextType' => '

A filter that returns only contexts of the specified type.

', 'ListTrialComponentsRequest$SourceArn' => '

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can\'t filter by ExperimentName or TrialName.

', 'ModelMetadataFilter$Value' => '

The value to filter the model metadata.

', 'ModelStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the created model.

', 'OutputParameter$Name' => '

The name of the output parameter.

', 'QualityCheckStepMetadata$CheckType' => '

The type of the Quality check step.

', 'QualityCheckStepMetadata$ModelPackageGroupName' => '

The model package group name.

', 'QualityCheckStepMetadata$CheckJobArn' => '

The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

', 'QueryProperties$key' => NULL, 'QueryProperties$value' => NULL, 'RegisterModelStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the model package.

', 'SelectedStep$StepName' => '

The name of the pipeline step.

', 'SendPipelineExecutionStepFailureRequest$FailureReason' => '

A message describing why the step failed.

', ], ], 'String3072' => [ 'base' => NULL, 'refs' => [ 'FailStepMetadata$ErrorMessage' => '

A message that you define and then is processed and rendered by the Fail step when the error occurs.

', 'PipelineExecutionSummary$PipelineExecutionFailureReason' => '

A message generated by SageMaker Pipelines describing why the pipeline execution failed.

', ], ], 'String40' => [ 'base' => NULL, 'refs' => [ 'QueryTypes$member' => NULL, 'Vertex$Type' => '

The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...

', ], ], 'String64' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionType' => '

The type of the action.

', 'CategoricalParameter$Name' => '

The Name of the environment variable.

', 'ModelLatencyThreshold$Percentile' => '

The model latency percentile threshold. Acceptable values are P95 and P99. For custom load tests, specify the value as P95.

', ], ], 'String8192' => [ 'base' => NULL, 'refs' => [ 'QueryLineageRequest$NextToken' => '

Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.

', 'QueryLineageResponse$NextToken' => '

Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.

', ], ], 'StringParameterValue' => [ 'base' => NULL, 'refs' => [ 'ArtifactProperties$key' => NULL, 'LineageEntityParameters$key' => NULL, 'LineageEntityParameters$value' => NULL, 'ListLineageEntityParameterKey$member' => NULL, 'TrialComponentParameterValue$StringValue' => '

The string value of a categorical hyperparameter. If you specify a value for this parameter, you can\'t specify the NumberValue parameter.

', ], ], 'StudioLifecycleConfigAppType' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigAppType' => '

The App type that the Lifecycle Configuration is attached to.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigAppType' => '

The App type that the Lifecycle Configuration is attached to.

', 'ListStudioLifecycleConfigsRequest$AppTypeEquals' => '

A parameter to search for the App Type to which the Lifecycle Configuration is attached.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigAppType' => '

The App type to which the Lifecycle Configuration is attached.

', ], ], 'StudioLifecycleConfigArn' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => '

The ARN of your created Lifecycle Configuration.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigArn' => '

The ARN of the Lifecycle Configuration to describe.

', 'LifecycleConfigArns$member' => NULL, 'ResourceSpec$LifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigArn' => '

The Amazon Resource Name (ARN) of the Lifecycle Configuration.

', ], ], 'StudioLifecycleConfigContent' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigContent' => '

The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigContent' => '

The content of your Amazon SageMaker Studio Lifecycle Configuration script.

', ], ], 'StudioLifecycleConfigDetails' => [ 'base' => '

Details of the Amazon SageMaker Studio Lifecycle Configuration.

', 'refs' => [ 'StudioLifecycleConfigsList$member' => NULL, ], ], 'StudioLifecycleConfigName' => [ 'base' => NULL, 'refs' => [ 'CreateStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to create.

', 'DeleteStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.

', 'DescribeStudioLifecycleConfigRequest$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.

', 'DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.

', 'ListStudioLifecycleConfigsRequest$NameContains' => '

A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

', 'StudioLifecycleConfigDetails$StudioLifecycleConfigName' => '

The name of the Amazon SageMaker Studio Lifecycle Configuration.

', ], ], 'StudioLifecycleConfigSortKey' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsRequest$SortBy' => '

The property used to sort results. The default value is CreationTime.

', ], ], 'StudioLifecycleConfigsList' => [ 'base' => NULL, 'refs' => [ 'ListStudioLifecycleConfigsResponse$StudioLifecycleConfigs' => '

A list of Lifecycle Configurations and their properties.

', ], ], 'StudioWebPortal' => [ 'base' => NULL, 'refs' => [ 'UserSettings$StudioWebPortal' => '

Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'CreateNotebookInstanceInput$SubnetId' => '

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

', 'DescribeNotebookInstanceOutput$SubnetId' => '

The ID of the VPC subnet.

', 'Subnets$member' => NULL, ], ], 'Subnets' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$SubnetIds' => '

The VPC subnets that the domain uses for communication.

', 'DescribeDomainResponse$SubnetIds' => '

The VPC subnets that the domain uses for communication.

', 'UpdateDomainRequest$SubnetIds' => '

The VPC subnets that Studio uses for communication.

If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.

', 'VpcConfig$Subnets' => '

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

', ], ], 'SubscribedWorkteam' => [ 'base' => '

Describes a work team of a vendor that does the a labelling job.

', 'refs' => [ 'DescribeSubscribedWorkteamResponse$SubscribedWorkteam' => '

A Workteam instance that contains information about the work team.

', 'SubscribedWorkteams$member' => NULL, ], ], 'SubscribedWorkteams' => [ 'base' => NULL, 'refs' => [ 'ListSubscribedWorkteamsResponse$SubscribedWorkteams' => '

An array of Workteam objects, each describing a work team.

', ], ], 'Success' => [ 'base' => NULL, 'refs' => [ 'DeleteWorkteamResponse$Success' => '

Returns true if the work team was successfully deleted; otherwise, returns false.

', ], ], 'SuggestionQuery' => [ 'base' => '

Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.

', 'refs' => [ 'GetSearchSuggestionsRequest$SuggestionQuery' => '

Limits the property names that are included in the response.

', ], ], 'TableFormat' => [ 'base' => NULL, 'refs' => [ 'OfflineStoreConfig$TableFormat' => '

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

', ], ], 'TableName' => [ 'base' => NULL, 'refs' => [ 'DataCatalogConfig$TableName' => '

The name of the Glue table.

', ], ], 'TabularJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the tabular problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TabularJobConfig' => '

Settings used to configure an AutoML job V2 for the tabular problem type (regression, classification).

', ], ], 'TabularResolvedAttributes' => [ 'base' => '

The resolved attributes specific to the tabular problem type.

', 'refs' => [ 'AutoMLProblemTypeResolvedAttributes$TabularResolvedAttributes' => '

The resolved attributes for the tabular problem type.

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

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

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

The tag key. Tag keys must be unique per resource.

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

An array or one or more tag keys to delete.

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

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'AddTagsOutput$Tags' => '

A list of tags associated with the SageMaker resource.

', 'CreateActionRequest$Tags' => '

A list of tags to apply to the action.

', 'CreateAlgorithmInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateAppImageConfigRequest$Tags' => '

A list of tags to apply to the AppImageConfig.

', 'CreateAppRequest$Tags' => '

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

', 'CreateArtifactRequest$Tags' => '

A list of tags to apply to the artifact.

', 'CreateAutoMLJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

', 'CreateAutoMLJobV2Request$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, such as by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

', 'CreateClusterRequest$Tags' => '

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

', 'CreateCodeRepositoryInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateCompilationJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateContextRequest$Tags' => '

A list of tags to apply to the context.

', 'CreateDataQualityJobDefinitionRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateDeviceFleetRequest$Tags' => '

Creates tags for the specified fleet.

', 'CreateDomainRequest$Tags' => '

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

', 'CreateEdgeDeploymentPlanRequest$Tags' => '

List of tags with which to tag the edge deployment plan.

', 'CreateEdgePackagingJobRequest$Tags' => '

Creates tags for the packaging job.

', 'CreateEndpointConfigInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateEndpointInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateExperimentRequest$Tags' => '

A list of tags to associate with the experiment. You can use Search API to search on the tags.

', 'CreateFeatureGroupRequest$Tags' => '

Tags used to identify Features in each FeatureGroup.

', 'CreateFlowDefinitionRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

', 'CreateHubRequest$Tags' => '

Any tags to associate with the hub.

', 'CreateHumanTaskUiRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

', 'CreateHyperParameterTuningJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

', 'CreateImageRequest$Tags' => '

A list of tags to apply to the image.

', 'CreateInferenceComponentInput$Tags' => '

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

', 'CreateInferenceExperimentRequest$Tags' => '

Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.

', 'CreateInferenceRecommendationsJobRequest$Tags' => '

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

', 'CreateLabelingJobRequest$Tags' => '

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateModelBiasJobDefinitionRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateModelCardRequest$Tags' => '

Key-value pairs used to manage metadata for model cards.

', 'CreateModelExplainabilityJobDefinitionRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateModelInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateModelPackageGroupInput$Tags' => '

A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'CreateModelPackageInput$Tags' => '

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.

', 'CreateModelQualityJobDefinitionRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateMonitoringScheduleRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateNotebookInstanceInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreatePipelineRequest$Tags' => '

A list of tags to apply to the created pipeline.

', 'CreateProcessingJobRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateProjectInput$Tags' => '

An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'CreateSpaceRequest$Tags' => '

Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.

', 'CreateStudioLifecycleConfigRequest$Tags' => '

Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

', 'CreateTrainingJobRequest$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'CreateTransformJobRequest$Tags' => '

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'CreateTrialComponentRequest$Tags' => '

A list of tags to associate with the component. You can use Search API to search on the tags.

', 'CreateTrialRequest$Tags' => '

A list of tags to associate with the trial. You can use Search API to search on the tags.

', 'CreateUserProfileRequest$Tags' => '

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

', 'CreateWorkforceRequest$Tags' => '

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

', 'CreateWorkteamRequest$Tags' => '

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'DescribeLabelingJobResponse$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'Endpoint$Tags' => '

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'Experiment$Tags' => '

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

', 'FeatureGroup$Tags' => '

Tags used to define a FeatureGroup.

', 'HyperParameterTuningJobSearchEntity$Tags' => '

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

', 'ImportHubContentRequest$Tags' => '

Any tags associated with the hub content.

', 'ListTagsOutput$Tags' => '

An array of Tag objects, each with a tag key and a value.

', 'Model$Tags' => '

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'ModelCard$Tags' => '

Key-value pairs used to manage metadata for the model card.

', 'ModelDashboardModelCard$Tags' => '

The tags associated with a model card.

', 'ModelPackage$Tags' => '

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'ModelPackageGroup$Tags' => '

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'MonitoringSchedule$Tags' => '

A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

', 'Pipeline$Tags' => '

A list of tags that apply to the pipeline.

', 'ProcessingJob$Tags' => '

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

', 'Project$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'RegisterDevicesRequest$Tags' => '

The tags associated with devices.

', 'TrainingJob$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

', 'TransformJob$Tags' => '

A list of tags associated with the transform job.

', 'Trial$Tags' => '

The list of tags that are associated with the trial. You can use Search API to search on the tags.

', 'TrialComponent$Tags' => '

The list of tags that are associated with the component. You can use Search API to search on the tags.

', 'UpdateProjectInput$Tags' => '

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints.

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

The tag value.

', ], ], 'TargetAttributeName' => [ 'base' => NULL, 'refs' => [ 'AutoMLChannel$TargetAttributeName' => '

The name of the target variable in supervised learning, usually represented by \'y\'.

', 'TabularJobConfig$TargetAttributeName' => '

The name of the target variable in supervised learning, usually represented by \'y\'.

', 'TimeSeriesConfig$TargetAttributeName' => '

The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.

', ], ], 'TargetDevice' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetDevice' => '

The type of device that the model will run on after the compilation job has completed.

', 'OutputConfig$TargetDevice' => '

Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.

Currently ml_trn1 is available only in US East (N. Virginia) Region, and ml_inf2 is available only in US East (Ohio) Region.

', ], ], 'TargetLabelColumn' => [ 'base' => NULL, 'refs' => [ 'TextClassificationJobConfig$TargetLabelColumn' => '

The name of the column used to provide the class labels. It should not be same as the content column.

', ], ], 'TargetObjectiveMetricValue' => [ 'base' => NULL, 'refs' => [ 'TuningJobCompletionCriteria$TargetObjectiveMetricValue' => '

The value of the objective metric.

', ], ], 'TargetPlatform' => [ 'base' => '

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

', 'refs' => [ 'OutputConfig$TargetPlatform' => '

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:

  • Raspberry Pi 3 Model B+

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM_EABIHF"},

    "CompilerOptions": {\'mattr\': [\'+neon\']}

  • Jetson TX2

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "NVIDIA"},

    "CompilerOptions": {\'gpu-code\': \'sm_62\', \'trt-ver\': \'6.0.1\', \'cuda-ver\': \'10.0\'}

  • EC2 m5.2xlarge instance OS

    "TargetPlatform": {"Os": "LINUX", "Arch": "X86_64", "Accelerator": "NVIDIA"},

    "CompilerOptions": {\'mcpu\': \'skylake-avx512\'}

  • RK3399

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "MALI"}

  • ARMv7 phone (CPU)

    "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM_EABI"},

    "CompilerOptions": {\'ANDROID_PLATFORM\': 25, \'mattr\': [\'+neon\']}

  • ARMv8 phone (CPU)

    "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"},

    "CompilerOptions": {\'ANDROID_PLATFORM\': 29}

', ], ], 'TargetPlatformAccelerator' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformAccelerator' => '

The type of accelerator that the model will run on after the compilation job has completed.

', 'TargetPlatform$Accelerator' => '

Specifies a target platform accelerator (optional).

  • NVIDIA: Nvidia graphics processing unit. It also requires gpu-code, trt-ver, cuda-ver compiler options

  • MALI: ARM Mali graphics processor

  • INTEL_GRAPHICS: Integrated Intel graphics

', ], ], 'TargetPlatformArch' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformArch' => '

The type of architecture that the model will run on after the compilation job has completed.

', 'TargetPlatform$Arch' => '

Specifies a target platform architecture.

  • X86_64: 64-bit version of the x86 instruction set.

  • X86: 32-bit version of the x86 instruction set.

  • ARM64: ARMv8 64-bit CPU.

  • ARM_EABIHF: ARMv7 32-bit, Hard Float.

  • ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.

', ], ], 'TargetPlatformOs' => [ 'base' => NULL, 'refs' => [ 'CompilationJobSummary$CompilationTargetPlatformOs' => '

The type of OS that the model will run on after the compilation job has completed.

', 'TargetPlatform$Os' => '

Specifies a target platform OS.

  • LINUX: Linux-based operating systems.

  • ANDROID: Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, "CompilerOptions": {\'ANDROID_PLATFORM\': 28}

', ], ], 'TargetTrackingScalingPolicyConfiguration' => [ 'base' => '

A target tracking scaling policy. Includes support for predefined or customized metrics.

When using the PutScalingPolicy API, this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

', 'refs' => [ 'ScalingPolicy$TargetTracking' => '

A target tracking scaling policy. Includes support for predefined or customized metrics.

', ], ], 'TaskAvailabilityLifetimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskAvailabilityLifetimeInSeconds' => '

The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.

  • If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).

  • If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

', ], ], 'TaskCount' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$DesiredInstanceCount' => '

The variant\'s capacity.

', 'PendingProductionVariantSummary$CurrentInstanceCount' => '

The number of instances associated with the variant.

', 'PendingProductionVariantSummary$DesiredInstanceCount' => '

The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

', 'ProductionVariantSummary$CurrentInstanceCount' => '

The number of instances associated with the variant.

', 'ProductionVariantSummary$DesiredInstanceCount' => '

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

', 'RealTimeInferenceConfig$InstanceCount' => '

The number of instances of the type specified by InstanceType.

', ], ], 'TaskDescription' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskDescription' => '

A description of the task for your human workers.

', ], ], 'TaskInput' => [ 'base' => NULL, 'refs' => [ 'RenderableTask$Input' => '

A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as "text": "sample text".

', ], ], 'TaskKeyword' => [ 'base' => NULL, 'refs' => [ 'TaskKeywords$member' => NULL, ], ], 'TaskKeywords' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskKeywords' => '

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

', ], ], 'TaskTimeLimitInSeconds' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskTimeLimitInSeconds' => '

The amount of time that a worker has to complete a task.

If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).

If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:

  • For image and text labeling jobs, the maximum is 8 hours (28,800 seconds).

  • For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

', ], ], 'TaskTitle' => [ 'base' => NULL, 'refs' => [ 'HumanTaskConfig$TaskTitle' => '

A title for the task for your human workers.

', ], ], 'TemplateContent' => [ 'base' => NULL, 'refs' => [ 'UiTemplate$Content' => '

The content of the Liquid template for the worker user interface.

', ], ], 'TemplateContentSha256' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$ContentSha256' => '

The SHA-256 digest of the contents of the template.

', ], ], 'TemplateUrl' => [ 'base' => NULL, 'refs' => [ 'UiTemplateInfo$Url' => '

The URL for the user interface template.

', ], ], 'TensorBoardAppSettings' => [ 'base' => '

The TensorBoard app settings.

', 'refs' => [ 'UserSettings$TensorBoardAppSettings' => '

The TensorBoard app settings.

', ], ], 'TensorBoardOutputConfig' => [ 'base' => '

Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

', 'refs' => [ 'CreateTrainingJobRequest$TensorBoardOutputConfig' => NULL, 'DescribeTrainingJobResponse$TensorBoardOutputConfig' => NULL, 'TrainingJob$TensorBoardOutputConfig' => NULL, ], ], 'TenthFractionsOfACent' => [ 'base' => NULL, 'refs' => [ 'USD$TenthFractionsOfACent' => '

Fractions of a cent, in tenths.

', ], ], 'TerminationWaitInSeconds' => [ 'base' => NULL, 'refs' => [ 'BlueGreenUpdatePolicy$TerminationWaitInSeconds' => '

Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.

', ], ], 'TextClassificationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the text classification problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TextClassificationJobConfig' => '

Settings used to configure an AutoML job V2 for the text classification problem type.

', ], ], 'TextGenerationHyperParameterKey' => [ 'base' => NULL, 'refs' => [ 'TextGenerationHyperParameters$key' => NULL, ], ], 'TextGenerationHyperParameterValue' => [ 'base' => NULL, 'refs' => [ 'TextGenerationHyperParameters$value' => NULL, ], ], 'TextGenerationHyperParameters' => [ 'base' => NULL, 'refs' => [ 'TextGenerationJobConfig$TextGenerationHyperParameters' => '

The hyperparameters used to configure and optimize the learning process of the base model. You can set any combination of the following hyperparameters for all base models. For more information on each supported hyperparameter, see Optimize the learning process of your text generation models with hyperparameters.

  • "epochCount": The number of times the model goes through the entire training dataset. Its value should be a string containing an integer value within the range of "1" to "10".

  • "batchSize": The number of data samples used in each iteration of training. Its value should be a string containing an integer value within the range of "1" to "64".

  • "learningRate": The step size at which a model\'s parameters are updated during training. Its value should be a string containing a floating-point value within the range of "0" to "1".

  • "learningRateWarmupSteps": The number of training steps during which the learning rate gradually increases before reaching its target or maximum value. Its value should be a string containing an integer value within the range of "0" to "250".

Here is an example where all four hyperparameters are configured.

{ "epochCount":"5", "learningRate":"0.5", "batchSize": "32", "learningRateWarmupSteps": "10" }

', ], ], 'TextGenerationJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the text generation problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

', 'refs' => [ 'AutoMLProblemTypeConfig$TextGenerationJobConfig' => '

Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning) problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

', ], ], 'TextGenerationResolvedAttributes' => [ 'base' => '

The resolved attributes specific to the text generation problem type.

', 'refs' => [ 'AutoMLProblemTypeResolvedAttributes$TextGenerationResolvedAttributes' => '

The resolved attributes for the text generation problem type.

', ], ], 'ThingName' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$IotThingName' => '

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

', 'Device$IotThingName' => '

Amazon Web Services Internet of Things (IoT) object name.

', 'DeviceSummary$IotThingName' => '

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

', ], ], 'ThroughputConfig' => [ 'base' => '

Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

', 'refs' => [ 'CreateFeatureGroupRequest$ThroughputConfig' => NULL, ], ], 'ThroughputConfigDescription' => [ 'base' => '

Active throughput configuration of the feature group. Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

', 'refs' => [ 'DescribeFeatureGroupResponse$ThroughputConfig' => NULL, ], ], 'ThroughputConfigUpdate' => [ 'base' => '

The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period.

', 'refs' => [ 'UpdateFeatureGroupRequest$ThroughputConfig' => NULL, ], ], 'ThroughputMode' => [ 'base' => NULL, 'refs' => [ 'ThroughputConfig$ThroughputMode' => '

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

', 'ThroughputConfigDescription$ThroughputMode' => '

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

', 'ThroughputConfigUpdate$ThroughputMode' => '

Target throughput mode of the feature group. Throughput update is an asynchronous operation, and the outcome should be monitored by polling LastUpdateStatus field in DescribeFeatureGroup response. You cannot update a feature group\'s throughput while another update is in progress.

', ], ], 'TimeSeriesConfig' => [ 'base' => '

The collection of components that defines the time-series.

', 'refs' => [ 'TimeSeriesForecastingJobConfig$TimeSeriesConfig' => '

The collection of components that defines the time-series.

', ], ], 'TimeSeriesForecastingJobConfig' => [ 'base' => '

The collection of settings used by an AutoML job V2 for the time-series forecasting problem type.

', 'refs' => [ 'AutoMLProblemTypeConfig$TimeSeriesForecastingJobConfig' => '

Settings used to configure an AutoML job V2 for the time-series forecasting problem type.

', ], ], 'TimeSeriesForecastingSettings' => [ 'base' => '

Time series forecast settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$TimeSeriesForecastingSettings' => '

Time series forecast settings for the SageMaker Canvas application.

', ], ], 'TimeSeriesTransformations' => [ 'base' => '

Transformations allowed on the dataset. Supported transformations are Filling and Aggregation. Filling specifies how to add values to missing values in the dataset. Aggregation defines how to aggregate data that does not align with forecast frequency.

', 'refs' => [ 'TimeSeriesForecastingJobConfig$Transformations' => '

The transformations modifying specific attributes of the time-series, such as filling strategies for missing values.

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$CreationTime' => '

When the action was created.

', 'ActionSummary$LastModifiedTime' => '

When the action was last modified.

', 'AppImageConfigDetails$CreationTime' => '

When the AppImageConfig was created.

', 'AppImageConfigDetails$LastModifiedTime' => '

When the AppImageConfig was last modified.

', 'ArtifactSummary$CreationTime' => '

When the artifact was created.

', 'ArtifactSummary$LastModifiedTime' => '

When the artifact was last modified.

', 'AssociationSummary$CreationTime' => '

When the association was created.

', 'AutoMLCandidate$CreationTime' => '

The creation time.

', 'AutoMLCandidate$EndTime' => '

The end time.

', 'AutoMLCandidate$LastModifiedTime' => '

The last modified time.

', 'AutoMLJobSummary$CreationTime' => '

When the AutoML job was created.

', 'AutoMLJobSummary$EndTime' => '

The end time of an AutoML job.

', 'AutoMLJobSummary$LastModifiedTime' => '

When the AutoML job was last modified.

', 'ClusterNodeDetails$LaunchTime' => '

The time when the instance is launched.

', 'ClusterNodeSummary$LaunchTime' => '

The time when the instance is launched.

', 'ClusterSummary$CreationTime' => '

The time when the SageMaker HyperPod cluster is created.

', 'CompilationJobSummary$CompilationStartTime' => '

The time when the model compilation job started.

', 'CompilationJobSummary$CompilationEndTime' => '

The time when the model compilation job completed.

', 'ContextSummary$CreationTime' => '

When the context was created.

', 'ContextSummary$LastModifiedTime' => '

When the context was last modified.

', 'CreateTrialComponentRequest$StartTime' => '

When the component started.

', 'CreateTrialComponentRequest$EndTime' => '

When the component ended.

', 'DebugRuleEvaluationStatus$LastModifiedTime' => '

Timestamp when the rule evaluation status was last modified.

', 'DeployedImage$ResolutionTime' => '

The date and time when the image path for the model resolved to the ResolvedImage

', 'DescribeActionResponse$CreationTime' => '

When the action was created.

', 'DescribeActionResponse$LastModifiedTime' => '

When the action was last modified.

', 'DescribeAppImageConfigResponse$CreationTime' => '

When the AppImageConfig was created.

', 'DescribeAppImageConfigResponse$LastModifiedTime' => '

When the AppImageConfig was last modified.

', 'DescribeAppResponse$LastHealthCheckTimestamp' => '

The timestamp of the last health check.

', 'DescribeAppResponse$LastUserActivityTimestamp' => '

The timestamp of the last user\'s activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

', 'DescribeAppResponse$CreationTime' => '

The creation time.

', 'DescribeArtifactResponse$CreationTime' => '

When the artifact was created.

', 'DescribeArtifactResponse$LastModifiedTime' => '

When the artifact was last modified.

', 'DescribeAutoMLJobResponse$CreationTime' => '

Returns the creation time of the AutoML job.

', 'DescribeAutoMLJobResponse$EndTime' => '

Returns the end time of the AutoML job.

', 'DescribeAutoMLJobResponse$LastModifiedTime' => '

Returns the job\'s last modified time.

', 'DescribeAutoMLJobV2Response$CreationTime' => '

Returns the creation time of the AutoML job V2.

', 'DescribeAutoMLJobV2Response$EndTime' => '

Returns the end time of the AutoML job V2.

', 'DescribeAutoMLJobV2Response$LastModifiedTime' => '

Returns the job\'s last modified time.

', 'DescribeClusterResponse$CreationTime' => '

The time when the SageMaker Cluster is created.

', 'DescribeCompilationJobResponse$CompilationStartTime' => '

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That\'s because it takes time to download the compilation job, which depends on the size of the compilation job container.

', 'DescribeCompilationJobResponse$CompilationEndTime' => '

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job\'s model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

', 'DescribeContextResponse$CreationTime' => '

When the context was created.

', 'DescribeContextResponse$LastModifiedTime' => '

When the context was last modified.

', 'DescribeDataQualityJobDefinitionResponse$CreationTime' => '

The time that the data quality monitoring job definition was created.

', 'DescribeDeviceFleetResponse$CreationTime' => '

Timestamp of when the device fleet was created.

', 'DescribeDeviceFleetResponse$LastModifiedTime' => '

Timestamp of when the device fleet was last updated.

', 'DescribeDeviceResponse$RegistrationTime' => '

The timestamp of the last registration or de-reregistration.

', 'DescribeDeviceResponse$LatestHeartbeat' => '

The last heartbeat received from the device.

', 'DescribeEdgeDeploymentPlanResponse$CreationTime' => '

The time when the edge deployment plan was created.

', 'DescribeEdgeDeploymentPlanResponse$LastModifiedTime' => '

The time when the edge deployment plan was last updated.

', 'DescribeEdgePackagingJobResponse$CreationTime' => '

The timestamp of when the packaging job was created.

', 'DescribeEdgePackagingJobResponse$LastModifiedTime' => '

The timestamp of when the job was last updated.

', 'DescribeEndpointConfigOutput$CreationTime' => '

A timestamp that shows when the endpoint configuration was created.

', 'DescribeEndpointOutput$CreationTime' => '

A timestamp that shows when the endpoint was created.

', 'DescribeEndpointOutput$LastModifiedTime' => '

A timestamp that shows when the endpoint was last modified.

', 'DescribeExperimentResponse$CreationTime' => '

When the experiment was created.

', 'DescribeExperimentResponse$LastModifiedTime' => '

When the experiment was last modified.

', 'DescribeFlowDefinitionResponse$CreationTime' => '

The timestamp when the flow definition was created.

', 'DescribeHubContentResponse$CreationTime' => '

The date and time that hub content was created.

', 'DescribeHubResponse$CreationTime' => '

The date and time that the hub was created.

', 'DescribeHubResponse$LastModifiedTime' => '

The date and time that the hub was last modified.

', 'DescribeHumanTaskUiResponse$CreationTime' => '

The timestamp when the human task user interface was created.

', 'DescribeHyperParameterTuningJobResponse$CreationTime' => '

The date and time that the tuning job started.

', 'DescribeHyperParameterTuningJobResponse$HyperParameterTuningEndTime' => '

The date and time that the tuning job ended.

', 'DescribeHyperParameterTuningJobResponse$LastModifiedTime' => '

The date and time that the status of the tuning job was modified.

', 'DescribeImageResponse$CreationTime' => '

When the image was created.

', 'DescribeImageResponse$LastModifiedTime' => '

When the image was last modified.

', 'DescribeImageVersionResponse$CreationTime' => '

When the version was created.

', 'DescribeImageVersionResponse$LastModifiedTime' => '

When the version was last modified.

', 'DescribeInferenceComponentOutput$CreationTime' => '

The time when the inference component was created.

', 'DescribeInferenceComponentOutput$LastModifiedTime' => '

The time when the inference component was last updated.

', 'DescribeInferenceExperimentResponse$CreationTime' => '

The timestamp at which you created the inference experiment.

', 'DescribeInferenceExperimentResponse$CompletionTime' => '

The timestamp at which the inference experiment was completed.

', 'DescribeInferenceExperimentResponse$LastModifiedTime' => '

The timestamp at which you last modified the inference experiment.

', 'DescribeInferenceRecommendationsJobResponse$CompletionTime' => '

A timestamp that shows when the job completed.

', 'DescribeLabelingJobResponse$CreationTime' => '

The date and time that the labeling job was created.

', 'DescribeLabelingJobResponse$LastModifiedTime' => '

The date and time that the labeling job was last updated.

', 'DescribeLineageGroupResponse$CreationTime' => '

The creation time of lineage group.

', 'DescribeLineageGroupResponse$LastModifiedTime' => '

The last modified time of the lineage group.

', 'DescribeModelBiasJobDefinitionResponse$CreationTime' => '

The time at which the model bias job was created.

', 'DescribeModelCardExportJobResponse$CreatedAt' => '

The date and time that the model export job was created.

', 'DescribeModelCardExportJobResponse$LastModifiedAt' => '

The date and time that the model export job was last modified.

', 'DescribeModelCardResponse$CreationTime' => '

The date and time the model card was created.

', 'DescribeModelCardResponse$LastModifiedTime' => '

The date and time the model card was last modified.

', 'DescribeModelExplainabilityJobDefinitionResponse$CreationTime' => '

The time at which the model explainability job was created.

', 'DescribeModelOutput$CreationTime' => '

A timestamp that shows when the model was created.

', 'DescribeModelPackageOutput$LastModifiedTime' => '

The last time that the model package was modified.

', 'DescribeModelQualityJobDefinitionResponse$CreationTime' => '

The time at which the model quality job was created.

', 'DescribeMonitoringScheduleResponse$CreationTime' => '

The time at which the monitoring job was created.

', 'DescribeMonitoringScheduleResponse$LastModifiedTime' => '

The time at which the monitoring job was last modified.

', 'DescribePipelineDefinitionForExecutionResponse$CreationTime' => '

The time when the pipeline was created.

', 'DescribePipelineExecutionResponse$CreationTime' => '

The time when the pipeline execution was created.

', 'DescribePipelineExecutionResponse$LastModifiedTime' => '

The time when the pipeline execution was modified last.

', 'DescribePipelineResponse$CreationTime' => '

The time when the pipeline was created.

', 'DescribePipelineResponse$LastModifiedTime' => '

The time when the pipeline was last modified.

', 'DescribePipelineResponse$LastRunTime' => '

The time when the pipeline was last run.

', 'DescribeProcessingJobResponse$ProcessingEndTime' => '

The time at which the processing job completed.

', 'DescribeProcessingJobResponse$ProcessingStartTime' => '

The time at which the processing job started.

', 'DescribeProcessingJobResponse$LastModifiedTime' => '

The time at which the processing job was last modified.

', 'DescribeProcessingJobResponse$CreationTime' => '

The time at which the processing job was created.

', 'DescribeProjectOutput$CreationTime' => '

The time when the project was created.

', 'DescribeProjectOutput$LastModifiedTime' => '

The timestamp when project was last modified.

', 'DescribeStudioLifecycleConfigResponse$CreationTime' => '

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

', 'DescribeStudioLifecycleConfigResponse$LastModifiedTime' => '

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

', 'DescribeTrainingJobResponse$CreationTime' => '

A timestamp that indicates when the training job was created.

', 'DescribeTrainingJobResponse$TrainingStartTime' => '

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

', 'DescribeTrainingJobResponse$TrainingEndTime' => '

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'DescribeTrainingJobResponse$LastModifiedTime' => '

A timestamp that indicates when the status of the training job was last modified.

', 'DescribeTransformJobResponse$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'DescribeTransformJobResponse$TransformStartTime' => '

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

', 'DescribeTransformJobResponse$TransformEndTime' => '

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

', 'DescribeTrialComponentResponse$StartTime' => '

When the component started.

', 'DescribeTrialComponentResponse$EndTime' => '

When the component ended.

', 'DescribeTrialComponentResponse$CreationTime' => '

When the component was created.

', 'DescribeTrialComponentResponse$LastModifiedTime' => '

When the component was last modified.

', 'DescribeTrialResponse$CreationTime' => '

When the trial was created.

', 'DescribeTrialResponse$LastModifiedTime' => '

When the trial was last modified.

', 'DeviceDeploymentSummary$DeploymentStartTime' => '

The time when the deployment on the device started.

', 'DeviceFleetSummary$CreationTime' => '

Timestamp of when the device fleet was created.

', 'DeviceFleetSummary$LastModifiedTime' => '

Timestamp of when the device fleet was last updated.

', 'DeviceSummary$RegistrationTime' => '

The timestamp of the last registration or de-reregistration.

', 'DeviceSummary$LatestHeartbeat' => '

The last heartbeat received from the device.

', 'EdgeDeploymentPlanSummary$CreationTime' => '

The time when the edge deployment plan was created.

', 'EdgeDeploymentPlanSummary$LastModifiedTime' => '

The time when the edge deployment plan was last updated.

', 'EdgeDeploymentStatus$EdgeDeploymentStageStartTime' => '

The time when the deployment API started.

', 'EdgeModel$LatestSampleTime' => '

The timestamp of the last data sample taken.

', 'EdgeModel$LatestInference' => '

The timestamp of the last inference that was made.

', 'EdgePackagingJobSummary$CreationTime' => '

The timestamp of when the job was created.

', 'EdgePackagingJobSummary$LastModifiedTime' => '

The timestamp of when the edge packaging job was last updated.

', 'Endpoint$CreationTime' => '

The time that the endpoint was created.

', 'Endpoint$LastModifiedTime' => '

The last time the endpoint was modified.

', 'EndpointConfigSummary$CreationTime' => '

A timestamp that shows when the endpoint configuration was created.

', 'EndpointSummary$CreationTime' => '

A timestamp that shows when the endpoint was created.

', 'EndpointSummary$LastModifiedTime' => '

A timestamp that shows when the endpoint was last modified.

', 'Experiment$CreationTime' => '

When the experiment was created.

', 'Experiment$LastModifiedTime' => '

When the experiment was last modified.

', 'ExperimentSummary$CreationTime' => '

When the experiment was created.

', 'ExperimentSummary$LastModifiedTime' => '

When the experiment was last modified.

', 'FeatureGroupSummary$CreationTime' => '

A timestamp indicating the time of creation time of the FeatureGroup.

', 'FlowDefinitionSummary$CreationTime' => '

The timestamp when SageMaker created the flow definition.

', 'GetDeviceFleetReportResponse$ReportGenerated' => '

Timestamp of when the report was generated.

', 'HubContentInfo$CreationTime' => '

The date and time that the hub content was created.

', 'HubInfo$CreationTime' => '

The date and time that the hub was created.

', 'HubInfo$LastModifiedTime' => '

The date and time that the hub was last modified.

', 'HumanTaskUiSummary$CreationTime' => '

A timestamp when SageMaker created the human task user interface.

', 'HyperParameterTrainingJobSummary$CreationTime' => '

The date and time that the training job was created.

', 'HyperParameterTrainingJobSummary$TrainingStartTime' => '

The date and time that the training job started.

', 'HyperParameterTrainingJobSummary$TrainingEndTime' => '

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'HyperParameterTuningJobCompletionDetails$ConvergenceDetectedTime' => '

The time in timestamp format that AMT detected model convergence, as defined by a lack of significant improvement over time based on criteria developed over a wide range of diverse benchmarking tests.

', 'HyperParameterTuningJobSearchEntity$CreationTime' => '

The time that a hyperparameter tuning job was created.

', 'HyperParameterTuningJobSearchEntity$HyperParameterTuningEndTime' => '

The time that a hyperparameter tuning job ended.

', 'HyperParameterTuningJobSearchEntity$LastModifiedTime' => '

The time that a hyperparameter tuning job was last modified.

', 'HyperParameterTuningJobSummary$CreationTime' => '

The date and time that the tuning job was created.

', 'HyperParameterTuningJobSummary$HyperParameterTuningEndTime' => '

The date and time that the tuning job ended.

', 'HyperParameterTuningJobSummary$LastModifiedTime' => '

The date and time that the tuning job was modified.

', 'Image$CreationTime' => '

When the image was created.

', 'Image$LastModifiedTime' => '

When the image was last modified.

', 'ImageVersion$CreationTime' => '

When the version was created.

', 'ImageVersion$LastModifiedTime' => '

When the version was last modified.

', 'InferenceComponentSummary$CreationTime' => '

The time when the inference component was created.

', 'InferenceComponentSummary$LastModifiedTime' => '

The time when the inference component was last updated.

', 'InferenceExperimentSchedule$StartTime' => '

The timestamp at which the inference experiment started or will start.

', 'InferenceExperimentSchedule$EndTime' => '

The timestamp at which the inference experiment ended or will end.

', 'InferenceExperimentSummary$CreationTime' => '

The timestamp at which the inference experiment was created.

', 'InferenceExperimentSummary$CompletionTime' => '

The timestamp at which the inference experiment was completed.

', 'InferenceExperimentSummary$LastModifiedTime' => '

The timestamp when you last modified the inference experiment.

', 'InferenceRecommendationsJob$CompletionTime' => '

A timestamp that shows when the job completed.

', 'LabelingJobForWorkteamSummary$CreationTime' => '

The date and time that the labeling job was created.

', 'LabelingJobSummary$CreationTime' => '

The date and time that the job was created (timestamp).

', 'LabelingJobSummary$LastModifiedTime' => '

The date and time that the job was last modified (timestamp).

', 'LineageGroupSummary$CreationTime' => '

The creation time of the lineage group summary.

', 'LineageGroupSummary$LastModifiedTime' => '

The last modified time of the lineage group summary.

', 'ListActionsRequest$CreatedAfter' => '

A filter that returns only actions created on or after the specified time.

', 'ListActionsRequest$CreatedBefore' => '

A filter that returns only actions created on or before the specified time.

', 'ListAppImageConfigsRequest$CreationTimeBefore' => '

A filter that returns only AppImageConfigs created on or before the specified time.

', 'ListAppImageConfigsRequest$CreationTimeAfter' => '

A filter that returns only AppImageConfigs created on or after the specified time.

', 'ListAppImageConfigsRequest$ModifiedTimeBefore' => '

A filter that returns only AppImageConfigs modified on or before the specified time.

', 'ListAppImageConfigsRequest$ModifiedTimeAfter' => '

A filter that returns only AppImageConfigs modified on or after the specified time.

', 'ListArtifactsRequest$CreatedAfter' => '

A filter that returns only artifacts created on or after the specified time.

', 'ListArtifactsRequest$CreatedBefore' => '

A filter that returns only artifacts created on or before the specified time.

', 'ListAssociationsRequest$CreatedAfter' => '

A filter that returns only associations created on or after the specified time.

', 'ListAssociationsRequest$CreatedBefore' => '

A filter that returns only associations created on or before the specified time.

', 'ListAutoMLJobsRequest$CreationTimeAfter' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$CreationTimeBefore' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$LastModifiedTimeAfter' => '

Request a list of jobs, using a filter for time.

', 'ListAutoMLJobsRequest$LastModifiedTimeBefore' => '

Request a list of jobs, using a filter for time.

', 'ListClusterNodesRequest$CreationTimeAfter' => '

A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClusterNodesRequest$CreationTimeBefore' => '

A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClustersRequest$CreationTimeAfter' => '

Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListClustersRequest$CreationTimeBefore' => '

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

', 'ListCodeRepositoriesInput$LastModifiedTimeAfter' => '

A filter that returns only Git repositories that were last modified after the specified time.

', 'ListCodeRepositoriesInput$LastModifiedTimeBefore' => '

A filter that returns only Git repositories that were last modified before the specified time.

', 'ListContextsRequest$CreatedAfter' => '

A filter that returns only contexts created on or after the specified time.

', 'ListContextsRequest$CreatedBefore' => '

A filter that returns only contexts created on or before the specified time.

', 'ListDataQualityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only data quality monitoring job definitions created before the specified time.

', 'ListDataQualityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only data quality monitoring job definitions created after the specified time.

', 'ListDeviceFleetsRequest$CreationTimeAfter' => '

Filter fleets where packaging job was created after specified time.

', 'ListDeviceFleetsRequest$CreationTimeBefore' => '

Filter fleets where the edge packaging job was created before specified time.

', 'ListDeviceFleetsRequest$LastModifiedTimeAfter' => '

Select fleets where the job was updated after X

', 'ListDeviceFleetsRequest$LastModifiedTimeBefore' => '

Select fleets where the job was updated before X

', 'ListDevicesRequest$LatestHeartbeatAfter' => '

Select fleets where the job was updated after X

', 'ListEdgeDeploymentPlansRequest$CreationTimeAfter' => '

Selects edge deployment plans created after this time.

', 'ListEdgeDeploymentPlansRequest$CreationTimeBefore' => '

Selects edge deployment plans created before this time.

', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeAfter' => '

Selects edge deployment plans that were last updated after this time.

', 'ListEdgeDeploymentPlansRequest$LastModifiedTimeBefore' => '

Selects edge deployment plans that were last updated before this time.

', 'ListEdgePackagingJobsRequest$CreationTimeAfter' => '

Select jobs where the job was created after specified time.

', 'ListEdgePackagingJobsRequest$CreationTimeBefore' => '

Select jobs where the job was created before specified time.

', 'ListEdgePackagingJobsRequest$LastModifiedTimeAfter' => '

Select jobs where the job was updated after specified time.

', 'ListEdgePackagingJobsRequest$LastModifiedTimeBefore' => '

Select jobs where the job was updated before specified time.

', 'ListEndpointConfigsInput$CreationTimeBefore' => '

A filter that returns only endpoint configurations created before the specified time (timestamp).

', 'ListEndpointConfigsInput$CreationTimeAfter' => '

A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).

', 'ListEndpointsInput$CreationTimeBefore' => '

A filter that returns only endpoints that were created before the specified time (timestamp).

', 'ListEndpointsInput$CreationTimeAfter' => '

A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

', 'ListEndpointsInput$LastModifiedTimeBefore' => '

A filter that returns only endpoints that were modified before the specified timestamp.

', 'ListEndpointsInput$LastModifiedTimeAfter' => '

A filter that returns only endpoints that were modified after the specified timestamp.

', 'ListExperimentsRequest$CreatedAfter' => '

A filter that returns only experiments created after the specified time.

', 'ListExperimentsRequest$CreatedBefore' => '

A filter that returns only experiments created before the specified time.

', 'ListFlowDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

', 'ListFlowDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only flow definitions that were created before the specified timestamp.

', 'ListHubContentVersionsRequest$CreationTimeBefore' => '

Only list hub content versions that were created before the time specified.

', 'ListHubContentVersionsRequest$CreationTimeAfter' => '

Only list hub content versions that were created after the time specified.

', 'ListHubContentsRequest$CreationTimeBefore' => '

Only list hub content that was created before the time specified.

', 'ListHubContentsRequest$CreationTimeAfter' => '

Only list hub content that was created after the time specified.

', 'ListHubsRequest$CreationTimeBefore' => '

Only list hubs that were created before the time specified.

', 'ListHubsRequest$CreationTimeAfter' => '

Only list hubs that were created after the time specified.

', 'ListHubsRequest$LastModifiedTimeBefore' => '

Only list hubs that were last modified before the time specified.

', 'ListHubsRequest$LastModifiedTimeAfter' => '

Only list hubs that were last modified after the time specified.

', 'ListHumanTaskUisRequest$CreationTimeAfter' => '

A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

', 'ListHumanTaskUisRequest$CreationTimeBefore' => '

A filter that returns only human task user interfaces that were created before the specified timestamp.

', 'ListHyperParameterTuningJobsRequest$CreationTimeAfter' => '

A filter that returns only tuning jobs that were created after the specified time.

', 'ListHyperParameterTuningJobsRequest$CreationTimeBefore' => '

A filter that returns only tuning jobs that were created before the specified time.

', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only tuning jobs that were modified after the specified time.

', 'ListHyperParameterTuningJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only tuning jobs that were modified before the specified time.

', 'ListImageVersionsRequest$CreationTimeAfter' => '

A filter that returns only versions created on or after the specified time.

', 'ListImageVersionsRequest$CreationTimeBefore' => '

A filter that returns only versions created on or before the specified time.

', 'ListImageVersionsRequest$LastModifiedTimeAfter' => '

A filter that returns only versions modified on or after the specified time.

', 'ListImageVersionsRequest$LastModifiedTimeBefore' => '

A filter that returns only versions modified on or before the specified time.

', 'ListImagesRequest$CreationTimeAfter' => '

A filter that returns only images created on or after the specified time.

', 'ListImagesRequest$CreationTimeBefore' => '

A filter that returns only images created on or before the specified time.

', 'ListImagesRequest$LastModifiedTimeAfter' => '

A filter that returns only images modified on or after the specified time.

', 'ListImagesRequest$LastModifiedTimeBefore' => '

A filter that returns only images modified on or before the specified time.

', 'ListInferenceComponentsInput$CreationTimeBefore' => '

Filters the results to only those inference components that were created before the specified time.

', 'ListInferenceComponentsInput$CreationTimeAfter' => '

Filters the results to only those inference components that were created after the specified time.

', 'ListInferenceComponentsInput$LastModifiedTimeBefore' => '

Filters the results to only those inference components that were updated before the specified time.

', 'ListInferenceComponentsInput$LastModifiedTimeAfter' => '

Filters the results to only those inference components that were updated after the specified time.

', 'ListInferenceExperimentsRequest$CreationTimeAfter' => '

Selects inference experiments which were created after this timestamp.

', 'ListInferenceExperimentsRequest$CreationTimeBefore' => '

Selects inference experiments which were created before this timestamp.

', 'ListInferenceExperimentsRequest$LastModifiedTimeAfter' => '

Selects inference experiments which were last modified after this timestamp.

', 'ListInferenceExperimentsRequest$LastModifiedTimeBefore' => '

Selects inference experiments which were last modified before this timestamp.

', 'ListLabelingJobsForWorkteamRequest$CreationTimeAfter' => '

A filter that returns only labeling jobs created after the specified time (timestamp).

', 'ListLabelingJobsForWorkteamRequest$CreationTimeBefore' => '

A filter that returns only labeling jobs created before the specified time (timestamp).

', 'ListLabelingJobsRequest$CreationTimeAfter' => '

A filter that returns only labeling jobs created after the specified time (timestamp).

', 'ListLabelingJobsRequest$CreationTimeBefore' => '

A filter that returns only labeling jobs created before the specified time (timestamp).

', 'ListLabelingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only labeling jobs modified after the specified time (timestamp).

', 'ListLabelingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only labeling jobs modified before the specified time (timestamp).

', 'ListLineageGroupsRequest$CreatedAfter' => '

A timestamp to filter against lineage groups created after a certain point in time.

', 'ListLineageGroupsRequest$CreatedBefore' => '

A timestamp to filter against lineage groups created before a certain point in time.

', 'ListModelBiasJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model bias jobs created before a specified time.

', 'ListModelBiasJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model bias jobs created after a specified time.

', 'ListModelCardExportJobsRequest$CreationTimeAfter' => '

Only list model card export jobs that were created after the time specified.

', 'ListModelCardExportJobsRequest$CreationTimeBefore' => '

Only list model card export jobs that were created before the time specified.

', 'ListModelCardVersionsRequest$CreationTimeAfter' => '

Only list model card versions that were created after the time specified.

', 'ListModelCardVersionsRequest$CreationTimeBefore' => '

Only list model card versions that were created before the time specified.

', 'ListModelCardsRequest$CreationTimeAfter' => '

Only list model cards that were created after the time specified.

', 'ListModelCardsRequest$CreationTimeBefore' => '

Only list model cards that were created before the time specified.

', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model explainability jobs created before a specified time.

', 'ListModelExplainabilityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model explainability jobs created after a specified time.

', 'ListModelQualityJobDefinitionsRequest$CreationTimeBefore' => '

A filter that returns only model quality monitoring job definitions created before the specified time.

', 'ListModelQualityJobDefinitionsRequest$CreationTimeAfter' => '

A filter that returns only model quality monitoring job definitions created after the specified time.

', 'ListModelsInput$CreationTimeBefore' => '

A filter that returns only models created before the specified time (timestamp).

', 'ListModelsInput$CreationTimeAfter' => '

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

', 'ListMonitoringAlertHistoryRequest$CreationTimeBefore' => '

A filter that returns only alerts created on or before the specified time.

', 'ListMonitoringAlertHistoryRequest$CreationTimeAfter' => '

A filter that returns only alerts created on or after the specified time.

', 'ListMonitoringExecutionsRequest$ScheduledTimeBefore' => '

Filter for jobs scheduled before a specified time.

', 'ListMonitoringExecutionsRequest$ScheduledTimeAfter' => '

Filter for jobs scheduled after a specified time.

', 'ListMonitoringExecutionsRequest$CreationTimeBefore' => '

A filter that returns only jobs created before a specified time.

', 'ListMonitoringExecutionsRequest$CreationTimeAfter' => '

A filter that returns only jobs created after a specified time.

', 'ListMonitoringExecutionsRequest$LastModifiedTimeBefore' => '

A filter that returns only jobs modified after a specified time.

', 'ListMonitoringExecutionsRequest$LastModifiedTimeAfter' => '

A filter that returns only jobs modified before a specified time.

', 'ListMonitoringSchedulesRequest$CreationTimeBefore' => '

A filter that returns only monitoring schedules created before a specified time.

', 'ListMonitoringSchedulesRequest$CreationTimeAfter' => '

A filter that returns only monitoring schedules created after a specified time.

', 'ListMonitoringSchedulesRequest$LastModifiedTimeBefore' => '

A filter that returns only monitoring schedules modified before a specified time.

', 'ListMonitoringSchedulesRequest$LastModifiedTimeAfter' => '

A filter that returns only monitoring schedules modified after a specified time.

', 'ListPipelineExecutionsRequest$CreatedAfter' => '

A filter that returns the pipeline executions that were created after a specified time.

', 'ListPipelineExecutionsRequest$CreatedBefore' => '

A filter that returns the pipeline executions that were created before a specified time.

', 'ListPipelinesRequest$CreatedAfter' => '

A filter that returns the pipelines that were created after a specified time.

', 'ListPipelinesRequest$CreatedBefore' => '

A filter that returns the pipelines that were created before a specified time.

', 'ListProcessingJobsRequest$CreationTimeAfter' => '

A filter that returns only processing jobs created after the specified time.

', 'ListProcessingJobsRequest$CreationTimeBefore' => '

A filter that returns only processing jobs created after the specified time.

', 'ListProcessingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only processing jobs modified after the specified time.

', 'ListProcessingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only processing jobs modified before the specified time.

', 'ListProjectsInput$CreationTimeAfter' => '

A filter that returns the projects that were created after a specified time.

', 'ListProjectsInput$CreationTimeBefore' => '

A filter that returns the projects that were created before a specified time.

', 'ListResourceCatalogsRequest$CreationTimeAfter' => '

Use this parameter to search for ResourceCatalogs created after a specific date and time.

', 'ListResourceCatalogsRequest$CreationTimeBefore' => '

Use this parameter to search for ResourceCatalogs created before a specific date and time.

', 'ListStudioLifecycleConfigsRequest$CreationTimeBefore' => '

A filter that returns only Lifecycle Configurations created on or before the specified time.

', 'ListStudioLifecycleConfigsRequest$CreationTimeAfter' => '

A filter that returns only Lifecycle Configurations created on or after the specified time.

', 'ListStudioLifecycleConfigsRequest$ModifiedTimeBefore' => '

A filter that returns only Lifecycle Configurations modified before the specified time.

', 'ListStudioLifecycleConfigsRequest$ModifiedTimeAfter' => '

A filter that returns only Lifecycle Configurations modified after the specified time.

', 'ListTrainingJobsRequest$CreationTimeAfter' => '

A filter that returns only training jobs created after the specified time (timestamp).

', 'ListTrainingJobsRequest$CreationTimeBefore' => '

A filter that returns only training jobs created before the specified time (timestamp).

', 'ListTrainingJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only training jobs modified after the specified time (timestamp).

', 'ListTrainingJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only training jobs modified before the specified time (timestamp).

', 'ListTransformJobsRequest$CreationTimeAfter' => '

A filter that returns only transform jobs created after the specified time.

', 'ListTransformJobsRequest$CreationTimeBefore' => '

A filter that returns only transform jobs created before the specified time.

', 'ListTransformJobsRequest$LastModifiedTimeAfter' => '

A filter that returns only transform jobs modified after the specified time.

', 'ListTransformJobsRequest$LastModifiedTimeBefore' => '

A filter that returns only transform jobs modified before the specified time.

', 'ListTrialComponentsRequest$CreatedAfter' => '

A filter that returns only components created after the specified time.

', 'ListTrialComponentsRequest$CreatedBefore' => '

A filter that returns only components created before the specified time.

', 'ListTrialsRequest$CreatedAfter' => '

A filter that returns only trials created after the specified time.

', 'ListTrialsRequest$CreatedBefore' => '

A filter that returns only trials created before the specified time.

', 'MetricData$Timestamp' => '

The date and time that the algorithm emitted the metric.

', 'Model$CreationTime' => '

A timestamp that indicates when the model was created.

', 'ModelCard$CreationTime' => '

The date and time that the model card was created.

', 'ModelCard$LastModifiedTime' => '

The date and time that the model card was last modified.

', 'ModelCardExportJobSummary$CreatedAt' => '

The date and time that the model card export job was created.

', 'ModelCardExportJobSummary$LastModifiedAt' => '

The date and time that the model card export job was last modified..

', 'ModelCardSummary$CreationTime' => '

The date and time that the model card was created.

', 'ModelCardSummary$LastModifiedTime' => '

The date and time that the model card was last modified.

', 'ModelCardVersionSummary$CreationTime' => '

The date and time that the model card version was created.

', 'ModelCardVersionSummary$LastModifiedTime' => '

The time date and time that the model card version was last modified.

', 'ModelDashboardEndpoint$CreationTime' => '

A timestamp that indicates when the endpoint was created.

', 'ModelDashboardEndpoint$LastModifiedTime' => '

The last time the endpoint was modified.

', 'ModelDashboardModelCard$CreationTime' => '

A timestamp that indicates when the model card was created.

', 'ModelDashboardModelCard$LastModifiedTime' => '

A timestamp that indicates when the model card was last updated.

', 'ModelDashboardMonitoringSchedule$CreationTime' => '

A timestamp that indicates when the monitoring schedule was created.

', 'ModelDashboardMonitoringSchedule$LastModifiedTime' => '

A timestamp that indicates when the monitoring schedule was last updated.

', 'ModelPackage$LastModifiedTime' => '

The last time the model package was modified.

', 'ModelSummary$CreationTime' => '

A timestamp that indicates when the model was created.

', 'MonitoringAlertHistorySummary$CreationTime' => '

A timestamp that indicates when the first alert transition occurred in an alert history. An alert transition can be from status InAlert to OK, or from OK to InAlert.

', 'MonitoringAlertSummary$CreationTime' => '

A timestamp that indicates when a monitor alert was created.

', 'MonitoringAlertSummary$LastModifiedTime' => '

A timestamp that indicates when a monitor alert was last updated.

', 'MonitoringExecutionSummary$ScheduledTime' => '

The time the monitoring job was scheduled.

', 'MonitoringExecutionSummary$CreationTime' => '

The time at which the monitoring job was created.

', 'MonitoringExecutionSummary$LastModifiedTime' => '

A timestamp that indicates the last time the monitoring job was modified.

', 'MonitoringJobDefinitionSummary$CreationTime' => '

The time that the monitoring job was created.

', 'MonitoringSchedule$CreationTime' => '

The time that the monitoring schedule was created.

', 'MonitoringSchedule$LastModifiedTime' => '

The last time the monitoring schedule was changed.

', 'MonitoringScheduleSummary$CreationTime' => '

The creation time of the monitoring schedule.

', 'MonitoringScheduleSummary$LastModifiedTime' => '

The last time the monitoring schedule was modified.

', 'PendingDeploymentSummary$StartTime' => '

The start time of the deployment.

', 'Pipeline$CreationTime' => '

The creation time of the pipeline.

', 'Pipeline$LastModifiedTime' => '

The time that the pipeline was last modified.

', 'Pipeline$LastRunTime' => '

The time when the pipeline was last run.

', 'PipelineExecution$CreationTime' => '

The creation time of the pipeline execution.

', 'PipelineExecution$LastModifiedTime' => '

The time that the pipeline execution was last modified.

', 'PipelineExecutionStep$StartTime' => '

The time that the step started executing.

', 'PipelineExecutionStep$EndTime' => '

The time that the step stopped executing.

', 'PipelineExecutionSummary$StartTime' => '

The start time of the pipeline execution.

', 'PipelineSummary$CreationTime' => '

The creation time of the pipeline.

', 'PipelineSummary$LastModifiedTime' => '

The time that the pipeline was last modified.

', 'PipelineSummary$LastExecutionTime' => '

The last time that a pipeline execution began.

', 'ProcessingJob$ProcessingEndTime' => '

The time that the processing job ended.

', 'ProcessingJob$ProcessingStartTime' => '

The time that the processing job started.

', 'ProcessingJob$LastModifiedTime' => '

The time the processing job was last modified.

', 'ProcessingJob$CreationTime' => '

The time the processing job was created.

', 'ProcessingJobSummary$CreationTime' => '

The time at which the processing job was created.

', 'ProcessingJobSummary$ProcessingEndTime' => '

The time at which the processing job completed.

', 'ProcessingJobSummary$LastModifiedTime' => '

A timestamp that indicates the last time the processing job was modified.

', 'ProductionVariantStatus$StartTime' => '

The start time of the current status change.

', 'ProfilerRuleEvaluationStatus$LastModifiedTime' => '

Timestamp when the rule evaluation status was last modified.

', 'Project$CreationTime' => '

A timestamp specifying when the project was created.

', 'Project$LastModifiedTime' => '

A timestamp container for when the project was last modified.

', 'ProjectSummary$CreationTime' => '

The time that the project was created.

', 'QueryFilters$CreatedBefore' => '

Filter the lineage entities connected to the StartArn(s) by created date.

', 'QueryFilters$CreatedAfter' => '

Filter the lineage entities connected to the StartArn(s) after the create date.

', 'QueryFilters$ModifiedBefore' => '

Filter the lineage entities connected to the StartArn(s) before the last modified date.

', 'QueryFilters$ModifiedAfter' => '

Filter the lineage entities connected to the StartArn(s) after the last modified date.

', 'ResourceCatalog$CreationTime' => '

The time the ResourceCatalog was created.

', 'SecondaryStatusTransition$StartTime' => '

A timestamp that shows when the training job transitioned to the current secondary status state.

', 'SecondaryStatusTransition$EndTime' => '

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

', 'StudioLifecycleConfigDetails$CreationTime' => '

The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

', 'StudioLifecycleConfigDetails$LastModifiedTime' => '

This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

', 'TrainingJob$CreationTime' => '

A timestamp that indicates when the training job was created.

', 'TrainingJob$TrainingStartTime' => '

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

', 'TrainingJob$TrainingEndTime' => '

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

', 'TrainingJob$LastModifiedTime' => '

A timestamp that indicates when the status of the training job was last modified.

', 'TrainingJobSummary$CreationTime' => '

A timestamp that shows when the training job was created.

', 'TrainingJobSummary$TrainingEndTime' => '

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

', 'TrainingJobSummary$LastModifiedTime' => '

Timestamp when the training job was last modified.

', 'TransformJob$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'TransformJob$TransformStartTime' => '

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

', 'TransformJob$TransformEndTime' => '

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

', 'TransformJobSummary$CreationTime' => '

A timestamp that shows when the transform Job was created.

', 'TransformJobSummary$TransformEndTime' => '

Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

', 'TransformJobSummary$LastModifiedTime' => '

Indicates when the transform job was last modified.

', 'Trial$CreationTime' => '

When the trial was created.

', 'Trial$LastModifiedTime' => '

Who last modified the trial.

', 'TrialComponent$StartTime' => '

When the component started.

', 'TrialComponent$EndTime' => '

When the component ended.

', 'TrialComponent$CreationTime' => '

When the component was created.

', 'TrialComponent$LastModifiedTime' => '

When the component was last modified.

', 'TrialComponentMetricSummary$TimeStamp' => '

When the metric was last updated.

', 'TrialComponentSimpleSummary$CreationTime' => '

When the component was created.

', 'TrialComponentSummary$StartTime' => '

When the component started.

', 'TrialComponentSummary$EndTime' => '

When the component ended.

', 'TrialComponentSummary$CreationTime' => '

When the component was created.

', 'TrialComponentSummary$LastModifiedTime' => '

When the component was last modified.

', 'TrialSummary$CreationTime' => '

When the trial was created.

', 'TrialSummary$LastModifiedTime' => '

When the trial was last modified.

', 'UpdateTrialComponentRequest$StartTime' => '

When the component started.

', 'UpdateTrialComponentRequest$EndTime' => '

When the component ended.

', 'Workforce$LastUpdatedDate' => '

The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce\'s allow list.

', 'Workforce$CreateDate' => '

The date that the workforce is created.

', 'Workteam$CreateDate' => '

The date and time that the work team was created (timestamp).

', 'Workteam$LastUpdatedDate' => '

The date and time that the work team was last updated (timestamp).

', ], ], 'TimestampAttributeName' => [ 'base' => NULL, 'refs' => [ 'TimeSeriesConfig$TimestampAttributeName' => '

The name of the column indicating a point in time at which the target value of a given item is recorded.

', ], ], 'TrafficDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'Phase$DurationInSeconds' => '

Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600. This value should not exceed JobDurationInSeconds.

', 'Stairs$DurationInSeconds' => '

Defines how long each traffic step should be.

', ], ], 'TrafficPattern' => [ 'base' => '

Defines the traffic pattern of the load test.

', 'refs' => [ 'RecommendationJobInputConfig$TrafficPattern' => '

Specifies the traffic pattern of the job.

', ], ], 'TrafficRoutingConfig' => [ 'base' => '

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

', 'refs' => [ 'BlueGreenUpdatePolicy$TrafficRoutingConfiguration' => '

Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.

', ], ], 'TrafficRoutingConfigType' => [ 'base' => NULL, 'refs' => [ 'TrafficRoutingConfig$Type' => '

Traffic routing strategy type.

  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

', ], ], 'TrafficType' => [ 'base' => NULL, 'refs' => [ 'TrafficPattern$TrafficType' => '

Defines the traffic patterns. Choose either PHASES or STAIRS.

', ], ], 'TrainingContainerArgument' => [ 'base' => NULL, 'refs' => [ 'TrainingContainerArguments$member' => NULL, ], ], 'TrainingContainerArguments' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$ContainerArguments' => '

The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.

', ], ], 'TrainingContainerEntrypoint' => [ 'base' => NULL, 'refs' => [ 'AlgorithmSpecification$ContainerEntrypoint' => '

The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.

', ], ], 'TrainingContainerEntrypointString' => [ 'base' => NULL, 'refs' => [ 'TrainingContainerEntrypoint$member' => NULL, ], ], 'TrainingEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$key' => NULL, ], ], 'TrainingEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$Environment' => '

The environment variables to set in the Docker container.

', 'DescribeTrainingJobResponse$Environment' => '

The environment variables to set in the Docker container.

', 'TrainingJob$Environment' => '

The environment variables to set in the Docker container.

', ], ], 'TrainingEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TrainingEnvironmentMap$value' => NULL, ], ], 'TrainingImageConfig' => [ 'base' => '

The configuration to use an image from a private Docker registry for a training job.

', 'refs' => [ 'AlgorithmSpecification$TrainingImageConfig' => '

The configuration to use an image from a private Docker registry for a training job.

', ], ], 'TrainingInputMode' => [ 'base' => '

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won\'t be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren\'t supported. The startup time is lower when there are fewer files in the S3 bucket provided.

', 'refs' => [ 'AlgorithmSpecification$TrainingInputMode' => NULL, 'Channel$InputMode' => '

(Optional) The input mode to use for the data channel in a training job. If you don\'t set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job\'s general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

', 'HyperParameterAlgorithmSpecification$TrainingInputMode' => NULL, 'InputModes$member' => NULL, 'TrainingJobDefinition$TrainingInputMode' => NULL, ], ], 'TrainingInstanceCount' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$InstanceCount' => '

The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.

', 'HyperParameterTuningResourceConfig$InstanceCount' => '

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

', 'InstanceGroup$InstanceCount' => '

Specifies the number of instances of the instance group.

', 'ResourceConfig$InstanceCount' => '

The number of ML compute instances to use. For distributed training, provide a value greater than 1.

', ], ], 'TrainingInstanceType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$InstanceType' => '

The instance type used for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

', 'HyperParameterTuningResourceConfig$InstanceType' => '

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

', 'InstanceGroup$InstanceType' => '

Specifies the instance type of the instance group.

', 'ResourceConfig$InstanceType' => '

The ML compute instance type.

SageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting December 9th, 2022.

Amazon EC2 P4de instances (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance HBM2e GPU memory, which accelerate the speed of training ML models that need to be trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker supports ML training jobs on P4de instances (ml.p4de.24xlarge) to reduce model training time. The ml.p4de.24xlarge instances are available in the following Amazon Web Services Regions.

  • US East (N. Virginia) (us-east-1)

  • US West (Oregon) (us-west-2)

To request quota limit increase and start using P4de instances, contact the SageMaker Training service team through your account team.

', 'TrainingInstanceTypes$member' => NULL, ], ], 'TrainingInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'TrainingSpecification$SupportedTrainingInstanceTypes' => '

A list of the instance types that this algorithm can use for training.

', ], ], 'TrainingJob' => [ 'base' => '

Contains information about a training job.

', 'refs' => [ 'SearchRecord$TrainingJob' => '

The properties of a training job.

', 'TrialComponentSourceDetail$TrainingJob' => '

Information about a training job that\'s the source of a trial component.

', ], ], 'TrainingJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'DescribeProcessingJobResponse$TrainingJobArn' => '

The ARN of a training job associated with this processing job.

', 'DescribeTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'HyperParameterTrainingJobSummary$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'ProcessingJob$TrainingJobArn' => '

The ARN of the training job associated with this processing job.

', 'TrainingJob$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'TrainingJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

', 'TrainingJobSummary$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', 'UpdateTrainingJobResponse$TrainingJobArn' => '

The Amazon Resource Name (ARN) of the training job.

', ], ], 'TrainingJobDefinition' => [ 'base' => '

Defines the input needed to run a training job using the algorithm.

', 'refs' => [ 'AlgorithmValidationProfile$TrainingJobDefinition' => '

The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.

', ], ], 'TrainingJobEarlyStoppingType' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningJobConfig$TrainingJobEarlyStoppingType' => '

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

', ], ], 'TrainingJobName' => [ 'base' => NULL, 'refs' => [ 'CreateTrainingJobRequest$TrainingJobName' => '

The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeTrainingJobRequest$TrainingJobName' => '

The name of the training job.

', 'DescribeTrainingJobResponse$TrainingJobName' => '

Name of the model training job.

', 'HyperParameterTrainingJobSummary$TrainingJobName' => '

The name of the training job.

', 'StopTrainingJobRequest$TrainingJobName' => '

The name of the training job to stop.

', 'TrainingJob$TrainingJobName' => '

The name of the training job.

', 'TrainingJobSummary$TrainingJobName' => '

The name of the training job that you want a summary for.

', 'UpdateTrainingJobRequest$TrainingJobName' => '

The name of a training job to update the Debugger profiling configuration.

', 'WarmPoolStatus$ReusedByJob' => '

The name of the matching training job that reused the warm pool.

', ], ], 'TrainingJobSortByOptions' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsForHyperParameterTuningJobRequest$SortBy' => '

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

', ], ], 'TrainingJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$TrainingJobStatus' => '

The status of the training job.

SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

', 'HyperParameterTrainingJobSummary$TrainingJobStatus' => '

The status of the training job.

', 'ListTrainingJobsForHyperParameterTuningJobRequest$StatusEquals' => '

A filter that returns only training jobs with the specified status.

', 'ListTrainingJobsRequest$StatusEquals' => '

A filter that retrieves only training jobs with a specific status.

', 'TrainingJob$TrainingJobStatus' => '

The status of the training job.

Training job statuses are:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

', 'TrainingJobSummary$TrainingJobStatus' => '

The status of the training job.

', ], ], 'TrainingJobStatusCounter' => [ 'base' => NULL, 'refs' => [ 'TrainingJobStatusCounters$Completed' => '

The number of completed training jobs launched by the hyperparameter tuning job.

', 'TrainingJobStatusCounters$InProgress' => '

The number of in-progress training jobs launched by a hyperparameter tuning job.

', 'TrainingJobStatusCounters$RetryableError' => '

The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

', 'TrainingJobStatusCounters$NonRetryableError' => '

The number of training jobs that failed and can\'t be retried. A failed training job can\'t be retried if it failed because a client error occurred.

', 'TrainingJobStatusCounters$Stopped' => '

The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

', ], ], 'TrainingJobStatusCounters' => [ 'base' => '

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

', 'refs' => [ 'DescribeHyperParameterTuningJobResponse$TrainingJobStatusCounters' => '

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

', 'HyperParameterTuningJobSearchEntity$TrainingJobStatusCounters' => NULL, 'HyperParameterTuningJobSummary$TrainingJobStatusCounters' => '

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

', ], ], 'TrainingJobStepMetadata' => [ 'base' => '

Metadata for a training job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TrainingJob' => '

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

', ], ], 'TrainingJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsResponse$TrainingJobSummaries' => '

An array of TrainingJobSummary objects, each listing a training job.

', ], ], 'TrainingJobSummary' => [ 'base' => '

Provides summary information about a training job.

', 'refs' => [ 'TrainingJobSummaries$member' => NULL, ], ], 'TrainingRepositoryAccessMode' => [ 'base' => NULL, 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAccessMode' => '

The method that your training job will use to gain access to the images in your private Docker registry. For access to an image in a private Docker registry, set to Vpc.

', ], ], 'TrainingRepositoryAuthConfig' => [ 'base' => '

An object containing authentication information for a private Docker registry.

', 'refs' => [ 'TrainingImageConfig$TrainingRepositoryAuthConfig' => '

An object containing authentication information for a private Docker registry containing your training images.

', ], ], 'TrainingRepositoryCredentialsProviderArn' => [ 'base' => NULL, 'refs' => [ 'TrainingRepositoryAuthConfig$TrainingRepositoryCredentialsProviderArn' => '

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access credentials to your private Docker registry.

', ], ], 'TrainingSpecification' => [ 'base' => '

Defines how the algorithm is used for a training job.

', 'refs' => [ 'CreateAlgorithmInput$TrainingSpecification' => '

Specifies details about training jobs run by this algorithm, including the following:

  • The Amazon ECR path of the container and the version digest of the algorithm.

  • The hyperparameters that the algorithm supports.

  • The instance types that the algorithm supports for training.

  • Whether the algorithm supports distributed training.

  • The metrics that the algorithm emits to Amazon CloudWatch.

  • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

  • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

', 'DescribeAlgorithmOutput$TrainingSpecification' => '

Details about training jobs run by this algorithm.

', ], ], 'TrainingTimeInSeconds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrainingJobResponse$TrainingTimeInSeconds' => '

The training time in seconds.

', 'TrainingJob$TrainingTimeInSeconds' => '

The training time in seconds.

', ], ], 'TransformDataSource' => [ 'base' => '

Describes the location of the channel data.

', 'refs' => [ 'TransformInput$DataSource' => '

Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

', ], ], 'TransformEnvironmentKey' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$key' => NULL, ], ], 'TransformEnvironmentMap' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'DescribeTransformJobResponse$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'TransformJob$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', 'TransformJobDefinition$Environment' => '

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

', ], ], 'TransformEnvironmentValue' => [ 'base' => NULL, 'refs' => [ 'TransformEnvironmentMap$value' => NULL, ], ], 'TransformInput' => [ 'base' => '

Describes the input source of a transform job and the way the transform job consumes it.

', 'refs' => [ 'CreateTransformJobRequest$TransformInput' => '

Describes the input source and the way the transform job consumes it.

', 'DescribeTransformJobResponse$TransformInput' => '

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

', 'TransformJob$TransformInput' => NULL, 'TransformJobDefinition$TransformInput' => '

A description of the input source and the way the transform job consumes it.

', ], ], 'TransformInstanceCount' => [ 'base' => NULL, 'refs' => [ 'TransformResources$InstanceCount' => '

The number of ML compute instances to use in the transform job. The default value is 1, and the maximum is 100. For distributed transform jobs, specify a value greater than 1.

', ], ], 'TransformInstanceType' => [ 'base' => NULL, 'refs' => [ 'TransformInstanceTypes$member' => NULL, 'TransformResources$InstanceType' => '

The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.

', ], ], 'TransformInstanceTypes' => [ 'base' => NULL, 'refs' => [ 'AdditionalInferenceSpecificationDefinition$SupportedTransformInstanceTypes' => '

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

', 'InferenceSpecification$SupportedTransformInstanceTypes' => '

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

', ], ], 'TransformJob' => [ 'base' => '

A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.

', 'refs' => [ 'ModelDashboardModel$LastBatchTransformJob' => NULL, 'TrialComponentSourceDetail$TransformJob' => '

Information about a transform job that\'s the source of a trial component.

', ], ], 'TransformJobArn' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobResponse$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'DescribeTransformJobResponse$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'TransformJob$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', 'TransformJobStepMetadata$Arn' => '

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

', 'TransformJobSummary$TransformJobArn' => '

The Amazon Resource Name (ARN) of the transform job.

', ], ], 'TransformJobDefinition' => [ 'base' => '

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

', 'refs' => [ 'AlgorithmValidationProfile$TransformJobDefinition' => '

The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.

', 'ModelPackageValidationProfile$TransformJobDefinition' => '

The TransformJobDefinition object that describes the transform job used for the validation of the model package.

', ], ], 'TransformJobName' => [ 'base' => NULL, 'refs' => [ 'CreateTransformJobRequest$TransformJobName' => '

The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

', 'DescribeTransformJobRequest$TransformJobName' => '

The name of the transform job that you want to view details of.

', 'DescribeTransformJobResponse$TransformJobName' => '

The name of the transform job.

', 'StopTransformJobRequest$TransformJobName' => '

The name of the batch transform job to stop.

', 'TransformJob$TransformJobName' => '

The name of the transform job.

', 'TransformJobSummary$TransformJobName' => '

The name of the transform job.

', ], ], 'TransformJobStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTransformJobResponse$TransformJobStatus' => '

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

', 'ListTransformJobsRequest$StatusEquals' => '

A filter that retrieves only transform jobs with a specific status.

', 'TransformJob$TransformJobStatus' => '

The status of the transform job.

Transform job statuses are:

  • InProgress - The job is in progress.

  • Completed - The job has completed.

  • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.

  • Stopping - The transform job is stopping.

  • Stopped - The transform job has stopped.

', 'TransformJobSummary$TransformJobStatus' => '

The status of the transform job.

', ], ], 'TransformJobStepMetadata' => [ 'base' => '

Metadata for a transform job step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TransformJob' => '

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

', ], ], 'TransformJobSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTransformJobsResponse$TransformJobSummaries' => '

An array of TransformJobSummary objects.

', ], ], 'TransformJobSummary' => [ 'base' => '

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

', 'refs' => [ 'TransformJobSummaries$member' => NULL, ], ], 'TransformOutput' => [ 'base' => '

Describes the results of a transform job.

', 'refs' => [ 'CreateTransformJobRequest$TransformOutput' => '

Describes the results of the transform job.

', 'DescribeTransformJobResponse$TransformOutput' => '

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

', 'TransformJob$TransformOutput' => NULL, 'TransformJobDefinition$TransformOutput' => '

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

', ], ], 'TransformResources' => [ 'base' => '

Describes the resources, including ML instance types and ML instance count, to use for transform job.

', 'refs' => [ 'CreateTransformJobRequest$TransformResources' => '

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

', 'DescribeTransformJobResponse$TransformResources' => '

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

', 'TransformJob$TransformResources' => NULL, 'TransformJobDefinition$TransformResources' => '

Identifies the ML compute instances for the transform job.

', ], ], 'TransformS3DataSource' => [ 'base' => '

Describes the S3 data source.

', 'refs' => [ 'TransformDataSource$S3DataSource' => '

The S3 location of the data source that is associated with a channel.

', ], ], 'TransformationAttributeName' => [ 'base' => NULL, 'refs' => [ 'AggregationTransformations$key' => NULL, 'FillingTransformations$key' => NULL, ], ], 'Trial' => [ 'base' => '

The properties of a trial as returned by the Search API.

', 'refs' => [ 'SearchRecord$Trial' => '

The properties of a trial.

', ], ], 'TrialArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'CreateTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'DeleteTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial that is being deleted.

', 'DescribeTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'DisassociateTrialComponentResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'Trial$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'TrialSummary$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', 'UpdateTrialResponse$TrialArn' => '

The Amazon Resource Name (ARN) of the trial.

', ], ], 'TrialComponent' => [ 'base' => '

The properties of a trial component as returned by the Search API.

', 'refs' => [ 'SearchRecord$TrialComponent' => '

The properties of a trial component.

', ], ], 'TrialComponentArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'CreateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'DeleteTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the component is being deleted.

', 'DescribeTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'DisassociateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponent$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponentSimpleSummary$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'TrialComponentSummary$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', 'UpdateTrialComponentResponse$TrialComponentArn' => '

The Amazon Resource Name (ARN) of the trial component.

', ], ], 'TrialComponentArtifact' => [ 'base' => '

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

', 'refs' => [ 'TrialComponentArtifacts$value' => NULL, ], ], 'TrialComponentArtifactValue' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifact$Value' => '

The location of the artifact.

', ], ], 'TrialComponentArtifacts' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$InputArtifacts' => '

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

', 'CreateTrialComponentRequest$OutputArtifacts' => '

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

', 'DescribeTrialComponentResponse$InputArtifacts' => '

The input artifacts of the component.

', 'DescribeTrialComponentResponse$OutputArtifacts' => '

The output artifacts of the component.

', 'TrialComponent$InputArtifacts' => '

The input artifacts of the component.

', 'TrialComponent$OutputArtifacts' => '

The output artifacts of the component.

', 'UpdateTrialComponentRequest$InputArtifacts' => '

Replaces all of the component\'s input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

', 'UpdateTrialComponentRequest$OutputArtifacts' => '

Replaces all of the component\'s output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

', ], ], 'TrialComponentKey128' => [ 'base' => NULL, 'refs' => [ 'TrialComponentArtifacts$key' => NULL, ], ], 'TrialComponentKey256' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentKey256$member' => NULL, ], ], 'TrialComponentKey320' => [ 'base' => NULL, 'refs' => [ 'TrialComponentParameters$key' => NULL, ], ], 'TrialComponentMetricSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Metrics' => '

The metrics for the component.

', 'TrialComponent$Metrics' => '

The metrics for the component.

', ], ], 'TrialComponentMetricSummary' => [ 'base' => '

A summary of the metrics of a trial component.

', 'refs' => [ 'TrialComponentMetricSummaries$member' => NULL, ], ], 'TrialComponentParameterValue' => [ 'base' => '

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

This object is specified in the CreateTrialComponent request.

', 'refs' => [ 'TrialComponentParameters$value' => NULL, ], ], 'TrialComponentParameters' => [ 'base' => NULL, 'refs' => [ 'CreateTrialComponentRequest$Parameters' => '

The hyperparameters for the component.

', 'DescribeTrialComponentResponse$Parameters' => '

The hyperparameters of the component.

', 'TrialComponent$Parameters' => '

The hyperparameters of the component.

', 'UpdateTrialComponentRequest$Parameters' => '

Replaces all of the component\'s hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

', ], ], 'TrialComponentPrimaryStatus' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$PrimaryStatus' => '

The status of the trial component.

', ], ], 'TrialComponentSimpleSummaries' => [ 'base' => NULL, 'refs' => [ 'Trial$TrialComponentSummaries' => '

A list of the components associated with the trial. For each component, a summary of the component\'s properties is included.

', ], ], 'TrialComponentSimpleSummary' => [ 'base' => '

A short summary of a trial component.

', 'refs' => [ 'TrialComponentSimpleSummaries$member' => NULL, ], ], 'TrialComponentSource' => [ 'base' => '

The Amazon Resource Name (ARN) and job type of the source of a trial component.

', 'refs' => [ 'DescribeTrialComponentResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

', 'TrialComponent$Source' => '

The Amazon Resource Name (ARN) and job type of the source of the component.

', 'TrialComponentSimpleSummary$TrialComponentSource' => NULL, 'TrialComponentSources$member' => NULL, 'TrialComponentSummary$TrialComponentSource' => NULL, ], ], 'TrialComponentSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialComponentMetricSummary$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', 'TrialComponentSource$SourceArn' => '

The source Amazon Resource Name (ARN).

', 'TrialComponentSourceDetail$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'TrialComponentSourceDetail' => [ 'base' => '

Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.

', 'refs' => [ 'TrialComponent$SourceDetail' => '

Details of the source of the component.

', ], ], 'TrialComponentSources' => [ 'base' => NULL, 'refs' => [ 'DescribeTrialComponentResponse$Sources' => '

A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

', ], ], 'TrialComponentStatus' => [ 'base' => '

The status of the trial component.

', 'refs' => [ 'CreateTrialComponentRequest$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'DescribeTrialComponentResponse$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'TrialComponent$Status' => NULL, 'TrialComponentSummary$Status' => '

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

', 'UpdateTrialComponentRequest$Status' => '

The new status of the component.

', ], ], 'TrialComponentStatusMessage' => [ 'base' => NULL, 'refs' => [ 'TrialComponentStatus$Message' => '

If the component failed, a message describing why.

', ], ], 'TrialComponentSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialComponentsResponse$TrialComponentSummaries' => '

A list of the summaries of your trial components.

', ], ], 'TrialComponentSummary' => [ 'base' => '

A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.

', 'refs' => [ 'TrialComponentSummaries$member' => NULL, ], ], 'TrialSource' => [ 'base' => '

The source of the trial.

', 'refs' => [ 'DescribeTrialResponse$Source' => '

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

', 'Trial$Source' => NULL, 'TrialSummary$TrialSource' => NULL, ], ], 'TrialSourceArn' => [ 'base' => NULL, 'refs' => [ 'TrialSource$SourceArn' => '

The Amazon Resource Name (ARN) of the source.

', ], ], 'TrialSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTrialsResponse$TrialSummaries' => '

A list of the summaries of your trials.

', ], ], 'TrialSummary' => [ 'base' => '

A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.

', 'refs' => [ 'TrialSummaries$member' => NULL, ], ], 'TtlDuration' => [ 'base' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', 'refs' => [ 'OnlineStoreConfig$TtlDuration' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', 'OnlineStoreConfigUpdate$TtlDuration' => '

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

', ], ], 'TtlDurationUnit' => [ 'base' => NULL, 'refs' => [ 'TtlDuration$Unit' => '

TtlDuration time unit.

', ], ], 'TtlDurationValue' => [ 'base' => NULL, 'refs' => [ 'TtlDuration$Value' => '

TtlDuration time value.

', ], ], 'TuningJobCompletionCriteria' => [ 'base' => '

The job completion criteria.

', 'refs' => [ 'HyperParameterTuningJobConfig$TuningJobCompletionCriteria' => '

The tuning job\'s completion criteria.

', ], ], 'TuningJobStepMetaData' => [ 'base' => '

Metadata for a tuning step.

', 'refs' => [ 'PipelineExecutionStepMetadata$TuningJob' => '

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

', ], ], 'USD' => [ 'base' => '

Represents an amount of money in United States dollars.

', 'refs' => [ 'PublicWorkforceTaskPrice$AmountInUsd' => '

Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

', ], ], 'UiConfig' => [ 'base' => '

Provided configuration information for the worker UI for a labeling job. Provide either HumanTaskUiArn or UiTemplateS3Uri.

For named entity recognition, 3D point cloud and video frame labeling jobs, use HumanTaskUiArn.

For all other Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to specify the location of a worker task template in Amazon S3.

', 'refs' => [ 'HumanTaskConfig$UiConfig' => '

Information about the user interface that workers use to complete the labeling task.

', ], ], 'UiTemplate' => [ 'base' => '

The Liquid template for the worker user interface.

', 'refs' => [ 'CreateHumanTaskUiRequest$UiTemplate' => NULL, 'RenderUiTemplateRequest$UiTemplate' => '

A Template object containing the worker UI template to render.

', ], ], 'UiTemplateInfo' => [ 'base' => '

Container for user interface template information.

', 'refs' => [ 'DescribeHumanTaskUiResponse$UiTemplate' => NULL, ], ], 'Uid' => [ 'base' => NULL, 'refs' => [ 'CustomPosixUserConfig$Uid' => '

The POSIX user ID.

', ], ], 'UpdateActionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateActionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppImageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateArtifactResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCodeRepositoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContextResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEndpointWeightsAndCapacitiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFeatureMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateHubResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImageVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentRuntimeConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceComponentRuntimeConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInferenceExperimentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelCardResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelPackageOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringAlertResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMonitoringScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceLifecycleConfigOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNotebookInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineExecutionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSpaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrainingJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialComponentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrialResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkforceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkteamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'AutoMLContainerDefinition$ModelDataUrl' => '

The location of the model artifacts. For more information, see ContainerDefinition.

', 'ClarifyShapBaselineConfig$ShapBaselineUri' => '

The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.

', 'ContainerDefinition$ModelDataUrl' => '

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

', 'InferenceComponentContainerSpecification$ArtifactUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

', 'InferenceComponentContainerSpecificationSummary$ArtifactUrl' => '

The Amazon S3 path where the model artifacts are stored.

', 'ModelPackageContainerDefinition$ModelDataUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

', 'SourceAlgorithm$ModelDataUrl' => '

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the algorithm.

', ], ], 'UserContext' => [ 'base' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

', 'refs' => [ 'AssociationSummary$CreatedBy' => NULL, 'DescribeActionResponse$CreatedBy' => NULL, 'DescribeActionResponse$LastModifiedBy' => NULL, 'DescribeArtifactResponse$CreatedBy' => NULL, 'DescribeArtifactResponse$LastModifiedBy' => NULL, 'DescribeContextResponse$CreatedBy' => NULL, 'DescribeContextResponse$LastModifiedBy' => NULL, 'DescribeExperimentResponse$CreatedBy' => '

Who created the experiment.

', 'DescribeExperimentResponse$LastModifiedBy' => '

Who last modified the experiment.

', 'DescribeLineageGroupResponse$CreatedBy' => NULL, 'DescribeLineageGroupResponse$LastModifiedBy' => NULL, 'DescribeModelCardResponse$CreatedBy' => NULL, 'DescribeModelCardResponse$LastModifiedBy' => NULL, 'DescribeModelPackageGroupOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$CreatedBy' => NULL, 'DescribeModelPackageOutput$LastModifiedBy' => NULL, 'DescribePipelineExecutionResponse$CreatedBy' => NULL, 'DescribePipelineExecutionResponse$LastModifiedBy' => NULL, 'DescribePipelineResponse$CreatedBy' => NULL, 'DescribePipelineResponse$LastModifiedBy' => NULL, 'DescribeProjectOutput$CreatedBy' => NULL, 'DescribeProjectOutput$LastModifiedBy' => NULL, 'DescribeTrialComponentResponse$CreatedBy' => '

Who created the trial component.

', 'DescribeTrialComponentResponse$LastModifiedBy' => '

Who last modified the component.

', 'DescribeTrialResponse$CreatedBy' => '

Who created the trial.

', 'DescribeTrialResponse$LastModifiedBy' => '

Who last modified the trial.

', 'Experiment$CreatedBy' => '

Who created the experiment.

', 'Experiment$LastModifiedBy' => NULL, 'ModelCard$CreatedBy' => NULL, 'ModelCard$LastModifiedBy' => NULL, 'ModelDashboardModelCard$CreatedBy' => NULL, 'ModelDashboardModelCard$LastModifiedBy' => NULL, 'ModelPackage$CreatedBy' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

', 'ModelPackage$LastModifiedBy' => '

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

', 'ModelPackageGroup$CreatedBy' => NULL, 'Pipeline$CreatedBy' => NULL, 'Pipeline$LastModifiedBy' => NULL, 'PipelineExecution$CreatedBy' => NULL, 'PipelineExecution$LastModifiedBy' => NULL, 'Project$CreatedBy' => '

Who created the project.

', 'Project$LastModifiedBy' => NULL, 'Trial$CreatedBy' => '

Who created the trial.

', 'Trial$LastModifiedBy' => NULL, 'TrialComponent$CreatedBy' => '

Who created the trial component.

', 'TrialComponent$LastModifiedBy' => NULL, 'TrialComponentSimpleSummary$CreatedBy' => NULL, 'TrialComponentSummary$CreatedBy' => '

Who created the trial component.

', 'TrialComponentSummary$LastModifiedBy' => '

Who last modified the component.

', ], ], 'UserProfileArn' => [ 'base' => NULL, 'refs' => [ 'CreateUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', 'DescribeUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', 'UpdateUserProfileResponse$UserProfileArn' => '

The user profile Amazon Resource Name (ARN).

', ], ], 'UserProfileDetails' => [ 'base' => '

The user profile details.

', 'refs' => [ 'UserProfileList$member' => NULL, ], ], 'UserProfileList' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesResponse$UserProfiles' => '

The list of user profiles.

', ], ], 'UserProfileName' => [ 'base' => NULL, 'refs' => [ 'AppDetails$UserProfileName' => '

The user profile name.

', 'CreateAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'CreatePresignedDomainUrlRequest$UserProfileName' => '

The name of the UserProfile to sign-in as.

', 'CreateUserProfileRequest$UserProfileName' => '

A name for the UserProfile. This value is not case sensitive.

', 'DeleteAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'DeleteUserProfileRequest$UserProfileName' => '

The user profile name.

', 'DescribeAppRequest$UserProfileName' => '

The user profile name. If this value is not set, then SpaceName must be set.

', 'DescribeAppResponse$UserProfileName' => '

The user profile name.

', 'DescribeUserProfileRequest$UserProfileName' => '

The user profile name. This value is not case sensitive.

', 'DescribeUserProfileResponse$UserProfileName' => '

The user profile name.

', 'ListAppsRequest$UserProfileNameEquals' => '

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

', 'ListUserProfilesRequest$UserProfileNameContains' => '

A parameter by which to filter the results.

', 'OwnershipSettings$OwnerUserProfileName' => '

The user profile who is the owner of the private space.

', 'OwnershipSettingsSummary$OwnerUserProfileName' => '

The user profile who is the owner of the private space.

', 'UpdateUserProfileRequest$UserProfileName' => '

The user profile name.

', 'UserProfileDetails$UserProfileName' => '

The user profile name.

', ], ], 'UserProfileSortKey' => [ 'base' => NULL, 'refs' => [ 'ListUserProfilesRequest$SortBy' => '

The parameter by which to sort the results. The default is CreationTime.

', ], ], 'UserProfileStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeUserProfileResponse$Status' => '

The status.

', 'UserProfileDetails$Status' => '

The status.

', ], ], 'UserSettings' => [ 'base' => '

A collection of settings that apply to users in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

', 'refs' => [ 'CreateDomainRequest$DefaultUserSettings' => '

The default settings to use to create a user profile when UserSettings isn\'t specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

', 'CreateUserProfileRequest$UserSettings' => '

A collection of settings.

', 'DescribeDomainResponse$DefaultUserSettings' => '

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

', 'DescribeUserProfileResponse$UserSettings' => '

A collection of settings.

', 'UpdateDomainRequest$DefaultUserSettings' => '

A collection of settings.

', 'UpdateUserProfileRequest$UserSettings' => '

A collection of settings.

', ], ], 'UsersPerStep' => [ 'base' => NULL, 'refs' => [ 'Stairs$UsersPerStep' => '

Specifies how many new users to spawn in each step.

', ], ], 'UtilizationMetric' => [ 'base' => NULL, 'refs' => [ 'RecommendationMetrics$CpuUtilization' => '

The expected CPU utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

', 'RecommendationMetrics$MemoryUtilization' => '

The expected memory utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

', ], ], 'UtilizationPercentagePerCore' => [ 'base' => NULL, 'refs' => [ 'GetScalingConfigurationRecommendationRequest$TargetCpuUtilizationPerCore' => '

The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.

', 'GetScalingConfigurationRecommendationResponse$TargetCpuUtilizationPerCore' => '

The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.

', ], ], 'ValidationFraction' => [ 'base' => NULL, 'refs' => [ 'AutoMLDataSplitConfig$ValidationFraction' => '

The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.

', ], ], 'VariantName' => [ 'base' => NULL, 'refs' => [ 'CreateInferenceComponentInput$VariantName' => '

The name of an existing production variant where you host the inference component.

', 'DescribeInferenceComponentOutput$VariantName' => '

The name of the production variant that hosts the inference component.

', 'DesiredWeightAndCapacity$VariantName' => '

The name of the variant to update.

', 'InferenceComponentSummary$VariantName' => '

The name of the production variant that hosts the inference component.

', 'ListInferenceComponentsInput$VariantNameEquals' => '

A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

', 'PendingProductionVariantSummary$VariantName' => '

The name of the variant.

', 'ProductionVariant$VariantName' => '

The name of the production variant.

', 'ProductionVariantSummary$VariantName' => '

The name of the variant.

', ], ], 'VariantProperty' => [ 'base' => '

Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.

', 'refs' => [ 'VariantPropertyList$member' => NULL, ], ], 'VariantPropertyList' => [ 'base' => NULL, 'refs' => [ 'UpdateEndpointInput$ExcludeRetainedVariantProperties' => '

When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don\'t specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

', ], ], 'VariantPropertyType' => [ 'base' => NULL, 'refs' => [ 'VariantProperty$VariantPropertyType' => '

The type of variant property. The supported values are:

  • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

  • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

  • DataCaptureConfig: (Not currently supported.)

', ], ], 'VariantStatus' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantStatus$Status' => '

The endpoint variant status which describes the current deployment stage status or operational status.

  • Creating: Creating inference resources for the production variant.

  • Deleting: Terminating inference resources for the production variant.

  • Updating: Updating capacity for the production variant.

  • ActivatingTraffic: Turning on traffic for the production variant.

  • Baking: Waiting period to monitor the CloudWatch alarms in the automatic rollback configuration.

', ], ], 'VariantStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ProductionVariantStatus$StatusMessage' => '

A message that describes the status of the production variant.

', ], ], 'VariantWeight' => [ 'base' => NULL, 'refs' => [ 'DesiredWeightAndCapacity$DesiredWeight' => '

The variant\'s weight.

', 'PendingProductionVariantSummary$CurrentWeight' => '

The weight associated with the variant.

', 'PendingProductionVariantSummary$DesiredWeight' => '

The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

', 'ProductionVariant$InitialVariantWeight' => '

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

', 'ProductionVariantSummary$CurrentWeight' => '

The weight associated with the variant.

', 'ProductionVariantSummary$DesiredWeight' => '

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

', ], ], 'VectorConfig' => [ 'base' => '

Configuration for your vector collection type.

', 'refs' => [ 'CollectionConfig$VectorConfig' => '

Configuration for your vector collection type.

  • Dimension: The number of elements in your vector.

', ], ], 'VendorGuidance' => [ 'base' => NULL, 'refs' => [ 'CreateImageVersionRequest$VendorGuidance' => '

The stability of the image version, specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', 'DescribeImageVersionResponse$VendorGuidance' => '

The stability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', 'UpdateImageVersionRequest$VendorGuidance' => '

The availability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

', ], ], 'VersionId' => [ 'base' => NULL, 'refs' => [ 'PipelineDefinitionS3Location$VersionId' => '

Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

', ], ], 'VersionedArnOrName' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

', 'DeleteModelPackageInput$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to delete.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', 'DescribeModelPackageInput$ModelPackageName' => '

The name or Amazon Resource Name (ARN) of the model package to describe.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

', ], ], 'Vertex' => [ 'base' => '

A lineage entity connected to the starting entity(ies).

', 'refs' => [ 'Vertices$member' => NULL, ], ], 'Vertices' => [ 'base' => NULL, 'refs' => [ 'QueryLineageResponse$Vertices' => '

A list of vertices connected to the start entity(ies) in the lineage graph.

', ], ], 'VisibilityConditions' => [ 'base' => '

The list of key-value pairs that you specify for your resources.

', 'refs' => [ 'VisibilityConditionsList$member' => NULL, ], ], 'VisibilityConditionsKey' => [ 'base' => NULL, 'refs' => [ 'VisibilityConditions$Key' => '

The key for that specifies the tag that you\'re using to filter the search results. The key must start with Tags..

', ], ], 'VisibilityConditionsList' => [ 'base' => NULL, 'refs' => [ 'SearchRequest$VisibilityConditions' => '

Limits the results of your search request to the resources that you can access.

', ], ], 'VisibilityConditionsValue' => [ 'base' => NULL, 'refs' => [ 'VisibilityConditions$Value' => '

The value for the tag that you\'re using to filter the search results.

', ], ], 'VolumeSizeInGB' => [ 'base' => NULL, 'refs' => [ 'HyperParameterTuningInstanceConfig$VolumeSizeInGB' => '

The volume size in GB of the data to be processed for hyperparameter optimization (optional).

', 'ResourceConfig$VolumeSizeInGB' => '

The size of the ML storage volume that you want to provision.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

When using an ML instance with NVMe SSD volumes, SageMaker doesn\'t provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance\'s storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and ml.g5.

When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example, ML instance families that use EBS volumes include ml.c5 and ml.p2.

To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.

To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.

', ], ], 'VpcConfig' => [ 'base' => '

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

', 'refs' => [ 'AutoMLSecurityConfig$VpcConfig' => '

The VPC configuration.

', 'CreateClusterRequest$VpcConfig' => NULL, 'CreateEndpointConfigInput$VpcConfig' => NULL, 'CreateModelInput$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

', 'CreateTrainingJobRequest$VpcConfig' => '

A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'DescribeClusterResponse$VpcConfig' => NULL, 'DescribeEndpointConfigOutput$VpcConfig' => NULL, 'DescribeModelOutput$VpcConfig' => '

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

', 'DescribeTrainingJobResponse$VpcConfig' => '

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'HyperParameterTrainingJobDefinition$VpcConfig' => '

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', 'LabelingJobResourceConfig$VpcConfig' => NULL, 'Model$VpcConfig' => NULL, 'MonitoringNetworkConfig$VpcConfig' => NULL, 'NetworkConfig$VpcConfig' => NULL, 'TrainingJob$VpcConfig' => '

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'CreateDomainRequest$VpcId' => '

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

', 'DescribeDomainResponse$VpcId' => '

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

', ], ], 'VpcOnlyTrustedAccounts' => [ 'base' => NULL, 'refs' => [ 'DockerSettings$VpcOnlyTrustedAccounts' => '

The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.

', ], ], 'VpcSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

', ], ], 'WaitIntervalInSeconds' => [ 'base' => NULL, 'refs' => [ 'RollingUpdatePolicy$WaitIntervalInSeconds' => '

The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.

', 'TrafficRoutingConfig$WaitIntervalInSeconds' => '

The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

', ], ], 'WarmPoolResourceStatus' => [ 'base' => NULL, 'refs' => [ 'ListTrainingJobsRequest$WarmPoolStatusEquals' => '

A filter that retrieves only training jobs with a specific warm pool status.

', 'WarmPoolStatus$Status' => '

The status of the warm pool.

  • InUse: The warm pool is in use for the training job.

  • Available: The warm pool is available to reuse for a matching training job.

  • Reused: The warm pool moved to a matching training job for reuse.

  • Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

', ], ], 'WarmPoolStatus' => [ 'base' => '

Status and billing information about the warm pool.

', 'refs' => [ 'DescribeTrainingJobResponse$WarmPoolStatus' => '

The status of the warm pool associated with the training job.

', 'TrainingJobSummary$WarmPoolStatus' => '

The status of the warm pool associated with the training job.

', ], ], 'Workforce' => [ 'base' => '

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'refs' => [ 'DescribeWorkforceResponse$Workforce' => '

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'UpdateWorkforceResponse$Workforce' => '

A single private workforce. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

', 'Workforces$member' => NULL, ], ], 'WorkforceArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceResponse$WorkforceArn' => '

The Amazon Resource Name (ARN) of the workforce.

', 'Workforce$WorkforceArn' => '

The Amazon Resource Name (ARN) of the private workforce.

', 'Workteam$WorkforceArn' => '

The Amazon Resource Name (ARN) of the workforce.

', ], ], 'WorkforceFailureReason' => [ 'base' => NULL, 'refs' => [ 'Workforce$FailureReason' => '

The reason your workforce failed.

', ], ], 'WorkforceName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkforceRequest$WorkforceName' => '

The name of the private workforce.

', 'CreateWorkteamRequest$WorkforceName' => '

The name of the workforce.

', 'DeleteWorkforceRequest$WorkforceName' => '

The name of the workforce.

', 'DescribeWorkforceRequest$WorkforceName' => '

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

', 'ListWorkforcesRequest$NameContains' => '

A filter you can use to search for workforces using part of the workforce name.

', 'UpdateWorkforceRequest$WorkforceName' => '

The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.

', 'Workforce$WorkforceName' => '

The name of the private workforce.

', ], ], 'WorkforceSecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSecurityGroupIds$member' => NULL, ], ], 'WorkforceSecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', 'WorkforceVpcConfigResponse$SecurityGroupIds' => '

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

', ], ], 'WorkforceStatus' => [ 'base' => NULL, 'refs' => [ 'Workforce$Status' => '

The status of your workforce.

', ], ], 'WorkforceSubnetId' => [ 'base' => NULL, 'refs' => [ 'WorkforceSubnets$member' => NULL, ], ], 'WorkforceSubnets' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$Subnets' => '

The ID of the subnets in the VPC that you want to connect.

', 'WorkforceVpcConfigResponse$Subnets' => '

The ID of the subnets in the VPC that you want to connect.

', ], ], 'WorkforceVpcConfigRequest' => [ 'base' => '

The VPC object you use to create or update a workforce.

', 'refs' => [ 'CreateWorkforceRequest$WorkforceVpcConfig' => '

Use this parameter to configure a workforce using VPC.

', 'UpdateWorkforceRequest$WorkforceVpcConfig' => '

Use this parameter to update your VPC configuration for a workforce.

', ], ], 'WorkforceVpcConfigResponse' => [ 'base' => '

A VpcConfig object that specifies the VPC that you want your workforce to connect to.

', 'refs' => [ 'Workforce$WorkforceVpcConfig' => '

The configuration of a VPC workforce.

', ], ], 'WorkforceVpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigResponse$VpcEndpointId' => '

The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

', ], ], 'WorkforceVpcId' => [ 'base' => NULL, 'refs' => [ 'WorkforceVpcConfigRequest$VpcId' => '

The ID of the VPC that the workforce uses for communication.

', 'WorkforceVpcConfigResponse$VpcId' => '

The ID of the VPC that the workforce uses for communication.

', ], ], 'Workforces' => [ 'base' => NULL, 'refs' => [ 'ListWorkforcesResponse$Workforces' => '

A list containing information about your workforce.

', ], ], 'WorkspaceSettings' => [ 'base' => '

The workspace settings for the SageMaker Canvas application.

', 'refs' => [ 'CanvasAppSettings$WorkspaceSettings' => '

The workspace settings for the SageMaker Canvas application.

', ], ], 'Workteam' => [ 'base' => '

Provides details about a labeling work team.

', 'refs' => [ 'DescribeWorkteamResponse$Workteam' => '

A Workteam instance that contains information about the work team.

', 'UpdateWorkteamResponse$Workteam' => '

A Workteam object that describes the updated work team.

', 'Workteams$member' => NULL, ], ], 'WorkteamArn' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamResponse$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

', 'DescribeSubscribedWorkteamRequest$WorkteamArn' => '

The Amazon Resource Name (ARN) of the subscribed work team to describe.

', 'HumanLoopConfig$WorkteamArn' => '

Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.

', 'HumanTaskConfig$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

', 'LabelingJobSummary$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team assigned to the job.

', 'ListLabelingJobsForWorkteamRequest$WorkteamArn' => '

The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

', 'SubscribedWorkteam$WorkteamArn' => '

The Amazon Resource Name (ARN) of the vendor that you have subscribed.

', 'Workteam$WorkteamArn' => '

The Amazon Resource Name (ARN) that identifies the work team.

', ], ], 'WorkteamName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkteamRequest$WorkteamName' => '

The name of the work team. Use this name to identify the work team.

', 'DeleteWorkteamRequest$WorkteamName' => '

The name of the work team to delete.

', 'DescribeWorkteamRequest$WorkteamName' => '

The name of the work team to return a description of.

', 'ListSubscribedWorkteamsRequest$NameContains' => '

A string in the work team name. This filter returns only work teams whose name contains the specified string.

', 'ListWorkteamsRequest$NameContains' => '

A string in the work team\'s name. This filter returns only work teams whose name contains the specified string.

', 'UpdateWorkteamRequest$WorkteamName' => '

The name of the work team to update.

', 'Workteam$WorkteamName' => '

The name of the work team.

', ], ], 'Workteams' => [ 'base' => NULL, 'refs' => [ 'ListWorkteamsResponse$Workteams' => '

An array of Workteam objects, each describing a work team.

', ], ], ],]; diff --git a/src/data/servicecatalog/2015-12-10/api-2.json b/src/data/servicecatalog/2015-12-10/api-2.json index 6ef77f2003..1215eced33 100644 --- a/src/data/servicecatalog/2015-12-10/api-2.json +++ b/src/data/servicecatalog/2015-12-10/api-2.json @@ -1339,7 +1339,11 @@ "ProductId":{"shape":"Id"}, "ProvisioningArtifactId":{"shape":"Id"}, "ServiceActionId":{"shape":"Id"}, - "AcceptLanguage":{"shape":"AcceptLanguage"} + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + } } }, "AssociateServiceActionWithProvisioningArtifactOutput":{ @@ -1834,7 +1838,11 @@ "required":["Id"], "members":{ "Id":{"shape":"Id"}, - "AcceptLanguage":{"shape":"AcceptLanguage"} + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + } } }, "DeleteServiceActionOutput":{ @@ -2219,7 +2227,11 @@ "ProductId":{"shape":"Id"}, "ProvisioningArtifactId":{"shape":"Id"}, "ServiceActionId":{"shape":"Id"}, - "AcceptLanguage":{"shape":"AcceptLanguage"} + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + } } }, "DisassociateServiceActionFromProvisioningArtifactOutput":{ diff --git a/src/data/servicecatalog/2015-12-10/api-2.json.php b/src/data/servicecatalog/2015-12-10/api-2.json.php index 6075474868..f625d748f1 100644 --- a/src/data/servicecatalog/2015-12-10/api-2.json.php +++ b/src/data/servicecatalog/2015-12-10/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2015-12-10', 'endpointPrefix' => 'servicecatalog', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'AWS Service Catalog', 'serviceId' => 'Service Catalog', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWS242ServiceCatalogService', 'uid' => 'servicecatalog-2015-12-10', ], 'operations' => [ 'AcceptPortfolioShare' => [ 'name' => 'AcceptPortfolioShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AcceptPortfolioShareInput', ], 'output' => [ 'shape' => 'AcceptPortfolioShareOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AssociateBudgetWithResource' => [ 'name' => 'AssociateBudgetWithResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateBudgetWithResourceInput', ], 'output' => [ 'shape' => 'AssociateBudgetWithResourceOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'AssociatePrincipalWithPortfolio' => [ 'name' => 'AssociatePrincipalWithPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociatePrincipalWithPortfolioInput', ], 'output' => [ 'shape' => 'AssociatePrincipalWithPortfolioOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AssociateProductWithPortfolio' => [ 'name' => 'AssociateProductWithPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateProductWithPortfolioInput', ], 'output' => [ 'shape' => 'AssociateProductWithPortfolioOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AssociateServiceActionWithProvisioningArtifact' => [ 'name' => 'AssociateServiceActionWithProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateServiceActionWithProvisioningArtifactInput', ], 'output' => [ 'shape' => 'AssociateServiceActionWithProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'AssociateTagOptionWithResource' => [ 'name' => 'AssociateTagOptionWithResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateTagOptionWithResourceInput', ], 'output' => [ 'shape' => 'AssociateTagOptionWithResourceOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'BatchAssociateServiceActionWithProvisioningArtifact' => [ 'name' => 'BatchAssociateServiceActionWithProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchAssociateServiceActionWithProvisioningArtifactInput', ], 'output' => [ 'shape' => 'BatchAssociateServiceActionWithProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'BatchDisassociateServiceActionFromProvisioningArtifact' => [ 'name' => 'BatchDisassociateServiceActionFromProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDisassociateServiceActionFromProvisioningArtifactInput', ], 'output' => [ 'shape' => 'BatchDisassociateServiceActionFromProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'CopyProduct' => [ 'name' => 'CopyProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyProductInput', ], 'output' => [ 'shape' => 'CopyProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'CreateConstraint' => [ 'name' => 'CreateConstraint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateConstraintInput', ], 'output' => [ 'shape' => 'CreateConstraintOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DuplicateResourceException', ], ], ], 'CreatePortfolio' => [ 'name' => 'CreatePortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePortfolioInput', ], 'output' => [ 'shape' => 'CreatePortfolioOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'CreatePortfolioShare' => [ 'name' => 'CreatePortfolioShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePortfolioShareInput', ], 'output' => [ 'shape' => 'CreatePortfolioShareOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'CreateProduct' => [ 'name' => 'CreateProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProductInput', ], 'output' => [ 'shape' => 'CreateProductOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'CreateProvisionedProductPlan' => [ 'name' => 'CreateProvisionedProductPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProvisionedProductPlanInput', ], 'output' => [ 'shape' => 'CreateProvisionedProductPlanOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'CreateProvisioningArtifact' => [ 'name' => 'CreateProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProvisioningArtifactInput', ], 'output' => [ 'shape' => 'CreateProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateServiceAction' => [ 'name' => 'CreateServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServiceActionInput', ], 'output' => [ 'shape' => 'CreateServiceActionOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateTagOption' => [ 'name' => 'CreateTagOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTagOptionInput', ], 'output' => [ 'shape' => 'CreateTagOptionOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'DeleteConstraint' => [ 'name' => 'DeleteConstraint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConstraintInput', ], 'output' => [ 'shape' => 'DeleteConstraintOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DeletePortfolio' => [ 'name' => 'DeletePortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePortfolioInput', ], 'output' => [ 'shape' => 'DeletePortfolioOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'DeletePortfolioShare' => [ 'name' => 'DeletePortfolioShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePortfolioShareInput', ], 'output' => [ 'shape' => 'DeletePortfolioShareOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'DeleteProduct' => [ 'name' => 'DeleteProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProductInput', ], 'output' => [ 'shape' => 'DeleteProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'DeleteProvisionedProductPlan' => [ 'name' => 'DeleteProvisionedProductPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProvisionedProductPlanInput', ], 'output' => [ 'shape' => 'DeleteProvisionedProductPlanOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DeleteProvisioningArtifact' => [ 'name' => 'DeleteProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProvisioningArtifactInput', ], 'output' => [ 'shape' => 'DeleteProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DeleteServiceAction' => [ 'name' => 'DeleteServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServiceActionInput', ], 'output' => [ 'shape' => 'DeleteServiceActionOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteTagOption' => [ 'name' => 'DeleteTagOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTagOptionInput', ], 'output' => [ 'shape' => 'DeleteTagOptionOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeConstraint' => [ 'name' => 'DescribeConstraint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConstraintInput', ], 'output' => [ 'shape' => 'DescribeConstraintOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeCopyProductStatus' => [ 'name' => 'DescribeCopyProductStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCopyProductStatusInput', ], 'output' => [ 'shape' => 'DescribeCopyProductStatusOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribePortfolio' => [ 'name' => 'DescribePortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePortfolioInput', ], 'output' => [ 'shape' => 'DescribePortfolioOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribePortfolioShareStatus' => [ 'name' => 'DescribePortfolioShareStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePortfolioShareStatusInput', ], 'output' => [ 'shape' => 'DescribePortfolioShareStatusOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'DescribePortfolioShares' => [ 'name' => 'DescribePortfolioShares', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePortfolioSharesInput', ], 'output' => [ 'shape' => 'DescribePortfolioSharesOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProduct' => [ 'name' => 'DescribeProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProductInput', ], 'output' => [ 'shape' => 'DescribeProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProductAsAdmin' => [ 'name' => 'DescribeProductAsAdmin', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProductAsAdminInput', ], 'output' => [ 'shape' => 'DescribeProductAsAdminOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProductView' => [ 'name' => 'DescribeProductView', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProductViewInput', ], 'output' => [ 'shape' => 'DescribeProductViewOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProvisionedProduct' => [ 'name' => 'DescribeProvisionedProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProvisionedProductInput', ], 'output' => [ 'shape' => 'DescribeProvisionedProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProvisionedProductPlan' => [ 'name' => 'DescribeProvisionedProductPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProvisionedProductPlanInput', ], 'output' => [ 'shape' => 'DescribeProvisionedProductPlanOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProvisioningArtifact' => [ 'name' => 'DescribeProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProvisioningArtifactInput', ], 'output' => [ 'shape' => 'DescribeProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProvisioningParameters' => [ 'name' => 'DescribeProvisioningParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProvisioningParametersInput', ], 'output' => [ 'shape' => 'DescribeProvisioningParametersOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeRecord' => [ 'name' => 'DescribeRecord', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRecordInput', ], 'output' => [ 'shape' => 'DescribeRecordOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeServiceAction' => [ 'name' => 'DescribeServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServiceActionInput', ], 'output' => [ 'shape' => 'DescribeServiceActionOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeServiceActionExecutionParameters' => [ 'name' => 'DescribeServiceActionExecutionParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServiceActionExecutionParametersInput', ], 'output' => [ 'shape' => 'DescribeServiceActionExecutionParametersOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeTagOption' => [ 'name' => 'DescribeTagOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTagOptionInput', ], 'output' => [ 'shape' => 'DescribeTagOptionOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DisableAWSOrganizationsAccess' => [ 'name' => 'DisableAWSOrganizationsAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableAWSOrganizationsAccessInput', ], 'output' => [ 'shape' => 'DisableAWSOrganizationsAccessOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'DisassociateBudgetFromResource' => [ 'name' => 'DisassociateBudgetFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateBudgetFromResourceInput', ], 'output' => [ 'shape' => 'DisassociateBudgetFromResourceOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DisassociatePrincipalFromPortfolio' => [ 'name' => 'DisassociatePrincipalFromPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociatePrincipalFromPortfolioInput', ], 'output' => [ 'shape' => 'DisassociatePrincipalFromPortfolioOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DisassociateProductFromPortfolio' => [ 'name' => 'DisassociateProductFromPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateProductFromPortfolioInput', ], 'output' => [ 'shape' => 'DisassociateProductFromPortfolioOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DisassociateServiceActionFromProvisioningArtifact' => [ 'name' => 'DisassociateServiceActionFromProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateServiceActionFromProvisioningArtifactInput', ], 'output' => [ 'shape' => 'DisassociateServiceActionFromProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DisassociateTagOptionFromResource' => [ 'name' => 'DisassociateTagOptionFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateTagOptionFromResourceInput', ], 'output' => [ 'shape' => 'DisassociateTagOptionFromResourceOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'EnableAWSOrganizationsAccess' => [ 'name' => 'EnableAWSOrganizationsAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableAWSOrganizationsAccessInput', ], 'output' => [ 'shape' => 'EnableAWSOrganizationsAccessOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'ExecuteProvisionedProductPlan' => [ 'name' => 'ExecuteProvisionedProductPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExecuteProvisionedProductPlanInput', ], 'output' => [ 'shape' => 'ExecuteProvisionedProductPlanOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'ExecuteProvisionedProductServiceAction' => [ 'name' => 'ExecuteProvisionedProductServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExecuteProvisionedProductServiceActionInput', ], 'output' => [ 'shape' => 'ExecuteProvisionedProductServiceActionOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'GetAWSOrganizationsAccessStatus' => [ 'name' => 'GetAWSOrganizationsAccessStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAWSOrganizationsAccessStatusInput', ], 'output' => [ 'shape' => 'GetAWSOrganizationsAccessStatusOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'GetProvisionedProductOutputs' => [ 'name' => 'GetProvisionedProductOutputs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetProvisionedProductOutputsInput', ], 'output' => [ 'shape' => 'GetProvisionedProductOutputsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ImportAsProvisionedProduct' => [ 'name' => 'ImportAsProvisionedProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportAsProvisionedProductInput', ], 'output' => [ 'shape' => 'ImportAsProvisionedProductOutput', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListAcceptedPortfolioShares' => [ 'name' => 'ListAcceptedPortfolioShares', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAcceptedPortfolioSharesInput', ], 'output' => [ 'shape' => 'ListAcceptedPortfolioSharesOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'ListBudgetsForResource' => [ 'name' => 'ListBudgetsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBudgetsForResourceInput', ], 'output' => [ 'shape' => 'ListBudgetsForResourceOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListConstraintsForPortfolio' => [ 'name' => 'ListConstraintsForPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListConstraintsForPortfolioInput', ], 'output' => [ 'shape' => 'ListConstraintsForPortfolioOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListLaunchPaths' => [ 'name' => 'ListLaunchPaths', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLaunchPathsInput', ], 'output' => [ 'shape' => 'ListLaunchPathsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListOrganizationPortfolioAccess' => [ 'name' => 'ListOrganizationPortfolioAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOrganizationPortfolioAccessInput', ], 'output' => [ 'shape' => 'ListOrganizationPortfolioAccessOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'ListPortfolioAccess' => [ 'name' => 'ListPortfolioAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPortfolioAccessInput', ], 'output' => [ 'shape' => 'ListPortfolioAccessOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListPortfolios' => [ 'name' => 'ListPortfolios', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPortfoliosInput', ], 'output' => [ 'shape' => 'ListPortfoliosOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'ListPortfoliosForProduct' => [ 'name' => 'ListPortfoliosForProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPortfoliosForProductInput', ], 'output' => [ 'shape' => 'ListPortfoliosForProductOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListPrincipalsForPortfolio' => [ 'name' => 'ListPrincipalsForPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPrincipalsForPortfolioInput', ], 'output' => [ 'shape' => 'ListPrincipalsForPortfolioOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListProvisionedProductPlans' => [ 'name' => 'ListProvisionedProductPlans', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProvisionedProductPlansInput', ], 'output' => [ 'shape' => 'ListProvisionedProductPlansOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListProvisioningArtifacts' => [ 'name' => 'ListProvisioningArtifacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProvisioningArtifactsInput', ], 'output' => [ 'shape' => 'ListProvisioningArtifactsOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListProvisioningArtifactsForServiceAction' => [ 'name' => 'ListProvisioningArtifactsForServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProvisioningArtifactsForServiceActionInput', ], 'output' => [ 'shape' => 'ListProvisioningArtifactsForServiceActionOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListRecordHistory' => [ 'name' => 'ListRecordHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRecordHistoryInput', ], 'output' => [ 'shape' => 'ListRecordHistoryOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'ListResourcesForTagOption' => [ 'name' => 'ListResourcesForTagOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourcesForTagOptionInput', ], 'output' => [ 'shape' => 'ListResourcesForTagOptionOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListServiceActions' => [ 'name' => 'ListServiceActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServiceActionsInput', ], 'output' => [ 'shape' => 'ListServiceActionsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'ListServiceActionsForProvisioningArtifact' => [ 'name' => 'ListServiceActionsForProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServiceActionsForProvisioningArtifactInput', ], 'output' => [ 'shape' => 'ListServiceActionsForProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListStackInstancesForProvisionedProduct' => [ 'name' => 'ListStackInstancesForProvisionedProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStackInstancesForProvisionedProductInput', ], 'output' => [ 'shape' => 'ListStackInstancesForProvisionedProductOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListTagOptions' => [ 'name' => 'ListTagOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagOptionsInput', ], 'output' => [ 'shape' => 'ListTagOptionsOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'NotifyProvisionProductEngineWorkflowResult' => [ 'name' => 'NotifyProvisionProductEngineWorkflowResult', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'NotifyProvisionProductEngineWorkflowResultInput', ], 'output' => [ 'shape' => 'NotifyProvisionProductEngineWorkflowResultOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'NotifyTerminateProvisionedProductEngineWorkflowResult' => [ 'name' => 'NotifyTerminateProvisionedProductEngineWorkflowResult', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'NotifyTerminateProvisionedProductEngineWorkflowResultInput', ], 'output' => [ 'shape' => 'NotifyTerminateProvisionedProductEngineWorkflowResultOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'NotifyUpdateProvisionedProductEngineWorkflowResult' => [ 'name' => 'NotifyUpdateProvisionedProductEngineWorkflowResult', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'NotifyUpdateProvisionedProductEngineWorkflowResultInput', ], 'output' => [ 'shape' => 'NotifyUpdateProvisionedProductEngineWorkflowResultOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ProvisionProduct' => [ 'name' => 'ProvisionProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ProvisionProductInput', ], 'output' => [ 'shape' => 'ProvisionProductOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DuplicateResourceException', ], ], ], 'RejectPortfolioShare' => [ 'name' => 'RejectPortfolioShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RejectPortfolioShareInput', ], 'output' => [ 'shape' => 'RejectPortfolioShareOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ScanProvisionedProducts' => [ 'name' => 'ScanProvisionedProducts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ScanProvisionedProductsInput', ], 'output' => [ 'shape' => 'ScanProvisionedProductsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'SearchProducts' => [ 'name' => 'SearchProducts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchProductsInput', ], 'output' => [ 'shape' => 'SearchProductsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'SearchProductsAsAdmin' => [ 'name' => 'SearchProductsAsAdmin', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchProductsAsAdminInput', ], 'output' => [ 'shape' => 'SearchProductsAsAdminOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'SearchProvisionedProducts' => [ 'name' => 'SearchProvisionedProducts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchProvisionedProductsInput', ], 'output' => [ 'shape' => 'SearchProvisionedProductsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'TerminateProvisionedProduct' => [ 'name' => 'TerminateProvisionedProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TerminateProvisionedProductInput', ], 'output' => [ 'shape' => 'TerminateProvisionedProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateConstraint' => [ 'name' => 'UpdateConstraint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateConstraintInput', ], 'output' => [ 'shape' => 'UpdateConstraintOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'UpdatePortfolio' => [ 'name' => 'UpdatePortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePortfolioInput', ], 'output' => [ 'shape' => 'UpdatePortfolioOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'UpdatePortfolioShare' => [ 'name' => 'UpdatePortfolioShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePortfolioShareInput', ], 'output' => [ 'shape' => 'UpdatePortfolioShareOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'UpdateProduct' => [ 'name' => 'UpdateProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProductInput', ], 'output' => [ 'shape' => 'UpdateProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'UpdateProvisionedProduct' => [ 'name' => 'UpdateProvisionedProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProvisionedProductInput', ], 'output' => [ 'shape' => 'UpdateProvisionedProductOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateProvisionedProductProperties' => [ 'name' => 'UpdateProvisionedProductProperties', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProvisionedProductPropertiesInput', ], 'output' => [ 'shape' => 'UpdateProvisionedProductPropertiesOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'UpdateProvisioningArtifact' => [ 'name' => 'UpdateProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProvisioningArtifactInput', ], 'output' => [ 'shape' => 'UpdateProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'UpdateServiceAction' => [ 'name' => 'UpdateServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateServiceActionInput', ], 'output' => [ 'shape' => 'UpdateServiceActionOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'UpdateTagOption' => [ 'name' => 'UpdateTagOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTagOptionInput', ], 'output' => [ 'shape' => 'UpdateTagOptionOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidParametersException', ], ], ], ], 'shapes' => [ 'AcceptLanguage' => [ 'type' => 'string', 'max' => 100, ], 'AcceptPortfolioShareInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'PortfolioShareType' => [ 'shape' => 'PortfolioShareType', ], ], ], 'AcceptPortfolioShareOutput' => [ 'type' => 'structure', 'members' => [], ], 'AccessLevelFilter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'AccessLevelFilterKey', ], 'Value' => [ 'shape' => 'AccessLevelFilterValue', ], ], ], 'AccessLevelFilterKey' => [ 'type' => 'string', 'enum' => [ 'Account', 'Role', 'User', ], ], 'AccessLevelFilterValue' => [ 'type' => 'string', ], 'AccessStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'UNDER_CHANGE', 'DISABLED', ], ], 'AccountId' => [ 'type' => 'string', 'pattern' => '^[0-9]{12}$', ], 'AccountIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], ], 'AddTags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 20, ], 'AllowedValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ApproximateCount' => [ 'type' => 'integer', ], 'AssociateBudgetWithResourceInput' => [ 'type' => 'structure', 'required' => [ 'BudgetName', 'ResourceId', ], 'members' => [ 'BudgetName' => [ 'shape' => 'BudgetName', ], 'ResourceId' => [ 'shape' => 'Id', ], ], ], 'AssociateBudgetWithResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'AssociatePrincipalWithPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', 'PrincipalARN', 'PrincipalType', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'PrincipalARN' => [ 'shape' => 'PrincipalARN', ], 'PrincipalType' => [ 'shape' => 'PrincipalType', ], ], ], 'AssociatePrincipalWithPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'AssociateProductWithPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'SourcePortfolioId' => [ 'shape' => 'Id', ], ], ], 'AssociateProductWithPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'AssociateServiceActionWithProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', 'ServiceActionId', ], 'members' => [ 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ServiceActionId' => [ 'shape' => 'Id', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'AssociateServiceActionWithProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [], ], 'AssociateTagOptionWithResourceInput' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'TagOptionId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'TagOptionId' => [ 'shape' => 'TagOptionId', ], ], ], 'AssociateTagOptionWithResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'AttributeValue' => [ 'type' => 'string', ], 'BatchAssociateServiceActionWithProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ServiceActionAssociations', ], 'members' => [ 'ServiceActionAssociations' => [ 'shape' => 'ServiceActionAssociations', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'BatchAssociateServiceActionWithProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'FailedServiceActionAssociations' => [ 'shape' => 'FailedServiceActionAssociations', ], ], ], 'BatchDisassociateServiceActionFromProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ServiceActionAssociations', ], 'members' => [ 'ServiceActionAssociations' => [ 'shape' => 'ServiceActionAssociations', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'BatchDisassociateServiceActionFromProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'FailedServiceActionAssociations' => [ 'shape' => 'FailedServiceActionAssociations', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BudgetDetail' => [ 'type' => 'structure', 'members' => [ 'BudgetName' => [ 'shape' => 'BudgetName', ], ], ], 'BudgetName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'Budgets' => [ 'type' => 'list', 'member' => [ 'shape' => 'BudgetDetail', ], ], 'CausingEntity' => [ 'type' => 'string', ], 'ChangeAction' => [ 'type' => 'string', 'enum' => [ 'ADD', 'MODIFY', 'REMOVE', ], ], 'CloudWatchDashboard' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'CloudWatchDashboardName', ], ], ], 'CloudWatchDashboardName' => [ 'type' => 'string', ], 'CloudWatchDashboards' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudWatchDashboard', ], ], 'CodeStarConnectionArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 1, 'pattern' => 'arn:[a-z0-9][-.a-z0-9]{0,62}:codestar-connections:([a-z0-9][-.a-z0-9]{0,62})?:([a-z0-9][-.a-z0-9]{0,62})?:[^/].{0,1023}$', ], 'CodeStarParameters' => [ 'type' => 'structure', 'required' => [ 'ConnectionArn', 'Repository', 'Branch', 'ArtifactPath', ], 'members' => [ 'ConnectionArn' => [ 'shape' => 'CodeStarConnectionArn', ], 'Repository' => [ 'shape' => 'Repository', ], 'Branch' => [ 'shape' => 'RepositoryBranch', ], 'ArtifactPath' => [ 'shape' => 'RepositoryArtifactPath', ], ], ], 'ConstraintDescription' => [ 'type' => 'string', 'max' => 2000, ], 'ConstraintDetail' => [ 'type' => 'structure', 'members' => [ 'ConstraintId' => [ 'shape' => 'Id', ], 'Type' => [ 'shape' => 'ConstraintType', ], 'Description' => [ 'shape' => 'ConstraintDescription', ], 'Owner' => [ 'shape' => 'AccountId', ], 'ProductId' => [ 'shape' => 'Id', ], 'PortfolioId' => [ 'shape' => 'Id', ], ], ], 'ConstraintDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConstraintDetail', ], ], 'ConstraintParameters' => [ 'type' => 'string', ], 'ConstraintSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConstraintSummary', ], ], 'ConstraintSummary' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ConstraintType', ], 'Description' => [ 'shape' => 'ConstraintDescription', ], ], ], 'ConstraintType' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'CopyOption' => [ 'type' => 'string', 'enum' => [ 'CopyTags', ], ], 'CopyOptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'CopyOption', ], ], 'CopyProductInput' => [ 'type' => 'structure', 'required' => [ 'SourceProductArn', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'SourceProductArn' => [ 'shape' => 'ProductArn', ], 'TargetProductId' => [ 'shape' => 'Id', ], 'TargetProductName' => [ 'shape' => 'ProductViewName', ], 'SourceProvisioningArtifactIdentifiers' => [ 'shape' => 'SourceProvisioningArtifactProperties', ], 'CopyOptions' => [ 'shape' => 'CopyOptions', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'CopyProductOutput' => [ 'type' => 'structure', 'members' => [ 'CopyProductToken' => [ 'shape' => 'Id', ], ], ], 'CopyProductStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'IN_PROGRESS', 'FAILED', ], ], 'CreateConstraintInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', 'ProductId', 'Parameters', 'Type', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'Parameters' => [ 'shape' => 'ConstraintParameters', ], 'Type' => [ 'shape' => 'ConstraintType', ], 'Description' => [ 'shape' => 'ConstraintDescription', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'CreateConstraintOutput' => [ 'type' => 'structure', 'members' => [ 'ConstraintDetail' => [ 'shape' => 'ConstraintDetail', ], 'ConstraintParameters' => [ 'shape' => 'ConstraintParameters', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'CreatePortfolioInput' => [ 'type' => 'structure', 'required' => [ 'DisplayName', 'ProviderName', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'DisplayName' => [ 'shape' => 'PortfolioDisplayName', ], 'Description' => [ 'shape' => 'PortfolioDescription', ], 'ProviderName' => [ 'shape' => 'ProviderName', ], 'Tags' => [ 'shape' => 'AddTags', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'CreatePortfolioOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetail' => [ 'shape' => 'PortfolioDetail', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'CreatePortfolioShareInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'OrganizationNode' => [ 'shape' => 'OrganizationNode', ], 'ShareTagOptions' => [ 'shape' => 'Boolean', ], 'SharePrincipals' => [ 'shape' => 'Boolean', ], ], ], 'CreatePortfolioShareOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioShareToken' => [ 'shape' => 'Id', ], ], ], 'CreateProductInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'Owner', 'ProductType', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Name' => [ 'shape' => 'ProductViewName', ], 'Owner' => [ 'shape' => 'ProductViewOwner', ], 'Description' => [ 'shape' => 'ProductViewShortDescription', ], 'Distributor' => [ 'shape' => 'ProductViewOwner', ], 'SupportDescription' => [ 'shape' => 'SupportDescription', ], 'SupportEmail' => [ 'shape' => 'SupportEmail', ], 'SupportUrl' => [ 'shape' => 'SupportUrl', ], 'ProductType' => [ 'shape' => 'ProductType', ], 'Tags' => [ 'shape' => 'AddTags', ], 'ProvisioningArtifactParameters' => [ 'shape' => 'ProvisioningArtifactProperties', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'SourceConnection' => [ 'shape' => 'SourceConnection', ], ], ], 'CreateProductOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewDetail' => [ 'shape' => 'ProductViewDetail', ], 'ProvisioningArtifactDetail' => [ 'shape' => 'ProvisioningArtifactDetail', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'CreateProvisionedProductPlanInput' => [ 'type' => 'structure', 'required' => [ 'PlanName', 'PlanType', 'ProductId', 'ProvisionedProductName', 'ProvisioningArtifactId', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PlanName' => [ 'shape' => 'ProvisionedProductPlanName', ], 'PlanType' => [ 'shape' => 'ProvisionedProductPlanType', ], 'NotificationArns' => [ 'shape' => 'NotificationArns', ], 'PathId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisioningParameters' => [ 'shape' => 'UpdateProvisioningParameters', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'CreateProvisionedProductPlanOutput' => [ 'type' => 'structure', 'members' => [ 'PlanName' => [ 'shape' => 'ProvisionedProductPlanName', ], 'PlanId' => [ 'shape' => 'Id', ], 'ProvisionProductId' => [ 'shape' => 'Id', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], ], ], 'CreateProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'Parameters', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'Parameters' => [ 'shape' => 'ProvisioningArtifactProperties', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'CreateProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactDetail' => [ 'shape' => 'ProvisioningArtifactDetail', ], 'Info' => [ 'shape' => 'ProvisioningArtifactInfo', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'CreateServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'DefinitionType', 'Definition', 'IdempotencyToken', ], 'members' => [ 'Name' => [ 'shape' => 'ServiceActionName', ], 'DefinitionType' => [ 'shape' => 'ServiceActionDefinitionType', ], 'Definition' => [ 'shape' => 'ServiceActionDefinitionMap', ], 'Description' => [ 'shape' => 'ServiceActionDescription', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'CreateServiceActionOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionDetail' => [ 'shape' => 'ServiceActionDetail', ], ], ], 'CreateTagOptionInput' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagOptionKey', ], 'Value' => [ 'shape' => 'TagOptionValue', ], ], ], 'CreateTagOptionOutput' => [ 'type' => 'structure', 'members' => [ 'TagOptionDetail' => [ 'shape' => 'TagOptionDetail', ], ], ], 'CreatedTime' => [ 'type' => 'timestamp', ], 'CreationTime' => [ 'type' => 'timestamp', ], 'DefaultValue' => [ 'type' => 'string', ], 'DeleteConstraintInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DeleteConstraintOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeletePortfolioInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DeletePortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeletePortfolioShareInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'OrganizationNode' => [ 'shape' => 'OrganizationNode', ], ], ], 'DeletePortfolioShareOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioShareToken' => [ 'shape' => 'Id', ], ], ], 'DeleteProductInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DeleteProductOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteProvisionedProductPlanInput' => [ 'type' => 'structure', 'required' => [ 'PlanId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PlanId' => [ 'shape' => 'Id', ], 'IgnoreErrors' => [ 'shape' => 'IgnoreErrors', ], ], ], 'DeleteProvisionedProductPlanOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], ], ], 'DeleteProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'DeleteServiceActionOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTagOptionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TagOptionId', ], ], ], 'DeleteTagOptionOutput' => [ 'type' => 'structure', 'members' => [], ], 'DescribeConstraintInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DescribeConstraintOutput' => [ 'type' => 'structure', 'members' => [ 'ConstraintDetail' => [ 'shape' => 'ConstraintDetail', ], 'ConstraintParameters' => [ 'shape' => 'ConstraintParameters', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'DescribeCopyProductStatusInput' => [ 'type' => 'structure', 'required' => [ 'CopyProductToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'CopyProductToken' => [ 'shape' => 'Id', ], ], ], 'DescribeCopyProductStatusOutput' => [ 'type' => 'structure', 'members' => [ 'CopyProductStatus' => [ 'shape' => 'CopyProductStatus', ], 'TargetProductId' => [ 'shape' => 'Id', ], 'StatusDetail' => [ 'shape' => 'StatusDetail', ], ], ], 'DescribePortfolioInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DescribePortfolioOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetail' => [ 'shape' => 'PortfolioDetail', ], 'Tags' => [ 'shape' => 'Tags', ], 'TagOptions' => [ 'shape' => 'TagOptionDetails', ], 'Budgets' => [ 'shape' => 'Budgets', ], ], ], 'DescribePortfolioShareStatusInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioShareToken', ], 'members' => [ 'PortfolioShareToken' => [ 'shape' => 'Id', ], ], ], 'DescribePortfolioShareStatusOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioShareToken' => [ 'shape' => 'Id', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'OrganizationNodeValue' => [ 'shape' => 'OrganizationNodeValue', ], 'Status' => [ 'shape' => 'ShareStatus', ], 'ShareDetails' => [ 'shape' => 'ShareDetails', ], ], ], 'DescribePortfolioShareType' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT', 'ORGANIZATION', 'ORGANIZATIONAL_UNIT', 'ORGANIZATION_MEMBER_ACCOUNT', ], ], 'DescribePortfolioSharesInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', 'Type', ], 'members' => [ 'PortfolioId' => [ 'shape' => 'Id', ], 'Type' => [ 'shape' => 'DescribePortfolioShareType', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], ], ], 'DescribePortfolioSharesOutput' => [ 'type' => 'structure', 'members' => [ 'NextPageToken' => [ 'shape' => 'PageToken', ], 'PortfolioShareDetails' => [ 'shape' => 'PortfolioShareDetails', ], ], ], 'DescribeProductAsAdminInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProductViewName', ], 'SourcePortfolioId' => [ 'shape' => 'Id', ], ], ], 'DescribeProductAsAdminOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewDetail' => [ 'shape' => 'ProductViewDetail', ], 'ProvisioningArtifactSummaries' => [ 'shape' => 'ProvisioningArtifactSummaries', ], 'Tags' => [ 'shape' => 'Tags', ], 'TagOptions' => [ 'shape' => 'TagOptionDetails', ], 'Budgets' => [ 'shape' => 'Budgets', ], ], ], 'DescribeProductInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProductViewName', ], ], ], 'DescribeProductOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewSummary' => [ 'shape' => 'ProductViewSummary', ], 'ProvisioningArtifacts' => [ 'shape' => 'ProvisioningArtifacts', ], 'Budgets' => [ 'shape' => 'Budgets', ], 'LaunchPaths' => [ 'shape' => 'LaunchPaths', ], ], ], 'DescribeProductViewInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DescribeProductViewOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewSummary' => [ 'shape' => 'ProductViewSummary', ], 'ProvisioningArtifacts' => [ 'shape' => 'ProvisioningArtifacts', ], ], ], 'DescribeProvisionedProductInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProvisionedProductName', ], ], ], 'DescribeProvisionedProductOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductDetail' => [ 'shape' => 'ProvisionedProductDetail', ], 'CloudWatchDashboards' => [ 'shape' => 'CloudWatchDashboards', ], ], ], 'DescribeProvisionedProductPlanInput' => [ 'type' => 'structure', 'required' => [ 'PlanId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PlanId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'DescribeProvisionedProductPlanOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductPlanDetails' => [ 'shape' => 'ProvisionedProductPlanDetails', ], 'ResourceChanges' => [ 'shape' => 'ResourceChanges', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'DescribeProvisioningArtifactInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactName' => [ 'shape' => 'ProvisioningArtifactName', ], 'ProductName' => [ 'shape' => 'ProductViewName', ], 'Verbose' => [ 'shape' => 'Verbose', ], 'IncludeProvisioningArtifactParameters' => [ 'shape' => 'Boolean', ], ], ], 'DescribeProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactDetail' => [ 'shape' => 'ProvisioningArtifactDetail', ], 'Info' => [ 'shape' => 'ProvisioningArtifactInfo', ], 'Status' => [ 'shape' => 'Status', ], 'ProvisioningArtifactParameters' => [ 'shape' => 'ProvisioningArtifactParameters', ], ], ], 'DescribeProvisioningParametersInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProductName' => [ 'shape' => 'ProductViewName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactName' => [ 'shape' => 'ProvisioningArtifactName', ], 'PathId' => [ 'shape' => 'Id', ], 'PathName' => [ 'shape' => 'PortfolioDisplayName', ], ], ], 'DescribeProvisioningParametersOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactParameters' => [ 'shape' => 'ProvisioningArtifactParameters', ], 'ConstraintSummaries' => [ 'shape' => 'ConstraintSummaries', ], 'UsageInstructions' => [ 'shape' => 'UsageInstructions', ], 'TagOptions' => [ 'shape' => 'TagOptionSummaries', ], 'ProvisioningArtifactPreferences' => [ 'shape' => 'ProvisioningArtifactPreferences', ], 'ProvisioningArtifactOutputs' => [ 'shape' => 'ProvisioningArtifactOutputs', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated and returns the Id and Description of the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the Keys and Descriptions of the outputs.', ], 'ProvisioningArtifactOutputKeys' => [ 'shape' => 'ProvisioningArtifactOutputs', ], ], ], 'DescribeRecordInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSize', ], ], ], 'DescribeRecordOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], 'RecordOutputs' => [ 'shape' => 'RecordOutputs', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'DescribeServiceActionExecutionParametersInput' => [ 'type' => 'structure', 'required' => [ 'ProvisionedProductId', 'ServiceActionId', ], 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ServiceActionId' => [ 'shape' => 'Id', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'DescribeServiceActionExecutionParametersOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionParameters' => [ 'shape' => 'ExecutionParameters', ], ], ], 'DescribeServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'DescribeServiceActionOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionDetail' => [ 'shape' => 'ServiceActionDetail', ], ], ], 'DescribeTagOptionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TagOptionId', ], ], ], 'DescribeTagOptionOutput' => [ 'type' => 'structure', 'members' => [ 'TagOptionDetail' => [ 'shape' => 'TagOptionDetail', ], ], ], 'Description' => [ 'type' => 'string', ], 'DisableAWSOrganizationsAccessInput' => [ 'type' => 'structure', 'members' => [], ], 'DisableAWSOrganizationsAccessOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisableTemplateValidation' => [ 'type' => 'boolean', ], 'DisassociateBudgetFromResourceInput' => [ 'type' => 'structure', 'required' => [ 'BudgetName', 'ResourceId', ], 'members' => [ 'BudgetName' => [ 'shape' => 'BudgetName', ], 'ResourceId' => [ 'shape' => 'Id', ], ], ], 'DisassociateBudgetFromResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociatePrincipalFromPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', 'PrincipalARN', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'PrincipalARN' => [ 'shape' => 'PrincipalARN', ], 'PrincipalType' => [ 'shape' => 'PrincipalType', ], ], ], 'DisassociatePrincipalFromPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateProductFromPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'PortfolioId' => [ 'shape' => 'Id', ], ], ], 'DisassociateProductFromPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateServiceActionFromProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', 'ServiceActionId', ], 'members' => [ 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ServiceActionId' => [ 'shape' => 'Id', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'DisassociateServiceActionFromProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateTagOptionFromResourceInput' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'TagOptionId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'TagOptionId' => [ 'shape' => 'TagOptionId', ], ], ], 'DisassociateTagOptionFromResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'DuplicateResourceException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'EnableAWSOrganizationsAccessInput' => [ 'type' => 'structure', 'members' => [], ], 'EnableAWSOrganizationsAccessOutput' => [ 'type' => 'structure', 'members' => [], ], 'EngineWorkflowFailureReason' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*', ], 'EngineWorkflowResourceIdentifier' => [ 'type' => 'structure', 'members' => [ 'UniqueTag' => [ 'shape' => 'UniqueTagResourceIdentifier', ], ], ], 'EngineWorkflowStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', ], ], 'EngineWorkflowToken' => [ 'type' => 'string', 'max' => 20000, 'min' => 1, 'pattern' => '[0-9A-Za-z+\\/=]+', ], 'Error' => [ 'type' => 'string', ], 'ErrorCode' => [ 'type' => 'string', ], 'ErrorDescription' => [ 'type' => 'string', ], 'EvaluationType' => [ 'type' => 'string', 'enum' => [ 'STATIC', 'DYNAMIC', ], ], 'ExecuteProvisionedProductPlanInput' => [ 'type' => 'structure', 'required' => [ 'PlanId', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PlanId' => [ 'shape' => 'Id', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'ExecuteProvisionedProductPlanOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'ExecuteProvisionedProductServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'ProvisionedProductId', 'ServiceActionId', 'ExecuteToken', ], 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ServiceActionId' => [ 'shape' => 'Id', ], 'ExecuteToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Parameters' => [ 'shape' => 'ExecutionParameterMap', ], ], ], 'ExecuteProvisionedProductServiceActionOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'ExecutionParameter' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ExecutionParameterKey', ], 'Type' => [ 'shape' => 'ExecutionParameterType', ], 'DefaultValues' => [ 'shape' => 'ExecutionParameterValueList', ], ], ], 'ExecutionParameterKey' => [ 'type' => 'string', 'max' => 50, 'min' => 1, ], 'ExecutionParameterMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ExecutionParameterKey', ], 'value' => [ 'shape' => 'ExecutionParameterValueList', ], 'max' => 200, 'min' => 1, ], 'ExecutionParameterType' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ExecutionParameterValue' => [ 'type' => 'string', 'max' => 512, 'min' => 0, ], 'ExecutionParameterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExecutionParameterValue', ], 'max' => 25, 'min' => 0, ], 'ExecutionParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExecutionParameter', ], ], 'FailedServiceActionAssociation' => [ 'type' => 'structure', 'members' => [ 'ServiceActionId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ErrorCode' => [ 'shape' => 'ServiceActionAssociationErrorCode', ], 'ErrorMessage' => [ 'shape' => 'ServiceActionAssociationErrorMessage', ], ], ], 'FailedServiceActionAssociations' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedServiceActionAssociation', ], 'max' => 50, ], 'GetAWSOrganizationsAccessStatusInput' => [ 'type' => 'structure', 'members' => [], ], 'GetAWSOrganizationsAccessStatusOutput' => [ 'type' => 'structure', 'members' => [ 'AccessStatus' => [ 'shape' => 'AccessStatus', ], ], ], 'GetProvisionedProductOutputsInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'OutputKeys' => [ 'shape' => 'OutputKeys', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'GetProvisionedProductOutputsOutput' => [ 'type' => 'structure', 'members' => [ 'Outputs' => [ 'shape' => 'RecordOutputs', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'HasDefaultPath' => [ 'type' => 'boolean', ], 'Id' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_\\-]*', ], 'IdempotencyToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9_-]*', ], 'IgnoreErrors' => [ 'type' => 'boolean', ], 'ImportAsProvisionedProductInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', 'ProvisionedProductName', 'PhysicalId', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'PhysicalId' => [ 'shape' => 'PhysicalId', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'ImportAsProvisionedProductOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'InstructionType' => [ 'type' => 'string', ], 'InstructionValue' => [ 'type' => 'string', ], 'InvalidParametersException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidStateException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'LastRequestId' => [ 'type' => 'string', ], 'LastSuccessfulSyncTime' => [ 'type' => 'timestamp', ], 'LastSync' => [ 'type' => 'structure', 'members' => [ 'LastSyncTime' => [ 'shape' => 'LastSyncTime', ], 'LastSyncStatus' => [ 'shape' => 'LastSyncStatus', ], 'LastSyncStatusMessage' => [ 'shape' => 'LastSyncStatusMessage', ], 'LastSuccessfulSyncTime' => [ 'shape' => 'LastSuccessfulSyncTime', ], 'LastSuccessfulSyncProvisioningArtifactId' => [ 'shape' => 'Id', ], ], ], 'LastSyncStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', ], ], 'LastSyncStatusMessage' => [ 'type' => 'string', ], 'LastSyncTime' => [ 'type' => 'timestamp', ], 'LaunchPath' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'PortfolioName', ], ], ], 'LaunchPathSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'LaunchPathSummary', ], ], 'LaunchPathSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'ConstraintSummaries' => [ 'shape' => 'ConstraintSummaries', ], 'Tags' => [ 'shape' => 'Tags', ], 'Name' => [ 'shape' => 'PortfolioName', ], ], ], 'LaunchPaths' => [ 'type' => 'list', 'member' => [ 'shape' => 'LaunchPath', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ListAcceptedPortfolioSharesInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], 'PortfolioShareType' => [ 'shape' => 'PortfolioShareType', ], ], ], 'ListAcceptedPortfolioSharesOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetails' => [ 'shape' => 'PortfolioDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListBudgetsForResourceInput' => [ 'type' => 'structure', 'required' => [ 'ResourceId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ResourceId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListBudgetsForResourceOutput' => [ 'type' => 'structure', 'members' => [ 'Budgets' => [ 'shape' => 'Budgets', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListConstraintsForPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListConstraintsForPortfolioOutput' => [ 'type' => 'structure', 'members' => [ 'ConstraintDetails' => [ 'shape' => 'ConstraintDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListLaunchPathsInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListLaunchPathsOutput' => [ 'type' => 'structure', 'members' => [ 'LaunchPathSummaries' => [ 'shape' => 'LaunchPathSummaries', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListOrganizationPortfolioAccessInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', 'OrganizationNodeType', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'OrganizationNodeType' => [ 'shape' => 'OrganizationNodeType', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSize', ], ], ], 'ListOrganizationPortfolioAccessOutput' => [ 'type' => 'structure', 'members' => [ 'OrganizationNodes' => [ 'shape' => 'OrganizationNodes', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListPortfolioAccessInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'OrganizationParentId' => [ 'shape' => 'Id', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], ], ], 'ListPortfolioAccessOutput' => [ 'type' => 'structure', 'members' => [ 'AccountIds' => [ 'shape' => 'AccountIds', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListPortfoliosForProductInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], ], ], 'ListPortfoliosForProductOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetails' => [ 'shape' => 'PortfolioDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListPortfoliosInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], ], ], 'ListPortfoliosOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetails' => [ 'shape' => 'PortfolioDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListPrincipalsForPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListPrincipalsForPortfolioOutput' => [ 'type' => 'structure', 'members' => [ 'Principals' => [ 'shape' => 'Principals', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListProvisionedProductPlansInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisionProductId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'AccessLevelFilter' => [ 'shape' => 'AccessLevelFilter', ], ], ], 'ListProvisionedProductPlansOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductPlans' => [ 'shape' => 'ProvisionedProductPlans', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListProvisioningArtifactsForServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'ServiceActionId', ], 'members' => [ 'ServiceActionId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'ListProvisioningArtifactsForServiceActionOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactViews' => [ 'shape' => 'ProvisioningArtifactViews', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListProvisioningArtifactsInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], ], ], 'ListProvisioningArtifactsOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactDetails' => [ 'shape' => 'ProvisioningArtifactDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListRecordHistoryInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'AccessLevelFilter' => [ 'shape' => 'AccessLevelFilter', ], 'SearchFilter' => [ 'shape' => 'ListRecordHistorySearchFilter', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListRecordHistoryOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetails' => [ 'shape' => 'RecordDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListRecordHistorySearchFilter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'SearchFilterKey', ], 'Value' => [ 'shape' => 'SearchFilterValue', ], ], ], 'ListResourcesForTagOptionInput' => [ 'type' => 'structure', 'required' => [ 'TagOptionId', ], 'members' => [ 'TagOptionId' => [ 'shape' => 'TagOptionId', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListResourcesForTagOptionOutput' => [ 'type' => 'structure', 'members' => [ 'ResourceDetails' => [ 'shape' => 'ResourceDetails', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListServiceActionsForProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', ], 'members' => [ 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'ListServiceActionsForProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionSummaries' => [ 'shape' => 'ServiceActionSummaries', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListServiceActionsInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListServiceActionsOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionSummaries' => [ 'shape' => 'ServiceActionSummaries', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListStackInstancesForProvisionedProductInput' => [ 'type' => 'structure', 'required' => [ 'ProvisionedProductId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSize', ], ], ], 'ListStackInstancesForProvisionedProductOutput' => [ 'type' => 'structure', 'members' => [ 'StackInstances' => [ 'shape' => 'StackInstances', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListTagOptionsFilters' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'TagOptionKey', ], 'Value' => [ 'shape' => 'TagOptionValue', ], 'Active' => [ 'shape' => 'TagOptionActive', ], ], ], 'ListTagOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ListTagOptionsFilters', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListTagOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'TagOptionDetails' => [ 'shape' => 'TagOptionDetails', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'LogicalResourceId' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'Namespaces' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], ], 'NoEcho' => [ 'type' => 'boolean', ], 'NotificationArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 1, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'NotificationArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotificationArn', ], 'max' => 5, ], 'NotifyProvisionProductEngineWorkflowResultInput' => [ 'type' => 'structure', 'required' => [ 'WorkflowToken', 'RecordId', 'Status', 'IdempotencyToken', ], 'members' => [ 'WorkflowToken' => [ 'shape' => 'EngineWorkflowToken', ], 'RecordId' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'EngineWorkflowStatus', ], 'FailureReason' => [ 'shape' => 'EngineWorkflowFailureReason', ], 'ResourceIdentifier' => [ 'shape' => 'EngineWorkflowResourceIdentifier', ], 'Outputs' => [ 'shape' => 'RecordOutputs', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'NotifyProvisionProductEngineWorkflowResultOutput' => [ 'type' => 'structure', 'members' => [], ], 'NotifyTerminateProvisionedProductEngineWorkflowResultInput' => [ 'type' => 'structure', 'required' => [ 'WorkflowToken', 'RecordId', 'Status', 'IdempotencyToken', ], 'members' => [ 'WorkflowToken' => [ 'shape' => 'EngineWorkflowToken', ], 'RecordId' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'EngineWorkflowStatus', ], 'FailureReason' => [ 'shape' => 'EngineWorkflowFailureReason', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'NotifyTerminateProvisionedProductEngineWorkflowResultOutput' => [ 'type' => 'structure', 'members' => [], ], 'NotifyUpdateProvisionedProductEngineWorkflowResultInput' => [ 'type' => 'structure', 'required' => [ 'WorkflowToken', 'RecordId', 'Status', 'IdempotencyToken', ], 'members' => [ 'WorkflowToken' => [ 'shape' => 'EngineWorkflowToken', ], 'RecordId' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'EngineWorkflowStatus', ], 'FailureReason' => [ 'shape' => 'EngineWorkflowFailureReason', ], 'Outputs' => [ 'shape' => 'RecordOutputs', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'NotifyUpdateProvisionedProductEngineWorkflowResultOutput' => [ 'type' => 'structure', 'members' => [], ], 'NullableBoolean' => [ 'type' => 'boolean', 'box' => true, ], 'OperationNotSupportedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OrganizationNode' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'OrganizationNodeType', ], 'Value' => [ 'shape' => 'OrganizationNodeValue', ], ], ], 'OrganizationNodeType' => [ 'type' => 'string', 'enum' => [ 'ORGANIZATION', 'ORGANIZATIONAL_UNIT', 'ACCOUNT', ], ], 'OrganizationNodeValue' => [ 'type' => 'string', 'pattern' => '(^[0-9]{12}$)|(^arn:aws:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32})|(^o-[a-z0-9]{10,32}$)|(^arn:aws:organizations::\\d{12}:ou\\/o-[a-z0-9]{10,32}\\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$)|(^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$)', ], 'OrganizationNodes' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationNode', ], ], 'OutputDescription' => [ 'type' => 'string', 'max' => 1024, ], 'OutputKey' => [ 'type' => 'string', ], 'OutputKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputKey', ], 'max' => 60, ], 'OutputValue' => [ 'type' => 'string', ], 'Owner' => [ 'type' => 'string', ], 'PageSize' => [ 'type' => 'integer', 'max' => 20, 'min' => 0, ], 'PageSizeMax100' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'PageToken' => [ 'type' => 'string', 'max' => 2024, 'pattern' => '[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*', ], 'ParameterConstraints' => [ 'type' => 'structure', 'members' => [ 'AllowedValues' => [ 'shape' => 'AllowedValues', ], 'AllowedPattern' => [ 'shape' => 'String', ], 'ConstraintDescription' => [ 'shape' => 'String', ], 'MaxLength' => [ 'shape' => 'String', ], 'MinLength' => [ 'shape' => 'String', ], 'MaxValue' => [ 'shape' => 'String', ], 'MinValue' => [ 'shape' => 'String', ], ], ], 'ParameterKey' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'ParameterType' => [ 'type' => 'string', ], 'ParameterValue' => [ 'type' => 'string', 'max' => 4096, ], 'PhysicalId' => [ 'type' => 'string', ], 'PhysicalResourceId' => [ 'type' => 'string', ], 'PlanResourceType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'PortfolioDescription' => [ 'type' => 'string', 'max' => 2000, ], 'PortfolioDetail' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'ARN' => [ 'shape' => 'ResourceARN', ], 'DisplayName' => [ 'shape' => 'PortfolioDisplayName', ], 'Description' => [ 'shape' => 'PortfolioDescription', ], 'CreatedTime' => [ 'shape' => 'CreationTime', ], 'ProviderName' => [ 'shape' => 'ProviderName', ], ], ], 'PortfolioDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortfolioDetail', ], ], 'PortfolioDisplayName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'PortfolioName' => [ 'type' => 'string', ], 'PortfolioShareDetail' => [ 'type' => 'structure', 'members' => [ 'PrincipalId' => [ 'shape' => 'Id', ], 'Type' => [ 'shape' => 'DescribePortfolioShareType', ], 'Accepted' => [ 'shape' => 'Boolean', ], 'ShareTagOptions' => [ 'shape' => 'Boolean', ], 'SharePrincipals' => [ 'shape' => 'Boolean', ], ], ], 'PortfolioShareDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortfolioShareDetail', ], ], 'PortfolioShareType' => [ 'type' => 'string', 'enum' => [ 'IMPORTED', 'AWS_SERVICECATALOG', 'AWS_ORGANIZATIONS', ], ], 'Principal' => [ 'type' => 'structure', 'members' => [ 'PrincipalARN' => [ 'shape' => 'PrincipalARN', ], 'PrincipalType' => [ 'shape' => 'PrincipalType', ], ], ], 'PrincipalARN' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'PrincipalType' => [ 'type' => 'string', 'enum' => [ 'IAM', 'IAM_PATTERN', ], ], 'Principals' => [ 'type' => 'list', 'member' => [ 'shape' => 'Principal', ], ], 'ProductArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 1, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'ProductSource' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT', ], ], 'ProductType' => [ 'type' => 'string', 'enum' => [ 'CLOUD_FORMATION_TEMPLATE', 'MARKETPLACE', 'TERRAFORM_OPEN_SOURCE', 'TERRAFORM_CLOUD', 'EXTERNAL', ], 'max' => 8191, ], 'ProductViewAggregationType' => [ 'type' => 'string', ], 'ProductViewAggregationValue' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'AttributeValue', ], 'ApproximateCount' => [ 'shape' => 'ApproximateCount', ], ], ], 'ProductViewAggregationValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductViewAggregationValue', ], ], 'ProductViewAggregations' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProductViewAggregationType', ], 'value' => [ 'shape' => 'ProductViewAggregationValues', ], ], 'ProductViewDetail' => [ 'type' => 'structure', 'members' => [ 'ProductViewSummary' => [ 'shape' => 'ProductViewSummary', ], 'Status' => [ 'shape' => 'Status', ], 'ProductARN' => [ 'shape' => 'ResourceARN', ], 'CreatedTime' => [ 'shape' => 'CreatedTime', ], 'SourceConnection' => [ 'shape' => 'SourceConnectionDetail', ], ], ], 'ProductViewDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductViewDetail', ], ], 'ProductViewDistributor' => [ 'type' => 'string', ], 'ProductViewFilterBy' => [ 'type' => 'string', 'enum' => [ 'FullTextSearch', 'Owner', 'ProductType', 'SourceProductId', ], ], 'ProductViewFilterValue' => [ 'type' => 'string', ], 'ProductViewFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductViewFilterValue', ], ], 'ProductViewFilters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProductViewFilterBy', ], 'value' => [ 'shape' => 'ProductViewFilterValues', ], ], 'ProductViewName' => [ 'type' => 'string', 'max' => 8191, ], 'ProductViewOwner' => [ 'type' => 'string', 'max' => 8191, ], 'ProductViewShortDescription' => [ 'type' => 'string', 'max' => 8191, ], 'ProductViewSortBy' => [ 'type' => 'string', 'enum' => [ 'Title', 'VersionCount', 'CreationDate', ], ], 'ProductViewSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductViewSummary', ], ], 'ProductViewSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProductViewName', ], 'Owner' => [ 'shape' => 'ProductViewOwner', ], 'ShortDescription' => [ 'shape' => 'ProductViewShortDescription', ], 'Type' => [ 'shape' => 'ProductType', ], 'Distributor' => [ 'shape' => 'ProductViewDistributor', ], 'HasDefaultPath' => [ 'shape' => 'HasDefaultPath', ], 'SupportEmail' => [ 'shape' => 'SupportEmail', ], 'SupportDescription' => [ 'shape' => 'SupportDescription', ], 'SupportUrl' => [ 'shape' => 'SupportUrl', ], ], ], 'PropertyKey' => [ 'type' => 'string', 'enum' => [ 'OWNER', 'LAUNCH_ROLE', ], 'max' => 128, 'min' => 1, ], 'PropertyName' => [ 'type' => 'string', ], 'PropertyValue' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'ProviderName' => [ 'type' => 'string', 'max' => 50, 'min' => 1, ], 'ProvisionProductInput' => [ 'type' => 'structure', 'required' => [ 'ProvisionedProductName', 'ProvisionToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProductName' => [ 'shape' => 'ProductViewName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactName' => [ 'shape' => 'ProvisioningArtifactName', ], 'PathId' => [ 'shape' => 'Id', ], 'PathName' => [ 'shape' => 'PortfolioDisplayName', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], 'ProvisioningPreferences' => [ 'shape' => 'ProvisioningPreferences', ], 'Tags' => [ 'shape' => 'Tags', ], 'NotificationArns' => [ 'shape' => 'NotificationArns', ], 'ProvisionToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'ProvisionProductOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'ProvisionedProductAttribute' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'Arn' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'Type' => [ 'shape' => 'ProvisionedProductType', ], 'Id' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'ProvisionedProductStatus', ], 'StatusMessage' => [ 'shape' => 'ProvisionedProductStatusMessage', ], 'CreatedTime' => [ 'shape' => 'CreatedTime', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', ], 'LastRecordId' => [ 'shape' => 'Id', ], 'LastProvisioningRecordId' => [ 'shape' => 'Id', ], 'LastSuccessfulProvisioningRecordId' => [ 'shape' => 'Id', ], 'Tags' => [ 'shape' => 'Tags', ], 'PhysicalId' => [ 'shape' => 'PhysicalId', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProductName' => [ 'shape' => 'ProductViewName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactName' => [ 'shape' => 'ProvisioningArtifactName', ], 'UserArn' => [ 'shape' => 'UserArn', ], 'UserArnSession' => [ 'shape' => 'UserArnSession', ], ], ], 'ProvisionedProductAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisionedProductAttribute', ], ], 'ProvisionedProductDetail' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'Arn' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'Type' => [ 'shape' => 'ProvisionedProductType', ], 'Id' => [ 'shape' => 'ProvisionedProductId', ], 'Status' => [ 'shape' => 'ProvisionedProductStatus', ], 'StatusMessage' => [ 'shape' => 'ProvisionedProductStatusMessage', ], 'CreatedTime' => [ 'shape' => 'CreatedTime', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', ], 'LastRecordId' => [ 'shape' => 'LastRequestId', ], 'LastProvisioningRecordId' => [ 'shape' => 'Id', ], 'LastSuccessfulProvisioningRecordId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'LaunchRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'ProvisionedProductDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisionedProductDetail', ], ], 'ProvisionedProductFilters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProvisionedProductViewFilterBy', ], 'value' => [ 'shape' => 'ProvisionedProductViewFilterValues', ], ], 'ProvisionedProductId' => [ 'type' => 'string', ], 'ProvisionedProductName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9._-]*', ], 'ProvisionedProductNameOrArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'ProvisionedProductPlanDetails' => [ 'type' => 'structure', 'members' => [ 'CreatedTime' => [ 'shape' => 'CreatedTime', ], 'PathId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'PlanName' => [ 'shape' => 'ProvisionedProductPlanName', ], 'PlanId' => [ 'shape' => 'Id', ], 'ProvisionProductId' => [ 'shape' => 'Id', ], 'ProvisionProductName' => [ 'shape' => 'ProvisionedProductName', ], 'PlanType' => [ 'shape' => 'ProvisionedProductPlanType', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'ProvisionedProductPlanStatus', ], 'UpdatedTime' => [ 'shape' => 'UpdatedTime', ], 'NotificationArns' => [ 'shape' => 'NotificationArns', ], 'ProvisioningParameters' => [ 'shape' => 'UpdateProvisioningParameters', ], 'Tags' => [ 'shape' => 'Tags', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'ProvisionedProductPlanName' => [ 'type' => 'string', ], 'ProvisionedProductPlanStatus' => [ 'type' => 'string', 'enum' => [ 'CREATE_IN_PROGRESS', 'CREATE_SUCCESS', 'CREATE_FAILED', 'EXECUTE_IN_PROGRESS', 'EXECUTE_SUCCESS', 'EXECUTE_FAILED', ], ], 'ProvisionedProductPlanSummary' => [ 'type' => 'structure', 'members' => [ 'PlanName' => [ 'shape' => 'ProvisionedProductPlanName', ], 'PlanId' => [ 'shape' => 'Id', ], 'ProvisionProductId' => [ 'shape' => 'Id', ], 'ProvisionProductName' => [ 'shape' => 'ProvisionedProductName', ], 'PlanType' => [ 'shape' => 'ProvisionedProductPlanType', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], ], ], 'ProvisionedProductPlanType' => [ 'type' => 'string', 'enum' => [ 'CLOUDFORMATION', ], ], 'ProvisionedProductPlans' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisionedProductPlanSummary', ], ], 'ProvisionedProductProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'PropertyKey', ], 'value' => [ 'shape' => 'PropertyValue', ], 'max' => 100, 'min' => 1, ], 'ProvisionedProductStatus' => [ 'type' => 'string', 'enum' => [ 'AVAILABLE', 'UNDER_CHANGE', 'TAINTED', 'ERROR', 'PLAN_IN_PROGRESS', ], ], 'ProvisionedProductStatusMessage' => [ 'type' => 'string', ], 'ProvisionedProductType' => [ 'type' => 'string', ], 'ProvisionedProductViewFilterBy' => [ 'type' => 'string', 'enum' => [ 'SearchQuery', ], ], 'ProvisionedProductViewFilterValue' => [ 'type' => 'string', ], 'ProvisionedProductViewFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisionedProductViewFilterValue', ], ], 'ProvisioningArtifact' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProvisioningArtifactName', ], 'Description' => [ 'shape' => 'ProvisioningArtifactDescription', ], 'CreatedTime' => [ 'shape' => 'ProvisioningArtifactCreatedTime', ], 'Guidance' => [ 'shape' => 'ProvisioningArtifactGuidance', ], ], ], 'ProvisioningArtifactActive' => [ 'type' => 'boolean', ], 'ProvisioningArtifactCreatedTime' => [ 'type' => 'timestamp', ], 'ProvisioningArtifactDescription' => [ 'type' => 'string', 'max' => 8192, ], 'ProvisioningArtifactDetail' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProvisioningArtifactName', ], 'Description' => [ 'shape' => 'ProvisioningArtifactName', ], 'Type' => [ 'shape' => 'ProvisioningArtifactType', ], 'CreatedTime' => [ 'shape' => 'CreationTime', ], 'Active' => [ 'shape' => 'ProvisioningArtifactActive', ], 'Guidance' => [ 'shape' => 'ProvisioningArtifactGuidance', ], 'SourceRevision' => [ 'shape' => 'SourceRevision', ], ], ], 'ProvisioningArtifactDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifactDetail', ], ], 'ProvisioningArtifactGuidance' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'DEPRECATED', ], ], 'ProvisioningArtifactInfo' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProvisioningArtifactInfoKey', ], 'value' => [ 'shape' => 'ProvisioningArtifactInfoValue', ], 'max' => 100, 'min' => 1, ], 'ProvisioningArtifactInfoKey' => [ 'type' => 'string', ], 'ProvisioningArtifactInfoValue' => [ 'type' => 'string', ], 'ProvisioningArtifactName' => [ 'type' => 'string', 'max' => 8192, ], 'ProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ProvisioningArtifactOutputKey', ], 'Description' => [ 'shape' => 'OutputDescription', ], ], ], 'ProvisioningArtifactOutputKey' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[a-zA-Z0-9]*', ], 'ProvisioningArtifactOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifactOutput', ], 'max' => 60, ], 'ProvisioningArtifactParameter' => [ 'type' => 'structure', 'members' => [ 'ParameterKey' => [ 'shape' => 'ParameterKey', ], 'DefaultValue' => [ 'shape' => 'DefaultValue', ], 'ParameterType' => [ 'shape' => 'ParameterType', ], 'IsNoEcho' => [ 'shape' => 'NoEcho', ], 'Description' => [ 'shape' => 'Description', ], 'ParameterConstraints' => [ 'shape' => 'ParameterConstraints', ], ], ], 'ProvisioningArtifactParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifactParameter', ], ], 'ProvisioningArtifactPreferences' => [ 'type' => 'structure', 'members' => [ 'StackSetAccounts' => [ 'shape' => 'StackSetAccounts', ], 'StackSetRegions' => [ 'shape' => 'StackSetRegions', ], ], ], 'ProvisioningArtifactProperties' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ProvisioningArtifactName', ], 'Description' => [ 'shape' => 'ProvisioningArtifactDescription', ], 'Info' => [ 'shape' => 'ProvisioningArtifactInfo', ], 'Type' => [ 'shape' => 'ProvisioningArtifactType', ], 'DisableTemplateValidation' => [ 'shape' => 'DisableTemplateValidation', ], ], ], 'ProvisioningArtifactPropertyName' => [ 'type' => 'string', 'enum' => [ 'Id', ], ], 'ProvisioningArtifactPropertyValue' => [ 'type' => 'string', ], 'ProvisioningArtifactSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifactSummary', ], ], 'ProvisioningArtifactSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProvisioningArtifactName', ], 'Description' => [ 'shape' => 'ProvisioningArtifactDescription', ], 'CreatedTime' => [ 'shape' => 'ProvisioningArtifactCreatedTime', ], 'ProvisioningArtifactMetadata' => [ 'shape' => 'ProvisioningArtifactInfo', ], ], ], 'ProvisioningArtifactType' => [ 'type' => 'string', 'enum' => [ 'CLOUD_FORMATION_TEMPLATE', 'MARKETPLACE_AMI', 'MARKETPLACE_CAR', 'TERRAFORM_OPEN_SOURCE', 'TERRAFORM_CLOUD', 'EXTERNAL', ], ], 'ProvisioningArtifactView' => [ 'type' => 'structure', 'members' => [ 'ProductViewSummary' => [ 'shape' => 'ProductViewSummary', ], 'ProvisioningArtifact' => [ 'shape' => 'ProvisioningArtifact', ], ], ], 'ProvisioningArtifactViews' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifactView', ], ], 'ProvisioningArtifacts' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifact', ], ], 'ProvisioningParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ParameterKey', ], 'Value' => [ 'shape' => 'ParameterValue', ], ], ], 'ProvisioningParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningParameter', ], ], 'ProvisioningPreferences' => [ 'type' => 'structure', 'members' => [ 'StackSetAccounts' => [ 'shape' => 'StackSetAccounts', ], 'StackSetRegions' => [ 'shape' => 'StackSetRegions', ], 'StackSetFailureToleranceCount' => [ 'shape' => 'StackSetFailureToleranceCount', ], 'StackSetFailureTolerancePercentage' => [ 'shape' => 'StackSetFailureTolerancePercentage', ], 'StackSetMaxConcurrencyCount' => [ 'shape' => 'StackSetMaxConcurrencyCount', ], 'StackSetMaxConcurrencyPercentage' => [ 'shape' => 'StackSetMaxConcurrencyPercentage', ], ], ], 'RecordDetail' => [ 'type' => 'structure', 'members' => [ 'RecordId' => [ 'shape' => 'Id', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'Status' => [ 'shape' => 'RecordStatus', ], 'CreatedTime' => [ 'shape' => 'CreatedTime', ], 'UpdatedTime' => [ 'shape' => 'UpdatedTime', ], 'ProvisionedProductType' => [ 'shape' => 'ProvisionedProductType', ], 'RecordType' => [ 'shape' => 'RecordType', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'PathId' => [ 'shape' => 'Id', ], 'RecordErrors' => [ 'shape' => 'RecordErrors', ], 'RecordTags' => [ 'shape' => 'RecordTags', ], 'LaunchRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'RecordDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordDetail', ], ], 'RecordError' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'ErrorCode', ], 'Description' => [ 'shape' => 'ErrorDescription', ], ], ], 'RecordErrors' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordError', ], ], 'RecordOutput' => [ 'type' => 'structure', 'members' => [ 'OutputKey' => [ 'shape' => 'OutputKey', ], 'OutputValue' => [ 'shape' => 'OutputValue', ], 'Description' => [ 'shape' => 'Description', ], ], ], 'RecordOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordOutput', ], ], 'RecordStatus' => [ 'type' => 'string', 'enum' => [ 'CREATED', 'IN_PROGRESS', 'IN_PROGRESS_IN_ERROR', 'SUCCEEDED', 'FAILED', ], ], 'RecordTag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'RecordTagKey', ], 'Value' => [ 'shape' => 'RecordTagValue', ], ], ], 'RecordTagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$', ], 'RecordTagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$', ], 'RecordTags' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordTag', ], 'max' => 50, ], 'RecordType' => [ 'type' => 'string', ], 'Region' => [ 'type' => 'string', ], 'RejectPortfolioShareInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'PortfolioShareType' => [ 'shape' => 'PortfolioShareType', ], ], ], 'RejectPortfolioShareOutput' => [ 'type' => 'structure', 'members' => [], ], 'Replacement' => [ 'type' => 'string', 'enum' => [ 'TRUE', 'FALSE', 'CONDITIONAL', ], ], 'Repository' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'RepositoryArtifactPath' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, ], 'RepositoryBranch' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'RequiresRecreation' => [ 'type' => 'string', 'enum' => [ 'NEVER', 'CONDITIONALLY', 'ALWAYS', ], ], 'ResourceARN' => [ 'type' => 'string', 'max' => 150, 'min' => 1, ], 'ResourceAttribute' => [ 'type' => 'string', 'enum' => [ 'PROPERTIES', 'METADATA', 'CREATIONPOLICY', 'UPDATEPOLICY', 'DELETIONPOLICY', 'TAGS', ], ], 'ResourceChange' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'ChangeAction', ], 'LogicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'PhysicalResourceId' => [ 'shape' => 'PhysicalResourceId', ], 'ResourceType' => [ 'shape' => 'PlanResourceType', ], 'Replacement' => [ 'shape' => 'Replacement', ], 'Scope' => [ 'shape' => 'Scope', ], 'Details' => [ 'shape' => 'ResourceChangeDetails', ], ], ], 'ResourceChangeDetail' => [ 'type' => 'structure', 'members' => [ 'Target' => [ 'shape' => 'ResourceTargetDefinition', ], 'Evaluation' => [ 'shape' => 'EvaluationType', ], 'CausingEntity' => [ 'shape' => 'CausingEntity', ], ], ], 'ResourceChangeDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceChangeDetail', ], ], 'ResourceChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceChange', ], ], 'ResourceDetail' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceDetailId', ], 'ARN' => [ 'shape' => 'ResourceDetailARN', ], 'Name' => [ 'shape' => 'ResourceDetailName', ], 'Description' => [ 'shape' => 'ResourceDetailDescription', ], 'CreatedTime' => [ 'shape' => 'ResourceDetailCreatedTime', ], ], ], 'ResourceDetailARN' => [ 'type' => 'string', ], 'ResourceDetailCreatedTime' => [ 'type' => 'timestamp', ], 'ResourceDetailDescription' => [ 'type' => 'string', ], 'ResourceDetailId' => [ 'type' => 'string', ], 'ResourceDetailName' => [ 'type' => 'string', ], 'ResourceDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceDetail', ], ], 'ResourceId' => [ 'type' => 'string', ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceTargetDefinition' => [ 'type' => 'structure', 'members' => [ 'Attribute' => [ 'shape' => 'ResourceAttribute', ], 'Name' => [ 'shape' => 'PropertyName', ], 'RequiresRecreation' => [ 'shape' => 'RequiresRecreation', ], ], ], 'ResourceType' => [ 'type' => 'string', ], 'RetainPhysicalResources' => [ 'type' => 'boolean', ], 'RoleArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 1, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:iam::[a-z0-9-\\.]{0,63}:role\\/.{0,1023}', ], 'ScanProvisionedProductsInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'AccessLevelFilter' => [ 'shape' => 'AccessLevelFilter', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ScanProvisionedProductsOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProducts' => [ 'shape' => 'ProvisionedProductDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'Scope' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceAttribute', ], ], 'SearchFilterKey' => [ 'type' => 'string', ], 'SearchFilterValue' => [ 'type' => 'string', ], 'SearchProductsAsAdminInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'Filters' => [ 'shape' => 'ProductViewFilters', ], 'SortBy' => [ 'shape' => 'ProductViewSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'ProductSource' => [ 'shape' => 'ProductSource', ], ], ], 'SearchProductsAsAdminOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewDetails' => [ 'shape' => 'ProductViewDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'SearchProductsInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Filters' => [ 'shape' => 'ProductViewFilters', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], 'SortBy' => [ 'shape' => 'ProductViewSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'SearchProductsOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewSummaries' => [ 'shape' => 'ProductViewSummaries', ], 'ProductViewAggregations' => [ 'shape' => 'ProductViewAggregations', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'SearchProvisionedProductsInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'AccessLevelFilter' => [ 'shape' => 'AccessLevelFilter', ], 'Filters' => [ 'shape' => 'ProvisionedProductFilters', ], 'SortBy' => [ 'shape' => 'SortField', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'PageSize' => [ 'shape' => 'SearchProvisionedProductsPageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'SearchProvisionedProductsOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProducts' => [ 'shape' => 'ProvisionedProductAttributes', ], 'TotalResultsCount' => [ 'shape' => 'TotalResultsCount', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'SearchProvisionedProductsPageSize' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ServiceActionAssociation' => [ 'type' => 'structure', 'required' => [ 'ServiceActionId', 'ProductId', 'ProvisioningArtifactId', ], 'members' => [ 'ServiceActionId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], ], ], 'ServiceActionAssociationErrorCode' => [ 'type' => 'string', 'enum' => [ 'DUPLICATE_RESOURCE', 'INTERNAL_FAILURE', 'LIMIT_EXCEEDED', 'RESOURCE_NOT_FOUND', 'THROTTLING', 'INVALID_PARAMETER', ], ], 'ServiceActionAssociationErrorMessage' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ServiceActionAssociations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceActionAssociation', ], 'max' => 50, 'min' => 1, ], 'ServiceActionDefinitionKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'Version', 'AssumeRole', 'Parameters', ], ], 'ServiceActionDefinitionMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ServiceActionDefinitionKey', ], 'value' => [ 'shape' => 'ServiceActionDefinitionValue', ], 'max' => 100, 'min' => 1, ], 'ServiceActionDefinitionType' => [ 'type' => 'string', 'enum' => [ 'SSM_AUTOMATION', ], ], 'ServiceActionDefinitionValue' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ServiceActionDescription' => [ 'type' => 'string', 'max' => 1024, ], 'ServiceActionDetail' => [ 'type' => 'structure', 'members' => [ 'ServiceActionSummary' => [ 'shape' => 'ServiceActionSummary', ], 'Definition' => [ 'shape' => 'ServiceActionDefinitionMap', ], ], ], 'ServiceActionName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_\\-.]*', ], 'ServiceActionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceActionSummary', ], ], 'ServiceActionSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ServiceActionName', ], 'Description' => [ 'shape' => 'ServiceActionDescription', ], 'DefinitionType' => [ 'shape' => 'ServiceActionDefinitionType', ], ], ], 'ShareDetails' => [ 'type' => 'structure', 'members' => [ 'SuccessfulShares' => [ 'shape' => 'SuccessfulShares', ], 'ShareErrors' => [ 'shape' => 'ShareErrors', ], ], ], 'ShareError' => [ 'type' => 'structure', 'members' => [ 'Accounts' => [ 'shape' => 'Namespaces', ], 'Message' => [ 'shape' => 'Message', ], 'Error' => [ 'shape' => 'Error', ], ], ], 'ShareErrors' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShareError', ], ], 'ShareStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETED', 'COMPLETED_WITH_ERRORS', 'ERROR', ], ], 'SortField' => [ 'type' => 'string', ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'SourceConnection' => [ 'type' => 'structure', 'required' => [ 'ConnectionParameters', ], 'members' => [ 'Type' => [ 'shape' => 'SourceType', ], 'ConnectionParameters' => [ 'shape' => 'SourceConnectionParameters', ], ], ], 'SourceConnectionDetail' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'SourceType', ], 'ConnectionParameters' => [ 'shape' => 'SourceConnectionParameters', ], 'LastSync' => [ 'shape' => 'LastSync', ], ], ], 'SourceConnectionParameters' => [ 'type' => 'structure', 'members' => [ 'CodeStar' => [ 'shape' => 'CodeStarParameters', ], ], ], 'SourceProvisioningArtifactProperties' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceProvisioningArtifactPropertiesMap', ], ], 'SourceProvisioningArtifactPropertiesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProvisioningArtifactPropertyName', ], 'value' => [ 'shape' => 'ProvisioningArtifactPropertyValue', ], ], 'SourceRevision' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'CODESTAR', ], ], 'StackInstance' => [ 'type' => 'structure', 'members' => [ 'Account' => [ 'shape' => 'AccountId', ], 'Region' => [ 'shape' => 'Region', ], 'StackInstanceStatus' => [ 'shape' => 'StackInstanceStatus', ], ], ], 'StackInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'CURRENT', 'OUTDATED', 'INOPERABLE', ], ], 'StackInstances' => [ 'type' => 'list', 'member' => [ 'shape' => 'StackInstance', ], ], 'StackSetAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], ], 'StackSetFailureToleranceCount' => [ 'type' => 'integer', 'min' => 0, ], 'StackSetFailureTolerancePercentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'StackSetMaxConcurrencyCount' => [ 'type' => 'integer', 'min' => 1, ], 'StackSetMaxConcurrencyPercentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'StackSetOperationType' => [ 'type' => 'string', 'enum' => [ 'CREATE', 'UPDATE', 'DELETE', ], ], 'StackSetRegions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Region', ], ], 'Status' => [ 'type' => 'string', 'enum' => [ 'AVAILABLE', 'CREATING', 'FAILED', ], ], 'StatusDetail' => [ 'type' => 'string', ], 'StatusMessage' => [ 'type' => 'string', 'pattern' => '[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*', ], 'String' => [ 'type' => 'string', ], 'SuccessfulShares' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], ], 'SupportDescription' => [ 'type' => 'string', 'max' => 8191, ], 'SupportEmail' => [ 'type' => 'string', 'max' => 254, ], 'SupportUrl' => [ 'type' => 'string', 'max' => 2083, ], '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}_.:/=+\\-@]*)$', ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagOptionActive' => [ 'type' => 'boolean', ], 'TagOptionDetail' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'TagOptionKey', ], 'Value' => [ 'shape' => 'TagOptionValue', ], 'Active' => [ 'shape' => 'TagOptionActive', ], 'Id' => [ 'shape' => 'TagOptionId', ], 'Owner' => [ 'shape' => 'Owner', ], ], ], 'TagOptionDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagOptionDetail', ], ], 'TagOptionId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'TagOptionKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagOptionNotMigratedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'TagOptionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagOptionSummary', ], ], 'TagOptionSummary' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'TagOptionKey', ], 'Values' => [ 'shape' => 'TagOptionValues', ], ], ], 'TagOptionValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagOptionValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagOptionValue', ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, ], 'TerminateProvisionedProductInput' => [ 'type' => 'structure', 'required' => [ 'TerminateToken', ], 'members' => [ 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'TerminateToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'IgnoreErrors' => [ 'shape' => 'IgnoreErrors', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'RetainPhysicalResources' => [ 'shape' => 'RetainPhysicalResources', ], ], ], 'TerminateProvisionedProductOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'TotalResultsCount' => [ 'type' => 'integer', ], 'UniqueTagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$', ], 'UniqueTagResourceIdentifier' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'UniqueTagKey', ], 'Value' => [ 'shape' => 'UniqueTagValue', ], ], ], 'UniqueTagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$', ], 'UpdateConstraintInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'Description' => [ 'shape' => 'ConstraintDescription', ], 'Parameters' => [ 'shape' => 'ConstraintParameters', ], ], ], 'UpdateConstraintOutput' => [ 'type' => 'structure', 'members' => [ 'ConstraintDetail' => [ 'shape' => 'ConstraintDetail', ], 'ConstraintParameters' => [ 'shape' => 'ConstraintParameters', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'UpdatePortfolioInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'DisplayName' => [ 'shape' => 'PortfolioDisplayName', ], 'Description' => [ 'shape' => 'PortfolioDescription', ], 'ProviderName' => [ 'shape' => 'ProviderName', ], 'AddTags' => [ 'shape' => 'AddTags', ], 'RemoveTags' => [ 'shape' => 'TagKeys', ], ], ], 'UpdatePortfolioOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetail' => [ 'shape' => 'PortfolioDetail', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'UpdatePortfolioShareInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'OrganizationNode' => [ 'shape' => 'OrganizationNode', ], 'ShareTagOptions' => [ 'shape' => 'NullableBoolean', ], 'SharePrincipals' => [ 'shape' => 'NullableBoolean', ], ], ], 'UpdatePortfolioShareOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioShareToken' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'ShareStatus', ], ], ], 'UpdateProductInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProductViewName', ], 'Owner' => [ 'shape' => 'ProductViewOwner', ], 'Description' => [ 'shape' => 'ProductViewShortDescription', ], 'Distributor' => [ 'shape' => 'ProductViewOwner', ], 'SupportDescription' => [ 'shape' => 'SupportDescription', ], 'SupportEmail' => [ 'shape' => 'SupportEmail', ], 'SupportUrl' => [ 'shape' => 'SupportUrl', ], 'AddTags' => [ 'shape' => 'AddTags', ], 'RemoveTags' => [ 'shape' => 'TagKeys', ], 'SourceConnection' => [ 'shape' => 'SourceConnection', ], ], ], 'UpdateProductOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewDetail' => [ 'shape' => 'ProductViewDetail', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'UpdateProvisionedProductInput' => [ 'type' => 'structure', 'required' => [ 'UpdateToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProductName' => [ 'shape' => 'ProductViewName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactName' => [ 'shape' => 'ProvisioningArtifactName', ], 'PathId' => [ 'shape' => 'Id', ], 'PathName' => [ 'shape' => 'PortfolioDisplayName', ], 'ProvisioningParameters' => [ 'shape' => 'UpdateProvisioningParameters', ], 'ProvisioningPreferences' => [ 'shape' => 'UpdateProvisioningPreferences', ], 'Tags' => [ 'shape' => 'Tags', ], 'UpdateToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'UpdateProvisionedProductOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'UpdateProvisionedProductPropertiesInput' => [ 'type' => 'structure', 'required' => [ 'ProvisionedProductId', 'ProvisionedProductProperties', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ProvisionedProductProperties' => [ 'shape' => 'ProvisionedProductProperties', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'UpdateProvisionedProductPropertiesOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ProvisionedProductProperties' => [ 'shape' => 'ProvisionedProductProperties', ], 'RecordId' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'RecordStatus', ], ], ], 'UpdateProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProvisioningArtifactName', ], 'Description' => [ 'shape' => 'ProvisioningArtifactDescription', ], 'Active' => [ 'shape' => 'ProvisioningArtifactActive', ], 'Guidance' => [ 'shape' => 'ProvisioningArtifactGuidance', ], ], ], 'UpdateProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactDetail' => [ 'shape' => 'ProvisioningArtifactDetail', ], 'Info' => [ 'shape' => 'ProvisioningArtifactInfo', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'UpdateProvisioningParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ParameterKey', ], 'Value' => [ 'shape' => 'ParameterValue', ], 'UsePreviousValue' => [ 'shape' => 'UsePreviousValue', ], ], ], 'UpdateProvisioningParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdateProvisioningParameter', ], ], 'UpdateProvisioningPreferences' => [ 'type' => 'structure', 'members' => [ 'StackSetAccounts' => [ 'shape' => 'StackSetAccounts', ], 'StackSetRegions' => [ 'shape' => 'StackSetRegions', ], 'StackSetFailureToleranceCount' => [ 'shape' => 'StackSetFailureToleranceCount', ], 'StackSetFailureTolerancePercentage' => [ 'shape' => 'StackSetFailureTolerancePercentage', ], 'StackSetMaxConcurrencyCount' => [ 'shape' => 'StackSetMaxConcurrencyCount', ], 'StackSetMaxConcurrencyPercentage' => [ 'shape' => 'StackSetMaxConcurrencyPercentage', ], 'StackSetOperationType' => [ 'shape' => 'StackSetOperationType', ], ], ], 'UpdateServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ServiceActionName', ], 'Definition' => [ 'shape' => 'ServiceActionDefinitionMap', ], 'Description' => [ 'shape' => 'ServiceActionDescription', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'UpdateServiceActionOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionDetail' => [ 'shape' => 'ServiceActionDetail', ], ], ], 'UpdateTagOptionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TagOptionId', ], 'Value' => [ 'shape' => 'TagOptionValue', ], 'Active' => [ 'shape' => 'TagOptionActive', ], ], ], 'UpdateTagOptionOutput' => [ 'type' => 'structure', 'members' => [ 'TagOptionDetail' => [ 'shape' => 'TagOptionDetail', ], ], ], 'UpdatedTime' => [ 'type' => 'timestamp', ], 'UsageInstruction' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'InstructionType', ], 'Value' => [ 'shape' => 'InstructionValue', ], ], ], 'UsageInstructions' => [ 'type' => 'list', 'member' => [ 'shape' => 'UsageInstruction', ], ], 'UsePreviousValue' => [ 'type' => 'boolean', ], 'UserArn' => [ 'type' => 'string', ], 'UserArnSession' => [ 'type' => 'string', ], 'Verbose' => [ 'type' => 'boolean', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2015-12-10', 'endpointPrefix' => 'servicecatalog', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'AWS Service Catalog', 'serviceId' => 'Service Catalog', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWS242ServiceCatalogService', 'uid' => 'servicecatalog-2015-12-10', ], 'operations' => [ 'AcceptPortfolioShare' => [ 'name' => 'AcceptPortfolioShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AcceptPortfolioShareInput', ], 'output' => [ 'shape' => 'AcceptPortfolioShareOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AssociateBudgetWithResource' => [ 'name' => 'AssociateBudgetWithResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateBudgetWithResourceInput', ], 'output' => [ 'shape' => 'AssociateBudgetWithResourceOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'AssociatePrincipalWithPortfolio' => [ 'name' => 'AssociatePrincipalWithPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociatePrincipalWithPortfolioInput', ], 'output' => [ 'shape' => 'AssociatePrincipalWithPortfolioOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AssociateProductWithPortfolio' => [ 'name' => 'AssociateProductWithPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateProductWithPortfolioInput', ], 'output' => [ 'shape' => 'AssociateProductWithPortfolioOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'AssociateServiceActionWithProvisioningArtifact' => [ 'name' => 'AssociateServiceActionWithProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateServiceActionWithProvisioningArtifactInput', ], 'output' => [ 'shape' => 'AssociateServiceActionWithProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'AssociateTagOptionWithResource' => [ 'name' => 'AssociateTagOptionWithResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateTagOptionWithResourceInput', ], 'output' => [ 'shape' => 'AssociateTagOptionWithResourceOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'BatchAssociateServiceActionWithProvisioningArtifact' => [ 'name' => 'BatchAssociateServiceActionWithProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchAssociateServiceActionWithProvisioningArtifactInput', ], 'output' => [ 'shape' => 'BatchAssociateServiceActionWithProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'BatchDisassociateServiceActionFromProvisioningArtifact' => [ 'name' => 'BatchDisassociateServiceActionFromProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDisassociateServiceActionFromProvisioningArtifactInput', ], 'output' => [ 'shape' => 'BatchDisassociateServiceActionFromProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'CopyProduct' => [ 'name' => 'CopyProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyProductInput', ], 'output' => [ 'shape' => 'CopyProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'CreateConstraint' => [ 'name' => 'CreateConstraint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateConstraintInput', ], 'output' => [ 'shape' => 'CreateConstraintOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DuplicateResourceException', ], ], ], 'CreatePortfolio' => [ 'name' => 'CreatePortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePortfolioInput', ], 'output' => [ 'shape' => 'CreatePortfolioOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'CreatePortfolioShare' => [ 'name' => 'CreatePortfolioShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePortfolioShareInput', ], 'output' => [ 'shape' => 'CreatePortfolioShareOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'CreateProduct' => [ 'name' => 'CreateProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProductInput', ], 'output' => [ 'shape' => 'CreateProductOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'CreateProvisionedProductPlan' => [ 'name' => 'CreateProvisionedProductPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProvisionedProductPlanInput', ], 'output' => [ 'shape' => 'CreateProvisionedProductPlanOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'CreateProvisioningArtifact' => [ 'name' => 'CreateProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProvisioningArtifactInput', ], 'output' => [ 'shape' => 'CreateProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateServiceAction' => [ 'name' => 'CreateServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServiceActionInput', ], 'output' => [ 'shape' => 'CreateServiceActionOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateTagOption' => [ 'name' => 'CreateTagOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTagOptionInput', ], 'output' => [ 'shape' => 'CreateTagOptionOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'DeleteConstraint' => [ 'name' => 'DeleteConstraint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConstraintInput', ], 'output' => [ 'shape' => 'DeleteConstraintOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DeletePortfolio' => [ 'name' => 'DeletePortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePortfolioInput', ], 'output' => [ 'shape' => 'DeletePortfolioOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'DeletePortfolioShare' => [ 'name' => 'DeletePortfolioShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePortfolioShareInput', ], 'output' => [ 'shape' => 'DeletePortfolioShareOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'DeleteProduct' => [ 'name' => 'DeleteProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProductInput', ], 'output' => [ 'shape' => 'DeleteProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'DeleteProvisionedProductPlan' => [ 'name' => 'DeleteProvisionedProductPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProvisionedProductPlanInput', ], 'output' => [ 'shape' => 'DeleteProvisionedProductPlanOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DeleteProvisioningArtifact' => [ 'name' => 'DeleteProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProvisioningArtifactInput', ], 'output' => [ 'shape' => 'DeleteProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DeleteServiceAction' => [ 'name' => 'DeleteServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServiceActionInput', ], 'output' => [ 'shape' => 'DeleteServiceActionOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteTagOption' => [ 'name' => 'DeleteTagOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTagOptionInput', ], 'output' => [ 'shape' => 'DeleteTagOptionOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeConstraint' => [ 'name' => 'DescribeConstraint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConstraintInput', ], 'output' => [ 'shape' => 'DescribeConstraintOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeCopyProductStatus' => [ 'name' => 'DescribeCopyProductStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCopyProductStatusInput', ], 'output' => [ 'shape' => 'DescribeCopyProductStatusOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribePortfolio' => [ 'name' => 'DescribePortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePortfolioInput', ], 'output' => [ 'shape' => 'DescribePortfolioOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribePortfolioShareStatus' => [ 'name' => 'DescribePortfolioShareStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePortfolioShareStatusInput', ], 'output' => [ 'shape' => 'DescribePortfolioShareStatusOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'DescribePortfolioShares' => [ 'name' => 'DescribePortfolioShares', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribePortfolioSharesInput', ], 'output' => [ 'shape' => 'DescribePortfolioSharesOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProduct' => [ 'name' => 'DescribeProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProductInput', ], 'output' => [ 'shape' => 'DescribeProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProductAsAdmin' => [ 'name' => 'DescribeProductAsAdmin', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProductAsAdminInput', ], 'output' => [ 'shape' => 'DescribeProductAsAdminOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProductView' => [ 'name' => 'DescribeProductView', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProductViewInput', ], 'output' => [ 'shape' => 'DescribeProductViewOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProvisionedProduct' => [ 'name' => 'DescribeProvisionedProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProvisionedProductInput', ], 'output' => [ 'shape' => 'DescribeProvisionedProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProvisionedProductPlan' => [ 'name' => 'DescribeProvisionedProductPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProvisionedProductPlanInput', ], 'output' => [ 'shape' => 'DescribeProvisionedProductPlanOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProvisioningArtifact' => [ 'name' => 'DescribeProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProvisioningArtifactInput', ], 'output' => [ 'shape' => 'DescribeProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DescribeProvisioningParameters' => [ 'name' => 'DescribeProvisioningParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeProvisioningParametersInput', ], 'output' => [ 'shape' => 'DescribeProvisioningParametersOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeRecord' => [ 'name' => 'DescribeRecord', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRecordInput', ], 'output' => [ 'shape' => 'DescribeRecordOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeServiceAction' => [ 'name' => 'DescribeServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServiceActionInput', ], 'output' => [ 'shape' => 'DescribeServiceActionOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeServiceActionExecutionParameters' => [ 'name' => 'DescribeServiceActionExecutionParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServiceActionExecutionParametersInput', ], 'output' => [ 'shape' => 'DescribeServiceActionExecutionParametersOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeTagOption' => [ 'name' => 'DescribeTagOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTagOptionInput', ], 'output' => [ 'shape' => 'DescribeTagOptionOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DisableAWSOrganizationsAccess' => [ 'name' => 'DisableAWSOrganizationsAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisableAWSOrganizationsAccessInput', ], 'output' => [ 'shape' => 'DisableAWSOrganizationsAccessOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'DisassociateBudgetFromResource' => [ 'name' => 'DisassociateBudgetFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateBudgetFromResourceInput', ], 'output' => [ 'shape' => 'DisassociateBudgetFromResourceOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DisassociatePrincipalFromPortfolio' => [ 'name' => 'DisassociatePrincipalFromPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociatePrincipalFromPortfolioInput', ], 'output' => [ 'shape' => 'DisassociatePrincipalFromPortfolioOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DisassociateProductFromPortfolio' => [ 'name' => 'DisassociateProductFromPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateProductFromPortfolioInput', ], 'output' => [ 'shape' => 'DisassociateProductFromPortfolioOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'DisassociateServiceActionFromProvisioningArtifact' => [ 'name' => 'DisassociateServiceActionFromProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateServiceActionFromProvisioningArtifactInput', ], 'output' => [ 'shape' => 'DisassociateServiceActionFromProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DisassociateTagOptionFromResource' => [ 'name' => 'DisassociateTagOptionFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateTagOptionFromResourceInput', ], 'output' => [ 'shape' => 'DisassociateTagOptionFromResourceOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'EnableAWSOrganizationsAccess' => [ 'name' => 'EnableAWSOrganizationsAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'EnableAWSOrganizationsAccessInput', ], 'output' => [ 'shape' => 'EnableAWSOrganizationsAccessOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'ExecuteProvisionedProductPlan' => [ 'name' => 'ExecuteProvisionedProductPlan', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExecuteProvisionedProductPlanInput', ], 'output' => [ 'shape' => 'ExecuteProvisionedProductPlanOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'ExecuteProvisionedProductServiceAction' => [ 'name' => 'ExecuteProvisionedProductServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExecuteProvisionedProductServiceActionInput', ], 'output' => [ 'shape' => 'ExecuteProvisionedProductServiceActionOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'GetAWSOrganizationsAccessStatus' => [ 'name' => 'GetAWSOrganizationsAccessStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAWSOrganizationsAccessStatusInput', ], 'output' => [ 'shape' => 'GetAWSOrganizationsAccessStatusOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'GetProvisionedProductOutputs' => [ 'name' => 'GetProvisionedProductOutputs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetProvisionedProductOutputsInput', ], 'output' => [ 'shape' => 'GetProvisionedProductOutputsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ImportAsProvisionedProduct' => [ 'name' => 'ImportAsProvisionedProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportAsProvisionedProductInput', ], 'output' => [ 'shape' => 'ImportAsProvisionedProductOutput', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListAcceptedPortfolioShares' => [ 'name' => 'ListAcceptedPortfolioShares', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAcceptedPortfolioSharesInput', ], 'output' => [ 'shape' => 'ListAcceptedPortfolioSharesOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'ListBudgetsForResource' => [ 'name' => 'ListBudgetsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBudgetsForResourceInput', ], 'output' => [ 'shape' => 'ListBudgetsForResourceOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListConstraintsForPortfolio' => [ 'name' => 'ListConstraintsForPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListConstraintsForPortfolioInput', ], 'output' => [ 'shape' => 'ListConstraintsForPortfolioOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListLaunchPaths' => [ 'name' => 'ListLaunchPaths', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListLaunchPathsInput', ], 'output' => [ 'shape' => 'ListLaunchPathsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListOrganizationPortfolioAccess' => [ 'name' => 'ListOrganizationPortfolioAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOrganizationPortfolioAccessInput', ], 'output' => [ 'shape' => 'ListOrganizationPortfolioAccessOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], ], ], 'ListPortfolioAccess' => [ 'name' => 'ListPortfolioAccess', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPortfolioAccessInput', ], 'output' => [ 'shape' => 'ListPortfolioAccessOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListPortfolios' => [ 'name' => 'ListPortfolios', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPortfoliosInput', ], 'output' => [ 'shape' => 'ListPortfoliosOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'ListPortfoliosForProduct' => [ 'name' => 'ListPortfoliosForProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPortfoliosForProductInput', ], 'output' => [ 'shape' => 'ListPortfoliosForProductOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListPrincipalsForPortfolio' => [ 'name' => 'ListPrincipalsForPortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPrincipalsForPortfolioInput', ], 'output' => [ 'shape' => 'ListPrincipalsForPortfolioOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListProvisionedProductPlans' => [ 'name' => 'ListProvisionedProductPlans', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProvisionedProductPlansInput', ], 'output' => [ 'shape' => 'ListProvisionedProductPlansOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListProvisioningArtifacts' => [ 'name' => 'ListProvisioningArtifacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProvisioningArtifactsInput', ], 'output' => [ 'shape' => 'ListProvisioningArtifactsOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListProvisioningArtifactsForServiceAction' => [ 'name' => 'ListProvisioningArtifactsForServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProvisioningArtifactsForServiceActionInput', ], 'output' => [ 'shape' => 'ListProvisioningArtifactsForServiceActionOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListRecordHistory' => [ 'name' => 'ListRecordHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRecordHistoryInput', ], 'output' => [ 'shape' => 'ListRecordHistoryOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'ListResourcesForTagOption' => [ 'name' => 'ListResourcesForTagOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourcesForTagOptionInput', ], 'output' => [ 'shape' => 'ListResourcesForTagOptionOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListServiceActions' => [ 'name' => 'ListServiceActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServiceActionsInput', ], 'output' => [ 'shape' => 'ListServiceActionsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'ListServiceActionsForProvisioningArtifact' => [ 'name' => 'ListServiceActionsForProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServiceActionsForProvisioningArtifactInput', ], 'output' => [ 'shape' => 'ListServiceActionsForProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'ListStackInstancesForProvisionedProduct' => [ 'name' => 'ListStackInstancesForProvisionedProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStackInstancesForProvisionedProductInput', ], 'output' => [ 'shape' => 'ListStackInstancesForProvisionedProductOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListTagOptions' => [ 'name' => 'ListTagOptions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagOptionsInput', ], 'output' => [ 'shape' => 'ListTagOptionsOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'NotifyProvisionProductEngineWorkflowResult' => [ 'name' => 'NotifyProvisionProductEngineWorkflowResult', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'NotifyProvisionProductEngineWorkflowResultInput', ], 'output' => [ 'shape' => 'NotifyProvisionProductEngineWorkflowResultOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'NotifyTerminateProvisionedProductEngineWorkflowResult' => [ 'name' => 'NotifyTerminateProvisionedProductEngineWorkflowResult', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'NotifyTerminateProvisionedProductEngineWorkflowResultInput', ], 'output' => [ 'shape' => 'NotifyTerminateProvisionedProductEngineWorkflowResultOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'NotifyUpdateProvisionedProductEngineWorkflowResult' => [ 'name' => 'NotifyUpdateProvisionedProductEngineWorkflowResult', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'NotifyUpdateProvisionedProductEngineWorkflowResultInput', ], 'output' => [ 'shape' => 'NotifyUpdateProvisionedProductEngineWorkflowResultOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ProvisionProduct' => [ 'name' => 'ProvisionProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ProvisionProductInput', ], 'output' => [ 'shape' => 'ProvisionProductOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DuplicateResourceException', ], ], ], 'RejectPortfolioShare' => [ 'name' => 'RejectPortfolioShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RejectPortfolioShareInput', ], 'output' => [ 'shape' => 'RejectPortfolioShareOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ScanProvisionedProducts' => [ 'name' => 'ScanProvisionedProducts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ScanProvisionedProductsInput', ], 'output' => [ 'shape' => 'ScanProvisionedProductsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'SearchProducts' => [ 'name' => 'SearchProducts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchProductsInput', ], 'output' => [ 'shape' => 'SearchProductsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'SearchProductsAsAdmin' => [ 'name' => 'SearchProductsAsAdmin', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchProductsAsAdminInput', ], 'output' => [ 'shape' => 'SearchProductsAsAdminOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'SearchProvisionedProducts' => [ 'name' => 'SearchProvisionedProducts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SearchProvisionedProductsInput', ], 'output' => [ 'shape' => 'SearchProvisionedProductsOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], ], ], 'TerminateProvisionedProduct' => [ 'name' => 'TerminateProvisionedProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TerminateProvisionedProductInput', ], 'output' => [ 'shape' => 'TerminateProvisionedProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateConstraint' => [ 'name' => 'UpdateConstraint', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateConstraintInput', ], 'output' => [ 'shape' => 'UpdateConstraintOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'UpdatePortfolio' => [ 'name' => 'UpdatePortfolio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePortfolioInput', ], 'output' => [ 'shape' => 'UpdatePortfolioOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'UpdatePortfolioShare' => [ 'name' => 'UpdatePortfolioShare', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePortfolioShareInput', ], 'output' => [ 'shape' => 'UpdatePortfolioShareOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'OperationNotSupportedException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'UpdateProduct' => [ 'name' => 'UpdateProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProductInput', ], 'output' => [ 'shape' => 'UpdateProductOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'TagOptionNotMigratedException', ], ], ], 'UpdateProvisionedProduct' => [ 'name' => 'UpdateProvisionedProduct', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProvisionedProductInput', ], 'output' => [ 'shape' => 'UpdateProvisionedProductOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateProvisionedProductProperties' => [ 'name' => 'UpdateProvisionedProductProperties', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProvisionedProductPropertiesInput', ], 'output' => [ 'shape' => 'UpdateProvisionedProductPropertiesOutput', ], 'errors' => [ [ 'shape' => 'InvalidParametersException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'UpdateProvisioningArtifact' => [ 'name' => 'UpdateProvisioningArtifact', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProvisioningArtifactInput', ], 'output' => [ 'shape' => 'UpdateProvisioningArtifactOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'UpdateServiceAction' => [ 'name' => 'UpdateServiceAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateServiceActionInput', ], 'output' => [ 'shape' => 'UpdateServiceActionOutput', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParametersException', ], ], ], 'UpdateTagOption' => [ 'name' => 'UpdateTagOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateTagOptionInput', ], 'output' => [ 'shape' => 'UpdateTagOptionOutput', ], 'errors' => [ [ 'shape' => 'TagOptionNotMigratedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidParametersException', ], ], ], ], 'shapes' => [ 'AcceptLanguage' => [ 'type' => 'string', 'max' => 100, ], 'AcceptPortfolioShareInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'PortfolioShareType' => [ 'shape' => 'PortfolioShareType', ], ], ], 'AcceptPortfolioShareOutput' => [ 'type' => 'structure', 'members' => [], ], 'AccessLevelFilter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'AccessLevelFilterKey', ], 'Value' => [ 'shape' => 'AccessLevelFilterValue', ], ], ], 'AccessLevelFilterKey' => [ 'type' => 'string', 'enum' => [ 'Account', 'Role', 'User', ], ], 'AccessLevelFilterValue' => [ 'type' => 'string', ], 'AccessStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'UNDER_CHANGE', 'DISABLED', ], ], 'AccountId' => [ 'type' => 'string', 'pattern' => '^[0-9]{12}$', ], 'AccountIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], ], 'AddTags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 20, ], 'AllowedValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ApproximateCount' => [ 'type' => 'integer', ], 'AssociateBudgetWithResourceInput' => [ 'type' => 'structure', 'required' => [ 'BudgetName', 'ResourceId', ], 'members' => [ 'BudgetName' => [ 'shape' => 'BudgetName', ], 'ResourceId' => [ 'shape' => 'Id', ], ], ], 'AssociateBudgetWithResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'AssociatePrincipalWithPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', 'PrincipalARN', 'PrincipalType', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'PrincipalARN' => [ 'shape' => 'PrincipalARN', ], 'PrincipalType' => [ 'shape' => 'PrincipalType', ], ], ], 'AssociatePrincipalWithPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'AssociateProductWithPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'SourcePortfolioId' => [ 'shape' => 'Id', ], ], ], 'AssociateProductWithPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'AssociateServiceActionWithProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', 'ServiceActionId', ], 'members' => [ 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ServiceActionId' => [ 'shape' => 'Id', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'AssociateServiceActionWithProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [], ], 'AssociateTagOptionWithResourceInput' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'TagOptionId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'TagOptionId' => [ 'shape' => 'TagOptionId', ], ], ], 'AssociateTagOptionWithResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'AttributeValue' => [ 'type' => 'string', ], 'BatchAssociateServiceActionWithProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ServiceActionAssociations', ], 'members' => [ 'ServiceActionAssociations' => [ 'shape' => 'ServiceActionAssociations', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'BatchAssociateServiceActionWithProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'FailedServiceActionAssociations' => [ 'shape' => 'FailedServiceActionAssociations', ], ], ], 'BatchDisassociateServiceActionFromProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ServiceActionAssociations', ], 'members' => [ 'ServiceActionAssociations' => [ 'shape' => 'ServiceActionAssociations', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'BatchDisassociateServiceActionFromProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'FailedServiceActionAssociations' => [ 'shape' => 'FailedServiceActionAssociations', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BudgetDetail' => [ 'type' => 'structure', 'members' => [ 'BudgetName' => [ 'shape' => 'BudgetName', ], ], ], 'BudgetName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'Budgets' => [ 'type' => 'list', 'member' => [ 'shape' => 'BudgetDetail', ], ], 'CausingEntity' => [ 'type' => 'string', ], 'ChangeAction' => [ 'type' => 'string', 'enum' => [ 'ADD', 'MODIFY', 'REMOVE', ], ], 'CloudWatchDashboard' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'CloudWatchDashboardName', ], ], ], 'CloudWatchDashboardName' => [ 'type' => 'string', ], 'CloudWatchDashboards' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudWatchDashboard', ], ], 'CodeStarConnectionArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 1, 'pattern' => 'arn:[a-z0-9][-.a-z0-9]{0,62}:codestar-connections:([a-z0-9][-.a-z0-9]{0,62})?:([a-z0-9][-.a-z0-9]{0,62})?:[^/].{0,1023}$', ], 'CodeStarParameters' => [ 'type' => 'structure', 'required' => [ 'ConnectionArn', 'Repository', 'Branch', 'ArtifactPath', ], 'members' => [ 'ConnectionArn' => [ 'shape' => 'CodeStarConnectionArn', ], 'Repository' => [ 'shape' => 'Repository', ], 'Branch' => [ 'shape' => 'RepositoryBranch', ], 'ArtifactPath' => [ 'shape' => 'RepositoryArtifactPath', ], ], ], 'ConstraintDescription' => [ 'type' => 'string', 'max' => 2000, ], 'ConstraintDetail' => [ 'type' => 'structure', 'members' => [ 'ConstraintId' => [ 'shape' => 'Id', ], 'Type' => [ 'shape' => 'ConstraintType', ], 'Description' => [ 'shape' => 'ConstraintDescription', ], 'Owner' => [ 'shape' => 'AccountId', ], 'ProductId' => [ 'shape' => 'Id', ], 'PortfolioId' => [ 'shape' => 'Id', ], ], ], 'ConstraintDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConstraintDetail', ], ], 'ConstraintParameters' => [ 'type' => 'string', ], 'ConstraintSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConstraintSummary', ], ], 'ConstraintSummary' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ConstraintType', ], 'Description' => [ 'shape' => 'ConstraintDescription', ], ], ], 'ConstraintType' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'CopyOption' => [ 'type' => 'string', 'enum' => [ 'CopyTags', ], ], 'CopyOptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'CopyOption', ], ], 'CopyProductInput' => [ 'type' => 'structure', 'required' => [ 'SourceProductArn', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'SourceProductArn' => [ 'shape' => 'ProductArn', ], 'TargetProductId' => [ 'shape' => 'Id', ], 'TargetProductName' => [ 'shape' => 'ProductViewName', ], 'SourceProvisioningArtifactIdentifiers' => [ 'shape' => 'SourceProvisioningArtifactProperties', ], 'CopyOptions' => [ 'shape' => 'CopyOptions', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'CopyProductOutput' => [ 'type' => 'structure', 'members' => [ 'CopyProductToken' => [ 'shape' => 'Id', ], ], ], 'CopyProductStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'IN_PROGRESS', 'FAILED', ], ], 'CreateConstraintInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', 'ProductId', 'Parameters', 'Type', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'Parameters' => [ 'shape' => 'ConstraintParameters', ], 'Type' => [ 'shape' => 'ConstraintType', ], 'Description' => [ 'shape' => 'ConstraintDescription', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'CreateConstraintOutput' => [ 'type' => 'structure', 'members' => [ 'ConstraintDetail' => [ 'shape' => 'ConstraintDetail', ], 'ConstraintParameters' => [ 'shape' => 'ConstraintParameters', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'CreatePortfolioInput' => [ 'type' => 'structure', 'required' => [ 'DisplayName', 'ProviderName', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'DisplayName' => [ 'shape' => 'PortfolioDisplayName', ], 'Description' => [ 'shape' => 'PortfolioDescription', ], 'ProviderName' => [ 'shape' => 'ProviderName', ], 'Tags' => [ 'shape' => 'AddTags', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'CreatePortfolioOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetail' => [ 'shape' => 'PortfolioDetail', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'CreatePortfolioShareInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'OrganizationNode' => [ 'shape' => 'OrganizationNode', ], 'ShareTagOptions' => [ 'shape' => 'Boolean', ], 'SharePrincipals' => [ 'shape' => 'Boolean', ], ], ], 'CreatePortfolioShareOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioShareToken' => [ 'shape' => 'Id', ], ], ], 'CreateProductInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'Owner', 'ProductType', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Name' => [ 'shape' => 'ProductViewName', ], 'Owner' => [ 'shape' => 'ProductViewOwner', ], 'Description' => [ 'shape' => 'ProductViewShortDescription', ], 'Distributor' => [ 'shape' => 'ProductViewOwner', ], 'SupportDescription' => [ 'shape' => 'SupportDescription', ], 'SupportEmail' => [ 'shape' => 'SupportEmail', ], 'SupportUrl' => [ 'shape' => 'SupportUrl', ], 'ProductType' => [ 'shape' => 'ProductType', ], 'Tags' => [ 'shape' => 'AddTags', ], 'ProvisioningArtifactParameters' => [ 'shape' => 'ProvisioningArtifactProperties', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'SourceConnection' => [ 'shape' => 'SourceConnection', ], ], ], 'CreateProductOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewDetail' => [ 'shape' => 'ProductViewDetail', ], 'ProvisioningArtifactDetail' => [ 'shape' => 'ProvisioningArtifactDetail', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'CreateProvisionedProductPlanInput' => [ 'type' => 'structure', 'required' => [ 'PlanName', 'PlanType', 'ProductId', 'ProvisionedProductName', 'ProvisioningArtifactId', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PlanName' => [ 'shape' => 'ProvisionedProductPlanName', ], 'PlanType' => [ 'shape' => 'ProvisionedProductPlanType', ], 'NotificationArns' => [ 'shape' => 'NotificationArns', ], 'PathId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisioningParameters' => [ 'shape' => 'UpdateProvisioningParameters', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'CreateProvisionedProductPlanOutput' => [ 'type' => 'structure', 'members' => [ 'PlanName' => [ 'shape' => 'ProvisionedProductPlanName', ], 'PlanId' => [ 'shape' => 'Id', ], 'ProvisionProductId' => [ 'shape' => 'Id', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], ], ], 'CreateProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'Parameters', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'Parameters' => [ 'shape' => 'ProvisioningArtifactProperties', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'CreateProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactDetail' => [ 'shape' => 'ProvisioningArtifactDetail', ], 'Info' => [ 'shape' => 'ProvisioningArtifactInfo', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'CreateServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'DefinitionType', 'Definition', 'IdempotencyToken', ], 'members' => [ 'Name' => [ 'shape' => 'ServiceActionName', ], 'DefinitionType' => [ 'shape' => 'ServiceActionDefinitionType', ], 'Definition' => [ 'shape' => 'ServiceActionDefinitionMap', ], 'Description' => [ 'shape' => 'ServiceActionDescription', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'CreateServiceActionOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionDetail' => [ 'shape' => 'ServiceActionDetail', ], ], ], 'CreateTagOptionInput' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagOptionKey', ], 'Value' => [ 'shape' => 'TagOptionValue', ], ], ], 'CreateTagOptionOutput' => [ 'type' => 'structure', 'members' => [ 'TagOptionDetail' => [ 'shape' => 'TagOptionDetail', ], ], ], 'CreatedTime' => [ 'type' => 'timestamp', ], 'CreationTime' => [ 'type' => 'timestamp', ], 'DefaultValue' => [ 'type' => 'string', ], 'DeleteConstraintInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DeleteConstraintOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeletePortfolioInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DeletePortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeletePortfolioShareInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'OrganizationNode' => [ 'shape' => 'OrganizationNode', ], ], ], 'DeletePortfolioShareOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioShareToken' => [ 'shape' => 'Id', ], ], ], 'DeleteProductInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DeleteProductOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteProvisionedProductPlanInput' => [ 'type' => 'structure', 'required' => [ 'PlanId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PlanId' => [ 'shape' => 'Id', ], 'IgnoreErrors' => [ 'shape' => 'IgnoreErrors', ], ], ], 'DeleteProvisionedProductPlanOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], ], ], 'DeleteProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'DeleteServiceActionOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTagOptionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TagOptionId', ], ], ], 'DeleteTagOptionOutput' => [ 'type' => 'structure', 'members' => [], ], 'DescribeConstraintInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DescribeConstraintOutput' => [ 'type' => 'structure', 'members' => [ 'ConstraintDetail' => [ 'shape' => 'ConstraintDetail', ], 'ConstraintParameters' => [ 'shape' => 'ConstraintParameters', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'DescribeCopyProductStatusInput' => [ 'type' => 'structure', 'required' => [ 'CopyProductToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'CopyProductToken' => [ 'shape' => 'Id', ], ], ], 'DescribeCopyProductStatusOutput' => [ 'type' => 'structure', 'members' => [ 'CopyProductStatus' => [ 'shape' => 'CopyProductStatus', ], 'TargetProductId' => [ 'shape' => 'Id', ], 'StatusDetail' => [ 'shape' => 'StatusDetail', ], ], ], 'DescribePortfolioInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DescribePortfolioOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetail' => [ 'shape' => 'PortfolioDetail', ], 'Tags' => [ 'shape' => 'Tags', ], 'TagOptions' => [ 'shape' => 'TagOptionDetails', ], 'Budgets' => [ 'shape' => 'Budgets', ], ], ], 'DescribePortfolioShareStatusInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioShareToken', ], 'members' => [ 'PortfolioShareToken' => [ 'shape' => 'Id', ], ], ], 'DescribePortfolioShareStatusOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioShareToken' => [ 'shape' => 'Id', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'OrganizationNodeValue' => [ 'shape' => 'OrganizationNodeValue', ], 'Status' => [ 'shape' => 'ShareStatus', ], 'ShareDetails' => [ 'shape' => 'ShareDetails', ], ], ], 'DescribePortfolioShareType' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT', 'ORGANIZATION', 'ORGANIZATIONAL_UNIT', 'ORGANIZATION_MEMBER_ACCOUNT', ], ], 'DescribePortfolioSharesInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', 'Type', ], 'members' => [ 'PortfolioId' => [ 'shape' => 'Id', ], 'Type' => [ 'shape' => 'DescribePortfolioShareType', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], ], ], 'DescribePortfolioSharesOutput' => [ 'type' => 'structure', 'members' => [ 'NextPageToken' => [ 'shape' => 'PageToken', ], 'PortfolioShareDetails' => [ 'shape' => 'PortfolioShareDetails', ], ], ], 'DescribeProductAsAdminInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProductViewName', ], 'SourcePortfolioId' => [ 'shape' => 'Id', ], ], ], 'DescribeProductAsAdminOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewDetail' => [ 'shape' => 'ProductViewDetail', ], 'ProvisioningArtifactSummaries' => [ 'shape' => 'ProvisioningArtifactSummaries', ], 'Tags' => [ 'shape' => 'Tags', ], 'TagOptions' => [ 'shape' => 'TagOptionDetails', ], 'Budgets' => [ 'shape' => 'Budgets', ], ], ], 'DescribeProductInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProductViewName', ], ], ], 'DescribeProductOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewSummary' => [ 'shape' => 'ProductViewSummary', ], 'ProvisioningArtifacts' => [ 'shape' => 'ProvisioningArtifacts', ], 'Budgets' => [ 'shape' => 'Budgets', ], 'LaunchPaths' => [ 'shape' => 'LaunchPaths', ], ], ], 'DescribeProductViewInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], ], ], 'DescribeProductViewOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewSummary' => [ 'shape' => 'ProductViewSummary', ], 'ProvisioningArtifacts' => [ 'shape' => 'ProvisioningArtifacts', ], ], ], 'DescribeProvisionedProductInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProvisionedProductName', ], ], ], 'DescribeProvisionedProductOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductDetail' => [ 'shape' => 'ProvisionedProductDetail', ], 'CloudWatchDashboards' => [ 'shape' => 'CloudWatchDashboards', ], ], ], 'DescribeProvisionedProductPlanInput' => [ 'type' => 'structure', 'required' => [ 'PlanId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PlanId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'DescribeProvisionedProductPlanOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductPlanDetails' => [ 'shape' => 'ProvisionedProductPlanDetails', ], 'ResourceChanges' => [ 'shape' => 'ResourceChanges', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'DescribeProvisioningArtifactInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactName' => [ 'shape' => 'ProvisioningArtifactName', ], 'ProductName' => [ 'shape' => 'ProductViewName', ], 'Verbose' => [ 'shape' => 'Verbose', ], 'IncludeProvisioningArtifactParameters' => [ 'shape' => 'Boolean', ], ], ], 'DescribeProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactDetail' => [ 'shape' => 'ProvisioningArtifactDetail', ], 'Info' => [ 'shape' => 'ProvisioningArtifactInfo', ], 'Status' => [ 'shape' => 'Status', ], 'ProvisioningArtifactParameters' => [ 'shape' => 'ProvisioningArtifactParameters', ], ], ], 'DescribeProvisioningParametersInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProductName' => [ 'shape' => 'ProductViewName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactName' => [ 'shape' => 'ProvisioningArtifactName', ], 'PathId' => [ 'shape' => 'Id', ], 'PathName' => [ 'shape' => 'PortfolioDisplayName', ], ], ], 'DescribeProvisioningParametersOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactParameters' => [ 'shape' => 'ProvisioningArtifactParameters', ], 'ConstraintSummaries' => [ 'shape' => 'ConstraintSummaries', ], 'UsageInstructions' => [ 'shape' => 'UsageInstructions', ], 'TagOptions' => [ 'shape' => 'TagOptionSummaries', ], 'ProvisioningArtifactPreferences' => [ 'shape' => 'ProvisioningArtifactPreferences', ], 'ProvisioningArtifactOutputs' => [ 'shape' => 'ProvisioningArtifactOutputs', 'deprecated' => true, 'deprecatedMessage' => 'This property is deprecated and returns the Id and Description of the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the Keys and Descriptions of the outputs.', ], 'ProvisioningArtifactOutputKeys' => [ 'shape' => 'ProvisioningArtifactOutputs', ], ], ], 'DescribeRecordInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSize', ], ], ], 'DescribeRecordOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], 'RecordOutputs' => [ 'shape' => 'RecordOutputs', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'DescribeServiceActionExecutionParametersInput' => [ 'type' => 'structure', 'required' => [ 'ProvisionedProductId', 'ServiceActionId', ], 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ServiceActionId' => [ 'shape' => 'Id', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'DescribeServiceActionExecutionParametersOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionParameters' => [ 'shape' => 'ExecutionParameters', ], ], ], 'DescribeServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'DescribeServiceActionOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionDetail' => [ 'shape' => 'ServiceActionDetail', ], ], ], 'DescribeTagOptionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TagOptionId', ], ], ], 'DescribeTagOptionOutput' => [ 'type' => 'structure', 'members' => [ 'TagOptionDetail' => [ 'shape' => 'TagOptionDetail', ], ], ], 'Description' => [ 'type' => 'string', ], 'DisableAWSOrganizationsAccessInput' => [ 'type' => 'structure', 'members' => [], ], 'DisableAWSOrganizationsAccessOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisableTemplateValidation' => [ 'type' => 'boolean', ], 'DisassociateBudgetFromResourceInput' => [ 'type' => 'structure', 'required' => [ 'BudgetName', 'ResourceId', ], 'members' => [ 'BudgetName' => [ 'shape' => 'BudgetName', ], 'ResourceId' => [ 'shape' => 'Id', ], ], ], 'DisassociateBudgetFromResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociatePrincipalFromPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', 'PrincipalARN', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'PrincipalARN' => [ 'shape' => 'PrincipalARN', ], 'PrincipalType' => [ 'shape' => 'PrincipalType', ], ], ], 'DisassociatePrincipalFromPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateProductFromPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'PortfolioId' => [ 'shape' => 'Id', ], ], ], 'DisassociateProductFromPortfolioOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateServiceActionFromProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', 'ServiceActionId', ], 'members' => [ 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ServiceActionId' => [ 'shape' => 'Id', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'DisassociateServiceActionFromProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateTagOptionFromResourceInput' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'TagOptionId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'TagOptionId' => [ 'shape' => 'TagOptionId', ], ], ], 'DisassociateTagOptionFromResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'DuplicateResourceException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'EnableAWSOrganizationsAccessInput' => [ 'type' => 'structure', 'members' => [], ], 'EnableAWSOrganizationsAccessOutput' => [ 'type' => 'structure', 'members' => [], ], 'EngineWorkflowFailureReason' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*', ], 'EngineWorkflowResourceIdentifier' => [ 'type' => 'structure', 'members' => [ 'UniqueTag' => [ 'shape' => 'UniqueTagResourceIdentifier', ], ], ], 'EngineWorkflowStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', ], ], 'EngineWorkflowToken' => [ 'type' => 'string', 'max' => 20000, 'min' => 1, 'pattern' => '[0-9A-Za-z+\\/=]+', ], 'Error' => [ 'type' => 'string', ], 'ErrorCode' => [ 'type' => 'string', ], 'ErrorDescription' => [ 'type' => 'string', ], 'EvaluationType' => [ 'type' => 'string', 'enum' => [ 'STATIC', 'DYNAMIC', ], ], 'ExecuteProvisionedProductPlanInput' => [ 'type' => 'structure', 'required' => [ 'PlanId', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PlanId' => [ 'shape' => 'Id', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'ExecuteProvisionedProductPlanOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'ExecuteProvisionedProductServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'ProvisionedProductId', 'ServiceActionId', 'ExecuteToken', ], 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ServiceActionId' => [ 'shape' => 'Id', ], 'ExecuteToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Parameters' => [ 'shape' => 'ExecutionParameterMap', ], ], ], 'ExecuteProvisionedProductServiceActionOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'ExecutionParameter' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ExecutionParameterKey', ], 'Type' => [ 'shape' => 'ExecutionParameterType', ], 'DefaultValues' => [ 'shape' => 'ExecutionParameterValueList', ], ], ], 'ExecutionParameterKey' => [ 'type' => 'string', 'max' => 50, 'min' => 1, ], 'ExecutionParameterMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ExecutionParameterKey', ], 'value' => [ 'shape' => 'ExecutionParameterValueList', ], 'max' => 200, 'min' => 1, ], 'ExecutionParameterType' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ExecutionParameterValue' => [ 'type' => 'string', 'max' => 512, 'min' => 0, ], 'ExecutionParameterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExecutionParameterValue', ], 'max' => 25, 'min' => 0, ], 'ExecutionParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExecutionParameter', ], ], 'FailedServiceActionAssociation' => [ 'type' => 'structure', 'members' => [ 'ServiceActionId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ErrorCode' => [ 'shape' => 'ServiceActionAssociationErrorCode', ], 'ErrorMessage' => [ 'shape' => 'ServiceActionAssociationErrorMessage', ], ], ], 'FailedServiceActionAssociations' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedServiceActionAssociation', ], 'max' => 50, ], 'GetAWSOrganizationsAccessStatusInput' => [ 'type' => 'structure', 'members' => [], ], 'GetAWSOrganizationsAccessStatusOutput' => [ 'type' => 'structure', 'members' => [ 'AccessStatus' => [ 'shape' => 'AccessStatus', ], ], ], 'GetProvisionedProductOutputsInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'OutputKeys' => [ 'shape' => 'OutputKeys', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'GetProvisionedProductOutputsOutput' => [ 'type' => 'structure', 'members' => [ 'Outputs' => [ 'shape' => 'RecordOutputs', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'HasDefaultPath' => [ 'type' => 'boolean', ], 'Id' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_\\-]*', ], 'IdempotencyToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9_-]*', ], 'IgnoreErrors' => [ 'type' => 'boolean', ], 'ImportAsProvisionedProductInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', 'ProvisionedProductName', 'PhysicalId', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'PhysicalId' => [ 'shape' => 'PhysicalId', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'ImportAsProvisionedProductOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'InstructionType' => [ 'type' => 'string', ], 'InstructionValue' => [ 'type' => 'string', ], 'InvalidParametersException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InvalidStateException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'LastRequestId' => [ 'type' => 'string', ], 'LastSuccessfulSyncTime' => [ 'type' => 'timestamp', ], 'LastSync' => [ 'type' => 'structure', 'members' => [ 'LastSyncTime' => [ 'shape' => 'LastSyncTime', ], 'LastSyncStatus' => [ 'shape' => 'LastSyncStatus', ], 'LastSyncStatusMessage' => [ 'shape' => 'LastSyncStatusMessage', ], 'LastSuccessfulSyncTime' => [ 'shape' => 'LastSuccessfulSyncTime', ], 'LastSuccessfulSyncProvisioningArtifactId' => [ 'shape' => 'Id', ], ], ], 'LastSyncStatus' => [ 'type' => 'string', 'enum' => [ 'SUCCEEDED', 'FAILED', ], ], 'LastSyncStatusMessage' => [ 'type' => 'string', ], 'LastSyncTime' => [ 'type' => 'timestamp', ], 'LaunchPath' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'PortfolioName', ], ], ], 'LaunchPathSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'LaunchPathSummary', ], ], 'LaunchPathSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'ConstraintSummaries' => [ 'shape' => 'ConstraintSummaries', ], 'Tags' => [ 'shape' => 'Tags', ], 'Name' => [ 'shape' => 'PortfolioName', ], ], ], 'LaunchPaths' => [ 'type' => 'list', 'member' => [ 'shape' => 'LaunchPath', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ListAcceptedPortfolioSharesInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], 'PortfolioShareType' => [ 'shape' => 'PortfolioShareType', ], ], ], 'ListAcceptedPortfolioSharesOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetails' => [ 'shape' => 'PortfolioDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListBudgetsForResourceInput' => [ 'type' => 'structure', 'required' => [ 'ResourceId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ResourceId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListBudgetsForResourceOutput' => [ 'type' => 'structure', 'members' => [ 'Budgets' => [ 'shape' => 'Budgets', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListConstraintsForPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListConstraintsForPortfolioOutput' => [ 'type' => 'structure', 'members' => [ 'ConstraintDetails' => [ 'shape' => 'ConstraintDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListLaunchPathsInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListLaunchPathsOutput' => [ 'type' => 'structure', 'members' => [ 'LaunchPathSummaries' => [ 'shape' => 'LaunchPathSummaries', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListOrganizationPortfolioAccessInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', 'OrganizationNodeType', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'OrganizationNodeType' => [ 'shape' => 'OrganizationNodeType', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSize', ], ], ], 'ListOrganizationPortfolioAccessOutput' => [ 'type' => 'structure', 'members' => [ 'OrganizationNodes' => [ 'shape' => 'OrganizationNodes', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListPortfolioAccessInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'OrganizationParentId' => [ 'shape' => 'Id', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], ], ], 'ListPortfolioAccessOutput' => [ 'type' => 'structure', 'members' => [ 'AccountIds' => [ 'shape' => 'AccountIds', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListPortfoliosForProductInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], ], ], 'ListPortfoliosForProductOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetails' => [ 'shape' => 'PortfolioDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListPortfoliosInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], ], ], 'ListPortfoliosOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetails' => [ 'shape' => 'PortfolioDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListPrincipalsForPortfolioInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListPrincipalsForPortfolioOutput' => [ 'type' => 'structure', 'members' => [ 'Principals' => [ 'shape' => 'Principals', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListProvisionedProductPlansInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisionProductId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'AccessLevelFilter' => [ 'shape' => 'AccessLevelFilter', ], ], ], 'ListProvisionedProductPlansOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductPlans' => [ 'shape' => 'ProvisionedProductPlans', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListProvisioningArtifactsForServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'ServiceActionId', ], 'members' => [ 'ServiceActionId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'ListProvisioningArtifactsForServiceActionOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactViews' => [ 'shape' => 'ProvisioningArtifactViews', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListProvisioningArtifactsInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], ], ], 'ListProvisioningArtifactsOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactDetails' => [ 'shape' => 'ProvisioningArtifactDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListRecordHistoryInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'AccessLevelFilter' => [ 'shape' => 'AccessLevelFilter', ], 'SearchFilter' => [ 'shape' => 'ListRecordHistorySearchFilter', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListRecordHistoryOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetails' => [ 'shape' => 'RecordDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListRecordHistorySearchFilter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'SearchFilterKey', ], 'Value' => [ 'shape' => 'SearchFilterValue', ], ], ], 'ListResourcesForTagOptionInput' => [ 'type' => 'structure', 'required' => [ 'TagOptionId', ], 'members' => [ 'TagOptionId' => [ 'shape' => 'TagOptionId', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListResourcesForTagOptionOutput' => [ 'type' => 'structure', 'members' => [ 'ResourceDetails' => [ 'shape' => 'ResourceDetails', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListServiceActionsForProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', ], 'members' => [ 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'ListServiceActionsForProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionSummaries' => [ 'shape' => 'ServiceActionSummaries', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListServiceActionsInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListServiceActionsOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionSummaries' => [ 'shape' => 'ServiceActionSummaries', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListStackInstancesForProvisionedProductInput' => [ 'type' => 'structure', 'required' => [ 'ProvisionedProductId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSize', ], ], ], 'ListStackInstancesForProvisionedProductOutput' => [ 'type' => 'structure', 'members' => [ 'StackInstances' => [ 'shape' => 'StackInstances', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListTagOptionsFilters' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'TagOptionKey', ], 'Value' => [ 'shape' => 'TagOptionValue', ], 'Active' => [ 'shape' => 'TagOptionActive', ], ], ], 'ListTagOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ListTagOptionsFilters', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ListTagOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'TagOptionDetails' => [ 'shape' => 'TagOptionDetails', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'LogicalResourceId' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'Namespaces' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], ], 'NoEcho' => [ 'type' => 'boolean', ], 'NotificationArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 1, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'NotificationArns' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotificationArn', ], 'max' => 5, ], 'NotifyProvisionProductEngineWorkflowResultInput' => [ 'type' => 'structure', 'required' => [ 'WorkflowToken', 'RecordId', 'Status', 'IdempotencyToken', ], 'members' => [ 'WorkflowToken' => [ 'shape' => 'EngineWorkflowToken', ], 'RecordId' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'EngineWorkflowStatus', ], 'FailureReason' => [ 'shape' => 'EngineWorkflowFailureReason', ], 'ResourceIdentifier' => [ 'shape' => 'EngineWorkflowResourceIdentifier', ], 'Outputs' => [ 'shape' => 'RecordOutputs', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'NotifyProvisionProductEngineWorkflowResultOutput' => [ 'type' => 'structure', 'members' => [], ], 'NotifyTerminateProvisionedProductEngineWorkflowResultInput' => [ 'type' => 'structure', 'required' => [ 'WorkflowToken', 'RecordId', 'Status', 'IdempotencyToken', ], 'members' => [ 'WorkflowToken' => [ 'shape' => 'EngineWorkflowToken', ], 'RecordId' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'EngineWorkflowStatus', ], 'FailureReason' => [ 'shape' => 'EngineWorkflowFailureReason', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'NotifyTerminateProvisionedProductEngineWorkflowResultOutput' => [ 'type' => 'structure', 'members' => [], ], 'NotifyUpdateProvisionedProductEngineWorkflowResultInput' => [ 'type' => 'structure', 'required' => [ 'WorkflowToken', 'RecordId', 'Status', 'IdempotencyToken', ], 'members' => [ 'WorkflowToken' => [ 'shape' => 'EngineWorkflowToken', ], 'RecordId' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'EngineWorkflowStatus', ], 'FailureReason' => [ 'shape' => 'EngineWorkflowFailureReason', ], 'Outputs' => [ 'shape' => 'RecordOutputs', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'NotifyUpdateProvisionedProductEngineWorkflowResultOutput' => [ 'type' => 'structure', 'members' => [], ], 'NullableBoolean' => [ 'type' => 'boolean', 'box' => true, ], 'OperationNotSupportedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'OrganizationNode' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'OrganizationNodeType', ], 'Value' => [ 'shape' => 'OrganizationNodeValue', ], ], ], 'OrganizationNodeType' => [ 'type' => 'string', 'enum' => [ 'ORGANIZATION', 'ORGANIZATIONAL_UNIT', 'ACCOUNT', ], ], 'OrganizationNodeValue' => [ 'type' => 'string', 'pattern' => '(^[0-9]{12}$)|(^arn:aws:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32})|(^o-[a-z0-9]{10,32}$)|(^arn:aws:organizations::\\d{12}:ou\\/o-[a-z0-9]{10,32}\\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$)|(^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$)', ], 'OrganizationNodes' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationNode', ], ], 'OutputDescription' => [ 'type' => 'string', 'max' => 1024, ], 'OutputKey' => [ 'type' => 'string', ], 'OutputKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputKey', ], 'max' => 60, ], 'OutputValue' => [ 'type' => 'string', ], 'Owner' => [ 'type' => 'string', ], 'PageSize' => [ 'type' => 'integer', 'max' => 20, 'min' => 0, ], 'PageSizeMax100' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'PageToken' => [ 'type' => 'string', 'max' => 2024, 'pattern' => '[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*', ], 'ParameterConstraints' => [ 'type' => 'structure', 'members' => [ 'AllowedValues' => [ 'shape' => 'AllowedValues', ], 'AllowedPattern' => [ 'shape' => 'String', ], 'ConstraintDescription' => [ 'shape' => 'String', ], 'MaxLength' => [ 'shape' => 'String', ], 'MinLength' => [ 'shape' => 'String', ], 'MaxValue' => [ 'shape' => 'String', ], 'MinValue' => [ 'shape' => 'String', ], ], ], 'ParameterKey' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'ParameterType' => [ 'type' => 'string', ], 'ParameterValue' => [ 'type' => 'string', 'max' => 4096, ], 'PhysicalId' => [ 'type' => 'string', ], 'PhysicalResourceId' => [ 'type' => 'string', ], 'PlanResourceType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'PortfolioDescription' => [ 'type' => 'string', 'max' => 2000, ], 'PortfolioDetail' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'ARN' => [ 'shape' => 'ResourceARN', ], 'DisplayName' => [ 'shape' => 'PortfolioDisplayName', ], 'Description' => [ 'shape' => 'PortfolioDescription', ], 'CreatedTime' => [ 'shape' => 'CreationTime', ], 'ProviderName' => [ 'shape' => 'ProviderName', ], ], ], 'PortfolioDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortfolioDetail', ], ], 'PortfolioDisplayName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'PortfolioName' => [ 'type' => 'string', ], 'PortfolioShareDetail' => [ 'type' => 'structure', 'members' => [ 'PrincipalId' => [ 'shape' => 'Id', ], 'Type' => [ 'shape' => 'DescribePortfolioShareType', ], 'Accepted' => [ 'shape' => 'Boolean', ], 'ShareTagOptions' => [ 'shape' => 'Boolean', ], 'SharePrincipals' => [ 'shape' => 'Boolean', ], ], ], 'PortfolioShareDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortfolioShareDetail', ], ], 'PortfolioShareType' => [ 'type' => 'string', 'enum' => [ 'IMPORTED', 'AWS_SERVICECATALOG', 'AWS_ORGANIZATIONS', ], ], 'Principal' => [ 'type' => 'structure', 'members' => [ 'PrincipalARN' => [ 'shape' => 'PrincipalARN', ], 'PrincipalType' => [ 'shape' => 'PrincipalType', ], ], ], 'PrincipalARN' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'PrincipalType' => [ 'type' => 'string', 'enum' => [ 'IAM', 'IAM_PATTERN', ], ], 'Principals' => [ 'type' => 'list', 'member' => [ 'shape' => 'Principal', ], ], 'ProductArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 1, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'ProductSource' => [ 'type' => 'string', 'enum' => [ 'ACCOUNT', ], ], 'ProductType' => [ 'type' => 'string', 'enum' => [ 'CLOUD_FORMATION_TEMPLATE', 'MARKETPLACE', 'TERRAFORM_OPEN_SOURCE', 'TERRAFORM_CLOUD', 'EXTERNAL', ], 'max' => 8191, ], 'ProductViewAggregationType' => [ 'type' => 'string', ], 'ProductViewAggregationValue' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'AttributeValue', ], 'ApproximateCount' => [ 'shape' => 'ApproximateCount', ], ], ], 'ProductViewAggregationValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductViewAggregationValue', ], ], 'ProductViewAggregations' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProductViewAggregationType', ], 'value' => [ 'shape' => 'ProductViewAggregationValues', ], ], 'ProductViewDetail' => [ 'type' => 'structure', 'members' => [ 'ProductViewSummary' => [ 'shape' => 'ProductViewSummary', ], 'Status' => [ 'shape' => 'Status', ], 'ProductARN' => [ 'shape' => 'ResourceARN', ], 'CreatedTime' => [ 'shape' => 'CreatedTime', ], 'SourceConnection' => [ 'shape' => 'SourceConnectionDetail', ], ], ], 'ProductViewDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductViewDetail', ], ], 'ProductViewDistributor' => [ 'type' => 'string', ], 'ProductViewFilterBy' => [ 'type' => 'string', 'enum' => [ 'FullTextSearch', 'Owner', 'ProductType', 'SourceProductId', ], ], 'ProductViewFilterValue' => [ 'type' => 'string', ], 'ProductViewFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductViewFilterValue', ], ], 'ProductViewFilters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProductViewFilterBy', ], 'value' => [ 'shape' => 'ProductViewFilterValues', ], ], 'ProductViewName' => [ 'type' => 'string', 'max' => 8191, ], 'ProductViewOwner' => [ 'type' => 'string', 'max' => 8191, ], 'ProductViewShortDescription' => [ 'type' => 'string', 'max' => 8191, ], 'ProductViewSortBy' => [ 'type' => 'string', 'enum' => [ 'Title', 'VersionCount', 'CreationDate', ], ], 'ProductViewSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProductViewSummary', ], ], 'ProductViewSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProductViewName', ], 'Owner' => [ 'shape' => 'ProductViewOwner', ], 'ShortDescription' => [ 'shape' => 'ProductViewShortDescription', ], 'Type' => [ 'shape' => 'ProductType', ], 'Distributor' => [ 'shape' => 'ProductViewDistributor', ], 'HasDefaultPath' => [ 'shape' => 'HasDefaultPath', ], 'SupportEmail' => [ 'shape' => 'SupportEmail', ], 'SupportDescription' => [ 'shape' => 'SupportDescription', ], 'SupportUrl' => [ 'shape' => 'SupportUrl', ], ], ], 'PropertyKey' => [ 'type' => 'string', 'enum' => [ 'OWNER', 'LAUNCH_ROLE', ], 'max' => 128, 'min' => 1, ], 'PropertyName' => [ 'type' => 'string', ], 'PropertyValue' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'ProviderName' => [ 'type' => 'string', 'max' => 50, 'min' => 1, ], 'ProvisionProductInput' => [ 'type' => 'structure', 'required' => [ 'ProvisionedProductName', 'ProvisionToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProductName' => [ 'shape' => 'ProductViewName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactName' => [ 'shape' => 'ProvisioningArtifactName', ], 'PathId' => [ 'shape' => 'Id', ], 'PathName' => [ 'shape' => 'PortfolioDisplayName', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'ProvisioningParameters' => [ 'shape' => 'ProvisioningParameters', ], 'ProvisioningPreferences' => [ 'shape' => 'ProvisioningPreferences', ], 'Tags' => [ 'shape' => 'Tags', ], 'NotificationArns' => [ 'shape' => 'NotificationArns', ], 'ProvisionToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'ProvisionProductOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'ProvisionedProductAttribute' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'Arn' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'Type' => [ 'shape' => 'ProvisionedProductType', ], 'Id' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'ProvisionedProductStatus', ], 'StatusMessage' => [ 'shape' => 'ProvisionedProductStatusMessage', ], 'CreatedTime' => [ 'shape' => 'CreatedTime', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', ], 'LastRecordId' => [ 'shape' => 'Id', ], 'LastProvisioningRecordId' => [ 'shape' => 'Id', ], 'LastSuccessfulProvisioningRecordId' => [ 'shape' => 'Id', ], 'Tags' => [ 'shape' => 'Tags', ], 'PhysicalId' => [ 'shape' => 'PhysicalId', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProductName' => [ 'shape' => 'ProductViewName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactName' => [ 'shape' => 'ProvisioningArtifactName', ], 'UserArn' => [ 'shape' => 'UserArn', ], 'UserArnSession' => [ 'shape' => 'UserArnSession', ], ], ], 'ProvisionedProductAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisionedProductAttribute', ], ], 'ProvisionedProductDetail' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'Arn' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'Type' => [ 'shape' => 'ProvisionedProductType', ], 'Id' => [ 'shape' => 'ProvisionedProductId', ], 'Status' => [ 'shape' => 'ProvisionedProductStatus', ], 'StatusMessage' => [ 'shape' => 'ProvisionedProductStatusMessage', ], 'CreatedTime' => [ 'shape' => 'CreatedTime', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', ], 'LastRecordId' => [ 'shape' => 'LastRequestId', ], 'LastProvisioningRecordId' => [ 'shape' => 'Id', ], 'LastSuccessfulProvisioningRecordId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'LaunchRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'ProvisionedProductDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisionedProductDetail', ], ], 'ProvisionedProductFilters' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProvisionedProductViewFilterBy', ], 'value' => [ 'shape' => 'ProvisionedProductViewFilterValues', ], ], 'ProvisionedProductId' => [ 'type' => 'string', ], 'ProvisionedProductName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9._-]*', ], 'ProvisionedProductNameOrArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 1, 'pattern' => '[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}', ], 'ProvisionedProductPlanDetails' => [ 'type' => 'structure', 'members' => [ 'CreatedTime' => [ 'shape' => 'CreatedTime', ], 'PathId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'PlanName' => [ 'shape' => 'ProvisionedProductPlanName', ], 'PlanId' => [ 'shape' => 'Id', ], 'ProvisionProductId' => [ 'shape' => 'Id', ], 'ProvisionProductName' => [ 'shape' => 'ProvisionedProductName', ], 'PlanType' => [ 'shape' => 'ProvisionedProductPlanType', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'ProvisionedProductPlanStatus', ], 'UpdatedTime' => [ 'shape' => 'UpdatedTime', ], 'NotificationArns' => [ 'shape' => 'NotificationArns', ], 'ProvisioningParameters' => [ 'shape' => 'UpdateProvisioningParameters', ], 'Tags' => [ 'shape' => 'Tags', ], 'StatusMessage' => [ 'shape' => 'StatusMessage', ], ], ], 'ProvisionedProductPlanName' => [ 'type' => 'string', ], 'ProvisionedProductPlanStatus' => [ 'type' => 'string', 'enum' => [ 'CREATE_IN_PROGRESS', 'CREATE_SUCCESS', 'CREATE_FAILED', 'EXECUTE_IN_PROGRESS', 'EXECUTE_SUCCESS', 'EXECUTE_FAILED', ], ], 'ProvisionedProductPlanSummary' => [ 'type' => 'structure', 'members' => [ 'PlanName' => [ 'shape' => 'ProvisionedProductPlanName', ], 'PlanId' => [ 'shape' => 'Id', ], 'ProvisionProductId' => [ 'shape' => 'Id', ], 'ProvisionProductName' => [ 'shape' => 'ProvisionedProductName', ], 'PlanType' => [ 'shape' => 'ProvisionedProductPlanType', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], ], ], 'ProvisionedProductPlanType' => [ 'type' => 'string', 'enum' => [ 'CLOUDFORMATION', ], ], 'ProvisionedProductPlans' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisionedProductPlanSummary', ], ], 'ProvisionedProductProperties' => [ 'type' => 'map', 'key' => [ 'shape' => 'PropertyKey', ], 'value' => [ 'shape' => 'PropertyValue', ], 'max' => 100, 'min' => 1, ], 'ProvisionedProductStatus' => [ 'type' => 'string', 'enum' => [ 'AVAILABLE', 'UNDER_CHANGE', 'TAINTED', 'ERROR', 'PLAN_IN_PROGRESS', ], ], 'ProvisionedProductStatusMessage' => [ 'type' => 'string', ], 'ProvisionedProductType' => [ 'type' => 'string', ], 'ProvisionedProductViewFilterBy' => [ 'type' => 'string', 'enum' => [ 'SearchQuery', ], ], 'ProvisionedProductViewFilterValue' => [ 'type' => 'string', ], 'ProvisionedProductViewFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisionedProductViewFilterValue', ], ], 'ProvisioningArtifact' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProvisioningArtifactName', ], 'Description' => [ 'shape' => 'ProvisioningArtifactDescription', ], 'CreatedTime' => [ 'shape' => 'ProvisioningArtifactCreatedTime', ], 'Guidance' => [ 'shape' => 'ProvisioningArtifactGuidance', ], ], ], 'ProvisioningArtifactActive' => [ 'type' => 'boolean', ], 'ProvisioningArtifactCreatedTime' => [ 'type' => 'timestamp', ], 'ProvisioningArtifactDescription' => [ 'type' => 'string', 'max' => 8192, ], 'ProvisioningArtifactDetail' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProvisioningArtifactName', ], 'Description' => [ 'shape' => 'ProvisioningArtifactName', ], 'Type' => [ 'shape' => 'ProvisioningArtifactType', ], 'CreatedTime' => [ 'shape' => 'CreationTime', ], 'Active' => [ 'shape' => 'ProvisioningArtifactActive', ], 'Guidance' => [ 'shape' => 'ProvisioningArtifactGuidance', ], 'SourceRevision' => [ 'shape' => 'SourceRevision', ], ], ], 'ProvisioningArtifactDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifactDetail', ], ], 'ProvisioningArtifactGuidance' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'DEPRECATED', ], ], 'ProvisioningArtifactInfo' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProvisioningArtifactInfoKey', ], 'value' => [ 'shape' => 'ProvisioningArtifactInfoValue', ], 'max' => 100, 'min' => 1, ], 'ProvisioningArtifactInfoKey' => [ 'type' => 'string', ], 'ProvisioningArtifactInfoValue' => [ 'type' => 'string', ], 'ProvisioningArtifactName' => [ 'type' => 'string', 'max' => 8192, ], 'ProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ProvisioningArtifactOutputKey', ], 'Description' => [ 'shape' => 'OutputDescription', ], ], ], 'ProvisioningArtifactOutputKey' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[a-zA-Z0-9]*', ], 'ProvisioningArtifactOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifactOutput', ], 'max' => 60, ], 'ProvisioningArtifactParameter' => [ 'type' => 'structure', 'members' => [ 'ParameterKey' => [ 'shape' => 'ParameterKey', ], 'DefaultValue' => [ 'shape' => 'DefaultValue', ], 'ParameterType' => [ 'shape' => 'ParameterType', ], 'IsNoEcho' => [ 'shape' => 'NoEcho', ], 'Description' => [ 'shape' => 'Description', ], 'ParameterConstraints' => [ 'shape' => 'ParameterConstraints', ], ], ], 'ProvisioningArtifactParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifactParameter', ], ], 'ProvisioningArtifactPreferences' => [ 'type' => 'structure', 'members' => [ 'StackSetAccounts' => [ 'shape' => 'StackSetAccounts', ], 'StackSetRegions' => [ 'shape' => 'StackSetRegions', ], ], ], 'ProvisioningArtifactProperties' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ProvisioningArtifactName', ], 'Description' => [ 'shape' => 'ProvisioningArtifactDescription', ], 'Info' => [ 'shape' => 'ProvisioningArtifactInfo', ], 'Type' => [ 'shape' => 'ProvisioningArtifactType', ], 'DisableTemplateValidation' => [ 'shape' => 'DisableTemplateValidation', ], ], ], 'ProvisioningArtifactPropertyName' => [ 'type' => 'string', 'enum' => [ 'Id', ], ], 'ProvisioningArtifactPropertyValue' => [ 'type' => 'string', ], 'ProvisioningArtifactSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifactSummary', ], ], 'ProvisioningArtifactSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProvisioningArtifactName', ], 'Description' => [ 'shape' => 'ProvisioningArtifactDescription', ], 'CreatedTime' => [ 'shape' => 'ProvisioningArtifactCreatedTime', ], 'ProvisioningArtifactMetadata' => [ 'shape' => 'ProvisioningArtifactInfo', ], ], ], 'ProvisioningArtifactType' => [ 'type' => 'string', 'enum' => [ 'CLOUD_FORMATION_TEMPLATE', 'MARKETPLACE_AMI', 'MARKETPLACE_CAR', 'TERRAFORM_OPEN_SOURCE', 'TERRAFORM_CLOUD', 'EXTERNAL', ], ], 'ProvisioningArtifactView' => [ 'type' => 'structure', 'members' => [ 'ProductViewSummary' => [ 'shape' => 'ProductViewSummary', ], 'ProvisioningArtifact' => [ 'shape' => 'ProvisioningArtifact', ], ], ], 'ProvisioningArtifactViews' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifactView', ], ], 'ProvisioningArtifacts' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningArtifact', ], ], 'ProvisioningParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ParameterKey', ], 'Value' => [ 'shape' => 'ParameterValue', ], ], ], 'ProvisioningParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProvisioningParameter', ], ], 'ProvisioningPreferences' => [ 'type' => 'structure', 'members' => [ 'StackSetAccounts' => [ 'shape' => 'StackSetAccounts', ], 'StackSetRegions' => [ 'shape' => 'StackSetRegions', ], 'StackSetFailureToleranceCount' => [ 'shape' => 'StackSetFailureToleranceCount', ], 'StackSetFailureTolerancePercentage' => [ 'shape' => 'StackSetFailureTolerancePercentage', ], 'StackSetMaxConcurrencyCount' => [ 'shape' => 'StackSetMaxConcurrencyCount', ], 'StackSetMaxConcurrencyPercentage' => [ 'shape' => 'StackSetMaxConcurrencyPercentage', ], ], ], 'RecordDetail' => [ 'type' => 'structure', 'members' => [ 'RecordId' => [ 'shape' => 'Id', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductName', ], 'Status' => [ 'shape' => 'RecordStatus', ], 'CreatedTime' => [ 'shape' => 'CreatedTime', ], 'UpdatedTime' => [ 'shape' => 'UpdatedTime', ], 'ProvisionedProductType' => [ 'shape' => 'ProvisionedProductType', ], 'RecordType' => [ 'shape' => 'RecordType', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'PathId' => [ 'shape' => 'Id', ], 'RecordErrors' => [ 'shape' => 'RecordErrors', ], 'RecordTags' => [ 'shape' => 'RecordTags', ], 'LaunchRoleArn' => [ 'shape' => 'RoleArn', ], ], ], 'RecordDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordDetail', ], ], 'RecordError' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'ErrorCode', ], 'Description' => [ 'shape' => 'ErrorDescription', ], ], ], 'RecordErrors' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordError', ], ], 'RecordOutput' => [ 'type' => 'structure', 'members' => [ 'OutputKey' => [ 'shape' => 'OutputKey', ], 'OutputValue' => [ 'shape' => 'OutputValue', ], 'Description' => [ 'shape' => 'Description', ], ], ], 'RecordOutputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordOutput', ], ], 'RecordStatus' => [ 'type' => 'string', 'enum' => [ 'CREATED', 'IN_PROGRESS', 'IN_PROGRESS_IN_ERROR', 'SUCCEEDED', 'FAILED', ], ], 'RecordTag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'RecordTagKey', ], 'Value' => [ 'shape' => 'RecordTagValue', ], ], ], 'RecordTagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$', ], 'RecordTagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$', ], 'RecordTags' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordTag', ], 'max' => 50, ], 'RecordType' => [ 'type' => 'string', ], 'Region' => [ 'type' => 'string', ], 'RejectPortfolioShareInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'PortfolioShareType' => [ 'shape' => 'PortfolioShareType', ], ], ], 'RejectPortfolioShareOutput' => [ 'type' => 'structure', 'members' => [], ], 'Replacement' => [ 'type' => 'string', 'enum' => [ 'TRUE', 'FALSE', 'CONDITIONAL', ], ], 'Repository' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'RepositoryArtifactPath' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, ], 'RepositoryBranch' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'RequiresRecreation' => [ 'type' => 'string', 'enum' => [ 'NEVER', 'CONDITIONALLY', 'ALWAYS', ], ], 'ResourceARN' => [ 'type' => 'string', 'max' => 150, 'min' => 1, ], 'ResourceAttribute' => [ 'type' => 'string', 'enum' => [ 'PROPERTIES', 'METADATA', 'CREATIONPOLICY', 'UPDATEPOLICY', 'DELETIONPOLICY', 'TAGS', ], ], 'ResourceChange' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'ChangeAction', ], 'LogicalResourceId' => [ 'shape' => 'LogicalResourceId', ], 'PhysicalResourceId' => [ 'shape' => 'PhysicalResourceId', ], 'ResourceType' => [ 'shape' => 'PlanResourceType', ], 'Replacement' => [ 'shape' => 'Replacement', ], 'Scope' => [ 'shape' => 'Scope', ], 'Details' => [ 'shape' => 'ResourceChangeDetails', ], ], ], 'ResourceChangeDetail' => [ 'type' => 'structure', 'members' => [ 'Target' => [ 'shape' => 'ResourceTargetDefinition', ], 'Evaluation' => [ 'shape' => 'EvaluationType', ], 'CausingEntity' => [ 'shape' => 'CausingEntity', ], ], ], 'ResourceChangeDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceChangeDetail', ], ], 'ResourceChanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceChange', ], ], 'ResourceDetail' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ResourceDetailId', ], 'ARN' => [ 'shape' => 'ResourceDetailARN', ], 'Name' => [ 'shape' => 'ResourceDetailName', ], 'Description' => [ 'shape' => 'ResourceDetailDescription', ], 'CreatedTime' => [ 'shape' => 'ResourceDetailCreatedTime', ], ], ], 'ResourceDetailARN' => [ 'type' => 'string', ], 'ResourceDetailCreatedTime' => [ 'type' => 'timestamp', ], 'ResourceDetailDescription' => [ 'type' => 'string', ], 'ResourceDetailId' => [ 'type' => 'string', ], 'ResourceDetailName' => [ 'type' => 'string', ], 'ResourceDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceDetail', ], ], 'ResourceId' => [ 'type' => 'string', ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'ResourceTargetDefinition' => [ 'type' => 'structure', 'members' => [ 'Attribute' => [ 'shape' => 'ResourceAttribute', ], 'Name' => [ 'shape' => 'PropertyName', ], 'RequiresRecreation' => [ 'shape' => 'RequiresRecreation', ], ], ], 'ResourceType' => [ 'type' => 'string', ], 'RetainPhysicalResources' => [ 'type' => 'boolean', ], 'RoleArn' => [ 'type' => 'string', 'max' => 1224, 'min' => 1, 'pattern' => 'arn:[a-z0-9-\\.]{1,63}:iam::[a-z0-9-\\.]{0,63}:role\\/.{0,1023}', ], 'ScanProvisionedProductsInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'AccessLevelFilter' => [ 'shape' => 'AccessLevelFilter', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'ScanProvisionedProductsOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProducts' => [ 'shape' => 'ProvisionedProductDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'Scope' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceAttribute', ], ], 'SearchFilterKey' => [ 'type' => 'string', ], 'SearchFilterValue' => [ 'type' => 'string', ], 'SearchProductsAsAdminInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'Filters' => [ 'shape' => 'ProductViewFilters', ], 'SortBy' => [ 'shape' => 'ProductViewSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'PageToken' => [ 'shape' => 'PageToken', ], 'PageSize' => [ 'shape' => 'PageSize', ], 'ProductSource' => [ 'shape' => 'ProductSource', ], ], ], 'SearchProductsAsAdminOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewDetails' => [ 'shape' => 'ProductViewDetails', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'SearchProductsInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Filters' => [ 'shape' => 'ProductViewFilters', ], 'PageSize' => [ 'shape' => 'PageSizeMax100', ], 'SortBy' => [ 'shape' => 'ProductViewSortBy', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'SearchProductsOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewSummaries' => [ 'shape' => 'ProductViewSummaries', ], 'ProductViewAggregations' => [ 'shape' => 'ProductViewAggregations', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'SearchProvisionedProductsInput' => [ 'type' => 'structure', 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'AccessLevelFilter' => [ 'shape' => 'AccessLevelFilter', ], 'Filters' => [ 'shape' => 'ProvisionedProductFilters', ], 'SortBy' => [ 'shape' => 'SortField', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], 'PageSize' => [ 'shape' => 'SearchProvisionedProductsPageSize', ], 'PageToken' => [ 'shape' => 'PageToken', ], ], ], 'SearchProvisionedProductsOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProducts' => [ 'shape' => 'ProvisionedProductAttributes', ], 'TotalResultsCount' => [ 'shape' => 'TotalResultsCount', ], 'NextPageToken' => [ 'shape' => 'PageToken', ], ], ], 'SearchProvisionedProductsPageSize' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'ServiceActionAssociation' => [ 'type' => 'structure', 'required' => [ 'ServiceActionId', 'ProductId', 'ProvisioningArtifactId', ], 'members' => [ 'ServiceActionId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], ], ], 'ServiceActionAssociationErrorCode' => [ 'type' => 'string', 'enum' => [ 'DUPLICATE_RESOURCE', 'INTERNAL_FAILURE', 'LIMIT_EXCEEDED', 'RESOURCE_NOT_FOUND', 'THROTTLING', 'INVALID_PARAMETER', ], ], 'ServiceActionAssociationErrorMessage' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ServiceActionAssociations' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceActionAssociation', ], 'max' => 50, 'min' => 1, ], 'ServiceActionDefinitionKey' => [ 'type' => 'string', 'enum' => [ 'Name', 'Version', 'AssumeRole', 'Parameters', ], ], 'ServiceActionDefinitionMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ServiceActionDefinitionKey', ], 'value' => [ 'shape' => 'ServiceActionDefinitionValue', ], 'max' => 100, 'min' => 1, ], 'ServiceActionDefinitionType' => [ 'type' => 'string', 'enum' => [ 'SSM_AUTOMATION', ], ], 'ServiceActionDefinitionValue' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ServiceActionDescription' => [ 'type' => 'string', 'max' => 1024, ], 'ServiceActionDetail' => [ 'type' => 'structure', 'members' => [ 'ServiceActionSummary' => [ 'shape' => 'ServiceActionSummary', ], 'Definition' => [ 'shape' => 'ServiceActionDefinitionMap', ], ], ], 'ServiceActionName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_\\-.]*', ], 'ServiceActionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceActionSummary', ], ], 'ServiceActionSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ServiceActionName', ], 'Description' => [ 'shape' => 'ServiceActionDescription', ], 'DefinitionType' => [ 'shape' => 'ServiceActionDefinitionType', ], ], ], 'ShareDetails' => [ 'type' => 'structure', 'members' => [ 'SuccessfulShares' => [ 'shape' => 'SuccessfulShares', ], 'ShareErrors' => [ 'shape' => 'ShareErrors', ], ], ], 'ShareError' => [ 'type' => 'structure', 'members' => [ 'Accounts' => [ 'shape' => 'Namespaces', ], 'Message' => [ 'shape' => 'Message', ], 'Error' => [ 'shape' => 'Error', ], ], ], 'ShareErrors' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShareError', ], ], 'ShareStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETED', 'COMPLETED_WITH_ERRORS', 'ERROR', ], ], 'SortField' => [ 'type' => 'string', ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'SourceConnection' => [ 'type' => 'structure', 'required' => [ 'ConnectionParameters', ], 'members' => [ 'Type' => [ 'shape' => 'SourceType', ], 'ConnectionParameters' => [ 'shape' => 'SourceConnectionParameters', ], ], ], 'SourceConnectionDetail' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'SourceType', ], 'ConnectionParameters' => [ 'shape' => 'SourceConnectionParameters', ], 'LastSync' => [ 'shape' => 'LastSync', ], ], ], 'SourceConnectionParameters' => [ 'type' => 'structure', 'members' => [ 'CodeStar' => [ 'shape' => 'CodeStarParameters', ], ], ], 'SourceProvisioningArtifactProperties' => [ 'type' => 'list', 'member' => [ 'shape' => 'SourceProvisioningArtifactPropertiesMap', ], ], 'SourceProvisioningArtifactPropertiesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ProvisioningArtifactPropertyName', ], 'value' => [ 'shape' => 'ProvisioningArtifactPropertyValue', ], ], 'SourceRevision' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'CODESTAR', ], ], 'StackInstance' => [ 'type' => 'structure', 'members' => [ 'Account' => [ 'shape' => 'AccountId', ], 'Region' => [ 'shape' => 'Region', ], 'StackInstanceStatus' => [ 'shape' => 'StackInstanceStatus', ], ], ], 'StackInstanceStatus' => [ 'type' => 'string', 'enum' => [ 'CURRENT', 'OUTDATED', 'INOPERABLE', ], ], 'StackInstances' => [ 'type' => 'list', 'member' => [ 'shape' => 'StackInstance', ], ], 'StackSetAccounts' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], ], 'StackSetFailureToleranceCount' => [ 'type' => 'integer', 'min' => 0, ], 'StackSetFailureTolerancePercentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'StackSetMaxConcurrencyCount' => [ 'type' => 'integer', 'min' => 1, ], 'StackSetMaxConcurrencyPercentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'StackSetOperationType' => [ 'type' => 'string', 'enum' => [ 'CREATE', 'UPDATE', 'DELETE', ], ], 'StackSetRegions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Region', ], ], 'Status' => [ 'type' => 'string', 'enum' => [ 'AVAILABLE', 'CREATING', 'FAILED', ], ], 'StatusDetail' => [ 'type' => 'string', ], 'StatusMessage' => [ 'type' => 'string', 'pattern' => '[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*', ], 'String' => [ 'type' => 'string', ], 'SuccessfulShares' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountId', ], ], 'SupportDescription' => [ 'type' => 'string', 'max' => 8191, ], 'SupportEmail' => [ 'type' => 'string', 'max' => 254, ], 'SupportUrl' => [ 'type' => 'string', 'max' => 2083, ], '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}_.:/=+\\-@]*)$', ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagOptionActive' => [ 'type' => 'boolean', ], 'TagOptionDetail' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'TagOptionKey', ], 'Value' => [ 'shape' => 'TagOptionValue', ], 'Active' => [ 'shape' => 'TagOptionActive', ], 'Id' => [ 'shape' => 'TagOptionId', ], 'Owner' => [ 'shape' => 'Owner', ], ], ], 'TagOptionDetails' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagOptionDetail', ], ], 'TagOptionId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'TagOptionKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagOptionNotMigratedException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'TagOptionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagOptionSummary', ], ], 'TagOptionSummary' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'TagOptionKey', ], 'Values' => [ 'shape' => 'TagOptionValues', ], ], ], 'TagOptionValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagOptionValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagOptionValue', ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, ], 'TerminateProvisionedProductInput' => [ 'type' => 'structure', 'required' => [ 'TerminateToken', ], 'members' => [ 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'TerminateToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], 'IgnoreErrors' => [ 'shape' => 'IgnoreErrors', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'RetainPhysicalResources' => [ 'shape' => 'RetainPhysicalResources', ], ], ], 'TerminateProvisionedProductOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'TotalResultsCount' => [ 'type' => 'integer', ], 'UniqueTagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$', ], 'UniqueTagResourceIdentifier' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'UniqueTagKey', ], 'Value' => [ 'shape' => 'UniqueTagValue', ], ], ], 'UniqueTagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$', ], 'UpdateConstraintInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'Description' => [ 'shape' => 'ConstraintDescription', ], 'Parameters' => [ 'shape' => 'ConstraintParameters', ], ], ], 'UpdateConstraintOutput' => [ 'type' => 'structure', 'members' => [ 'ConstraintDetail' => [ 'shape' => 'ConstraintDetail', ], 'ConstraintParameters' => [ 'shape' => 'ConstraintParameters', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'UpdatePortfolioInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'DisplayName' => [ 'shape' => 'PortfolioDisplayName', ], 'Description' => [ 'shape' => 'PortfolioDescription', ], 'ProviderName' => [ 'shape' => 'ProviderName', ], 'AddTags' => [ 'shape' => 'AddTags', ], 'RemoveTags' => [ 'shape' => 'TagKeys', ], ], ], 'UpdatePortfolioOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioDetail' => [ 'shape' => 'PortfolioDetail', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'UpdatePortfolioShareInput' => [ 'type' => 'structure', 'required' => [ 'PortfolioId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'PortfolioId' => [ 'shape' => 'Id', ], 'AccountId' => [ 'shape' => 'AccountId', ], 'OrganizationNode' => [ 'shape' => 'OrganizationNode', ], 'ShareTagOptions' => [ 'shape' => 'NullableBoolean', ], 'SharePrincipals' => [ 'shape' => 'NullableBoolean', ], ], ], 'UpdatePortfolioShareOutput' => [ 'type' => 'structure', 'members' => [ 'PortfolioShareToken' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'ShareStatus', ], ], ], 'UpdateProductInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProductViewName', ], 'Owner' => [ 'shape' => 'ProductViewOwner', ], 'Description' => [ 'shape' => 'ProductViewShortDescription', ], 'Distributor' => [ 'shape' => 'ProductViewOwner', ], 'SupportDescription' => [ 'shape' => 'SupportDescription', ], 'SupportEmail' => [ 'shape' => 'SupportEmail', ], 'SupportUrl' => [ 'shape' => 'SupportUrl', ], 'AddTags' => [ 'shape' => 'AddTags', ], 'RemoveTags' => [ 'shape' => 'TagKeys', ], 'SourceConnection' => [ 'shape' => 'SourceConnection', ], ], ], 'UpdateProductOutput' => [ 'type' => 'structure', 'members' => [ 'ProductViewDetail' => [ 'shape' => 'ProductViewDetail', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'UpdateProvisionedProductInput' => [ 'type' => 'structure', 'required' => [ 'UpdateToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisionedProductName' => [ 'shape' => 'ProvisionedProductNameOrArn', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProductName' => [ 'shape' => 'ProductViewName', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactName' => [ 'shape' => 'ProvisioningArtifactName', ], 'PathId' => [ 'shape' => 'Id', ], 'PathName' => [ 'shape' => 'PortfolioDisplayName', ], 'ProvisioningParameters' => [ 'shape' => 'UpdateProvisioningParameters', ], 'ProvisioningPreferences' => [ 'shape' => 'UpdateProvisioningPreferences', ], 'Tags' => [ 'shape' => 'Tags', ], 'UpdateToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'UpdateProvisionedProductOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDetail' => [ 'shape' => 'RecordDetail', ], ], ], 'UpdateProvisionedProductPropertiesInput' => [ 'type' => 'structure', 'required' => [ 'ProvisionedProductId', 'ProvisionedProductProperties', 'IdempotencyToken', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ProvisionedProductProperties' => [ 'shape' => 'ProvisionedProductProperties', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', 'idempotencyToken' => true, ], ], ], 'UpdateProvisionedProductPropertiesOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisionedProductId' => [ 'shape' => 'Id', ], 'ProvisionedProductProperties' => [ 'shape' => 'ProvisionedProductProperties', ], 'RecordId' => [ 'shape' => 'Id', ], 'Status' => [ 'shape' => 'RecordStatus', ], ], ], 'UpdateProvisioningArtifactInput' => [ 'type' => 'structure', 'required' => [ 'ProductId', 'ProvisioningArtifactId', ], 'members' => [ 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], 'ProductId' => [ 'shape' => 'Id', ], 'ProvisioningArtifactId' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ProvisioningArtifactName', ], 'Description' => [ 'shape' => 'ProvisioningArtifactDescription', ], 'Active' => [ 'shape' => 'ProvisioningArtifactActive', ], 'Guidance' => [ 'shape' => 'ProvisioningArtifactGuidance', ], ], ], 'UpdateProvisioningArtifactOutput' => [ 'type' => 'structure', 'members' => [ 'ProvisioningArtifactDetail' => [ 'shape' => 'ProvisioningArtifactDetail', ], 'Info' => [ 'shape' => 'ProvisioningArtifactInfo', ], 'Status' => [ 'shape' => 'Status', ], ], ], 'UpdateProvisioningParameter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ParameterKey', ], 'Value' => [ 'shape' => 'ParameterValue', ], 'UsePreviousValue' => [ 'shape' => 'UsePreviousValue', ], ], ], 'UpdateProvisioningParameters' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdateProvisioningParameter', ], ], 'UpdateProvisioningPreferences' => [ 'type' => 'structure', 'members' => [ 'StackSetAccounts' => [ 'shape' => 'StackSetAccounts', ], 'StackSetRegions' => [ 'shape' => 'StackSetRegions', ], 'StackSetFailureToleranceCount' => [ 'shape' => 'StackSetFailureToleranceCount', ], 'StackSetFailureTolerancePercentage' => [ 'shape' => 'StackSetFailureTolerancePercentage', ], 'StackSetMaxConcurrencyCount' => [ 'shape' => 'StackSetMaxConcurrencyCount', ], 'StackSetMaxConcurrencyPercentage' => [ 'shape' => 'StackSetMaxConcurrencyPercentage', ], 'StackSetOperationType' => [ 'shape' => 'StackSetOperationType', ], ], ], 'UpdateServiceActionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'ServiceActionName', ], 'Definition' => [ 'shape' => 'ServiceActionDefinitionMap', ], 'Description' => [ 'shape' => 'ServiceActionDescription', ], 'AcceptLanguage' => [ 'shape' => 'AcceptLanguage', ], ], ], 'UpdateServiceActionOutput' => [ 'type' => 'structure', 'members' => [ 'ServiceActionDetail' => [ 'shape' => 'ServiceActionDetail', ], ], ], 'UpdateTagOptionInput' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TagOptionId', ], 'Value' => [ 'shape' => 'TagOptionValue', ], 'Active' => [ 'shape' => 'TagOptionActive', ], ], ], 'UpdateTagOptionOutput' => [ 'type' => 'structure', 'members' => [ 'TagOptionDetail' => [ 'shape' => 'TagOptionDetail', ], ], ], 'UpdatedTime' => [ 'type' => 'timestamp', ], 'UsageInstruction' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'InstructionType', ], 'Value' => [ 'shape' => 'InstructionValue', ], ], ], 'UsageInstructions' => [ 'type' => 'list', 'member' => [ 'shape' => 'UsageInstruction', ], ], 'UsePreviousValue' => [ 'type' => 'boolean', ], 'UserArn' => [ 'type' => 'string', ], 'UserArnSession' => [ 'type' => 'string', ], 'Verbose' => [ 'type' => 'boolean', ], ],]; diff --git a/src/data/servicecatalog/2015-12-10/docs-2.json b/src/data/servicecatalog/2015-12-10/docs-2.json index fc5b846d84..aeaa668e87 100644 --- a/src/data/servicecatalog/2015-12-10/docs-2.json +++ b/src/data/servicecatalog/2015-12-10/docs-2.json @@ -329,7 +329,7 @@ "base": null, "refs": { "CreatePortfolioShareInput$ShareTagOptions": "

Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

", - "CreatePortfolioShareInput$SharePrincipals": "

Enables or disables Principal sharing when creating the portfolio share. If this flag is not provided, principal sharing is disabled.

When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in the recipient account before or after creating the share.

", + "CreatePortfolioShareInput$SharePrincipals": "

This parameter is only supported for portfolios with an OrganizationalNode Type of ORGANIZATION or ORGANIZATIONAL_UNIT.

Enables or disables Principal sharing when creating the portfolio share. If you do not provide this flag, principal sharing is disabled.

When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in the recipient account before or after creating the share.

", "DescribeProvisioningArtifactInput$IncludeProvisioningArtifactParameters": "

Indicates if the API call response does or does not include additional details about the provisioning parameters.

", "PortfolioShareDetail$Accepted": "

Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.

", "PortfolioShareDetail$ShareTagOptions": "

Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

", @@ -1236,6 +1236,7 @@ "IdempotencyToken": { "base": null, "refs": { + "AssociateServiceActionWithProvisioningArtifactInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request.

", "CopyProductInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

", "CreateConstraintInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

", "CreatePortfolioInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

", @@ -1243,6 +1244,8 @@ "CreateProvisionedProductPlanInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

", "CreateProvisioningArtifactInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

", "CreateServiceActionInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

", + "DeleteServiceActionInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request.

", + "DisassociateServiceActionFromProvisioningArtifactInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request.

", "ExecuteProvisionedProductPlanInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

", "ExecuteProvisionedProductServiceActionInput$ExecuteToken": "

An idempotency token that uniquely identifies the execute request.

", "ImportAsProvisionedProductInput$IdempotencyToken": "

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

", diff --git a/src/data/servicecatalog/2015-12-10/docs-2.json.php b/src/data/servicecatalog/2015-12-10/docs-2.json.php index 92af0e0b42..d3a94d9ddd 100644 --- a/src/data/servicecatalog/2015-12-10/docs-2.json.php +++ b/src/data/servicecatalog/2015-12-10/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Service Catalog

Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in Service Catalog Concepts.

', 'operations' => [ 'AcceptPortfolioShare' => '

Accepts an offer to share the specified portfolio.

', 'AssociateBudgetWithResource' => '

Associates the specified budget with the specified resource.

', 'AssociatePrincipalWithPortfolio' => '

Associates the specified principal ARN with the specified portfolio.

If you share the portfolio with principal name sharing enabled, the PrincipalARN association is included in the share.

The PortfolioID, PrincipalARN, and PrincipalType parameters are required.

You can associate a maximum of 10 Principals with a portfolio using PrincipalType as IAM_PATTERN.

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

', 'AssociateProductWithPortfolio' => '

Associates the specified product with the specified portfolio.

A delegated admin is authorized to invoke this command.

', 'AssociateServiceActionWithProvisioningArtifact' => '

Associates a self-service action with a provisioning artifact.

', 'AssociateTagOptionWithResource' => '

Associate the specified TagOption with the specified portfolio or product.

', 'BatchAssociateServiceActionWithProvisioningArtifact' => '

Associates multiple self-service actions with provisioning artifacts.

', 'BatchDisassociateServiceActionFromProvisioningArtifact' => '

Disassociates a batch of self-service actions from the specified provisioning artifact.

', 'CopyProduct' => '

Copies the specified source product to the specified target product or a new product.

You can copy a product to the same account or another account. You can copy a product to the same Region or another Region. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare.

This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

', 'CreateConstraint' => '

Creates a constraint.

A delegated admin is authorized to invoke this command.

', 'CreatePortfolio' => '

Creates a portfolio.

A delegated admin is authorized to invoke this command.

', 'CreatePortfolioShare' => '

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

You can\'t share a shared resource, including portfolios that contain a shared product.

If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

', 'CreateProduct' => '

Creates a product.

A delegated admin is authorized to invoke this command.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

', 'CreateProvisionedProductPlan' => '

Creates a plan.

A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.

You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.

To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

', 'CreateProvisioningArtifact' => '

Creates a provisioning artifact (also known as a version) for the specified product.

You cannot create a provisioning artifact for a product that was shared with you.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

', 'CreateServiceAction' => '

Creates a self-service action.

', 'CreateTagOption' => '

Creates a TagOption.

', 'DeleteConstraint' => '

Deletes the specified constraint.

A delegated admin is authorized to invoke this command.

', 'DeletePortfolio' => '

Deletes the specified portfolio.

You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.

A delegated admin is authorized to invoke this command.

', 'DeletePortfolioShare' => '

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.

Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

', 'DeleteProduct' => '

Deletes the specified product.

You cannot delete a product if it was shared with you or is associated with a portfolio.

A delegated admin is authorized to invoke this command.

', 'DeleteProvisionedProductPlan' => '

Deletes the specified plan.

', 'DeleteProvisioningArtifact' => '

Deletes the specified provisioning artifact (also known as a version) for the specified product.

You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.

', 'DeleteServiceAction' => '

Deletes a self-service action.

', 'DeleteTagOption' => '

Deletes the specified TagOption.

You cannot delete a TagOption if it is associated with a product or portfolio.

', 'DescribeConstraint' => '

Gets information about the specified constraint.

', 'DescribeCopyProductStatus' => '

Gets the status of the specified copy product operation.

', 'DescribePortfolio' => '

Gets information about the specified portfolio.

A delegated admin is authorized to invoke this command.

', 'DescribePortfolioShareStatus' => '

Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.

', 'DescribePortfolioShares' => '

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.

The PortfolioId and Type parameters are both required.

', 'DescribeProduct' => '

Gets information about the specified product.

Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.

', 'DescribeProductAsAdmin' => '

Gets information about the specified product. This operation is run with administrator access.

', 'DescribeProductView' => '

Gets information about the specified product.

', 'DescribeProvisionedProduct' => '

Gets information about the specified provisioned product.

', 'DescribeProvisionedProductPlan' => '

Gets information about the resource changes for the specified plan.

', 'DescribeProvisioningArtifact' => '

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

', 'DescribeProvisioningParameters' => '

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

', 'DescribeRecord' => '

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product\'s history from when he was the owner.

', 'DescribeServiceAction' => '

Describes a self-service action.

', 'DescribeServiceActionExecutionParameters' => '

Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.

', 'DescribeTagOption' => '

Gets information about the specified TagOption.

', 'DisableAWSOrganizationsAccess' => '

Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.

You cannot call this API if there are active delegated administrators in the organization.

Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

If you share an Service Catalog portfolio in an organization within Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio.

', 'DisassociateBudgetFromResource' => '

Disassociates the specified budget from the specified resource.

', 'DisassociatePrincipalFromPortfolio' => '

Disassociates a previously associated principal ARN from a specified portfolio.

The PrincipalType and PrincipalARN must match the AssociatePrincipalWithPortfolio call request details. For example, to disassociate an association created with a PrincipalARN of PrincipalType IAM you must use the PrincipalType IAM when calling DisassociatePrincipalFromPortfolio.

For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.

For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.

If you disassociate a principal from a portfolio, with PrincipalType as IAM, the same principal will still have access to the portfolio if it matches one of the associated principals of type IAM_PATTERN. To fully remove access for a principal, verify all the associated Principals of type IAM_PATTERN, and then ensure you disassociate any IAM_PATTERN principals that match the principal whose access you are removing.

', 'DisassociateProductFromPortfolio' => '

Disassociates the specified product from the specified portfolio.

A delegated admin is authorized to invoke this command.

', 'DisassociateServiceActionFromProvisioningArtifact' => '

Disassociates the specified self-service action association from the specified provisioning artifact.

', 'DisassociateTagOptionFromResource' => '

Disassociates the specified TagOption from the specified resource.

', 'EnableAWSOrganizationsAccess' => '

Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.

When you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your behalf so that your shares stay in sync with any changes in your Organizations structure.

Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services is working to resolve this issue.

', 'ExecuteProvisionedProductPlan' => '

Provisions or modifies a product based on the resource changes for the specified plan.

', 'ExecuteProvisionedProductServiceAction' => '

Executes a self-service action against a provisioned product.

', 'GetAWSOrganizationsAccessStatus' => '

Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.

', 'GetProvisionedProductOutputs' => '

This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

', 'ImportAsProvisionedProduct' => '

Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.

Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks, are not supported.

The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and IMPORT_ROLLBACK_COMPLETE.

Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.

When you import an existing CloudFormation stack into a portfolio, Service Catalog does not apply the product\'s associated constraints during the import process. Service Catalog applies the constraints after you call UpdateProvisionedProduct for the provisioned product.

The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.

You can only import one provisioned product at a time. The product\'s CloudFormation stack must have the IMPORT_COMPLETE status before you import another.

', 'ListAcceptedPortfolioShares' => '

Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.

', 'ListBudgetsForResource' => '

Lists all the budgets associated to the specified resource.

', 'ListConstraintsForPortfolio' => '

Lists the constraints for the specified portfolio and product.

', 'ListLaunchPaths' => '

Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.

When provisioning a product that\'s been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.

', 'ListOrganizationPortfolioAccess' => '

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.

If a delegated admin is de-registered, they can no longer perform this operation.

', 'ListPortfolioAccess' => '

Lists the account IDs that have access to the specified portfolio.

A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

', 'ListPortfolios' => '

Lists all portfolios in the catalog.

', 'ListPortfoliosForProduct' => '

Lists all portfolios that the specified product is associated with.

', 'ListPrincipalsForPortfolio' => '

Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.

', 'ListProvisionedProductPlans' => '

Lists the plans for the specified provisioned product or all plans to which the user has access.

', 'ListProvisioningArtifacts' => '

Lists all provisioning artifacts (also known as versions) for the specified product.

', 'ListProvisioningArtifactsForServiceAction' => '

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

', 'ListRecordHistory' => '

Lists the specified requests or all performed requests.

', 'ListResourcesForTagOption' => '

Lists the resources associated with the specified TagOption.

', 'ListServiceActions' => '

Lists all self-service actions.

', 'ListServiceActionsForProvisioningArtifact' => '

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

', 'ListStackInstancesForProvisionedProduct' => '

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.

', 'ListTagOptions' => '

Lists the specified TagOptions or all TagOptions.

', 'NotifyProvisionProductEngineWorkflowResult' => '

Notifies the result of the provisioning engine execution.

', 'NotifyTerminateProvisionedProductEngineWorkflowResult' => '

Notifies the result of the terminate engine execution.

', 'NotifyUpdateProvisionedProductEngineWorkflowResult' => '

Notifies the result of the update engine execution.

', 'ProvisionProduct' => '

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product that\'s based on an CloudFormation template launches an CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.

If the request contains a tag key with an empty list of values, there\'s a tag conflict for that key. Don\'t include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

When provisioning a product that\'s been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.

', 'RejectPortfolioShare' => '

Rejects an offer to share the specified portfolio.

', 'ScanProvisionedProducts' => '

Lists the provisioned products that are available (not terminated).

To use additional filtering, see SearchProvisionedProducts.

', 'SearchProducts' => '

Gets information about the products to which the caller has access.

', 'SearchProductsAsAdmin' => '

Gets information about the products for the specified portfolio or all products.

', 'SearchProvisionedProducts' => '

Gets information about the provisioned products that meet the specified criteria.

', 'TerminateProvisionedProduct' => '

Terminates the specified provisioned product.

This operation does not delete any records associated with the provisioned product.

You can check the status of this request using DescribeRecord.

', 'UpdateConstraint' => '

Updates the specified constraint.

', 'UpdatePortfolio' => '

Updates the specified portfolio.

You cannot update a product that was shared with you.

', 'UpdatePortfolioShare' => '

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share.

The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be completed.

You must provide the accountId or organization node in the input, but not both.

If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.

This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

', 'UpdateProduct' => '

Updates the specified product.

', 'UpdateProvisionedProduct' => '

Requests updates to the configuration of the specified provisioned product.

If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.

You can check the status of this request using DescribeRecord.

', 'UpdateProvisionedProductProperties' => '

Requests updates to the properties of the specified provisioned product.

', 'UpdateProvisioningArtifact' => '

Updates the specified provisioning artifact (also known as a version) for the specified product.

You cannot update a provisioning artifact for a product that was shared with you.

', 'UpdateServiceAction' => '

Updates a self-service action.

', 'UpdateTagOption' => '

Updates the specified TagOption.

', ], 'shapes' => [ 'AcceptLanguage' => [ 'base' => NULL, 'refs' => [ 'AcceptPortfolioShareInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'AssociatePrincipalWithPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'AssociateProductWithPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'AssociateServiceActionWithProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'BatchAssociateServiceActionWithProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'BatchDisassociateServiceActionFromProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CopyProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreateConstraintInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreatePortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreatePortfolioShareInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreateProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreateProvisionedProductPlanInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreateProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreateServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeleteConstraintInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeletePortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeletePortfolioShareInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeleteProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeleteProvisionedProductPlanInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeleteProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeleteServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeConstraintInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeCopyProductStatusInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribePortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProductAsAdminInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProductViewInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProvisionedProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProvisionedProductPlanInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProvisioningParametersInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeRecordInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeServiceActionExecutionParametersInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DisassociatePrincipalFromPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DisassociateProductFromPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DisassociateServiceActionFromProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ExecuteProvisionedProductPlanInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ExecuteProvisionedProductServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'GetProvisionedProductOutputsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ImportAsProvisionedProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListAcceptedPortfolioSharesInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListBudgetsForResourceInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListConstraintsForPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListLaunchPathsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListOrganizationPortfolioAccessInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListPortfolioAccessInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListPortfoliosForProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListPortfoliosInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListPrincipalsForPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListProvisionedProductPlansInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListProvisioningArtifactsForServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListProvisioningArtifactsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListRecordHistoryInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListServiceActionsForProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListServiceActionsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListStackInstancesForProvisionedProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ProvisionProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'RejectPortfolioShareInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ScanProvisionedProductsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'SearchProductsAsAdminInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'SearchProductsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'SearchProvisionedProductsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'TerminateProvisionedProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateConstraintInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdatePortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdatePortfolioShareInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateProvisionedProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateProvisionedProductPropertiesInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', ], ], 'AcceptPortfolioShareInput' => [ 'base' => NULL, 'refs' => [], ], 'AcceptPortfolioShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'AccessLevelFilter' => [ 'base' => '

The access level to use to filter results.

', 'refs' => [ 'ListProvisionedProductPlansInput$AccessLevelFilter' => '

The access level to use to obtain results. The default is User.

', 'ListRecordHistoryInput$AccessLevelFilter' => '

The access level to use to obtain results. The default is User.

', 'ScanProvisionedProductsInput$AccessLevelFilter' => '

The access level to use to obtain results. The default is User.

', 'SearchProvisionedProductsInput$AccessLevelFilter' => '

The access level to use to obtain results. The default is User.

', ], ], 'AccessLevelFilterKey' => [ 'base' => NULL, 'refs' => [ 'AccessLevelFilter$Key' => '

The access level.

  • Account - Filter results based on the account.

  • Role - Filter results based on the federated role of the specified user.

  • User - Filter results based on the specified user.

', ], ], 'AccessLevelFilterValue' => [ 'base' => NULL, 'refs' => [ 'AccessLevelFilter$Value' => '

The user to which the access level applies. The only supported value is self.

', ], ], 'AccessStatus' => [ 'base' => NULL, 'refs' => [ 'GetAWSOrganizationsAccessStatusOutput$AccessStatus' => '

The status of the portfolio share feature.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AccountIds$member' => NULL, 'ConstraintDetail$Owner' => '

The owner of the constraint.

', 'CreatePortfolioShareInput$AccountId' => '

The Amazon Web Services account ID. For example, 123456789012.

', 'DeletePortfolioShareInput$AccountId' => '

The Amazon Web Services account ID.

', 'Namespaces$member' => NULL, 'StackInstance$Account' => '

The name of the Amazon Web Services account that the stack instance is associated with.

', 'StackSetAccounts$member' => NULL, 'SuccessfulShares$member' => NULL, 'UpdatePortfolioShareInput$AccountId' => '

The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.

', ], ], 'AccountIds' => [ 'base' => NULL, 'refs' => [ 'ListPortfolioAccessOutput$AccountIds' => '

Information about the Amazon Web Services accounts with access to the portfolio.

', ], ], 'AddTags' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioInput$Tags' => '

One or more tags.

', 'CreateProductInput$Tags' => '

One or more tags.

', 'UpdatePortfolioInput$AddTags' => '

The tags to add.

', 'UpdateProductInput$AddTags' => '

The tags to add to the product.

', ], ], 'AllowedValues' => [ 'base' => NULL, 'refs' => [ 'ParameterConstraints$AllowedValues' => '

The values that the administrator has allowed for the parameter.

', ], ], 'ApproximateCount' => [ 'base' => NULL, 'refs' => [ 'ProductViewAggregationValue$ApproximateCount' => '

An approximate count of the products that match the value.

', ], ], 'AssociateBudgetWithResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateBudgetWithResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'AssociatePrincipalWithPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'AssociatePrincipalWithPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateProductWithPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateProductWithPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateServiceActionWithProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateServiceActionWithProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTagOptionWithResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTagOptionWithResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'AttributeValue' => [ 'base' => NULL, 'refs' => [ 'ProductViewAggregationValue$Value' => '

The value of the product view aggregation.

', ], ], 'BatchAssociateServiceActionWithProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchAssociateServiceActionWithProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateServiceActionFromProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateServiceActionFromProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioShareInput$ShareTagOptions' => '

Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

', 'CreatePortfolioShareInput$SharePrincipals' => '

Enables or disables Principal sharing when creating the portfolio share. If this flag is not provided, principal sharing is disabled.

When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in the recipient account before or after creating the share.

', 'DescribeProvisioningArtifactInput$IncludeProvisioningArtifactParameters' => '

Indicates if the API call response does or does not include additional details about the provisioning parameters.

', 'PortfolioShareDetail$Accepted' => '

Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.

', 'PortfolioShareDetail$ShareTagOptions' => '

Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

', 'PortfolioShareDetail$SharePrincipals' => '

Indicates if Principal sharing is enabled or disabled for the portfolio share.

', ], ], 'BudgetDetail' => [ 'base' => '

Information about a budget.

', 'refs' => [ 'Budgets$member' => NULL, ], ], 'BudgetName' => [ 'base' => NULL, 'refs' => [ 'AssociateBudgetWithResourceInput$BudgetName' => '

The name of the budget you want to associate.

', 'BudgetDetail$BudgetName' => '

Name of the associated budget.

', 'DisassociateBudgetFromResourceInput$BudgetName' => '

The name of the budget you want to disassociate.

', ], ], 'Budgets' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioOutput$Budgets' => '

Information about the associated budgets.

', 'DescribeProductAsAdminOutput$Budgets' => '

Information about the associated budgets.

', 'DescribeProductOutput$Budgets' => '

Information about the associated budgets.

', 'ListBudgetsForResourceOutput$Budgets' => '

Information about the associated budgets.

', ], ], 'CausingEntity' => [ 'base' => NULL, 'refs' => [ 'ResourceChangeDetail$CausingEntity' => '

The ID of the entity that caused the change.

', ], ], 'ChangeAction' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Action' => '

The change action.

', ], ], 'CloudWatchDashboard' => [ 'base' => '

Information about a CloudWatch dashboard.

', 'refs' => [ 'CloudWatchDashboards$member' => NULL, ], ], 'CloudWatchDashboardName' => [ 'base' => NULL, 'refs' => [ 'CloudWatchDashboard$Name' => '

The name of the CloudWatch dashboard.

', ], ], 'CloudWatchDashboards' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisionedProductOutput$CloudWatchDashboards' => '

Any CloudWatch dashboards that were created when provisioning the product.

', ], ], 'CodeStarConnectionArn' => [ 'base' => NULL, 'refs' => [ 'CodeStarParameters$ConnectionArn' => '

The CodeStar ARN, which is the connection between Service Catalog and the external repository.

', ], ], 'CodeStarParameters' => [ 'base' => '

The subtype containing details about the Codestar connection Type.

', 'refs' => [ 'SourceConnectionParameters$CodeStar' => '

Provides ConnectionType details.

', ], ], 'ConstraintDescription' => [ 'base' => NULL, 'refs' => [ 'ConstraintDetail$Description' => '

The description of the constraint.

', 'ConstraintSummary$Description' => '

The description of the constraint.

', 'CreateConstraintInput$Description' => '

The description of the constraint.

', 'UpdateConstraintInput$Description' => '

The updated description of the constraint.

', ], ], 'ConstraintDetail' => [ 'base' => '

Information about a constraint.

', 'refs' => [ 'ConstraintDetails$member' => NULL, 'CreateConstraintOutput$ConstraintDetail' => '

Information about the constraint.

', 'DescribeConstraintOutput$ConstraintDetail' => '

Information about the constraint.

', 'UpdateConstraintOutput$ConstraintDetail' => '

Information about the constraint.

', ], ], 'ConstraintDetails' => [ 'base' => NULL, 'refs' => [ 'ListConstraintsForPortfolioOutput$ConstraintDetails' => '

Information about the constraints.

', ], ], 'ConstraintParameters' => [ 'base' => NULL, 'refs' => [ 'CreateConstraintInput$Parameters' => '

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH

You are required to specify either the RoleArn or the LocalRoleName but can\'t use both.

Specify the RoleArn property as follows:

{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

Specify the LocalRoleName property as follows:

{"LocalRoleName": "SCBasicLaunchRole"}

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one LAUNCH constraint on a product and portfolio.

NOTIFICATION

Specify the NotificationArns property as follows:

{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

RESOURCE_UPDATE

Specify the TagUpdatesOnProvisionedProduct property as follows:

{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

STACKSET

Specify the Parameters property as follows:

{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one STACKSET constraint on a product and portfolio.

Products with a STACKSET constraint will launch an CloudFormation stack set.

TEMPLATE

Specify the Rules property. For more information, see Template Constraint Rules.

', 'CreateConstraintOutput$ConstraintParameters' => '

The constraint parameters.

', 'DescribeConstraintOutput$ConstraintParameters' => '

The constraint parameters.

', 'UpdateConstraintInput$Parameters' => '

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH

You are required to specify either the RoleArn or the LocalRoleName but can\'t use both.

Specify the RoleArn property as follows:

{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

Specify the LocalRoleName property as follows:

{"LocalRoleName": "SCBasicLaunchRole"}

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one LAUNCH constraint on a product and portfolio.

NOTIFICATION

Specify the NotificationArns property as follows:

{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

RESOURCE_UPDATE

Specify the TagUpdatesOnProvisionedProduct property as follows:

{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

STACKSET

Specify the Parameters property as follows:

{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one STACKSET constraint on a product and portfolio.

Products with a STACKSET constraint will launch an CloudFormation stack set.

TEMPLATE

Specify the Rules property. For more information, see Template Constraint Rules.

', 'UpdateConstraintOutput$ConstraintParameters' => '

The constraint parameters.

', ], ], 'ConstraintSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningParametersOutput$ConstraintSummaries' => '

Information about the constraints used to provision the product.

', 'LaunchPathSummary$ConstraintSummaries' => '

The constraints on the portfolio-product relationship.

', ], ], 'ConstraintSummary' => [ 'base' => '

Summary information about a constraint.

', 'refs' => [ 'ConstraintSummaries$member' => NULL, ], ], 'ConstraintType' => [ 'base' => NULL, 'refs' => [ 'ConstraintDetail$Type' => '

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • STACKSET

  • TEMPLATE

', 'ConstraintSummary$Type' => '

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • STACKSET

  • TEMPLATE

', 'CreateConstraintInput$Type' => '

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

', ], ], 'CopyOption' => [ 'base' => NULL, 'refs' => [ 'CopyOptions$member' => NULL, ], ], 'CopyOptions' => [ 'base' => NULL, 'refs' => [ 'CopyProductInput$CopyOptions' => '

The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

', ], ], 'CopyProductInput' => [ 'base' => NULL, 'refs' => [], ], 'CopyProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'CopyProductStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeCopyProductStatusOutput$CopyProductStatus' => '

The status of the copy product operation.

', ], ], 'CreateConstraintInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateConstraintOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePortfolioShareInput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePortfolioShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProductInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisionedProductPlanInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisionedProductPlanOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateTagOptionInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateTagOptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatedTime' => [ 'base' => NULL, 'refs' => [ 'ProductViewDetail$CreatedTime' => '

The UTC time stamp of the creation time.

', 'ProvisionedProductAttribute$CreatedTime' => '

The UTC time stamp of the creation time.

', 'ProvisionedProductDetail$CreatedTime' => '

The UTC time stamp of the creation time.

', 'ProvisionedProductPlanDetails$CreatedTime' => '

The UTC time stamp of the creation time.

', 'RecordDetail$CreatedTime' => '

The UTC time stamp of the creation time.

', ], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'PortfolioDetail$CreatedTime' => '

The UTC time stamp of the creation time.

', 'ProvisioningArtifactDetail$CreatedTime' => '

The UTC time stamp of the creation time.

', ], ], 'DefaultValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactParameter$DefaultValue' => '

The default value.

', ], ], 'DeleteConstraintInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConstraintOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePortfolioShareInput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePortfolioShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProductInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisionedProductPlanInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisionedProductPlanOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagOptionInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagOptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConstraintInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConstraintOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCopyProductStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCopyProductStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioShareStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioShareStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioShareType' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioSharesInput$Type' => '

The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

1. ACCOUNT - Represents an external account to account share.

2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.

3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.

4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.

', 'PortfolioShareDetail$Type' => '

The type of the portfolio share.

', ], ], 'DescribePortfolioSharesInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioSharesOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductAsAdminInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductAsAdminOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductViewInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductViewOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisionedProductInput' => [ 'base' => 'DescribeProvisionedProductAPI input structure. AcceptLanguage - [Optional] The language code for localization. Id - [Optional] The provisioned product identifier. Name - [Optional] Another provisioned product identifier. Customers must provide either Id or Name.', 'refs' => [], ], 'DescribeProvisionedProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisionedProductPlanInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisionedProductPlanOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningParametersInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningParametersOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecordInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecordOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServiceActionExecutionParametersInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServiceActionExecutionParametersOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTagOptionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTagOptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactParameter$Description' => '

The description of the parameter.

', 'RecordOutput$Description' => '

The description of the output.

', ], ], 'DisableAWSOrganizationsAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'DisableAWSOrganizationsAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisableTemplateValidation' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactProperties$DisableTemplateValidation' => '

If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.

Service Catalog does not support template validation for the TERRAFORM_OS product type.

', ], ], 'DisassociateBudgetFromResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateBudgetFromResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePrincipalFromPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePrincipalFromPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateProductFromPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateProductFromPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateServiceActionFromProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateServiceActionFromProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTagOptionFromResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTagOptionFromResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DuplicateResourceException' => [ 'base' => '

The specified resource is a duplicate.

', 'refs' => [], ], 'EnableAWSOrganizationsAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'EnableAWSOrganizationsAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'EngineWorkflowFailureReason' => [ 'base' => NULL, 'refs' => [ 'NotifyProvisionProductEngineWorkflowResultInput$FailureReason' => '

The reason why the provisioning engine execution failed.

', 'NotifyTerminateProvisionedProductEngineWorkflowResultInput$FailureReason' => '

The reason why the terminate engine execution failed.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$FailureReason' => '

The reason why the update engine execution failed.

', ], ], 'EngineWorkflowResourceIdentifier' => [ 'base' => '

The ID for the provisioned product resources that are part of a resource group.

', 'refs' => [ 'NotifyProvisionProductEngineWorkflowResultInput$ResourceIdentifier' => '

The ID for the provisioned product resources that are part of a resource group.

', ], ], 'EngineWorkflowStatus' => [ 'base' => NULL, 'refs' => [ 'NotifyProvisionProductEngineWorkflowResultInput$Status' => '

The status of the provisioning engine execution.

', 'NotifyTerminateProvisionedProductEngineWorkflowResultInput$Status' => '

The status of the terminate engine execution.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$Status' => '

The status of the update engine execution.

', ], ], 'EngineWorkflowToken' => [ 'base' => NULL, 'refs' => [ 'NotifyProvisionProductEngineWorkflowResultInput$WorkflowToken' => '

The encrypted contents of the provisioning engine execution payload that Service Catalog sends after the Terraform product provisioning workflow starts.

', 'NotifyTerminateProvisionedProductEngineWorkflowResultInput$WorkflowToken' => '

The encrypted contents of the terminate engine execution payload that Service Catalog sends after the Terraform product terminate workflow starts.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$WorkflowToken' => '

The encrypted contents of the update engine execution payload that Service Catalog sends after the Terraform product update workflow starts.

', ], ], 'Error' => [ 'base' => NULL, 'refs' => [ 'ShareError$Error' => '

Error type that happened when processing the operation.

', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'RecordError$Code' => '

The numeric value of the error.

', ], ], 'ErrorDescription' => [ 'base' => NULL, 'refs' => [ 'RecordError$Description' => '

The description of the error.

', ], ], 'EvaluationType' => [ 'base' => NULL, 'refs' => [ 'ResourceChangeDetail$Evaluation' => '

For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.

', ], ], 'ExecuteProvisionedProductPlanInput' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteProvisionedProductPlanOutput' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteProvisionedProductServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteProvisionedProductServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'ExecutionParameter' => [ 'base' => '

Details of an execution parameter value that is passed to a self-service action when executed on a provisioned product.

', 'refs' => [ 'ExecutionParameters$member' => NULL, ], ], 'ExecutionParameterKey' => [ 'base' => NULL, 'refs' => [ 'ExecutionParameter$Name' => '

The name of the execution parameter.

', 'ExecutionParameterMap$key' => NULL, ], ], 'ExecutionParameterMap' => [ 'base' => NULL, 'refs' => [ 'ExecuteProvisionedProductServiceActionInput$Parameters' => '

A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET, the provided value will override the default value generated by Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for any special parameters such as TARGET.

', ], ], 'ExecutionParameterType' => [ 'base' => NULL, 'refs' => [ 'ExecutionParameter$Type' => '

The execution parameter type.

', ], ], 'ExecutionParameterValue' => [ 'base' => NULL, 'refs' => [ 'ExecutionParameterValueList$member' => NULL, ], ], 'ExecutionParameterValueList' => [ 'base' => NULL, 'refs' => [ 'ExecutionParameter$DefaultValues' => '

The default values for the execution parameter.

', 'ExecutionParameterMap$value' => NULL, ], ], 'ExecutionParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeServiceActionExecutionParametersOutput$ServiceActionParameters' => '

The parameters of the self-service action.

', ], ], 'FailedServiceActionAssociation' => [ 'base' => '

An object containing information about the error, along with identifying information about the self-service action and its associations.

', 'refs' => [ 'FailedServiceActionAssociations$member' => NULL, ], ], 'FailedServiceActionAssociations' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateServiceActionWithProvisioningArtifactOutput$FailedServiceActionAssociations' => '

An object that contains a list of errors, along with information to help you identify the self-service action.

', 'BatchDisassociateServiceActionFromProvisioningArtifactOutput$FailedServiceActionAssociations' => '

An object that contains a list of errors, along with information to help you identify the self-service action.

', ], ], 'GetAWSOrganizationsAccessStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'GetAWSOrganizationsAccessStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetProvisionedProductOutputsInput' => [ 'base' => NULL, 'refs' => [], ], 'GetProvisionedProductOutputsOutput' => [ 'base' => NULL, 'refs' => [], ], 'HasDefaultPath' => [ 'base' => NULL, 'refs' => [ 'ProductViewSummary$HasDefaultPath' => '

Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

', ], ], 'Id' => [ 'base' => NULL, 'refs' => [ 'AcceptPortfolioShareInput$PortfolioId' => '

The portfolio identifier.

', 'AssociateBudgetWithResourceInput$ResourceId' => '

The resource identifier. Either a portfolio-id or a product-id.

', 'AssociatePrincipalWithPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'AssociateProductWithPortfolioInput$ProductId' => '

The product identifier.

', 'AssociateProductWithPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'AssociateProductWithPortfolioInput$SourcePortfolioId' => '

The identifier of the source portfolio.

', 'AssociateServiceActionWithProvisioningArtifactInput$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'AssociateServiceActionWithProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'AssociateServiceActionWithProvisioningArtifactInput$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'ConstraintDetail$ConstraintId' => '

The identifier of the constraint.

', 'ConstraintDetail$ProductId' => '

The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.

', 'ConstraintDetail$PortfolioId' => '

The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.

', 'CopyProductInput$TargetProductId' => '

The identifier of the target product. By default, a new product is created.

', 'CopyProductOutput$CopyProductToken' => '

The token to use to track the progress of the operation.

', 'CreateConstraintInput$PortfolioId' => '

The portfolio identifier.

', 'CreateConstraintInput$ProductId' => '

The product identifier.

', 'CreatePortfolioShareInput$PortfolioId' => '

The portfolio identifier.

', 'CreatePortfolioShareOutput$PortfolioShareToken' => '

The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.

', 'CreateProvisionedProductPlanInput$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

', 'CreateProvisionedProductPlanInput$ProductId' => '

The product identifier.

', 'CreateProvisionedProductPlanInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'CreateProvisionedProductPlanOutput$PlanId' => '

The plan identifier.

', 'CreateProvisionedProductPlanOutput$ProvisionProductId' => '

The product identifier.

', 'CreateProvisionedProductPlanOutput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'CreateProvisioningArtifactInput$ProductId' => '

The product identifier.

', 'DeleteConstraintInput$Id' => '

The identifier of the constraint.

', 'DeletePortfolioInput$Id' => '

The portfolio identifier.

', 'DeletePortfolioShareInput$PortfolioId' => '

The portfolio identifier.

', 'DeletePortfolioShareOutput$PortfolioShareToken' => '

The portfolio share unique identifier. This will only be returned if delete is made to an organization node.

', 'DeleteProductInput$Id' => '

The product identifier.

', 'DeleteProvisionedProductPlanInput$PlanId' => '

The plan identifier.

', 'DeleteProvisioningArtifactInput$ProductId' => '

The product identifier.

', 'DeleteProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'DeleteServiceActionInput$Id' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'DescribeConstraintInput$Id' => '

The identifier of the constraint.

', 'DescribeCopyProductStatusInput$CopyProductToken' => '

The token for the copy product operation. This token is returned by CopyProduct.

', 'DescribeCopyProductStatusOutput$TargetProductId' => '

The identifier of the copied product.

', 'DescribePortfolioInput$Id' => '

The portfolio identifier.

', 'DescribePortfolioShareStatusInput$PortfolioShareToken' => '

The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

', 'DescribePortfolioShareStatusOutput$PortfolioShareToken' => '

The token for the portfolio share operation. For example, share-6v24abcdefghi.

', 'DescribePortfolioShareStatusOutput$PortfolioId' => '

The portfolio identifier.

', 'DescribePortfolioSharesInput$PortfolioId' => '

The unique identifier of the portfolio for which shares will be retrieved.

', 'DescribeProductAsAdminInput$Id' => '

The product identifier.

', 'DescribeProductAsAdminInput$SourcePortfolioId' => '

The unique identifier of the shared portfolio that the specified product is associated with.

You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned.

', 'DescribeProductInput$Id' => '

The product identifier.

', 'DescribeProductViewInput$Id' => '

The product view identifier.

', 'DescribeProvisionedProductInput$Id' => '

The provisioned product identifier. You must provide the name or ID, but not both.

If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

', 'DescribeProvisionedProductPlanInput$PlanId' => '

The plan identifier.

', 'DescribeProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'DescribeProvisioningArtifactInput$ProductId' => '

The product identifier.

', 'DescribeProvisioningParametersInput$ProductId' => '

The product identifier. You must provide the product name or ID, but not both.

', 'DescribeProvisioningParametersInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. You must provide the name or ID, but not both.

', 'DescribeProvisioningParametersInput$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

', 'DescribeRecordInput$Id' => '

The record identifier of the provisioned product. This identifier is returned by the request operation.

', 'DescribeServiceActionExecutionParametersInput$ProvisionedProductId' => '

The identifier of the provisioned product.

', 'DescribeServiceActionExecutionParametersInput$ServiceActionId' => '

The self-service action identifier.

', 'DescribeServiceActionInput$Id' => '

The self-service action identifier.

', 'DisassociateBudgetFromResourceInput$ResourceId' => '

The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.

', 'DisassociatePrincipalFromPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'DisassociateProductFromPortfolioInput$ProductId' => '

The product identifier.

', 'DisassociateProductFromPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'DisassociateServiceActionFromProvisioningArtifactInput$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'DisassociateServiceActionFromProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'DisassociateServiceActionFromProvisioningArtifactInput$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'ExecuteProvisionedProductPlanInput$PlanId' => '

The plan identifier.

', 'ExecuteProvisionedProductServiceActionInput$ProvisionedProductId' => '

The identifier of the provisioned product.

', 'ExecuteProvisionedProductServiceActionInput$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'FailedServiceActionAssociation$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'FailedServiceActionAssociation$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'FailedServiceActionAssociation$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'GetProvisionedProductOutputsInput$ProvisionedProductId' => '

The identifier of the provisioned product that you want the outputs from.

', 'ImportAsProvisionedProductInput$ProductId' => '

The product identifier.

', 'ImportAsProvisionedProductInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'LastSync$LastSuccessfulSyncProvisioningArtifactId' => '

The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.

', 'LaunchPath$Id' => '

The identifier of the launch path.

', 'LaunchPathSummary$Id' => '

The identifier of the product path.

', 'ListBudgetsForResourceInput$ResourceId' => '

The resource identifier.

', 'ListConstraintsForPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'ListConstraintsForPortfolioInput$ProductId' => '

The product identifier.

', 'ListLaunchPathsInput$ProductId' => '

The product identifier.

', 'ListOrganizationPortfolioAccessInput$PortfolioId' => '

The portfolio identifier. For example, port-2abcdext3y5fk.

', 'ListPortfolioAccessInput$PortfolioId' => '

The portfolio identifier.

', 'ListPortfolioAccessInput$OrganizationParentId' => '

The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

', 'ListPortfoliosForProductInput$ProductId' => '

The product identifier.

', 'ListPrincipalsForPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'ListProvisionedProductPlansInput$ProvisionProductId' => '

The product identifier.

', 'ListProvisioningArtifactsForServiceActionInput$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'ListProvisioningArtifactsInput$ProductId' => '

The product identifier.

', 'ListServiceActionsForProvisioningArtifactInput$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'ListServiceActionsForProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'ListStackInstancesForProvisionedProductInput$ProvisionedProductId' => '

The identifier of the provisioned product.

', 'NotifyProvisionProductEngineWorkflowResultInput$RecordId' => '

The identifier of the record.

', 'NotifyTerminateProvisionedProductEngineWorkflowResultInput$RecordId' => '

The identifier of the record.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$RecordId' => '

The identifier of the record.

', 'PortfolioDetail$Id' => '

The portfolio identifier.

', 'PortfolioShareDetail$PrincipalId' => '

The identifier of the recipient entity that received the portfolio share. The recipient entity can be one of the following:

1. An external account.

2. An organziation member account.

3. An organzational unit (OU).

4. The organization itself. (This shares with every account in the organization).

', 'ProductViewSummary$Id' => '

The product view identifier.

', 'ProductViewSummary$ProductId' => '

The product identifier.

', 'ProvisionProductInput$ProductId' => '

The product identifier. You must provide the name or ID, but not both.

', 'ProvisionProductInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. You must provide the name or ID, but not both.

', 'ProvisionProductInput$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

', 'ProvisionedProductAttribute$Id' => '

The identifier of the provisioned product.

', 'ProvisionedProductAttribute$LastRecordId' => '

The record identifier of the last request performed on this provisioned product.

', 'ProvisionedProductAttribute$LastProvisioningRecordId' => '

The record identifier of the last request performed on this provisioned product of the following types:

  • ProvisionProduct

  • UpdateProvisionedProduct

  • ExecuteProvisionedProductPlan

  • TerminateProvisionedProduct

', 'ProvisionedProductAttribute$LastSuccessfulProvisioningRecordId' => '

The record identifier of the last successful request performed on this provisioned product of the following types:

  • ProvisionProduct

  • UpdateProvisionedProduct

  • ExecuteProvisionedProductPlan

  • TerminateProvisionedProduct

', 'ProvisionedProductAttribute$ProductId' => '

The product identifier.

', 'ProvisionedProductAttribute$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'ProvisionedProductDetail$LastProvisioningRecordId' => '

The record identifier of the last request performed on this provisioned product of the following types:

  • ProvisionProduct

  • UpdateProvisionedProduct

  • ExecuteProvisionedProductPlan

  • TerminateProvisionedProduct

', 'ProvisionedProductDetail$LastSuccessfulProvisioningRecordId' => '

The record identifier of the last successful request performed on this provisioned product of the following types:

  • ProvisionProduct

  • UpdateProvisionedProduct

  • ExecuteProvisionedProductPlan

  • TerminateProvisionedProduct

', 'ProvisionedProductDetail$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'ProvisionedProductDetail$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'ProvisionedProductPlanDetails$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

', 'ProvisionedProductPlanDetails$ProductId' => '

The product identifier.

', 'ProvisionedProductPlanDetails$PlanId' => '

The plan identifier.

', 'ProvisionedProductPlanDetails$ProvisionProductId' => '

The product identifier.

', 'ProvisionedProductPlanDetails$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'ProvisionedProductPlanSummary$PlanId' => '

The plan identifier.

', 'ProvisionedProductPlanSummary$ProvisionProductId' => '

The product identifier.

', 'ProvisionedProductPlanSummary$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'ProvisioningArtifact$Id' => '

The identifier of the provisioning artifact.

', 'ProvisioningArtifactDetail$Id' => '

The identifier of the provisioning artifact.

', 'ProvisioningArtifactSummary$Id' => '

The identifier of the provisioning artifact.

', 'RecordDetail$RecordId' => '

The identifier of the record.

', 'RecordDetail$ProvisionedProductId' => '

The identifier of the provisioned product.

', 'RecordDetail$ProductId' => '

The product identifier.

', 'RecordDetail$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'RecordDetail$PathId' => '

The path identifier.

', 'RejectPortfolioShareInput$PortfolioId' => '

The portfolio identifier.

', 'SearchProductsAsAdminInput$PortfolioId' => '

The portfolio identifier.

', 'ServiceActionAssociation$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'ServiceActionAssociation$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'ServiceActionAssociation$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'ServiceActionSummary$Id' => '

The self-service action identifier.

', 'TerminateProvisionedProductInput$ProvisionedProductId' => '

The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

', 'UpdateConstraintInput$Id' => '

The identifier of the constraint.

', 'UpdatePortfolioInput$Id' => '

The portfolio identifier.

', 'UpdatePortfolioShareInput$PortfolioId' => '

The unique identifier of the portfolio for which the share will be updated.

', 'UpdatePortfolioShareOutput$PortfolioShareToken' => '

The token that tracks the status of the UpdatePortfolioShare operation for external account to account or organizational type sharing.

', 'UpdateProductInput$Id' => '

The product identifier.

', 'UpdateProvisionedProductInput$ProvisionedProductId' => '

The identifier of the provisioned product. You must provide the name or ID, but not both.

', 'UpdateProvisionedProductInput$ProductId' => '

The identifier of the product. You must provide the name or ID, but not both.

', 'UpdateProvisionedProductInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'UpdateProvisionedProductInput$PathId' => '

The path identifier. This value is optional if the product has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.

', 'UpdateProvisionedProductPropertiesInput$ProvisionedProductId' => '

The identifier of the provisioned product.

', 'UpdateProvisionedProductPropertiesOutput$ProvisionedProductId' => '

The provisioned product identifier.

', 'UpdateProvisionedProductPropertiesOutput$RecordId' => '

The identifier of the record.

', 'UpdateProvisioningArtifactInput$ProductId' => '

The product identifier.

', 'UpdateProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'UpdateServiceActionInput$Id' => '

The self-service action identifier.

', ], ], 'IdempotencyToken' => [ 'base' => NULL, 'refs' => [ 'CopyProductInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreateConstraintInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreatePortfolioInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreateProductInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreateProvisionedProductPlanInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreateProvisioningArtifactInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreateServiceActionInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'ExecuteProvisionedProductPlanInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'ExecuteProvisionedProductServiceActionInput$ExecuteToken' => '

An idempotency token that uniquely identifies the execute request.

', 'ImportAsProvisionedProductInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'NotifyProvisionProductEngineWorkflowResultInput$IdempotencyToken' => '

The idempotency token that identifies the provisioning engine execution.

', 'NotifyTerminateProvisionedProductEngineWorkflowResultInput$IdempotencyToken' => '

The idempotency token that identifies the terminate engine execution.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$IdempotencyToken' => '

The idempotency token that identifies the update engine execution.

', 'ProvisionProductInput$ProvisionToken' => '

An idempotency token that uniquely identifies the provisioning request.

', 'ProvisionedProductAttribute$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'ProvisionedProductDetail$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'TerminateProvisionedProductInput$TerminateToken' => '

An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

', 'UpdateProvisionedProductInput$UpdateToken' => '

The idempotency token that uniquely identifies the provisioning update request.

', 'UpdateProvisionedProductPropertiesInput$IdempotencyToken' => '

The idempotency token that uniquely identifies the provisioning product update request.

', ], ], 'IgnoreErrors' => [ 'base' => NULL, 'refs' => [ 'DeleteProvisionedProductPlanInput$IgnoreErrors' => '

If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

', 'TerminateProvisionedProductInput$IgnoreErrors' => '

If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

', ], ], 'ImportAsProvisionedProductInput' => [ 'base' => NULL, 'refs' => [], ], 'ImportAsProvisionedProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'InstructionType' => [ 'base' => NULL, 'refs' => [ 'UsageInstruction$Type' => '

The usage instruction type for the value.

', ], ], 'InstructionValue' => [ 'base' => NULL, 'refs' => [ 'UsageInstruction$Value' => '

The usage instruction value for this type.

', ], ], 'InvalidParametersException' => [ 'base' => '

One or more parameters provided to the operation are not valid.

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

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

', 'refs' => [], ], 'LastRequestId' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductDetail$LastRecordId' => '

The record identifier of the last request performed on this provisioned product.

', ], ], 'LastSuccessfulSyncTime' => [ 'base' => NULL, 'refs' => [ 'LastSync$LastSuccessfulSyncTime' => '

The time of the latest successful sync from the source repo artifact to the Service Catalog product.

', ], ], 'LastSync' => [ 'base' => '

Provides details about the product\'s connection sync and contains the following sub-fields.

  • LastSyncTime

  • LastSyncStatus

  • LastSyncStatusMessage

  • LastSuccessfulSyncTime

  • LastSuccessfulSyncProvisioningArtifactID

', 'refs' => [ 'SourceConnectionDetail$LastSync' => '

Provides details about the product\'s connection sync and contains the following sub-fields.

  • LastSyncTime

  • LastSyncStatus

  • LastSyncStatusMessage

  • LastSuccessfulSyncTime

  • LastSuccessfulSyncProvisioningArtifactID

', ], ], 'LastSyncStatus' => [ 'base' => NULL, 'refs' => [ 'LastSync$LastSyncStatus' => '

The current status of the sync. Responses include SUCCEEDED or FAILED.

', ], ], 'LastSyncStatusMessage' => [ 'base' => NULL, 'refs' => [ 'LastSync$LastSyncStatusMessage' => '

The sync\'s status message.

', ], ], 'LastSyncTime' => [ 'base' => NULL, 'refs' => [ 'LastSync$LastSyncTime' => '

The time of the last attempted sync from the repository to the Service Catalog product.

', ], ], 'LaunchPath' => [ 'base' => '

A launch path object.

', 'refs' => [ 'LaunchPaths$member' => NULL, ], ], 'LaunchPathSummaries' => [ 'base' => NULL, 'refs' => [ 'ListLaunchPathsOutput$LaunchPathSummaries' => '

Information about the launch path.

', ], ], 'LaunchPathSummary' => [ 'base' => '

Summary information about a product path for a user.

', 'refs' => [ 'LaunchPathSummaries$member' => NULL, ], ], 'LaunchPaths' => [ 'base' => NULL, 'refs' => [ 'DescribeProductOutput$LaunchPaths' => '

Information about the associated launch paths.

', ], ], 'LimitExceededException' => [ 'base' => '

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

', 'refs' => [], ], 'ListAcceptedPortfolioSharesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListAcceptedPortfolioSharesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBudgetsForResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBudgetsForResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListConstraintsForPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'ListConstraintsForPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListLaunchPathsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListLaunchPathsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationPortfolioAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationPortfolioAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfolioAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfolioAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfoliosForProductInput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfoliosForProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfoliosInput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfoliosOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPrincipalsForPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'ListPrincipalsForPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisionedProductPlansInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisionedProductPlansOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningArtifactsForServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningArtifactsForServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningArtifactsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningArtifactsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListRecordHistoryInput' => [ 'base' => NULL, 'refs' => [], ], 'ListRecordHistoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListRecordHistorySearchFilter' => [ 'base' => '

The search filter to use when listing history records.

', 'refs' => [ 'ListRecordHistoryInput$SearchFilter' => '

The search filter to scope the results.

', ], ], 'ListResourcesForTagOptionInput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcesForTagOptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListServiceActionsForProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'ListServiceActionsForProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListServiceActionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListServiceActionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackInstancesForProvisionedProductInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackInstancesForProvisionedProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagOptionsFilters' => [ 'base' => '

Filters to use when listing TagOptions.

', 'refs' => [ 'ListTagOptionsInput$Filters' => '

The search filters. If no search filters are specified, the output includes all TagOptions.

', ], ], 'ListTagOptionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagOptionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'LogicalResourceId' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$LogicalResourceId' => '

The ID of the resource, as defined in the CloudFormation template.

', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ShareError$Message' => '

Information about the error.

', ], ], 'Namespaces' => [ 'base' => NULL, 'refs' => [ 'ShareError$Accounts' => '

List of accounts impacted by the error.

', ], ], 'NoEcho' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactParameter$IsNoEcho' => '

If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.

', ], ], 'NotificationArn' => [ 'base' => NULL, 'refs' => [ 'NotificationArns$member' => NULL, ], ], 'NotificationArns' => [ 'base' => NULL, 'refs' => [ 'CreateProvisionedProductPlanInput$NotificationArns' => '

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

', 'ProvisionProductInput$NotificationArns' => '

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

', 'ProvisionedProductPlanDetails$NotificationArns' => '

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

', ], ], 'NotifyProvisionProductEngineWorkflowResultInput' => [ 'base' => NULL, 'refs' => [], ], 'NotifyProvisionProductEngineWorkflowResultOutput' => [ 'base' => NULL, 'refs' => [], ], 'NotifyTerminateProvisionedProductEngineWorkflowResultInput' => [ 'base' => NULL, 'refs' => [], ], 'NotifyTerminateProvisionedProductEngineWorkflowResultOutput' => [ 'base' => NULL, 'refs' => [], ], 'NotifyUpdateProvisionedProductEngineWorkflowResultInput' => [ 'base' => NULL, 'refs' => [], ], 'NotifyUpdateProvisionedProductEngineWorkflowResultOutput' => [ 'base' => NULL, 'refs' => [], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'UpdatePortfolioShareInput$ShareTagOptions' => '

Enables or disables TagOptions sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.

', 'UpdatePortfolioShareInput$SharePrincipals' => '

A flag to enables or disables Principals sharing in the portfolio. If this field is not provided, the current state of the Principals sharing on the portfolio share will not be modified.

', ], ], 'OperationNotSupportedException' => [ 'base' => '

The operation is not supported.

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

Information about the organization node.

', 'refs' => [ 'CreatePortfolioShareInput$OrganizationNode' => '

The organization node to whom you are going to share. When you pass OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services accounts that are associated to the OrganizationNode. The output returns a PortfolioShareToken, which enables the administrator to monitor the status of the PortfolioShare creation process.

', 'DeletePortfolioShareInput$OrganizationNode' => '

The organization node to whom you are going to stop sharing.

', 'OrganizationNodes$member' => NULL, 'UpdatePortfolioShareInput$OrganizationNode' => NULL, ], ], 'OrganizationNodeType' => [ 'base' => NULL, 'refs' => [ 'ListOrganizationPortfolioAccessInput$OrganizationNodeType' => '

The organization node type that will be returned in the output.

  • ORGANIZATION - Organization that has access to the portfolio.

  • ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.

  • ACCOUNT - Account that has access to the portfolio within your organization.

', 'OrganizationNode$Type' => '

The organization node type.

', ], ], 'OrganizationNodeValue' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioShareStatusOutput$OrganizationNodeValue' => '

Organization node identifier. It can be either account id, organizational unit id or organization id.

', 'OrganizationNode$Value' => '

The identifier of the organization node.

', ], ], 'OrganizationNodes' => [ 'base' => NULL, 'refs' => [ 'ListOrganizationPortfolioAccessOutput$OrganizationNodes' => '

Displays information about the organization nodes.

', ], ], 'OutputDescription' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactOutput$Description' => '

Description of the provisioning artifact output key.

', ], ], 'OutputKey' => [ 'base' => NULL, 'refs' => [ 'OutputKeys$member' => NULL, 'RecordOutput$OutputKey' => '

The output key.

', ], ], 'OutputKeys' => [ 'base' => NULL, 'refs' => [ 'GetProvisionedProductOutputsInput$OutputKeys' => '

The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product.

', ], ], 'OutputValue' => [ 'base' => NULL, 'refs' => [ 'RecordOutput$OutputValue' => '

The output value.

', ], ], 'Owner' => [ 'base' => NULL, 'refs' => [ 'TagOptionDetail$Owner' => '

The Amazon Web Services account Id of the owner account that created the TagOption.

', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisionedProductPlanInput$PageSize' => '

The maximum number of items to return with this call.

', 'DescribeRecordInput$PageSize' => '

The maximum number of items to return with this call.

', 'GetProvisionedProductOutputsInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListBudgetsForResourceInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListConstraintsForPortfolioInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListLaunchPathsInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListOrganizationPortfolioAccessInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListPrincipalsForPortfolioInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListProvisionedProductPlansInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListProvisioningArtifactsForServiceActionInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListRecordHistoryInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListResourcesForTagOptionInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListServiceActionsForProvisioningArtifactInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListServiceActionsInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListStackInstancesForProvisionedProductInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListTagOptionsInput$PageSize' => '

The maximum number of items to return with this call.

', 'ScanProvisionedProductsInput$PageSize' => '

The maximum number of items to return with this call.

', 'SearchProductsAsAdminInput$PageSize' => '

The maximum number of items to return with this call.

', ], ], 'PageSizeMax100' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioSharesInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListAcceptedPortfolioSharesInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListPortfolioAccessInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListPortfoliosForProductInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListPortfoliosInput$PageSize' => '

The maximum number of items to return with this call.

', 'SearchProductsInput$PageSize' => '

The maximum number of items to return with this call.

', ], ], 'PageToken' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioSharesInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'DescribePortfolioSharesOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'DescribeProvisionedProductPlanInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'DescribeProvisionedProductPlanOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'DescribeRecordInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'DescribeRecordOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'GetProvisionedProductOutputsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'GetProvisionedProductOutputsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListAcceptedPortfolioSharesInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListAcceptedPortfolioSharesOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListBudgetsForResourceInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListBudgetsForResourceOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListConstraintsForPortfolioInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListConstraintsForPortfolioOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListLaunchPathsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListLaunchPathsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListOrganizationPortfolioAccessInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListOrganizationPortfolioAccessOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListPortfolioAccessInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListPortfolioAccessOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListPortfoliosForProductInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListPortfoliosForProductOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListPortfoliosInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListPortfoliosOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListPrincipalsForPortfolioInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListPrincipalsForPortfolioOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListProvisionedProductPlansInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListProvisionedProductPlansOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListProvisioningArtifactsForServiceActionInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListProvisioningArtifactsForServiceActionOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListProvisioningArtifactsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListRecordHistoryInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListRecordHistoryOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListResourcesForTagOptionInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListResourcesForTagOptionOutput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListServiceActionsForProvisioningArtifactInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListServiceActionsForProvisioningArtifactOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListServiceActionsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListServiceActionsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListStackInstancesForProvisionedProductInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListStackInstancesForProvisionedProductOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListTagOptionsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListTagOptionsOutput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ScanProvisionedProductsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ScanProvisionedProductsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'SearchProductsAsAdminInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'SearchProductsAsAdminOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'SearchProductsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'SearchProductsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'SearchProvisionedProductsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'SearchProvisionedProductsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', ], ], 'ParameterConstraints' => [ 'base' => '

The constraints that the administrator has put on the parameter.

', 'refs' => [ 'ProvisioningArtifactParameter$ParameterConstraints' => '

Constraints that the administrator has put on a parameter.

', ], ], 'ParameterKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactParameter$ParameterKey' => '

The parameter key.

', 'ProvisioningParameter$Key' => '

The parameter key.

', 'UpdateProvisioningParameter$Key' => '

The parameter key.

', ], ], 'ParameterType' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactParameter$ParameterType' => '

The parameter type.

', ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Value' => '

The parameter value.

', 'UpdateProvisioningParameter$Value' => '

The parameter value.

', ], ], 'PhysicalId' => [ 'base' => NULL, 'refs' => [ 'ImportAsProvisionedProductInput$PhysicalId' => '

The unique identifier of the resource to be imported. It only currently supports CloudFormation stack IDs.

', 'ProvisionedProductAttribute$PhysicalId' => '

The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.

', ], ], 'PhysicalResourceId' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$PhysicalResourceId' => '

The ID of the resource, if it was already created.

', ], ], 'PlanResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$ResourceType' => '

The type of resource.

', ], ], 'PortfolioDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioInput$Description' => '

The description of the portfolio.

', 'PortfolioDetail$Description' => '

The description of the portfolio.

', 'UpdatePortfolioInput$Description' => '

The updated description of the portfolio.

', ], ], 'PortfolioDetail' => [ 'base' => '

Information about a portfolio.

', 'refs' => [ 'CreatePortfolioOutput$PortfolioDetail' => '

Information about the portfolio.

', 'DescribePortfolioOutput$PortfolioDetail' => '

Information about the portfolio.

', 'PortfolioDetails$member' => NULL, 'UpdatePortfolioOutput$PortfolioDetail' => '

Information about the portfolio.

', ], ], 'PortfolioDetails' => [ 'base' => NULL, 'refs' => [ 'ListAcceptedPortfolioSharesOutput$PortfolioDetails' => '

Information about the portfolios.

', 'ListPortfoliosForProductOutput$PortfolioDetails' => '

Information about the portfolios.

', 'ListPortfoliosOutput$PortfolioDetails' => '

Information about the portfolios.

', ], ], 'PortfolioDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioInput$DisplayName' => '

The name to use for display purposes.

', 'DescribeProvisioningParametersInput$PathName' => '

The name of the path. You must provide the name or ID, but not both.

', 'PortfolioDetail$DisplayName' => '

The name to use for display purposes.

', 'ProvisionProductInput$PathName' => '

The name of the path. You must provide the name or ID, but not both.

', 'UpdatePortfolioInput$DisplayName' => '

The name to use for display purposes.

', 'UpdateProvisionedProductInput$PathName' => '

The name of the path. You must provide the name or ID, but not both.

', ], ], 'PortfolioName' => [ 'base' => NULL, 'refs' => [ 'LaunchPath$Name' => '

The name of the launch path.

', 'LaunchPathSummary$Name' => '

The name of the portfolio that contains the product.

', ], ], 'PortfolioShareDetail' => [ 'base' => '

Information about the portfolio share.

', 'refs' => [ 'PortfolioShareDetails$member' => NULL, ], ], 'PortfolioShareDetails' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioSharesOutput$PortfolioShareDetails' => '

Summaries about each of the portfolio shares.

', ], ], 'PortfolioShareType' => [ 'base' => NULL, 'refs' => [ 'AcceptPortfolioShareInput$PortfolioShareType' => '

The type of shared portfolios to accept. The default is to accept imported portfolios.

  • AWS_ORGANIZATIONS - Accept portfolios shared by the management account of your organization.

  • IMPORTED - Accept imported portfolios.

  • AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

For example, aws servicecatalog accept-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS

', 'ListAcceptedPortfolioSharesInput$PortfolioShareType' => '

The type of shared portfolios to list. The default is to list imported portfolios.

  • AWS_ORGANIZATIONS - List portfolios accepted and shared via organizational sharing by the management account or delegated administrator of your organization.

  • AWS_SERVICECATALOG - Deprecated type.

  • IMPORTED - List imported portfolios that have been accepted and shared through account-to-account sharing.

', 'RejectPortfolioShareInput$PortfolioShareType' => '

The type of shared portfolios to reject. The default is to reject imported portfolios.

  • AWS_ORGANIZATIONS - Reject portfolios shared by the management account of your organization.

  • IMPORTED - Reject imported portfolios.

  • AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

For example, aws servicecatalog reject-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS

', ], ], 'Principal' => [ 'base' => '

Information about a principal.

', 'refs' => [ 'Principals$member' => NULL, ], ], 'PrincipalARN' => [ 'base' => NULL, 'refs' => [ 'AssociatePrincipalWithPortfolioInput$PrincipalARN' => '

The ARN of the principal (user, role, or group). If the PrincipalType is IAM, the supported value is a fully defined IAM Amazon Resource Name (ARN). If the PrincipalType is IAM_PATTERN, the supported value is an IAM ARN without an AccountID in the following format:

arn:partition:iam:::resource-type/resource-id

The ARN resource-id can be either:

  • A fully formed resource-id. For example, arn:aws:iam:::role/resource-name or arn:aws:iam:::role/resource-path/resource-name

  • A wildcard ARN. The wildcard ARN accepts IAM_PATTERN values with a "*" or "?" in the resource-id segment of the ARN. For example arn:partition:service:::resource-type/resource-path/resource-name. The new symbols are exclusive to the resource-path and resource-name and cannot replace the resource-type or other ARN values.

    The ARN path and principal name allow unlimited wildcard characters.

Examples of an acceptable wildcard ARN:

  • arn:aws:iam:::role/ResourceName_*

  • arn:aws:iam:::role/*/ResourceName_?

Examples of an unacceptable wildcard ARN:

  • arn:aws:iam:::*/ResourceName

You can associate multiple IAM_PATTERNs even if the account has no principal with that name.

The "?" wildcard character matches zero or one of any character. This is similar to ".?" in regular regex context. The "*" wildcard character matches any number of any characters. This is similar to ".*" in regular regex context.

In the IAM Principal ARN format (arn:partition:iam:::resource-type/resource-path/resource-name), valid resource-type values include user/, group/, or role/. The "?" and "*" characters are allowed only after the resource-type in the resource-id segment. You can use special characters anywhere within the resource-id.

The "*" character also matches the "/" character, allowing paths to be formed within the resource-id. For example, arn:aws:iam:::role/*/ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and arn:aws:iam:::role/pathA/ResourceName_1.

', 'DisassociatePrincipalFromPortfolioInput$PrincipalARN' => '

The ARN of the principal (user, role, or group). This field allows an ARN with no accountID with or without wildcard characters if PrincipalType is IAM_PATTERN.

', 'Principal$PrincipalARN' => '

The ARN of the principal (user, role, or group). This field allows for an ARN with no accountID, with or without wildcard characters if the PrincipalType is an IAM_PATTERN.

For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.

', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'AssociatePrincipalWithPortfolioInput$PrincipalType' => '

The principal type. The supported value is IAM if you use a fully defined Amazon Resource Name (ARN), or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

', 'DisassociatePrincipalFromPortfolioInput$PrincipalType' => '

The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you specify an IAM ARN with no AccountId, with or without wildcard characters.

', 'Principal$PrincipalType' => '

The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

', ], ], 'Principals' => [ 'base' => NULL, 'refs' => [ 'ListPrincipalsForPortfolioOutput$Principals' => '

The PrincipalARNs and corresponding PrincipalTypes associated with the portfolio.

', ], ], 'ProductArn' => [ 'base' => NULL, 'refs' => [ 'CopyProductInput$SourceProductArn' => '

The Amazon Resource Name (ARN) of the source product.

', ], ], 'ProductSource' => [ 'base' => NULL, 'refs' => [ 'SearchProductsAsAdminInput$ProductSource' => '

Access level of the source of the product.

', ], ], 'ProductType' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$ProductType' => '

The type of product.

', 'ProductViewSummary$Type' => '

The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by Amazon Web Services Marketplace.

', ], ], 'ProductViewAggregationType' => [ 'base' => NULL, 'refs' => [ 'ProductViewAggregations$key' => NULL, ], ], 'ProductViewAggregationValue' => [ 'base' => '

A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.

', 'refs' => [ 'ProductViewAggregationValues$member' => NULL, ], ], 'ProductViewAggregationValues' => [ 'base' => NULL, 'refs' => [ 'ProductViewAggregations$value' => NULL, ], ], 'ProductViewAggregations' => [ 'base' => NULL, 'refs' => [ 'SearchProductsOutput$ProductViewAggregations' => '

The product view aggregations.

', ], ], 'ProductViewDetail' => [ 'base' => '

Information about a product view.

', 'refs' => [ 'CreateProductOutput$ProductViewDetail' => '

Information about the product view.

', 'DescribeProductAsAdminOutput$ProductViewDetail' => '

Information about the product view.

', 'ProductViewDetails$member' => NULL, 'UpdateProductOutput$ProductViewDetail' => '

Information about the product view.

', ], ], 'ProductViewDetails' => [ 'base' => NULL, 'refs' => [ 'SearchProductsAsAdminOutput$ProductViewDetails' => '

Information about the product views.

', ], ], 'ProductViewDistributor' => [ 'base' => NULL, 'refs' => [ 'ProductViewSummary$Distributor' => '

The distributor of the product. Contact the product administrator for the significance of this value.

', ], ], 'ProductViewFilterBy' => [ 'base' => NULL, 'refs' => [ 'ProductViewFilters$key' => NULL, ], ], 'ProductViewFilterValue' => [ 'base' => NULL, 'refs' => [ 'ProductViewFilterValues$member' => NULL, ], ], 'ProductViewFilterValues' => [ 'base' => NULL, 'refs' => [ 'ProductViewFilters$value' => NULL, ], ], 'ProductViewFilters' => [ 'base' => NULL, 'refs' => [ 'SearchProductsAsAdminInput$Filters' => '

The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

', 'SearchProductsInput$Filters' => '

The search filters. If no search filters are specified, the output includes all products to which the caller has access.

', ], ], 'ProductViewName' => [ 'base' => NULL, 'refs' => [ 'CopyProductInput$TargetProductName' => '

A name for the target product. The default is the name of the source product.

', 'CreateProductInput$Name' => '

The name of the product.

', 'DescribeProductAsAdminInput$Name' => '

The product name.

', 'DescribeProductInput$Name' => '

The product name.

', 'DescribeProvisioningArtifactInput$ProductName' => '

The product name.

', 'DescribeProvisioningParametersInput$ProductName' => '

The name of the product. You must provide the name or ID, but not both.

', 'ProductViewSummary$Name' => '

The name of the product.

', 'ProvisionProductInput$ProductName' => '

The name of the product. You must provide the name or ID, but not both.

', 'ProvisionedProductAttribute$ProductName' => '

The name of the product.

', 'UpdateProductInput$Name' => '

The updated product name.

', 'UpdateProvisionedProductInput$ProductName' => '

The name of the product. You must provide the name or ID, but not both.

', ], ], 'ProductViewOwner' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$Owner' => '

The owner of the product.

', 'CreateProductInput$Distributor' => '

The distributor of the product.

', 'ProductViewSummary$Owner' => '

The owner of the product. Contact the product administrator for the significance of this value.

', 'UpdateProductInput$Owner' => '

The updated owner of the product.

', 'UpdateProductInput$Distributor' => '

The updated distributor of the product.

', ], ], 'ProductViewShortDescription' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$Description' => '

The description of the product.

', 'ProductViewSummary$ShortDescription' => '

Short description of the product.

', 'UpdateProductInput$Description' => '

The updated description of the product.

', ], ], 'ProductViewSortBy' => [ 'base' => NULL, 'refs' => [ 'SearchProductsAsAdminInput$SortBy' => '

The sort field. If no value is specified, the results are not sorted.

', 'SearchProductsInput$SortBy' => '

The sort field. If no value is specified, the results are not sorted.

', ], ], 'ProductViewSummaries' => [ 'base' => NULL, 'refs' => [ 'SearchProductsOutput$ProductViewSummaries' => '

Information about the product views.

', ], ], 'ProductViewSummary' => [ 'base' => '

Summary information about a product view.

', 'refs' => [ 'DescribeProductOutput$ProductViewSummary' => '

Summary information about the product view.

', 'DescribeProductViewOutput$ProductViewSummary' => '

Summary information about the product.

', 'ProductViewDetail$ProductViewSummary' => '

Summary information about the product view.

', 'ProductViewSummaries$member' => NULL, 'ProvisioningArtifactView$ProductViewSummary' => '

Summary information about a product view.

', ], ], 'PropertyKey' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductProperties$key' => NULL, ], ], 'PropertyName' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$Name' => '

If the attribute is Properties, the value is the name of the property. Otherwise, the value is null.

', ], ], 'PropertyValue' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductProperties$value' => NULL, ], ], 'ProviderName' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioInput$ProviderName' => '

The name of the portfolio provider.

', 'PortfolioDetail$ProviderName' => '

The name of the portfolio provider.

', 'UpdatePortfolioInput$ProviderName' => '

The updated name of the portfolio provider.

', ], ], 'ProvisionProductInput' => [ 'base' => NULL, 'refs' => [], ], 'ProvisionProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'ProvisionedProductAttribute' => [ 'base' => '

Information about a provisioned product.

', 'refs' => [ 'ProvisionedProductAttributes$member' => NULL, ], ], 'ProvisionedProductAttributes' => [ 'base' => NULL, 'refs' => [ 'SearchProvisionedProductsOutput$ProvisionedProducts' => '

Information about the provisioned products.

', ], ], 'ProvisionedProductDetail' => [ 'base' => '

Information about a provisioned product.

', 'refs' => [ 'DescribeProvisionedProductOutput$ProvisionedProductDetail' => '

Information about the provisioned product.

', 'ProvisionedProductDetails$member' => NULL, ], ], 'ProvisionedProductDetails' => [ 'base' => NULL, 'refs' => [ 'ScanProvisionedProductsOutput$ProvisionedProducts' => '

Information about the provisioned products.

', ], ], 'ProvisionedProductFilters' => [ 'base' => NULL, 'refs' => [ 'SearchProvisionedProductsInput$Filters' => '

The search filters.

When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifactId, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

Example: "SearchQuery":["status:AVAILABLE"]

', ], ], 'ProvisionedProductId' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductDetail$Id' => '

The identifier of the provisioned product.

', ], ], 'ProvisionedProductName' => [ 'base' => NULL, 'refs' => [ 'CreateProvisionedProductPlanInput$ProvisionedProductName' => '

A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

', 'CreateProvisionedProductPlanOutput$ProvisionedProductName' => '

The user-friendly name of the provisioned product.

', 'DescribeProvisionedProductInput$Name' => '

The name of the provisioned product. You must provide the name or ID, but not both.

If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

', 'GetProvisionedProductOutputsInput$ProvisionedProductName' => '

The name of the provisioned product that you want the outputs from.

', 'ImportAsProvisionedProductInput$ProvisionedProductName' => '

The user-friendly name of the provisioned product. The value must be unique for the Amazon Web Services account. The name cannot be updated after the product is provisioned.

', 'ProvisionProductInput$ProvisionedProductName' => '

A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

', 'ProvisionedProductPlanDetails$ProvisionProductName' => '

The user-friendly name of the provisioned product.

', 'ProvisionedProductPlanSummary$ProvisionProductName' => '

The user-friendly name of the provisioned product.

', 'RecordDetail$ProvisionedProductName' => '

The user-friendly name of the provisioned product.

', ], ], 'ProvisionedProductNameOrArn' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$Name' => '

The user-friendly name of the provisioned product.

', 'ProvisionedProductAttribute$Arn' => '

The ARN of the provisioned product.

', 'ProvisionedProductDetail$Name' => '

The user-friendly name of the provisioned product.

', 'ProvisionedProductDetail$Arn' => '

The ARN of the provisioned product.

', 'TerminateProvisionedProductInput$ProvisionedProductName' => '

The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

', 'UpdateProvisionedProductInput$ProvisionedProductName' => '

The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

', ], ], 'ProvisionedProductPlanDetails' => [ 'base' => '

Information about a plan.

', 'refs' => [ 'DescribeProvisionedProductPlanOutput$ProvisionedProductPlanDetails' => '

Information about the plan.

', ], ], 'ProvisionedProductPlanName' => [ 'base' => NULL, 'refs' => [ 'CreateProvisionedProductPlanInput$PlanName' => '

The name of the plan.

', 'CreateProvisionedProductPlanOutput$PlanName' => '

The name of the plan.

', 'ProvisionedProductPlanDetails$PlanName' => '

The name of the plan.

', 'ProvisionedProductPlanSummary$PlanName' => '

The name of the plan.

', ], ], 'ProvisionedProductPlanStatus' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductPlanDetails$Status' => '

The status.

', ], ], 'ProvisionedProductPlanSummary' => [ 'base' => '

Summary information about a plan.

', 'refs' => [ 'ProvisionedProductPlans$member' => NULL, ], ], 'ProvisionedProductPlanType' => [ 'base' => NULL, 'refs' => [ 'CreateProvisionedProductPlanInput$PlanType' => '

The plan type.

', 'ProvisionedProductPlanDetails$PlanType' => '

The plan type.

', 'ProvisionedProductPlanSummary$PlanType' => '

The plan type.

', ], ], 'ProvisionedProductPlans' => [ 'base' => NULL, 'refs' => [ 'ListProvisionedProductPlansOutput$ProvisionedProductPlans' => '

Information about the plans.

', ], ], 'ProvisionedProductProperties' => [ 'base' => NULL, 'refs' => [ 'UpdateProvisionedProductPropertiesInput$ProvisionedProductProperties' => '

A map that contains the provisioned product properties to be updated.

The LAUNCH_ROLE key accepts role ARNs. This key allows an administrator to call UpdateProvisionedProductProperties to update the launch role that is associated with a provisioned product. This role is used when an end user calls a provisioning operation such as UpdateProvisionedProduct, TerminateProvisionedProduct, or ExecuteProvisionedProductServiceAction. Only a role ARN is valid. A user ARN is invalid.

The OWNER key accepts user ARNs, IAM role ARNs, and STS assumed-role ARNs. The owner is the user that has permission to see, update, terminate, and execute service actions in the provisioned product.

The administrator can change the owner of a provisioned product to another IAM or STS entity within the same account. Both end user owners and administrators can see ownership history of the provisioned product using the ListRecordHistory API. The new owner can describe all past records for the provisioned product using the DescribeRecord API. The previous owner can no longer use DescribeRecord, but can still see the product\'s history from when he was an owner using ListRecordHistory.

If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or Service Catalog console such as update, terminate, and execute service actions. If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through API or the Service Catalog console on that provisioned product.

', 'UpdateProvisionedProductPropertiesOutput$ProvisionedProductProperties' => '

A map that contains the properties updated.

', ], ], 'ProvisionedProductStatus' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$Status' => '

The current status of the provisioned product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

', 'ProvisionedProductDetail$Status' => '

The current status of the provisioned product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

', ], ], 'ProvisionedProductStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$StatusMessage' => '

The current status message of the provisioned product.

', 'ProvisionedProductDetail$StatusMessage' => '

The current status message of the provisioned product.

', ], ], 'ProvisionedProductType' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$Type' => '

The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

', 'ProvisionedProductDetail$Type' => '

The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

', 'RecordDetail$ProvisionedProductType' => '

The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

', ], ], 'ProvisionedProductViewFilterBy' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductFilters$key' => NULL, ], ], 'ProvisionedProductViewFilterValue' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductViewFilterValues$member' => NULL, ], ], 'ProvisionedProductViewFilterValues' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductFilters$value' => NULL, ], ], 'ProvisioningArtifact' => [ 'base' => '

Information about a provisioning artifact. A provisioning artifact is also known as a product version.

', 'refs' => [ 'ProvisioningArtifactView$ProvisioningArtifact' => '

Information about a provisioning artifact. A provisioning artifact is also known as a product version.

', 'ProvisioningArtifacts$member' => NULL, ], ], 'ProvisioningArtifactActive' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactDetail$Active' => '

Indicates whether the product version is active.

', 'UpdateProvisioningArtifactInput$Active' => '

Indicates whether the product version is active.

Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

', ], ], 'ProvisioningArtifactCreatedTime' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifact$CreatedTime' => '

The UTC time stamp of the creation time.

', 'ProvisioningArtifactSummary$CreatedTime' => '

The UTC time stamp of the creation time.

', ], ], 'ProvisioningArtifactDescription' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifact$Description' => '

The description of the provisioning artifact.

', 'ProvisioningArtifactProperties$Description' => '

The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

', 'ProvisioningArtifactSummary$Description' => '

The description of the provisioning artifact.

', 'UpdateProvisioningArtifactInput$Description' => '

The updated description of the provisioning artifact.

', ], ], 'ProvisioningArtifactDetail' => [ 'base' => '

Information about a provisioning artifact (also known as a version) for a product.

', 'refs' => [ 'CreateProductOutput$ProvisioningArtifactDetail' => '

Information about the provisioning artifact.

', 'CreateProvisioningArtifactOutput$ProvisioningArtifactDetail' => '

Information about the provisioning artifact.

', 'DescribeProvisioningArtifactOutput$ProvisioningArtifactDetail' => '

Information about the provisioning artifact.

', 'ProvisioningArtifactDetails$member' => NULL, 'UpdateProvisioningArtifactOutput$ProvisioningArtifactDetail' => '

Information about the provisioning artifact.

', ], ], 'ProvisioningArtifactDetails' => [ 'base' => NULL, 'refs' => [ 'ListProvisioningArtifactsOutput$ProvisioningArtifactDetails' => '

Information about the provisioning artifacts.

', ], ], 'ProvisioningArtifactGuidance' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifact$Guidance' => '

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

', 'ProvisioningArtifactDetail$Guidance' => '

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

', 'UpdateProvisioningArtifactInput$Guidance' => '

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

The DEFAULT value indicates that the product version is active.

The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

', ], ], 'ProvisioningArtifactInfo' => [ 'base' => NULL, 'refs' => [ 'CreateProvisioningArtifactOutput$Info' => '

Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ].

Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

LoadTemplateFromURL

Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

ImportFromPhysicalId

Use the physical id of the resource that contains the template; currently supports CloudFormation stack ARN.

', 'DescribeProvisioningArtifactOutput$Info' => '

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

', 'ProvisioningArtifactProperties$Info' => '

Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL in JSON format as follows:

"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

', 'ProvisioningArtifactSummary$ProvisioningArtifactMetadata' => '

The metadata for the provisioning artifact. This is used with Amazon Web Services Marketplace products.

', 'UpdateProvisioningArtifactOutput$Info' => '

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

', ], ], 'ProvisioningArtifactInfoKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactInfo$key' => NULL, ], ], 'ProvisioningArtifactInfoValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactInfo$value' => NULL, ], ], 'ProvisioningArtifactName' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningArtifactInput$ProvisioningArtifactName' => '

The provisioning artifact name.

', 'DescribeProvisioningParametersInput$ProvisioningArtifactName' => '

The name of the provisioning artifact. You must provide the name or ID, but not both.

', 'ProvisionProductInput$ProvisioningArtifactName' => '

The name of the provisioning artifact. You must provide the name or ID, but not both.

', 'ProvisionedProductAttribute$ProvisioningArtifactName' => '

The name of the provisioning artifact.

', 'ProvisioningArtifact$Name' => '

The name of the provisioning artifact.

', 'ProvisioningArtifactDetail$Name' => '

The name of the provisioning artifact.

', 'ProvisioningArtifactDetail$Description' => '

The description of the provisioning artifact.

', 'ProvisioningArtifactProperties$Name' => '

The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.

', 'ProvisioningArtifactSummary$Name' => '

The name of the provisioning artifact.

', 'UpdateProvisionedProductInput$ProvisioningArtifactName' => '

The name of the provisioning artifact. You must provide the name or ID, but not both.

', 'UpdateProvisioningArtifactInput$Name' => '

The updated name of the provisioning artifact.

', ], ], 'ProvisioningArtifactOutput' => [ 'base' => '

Provisioning artifact output.

', 'refs' => [ 'ProvisioningArtifactOutputs$member' => NULL, ], ], 'ProvisioningArtifactOutputKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactOutput$Key' => '

The provisioning artifact output key.

', ], ], 'ProvisioningArtifactOutputs' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningParametersOutput$ProvisioningArtifactOutputs' => '

The output of the provisioning artifact.

', 'DescribeProvisioningParametersOutput$ProvisioningArtifactOutputKeys' => '

A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

', ], ], 'ProvisioningArtifactParameter' => [ 'base' => '

Information about a parameter used to provision a product.

', 'refs' => [ 'ProvisioningArtifactParameters$member' => NULL, ], ], 'ProvisioningArtifactParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningArtifactOutput$ProvisioningArtifactParameters' => '

Information about the parameters used to provision the product.

', 'DescribeProvisioningParametersOutput$ProvisioningArtifactParameters' => '

Information about the parameters used to provision the product.

', ], ], 'ProvisioningArtifactPreferences' => [ 'base' => '

The user-defined preferences that will be applied during product provisioning, unless overridden by ProvisioningPreferences or UpdateProvisioningPreferences.

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options in the CloudFormation User Guide.

', 'refs' => [ 'DescribeProvisioningParametersOutput$ProvisioningArtifactPreferences' => '

An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

', ], ], 'ProvisioningArtifactProperties' => [ 'base' => '

Information about a provisioning artifact (also known as a version) for a product.

', 'refs' => [ 'CreateProductInput$ProvisioningArtifactParameters' => '

The configuration of the provisioning artifact.

', 'CreateProvisioningArtifactInput$Parameters' => '

The configuration for the provisioning artifact.

', ], ], 'ProvisioningArtifactPropertyName' => [ 'base' => NULL, 'refs' => [ 'SourceProvisioningArtifactPropertiesMap$key' => NULL, ], ], 'ProvisioningArtifactPropertyValue' => [ 'base' => NULL, 'refs' => [ 'SourceProvisioningArtifactPropertiesMap$value' => NULL, ], ], 'ProvisioningArtifactSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeProductAsAdminOutput$ProvisioningArtifactSummaries' => '

Information about the provisioning artifacts (also known as versions) for the specified product.

', ], ], 'ProvisioningArtifactSummary' => [ 'base' => '

Summary information about a provisioning artifact (also known as a version) for a product.

', 'refs' => [ 'ProvisioningArtifactSummaries$member' => NULL, ], ], 'ProvisioningArtifactType' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactDetail$Type' => '

The type of provisioning artifact.

  • CLOUD_FORMATION_TEMPLATE - CloudFormation template

  • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

  • TERRAFORM_CLOUD - Terraform Cloud configuration file

  • EXTERNAL - External configuration file

', 'ProvisioningArtifactProperties$Type' => '

The type of provisioning artifact.

  • CLOUD_FORMATION_TEMPLATE - CloudFormation template

  • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

  • TERRAFORM_CLOUD - Terraform Cloud configuration file

  • EXTERNAL - External configuration file

', ], ], 'ProvisioningArtifactView' => [ 'base' => '

An object that contains summary information about a product view and a provisioning artifact.

', 'refs' => [ 'ProvisioningArtifactViews$member' => NULL, ], ], 'ProvisioningArtifactViews' => [ 'base' => NULL, 'refs' => [ 'ListProvisioningArtifactsForServiceActionOutput$ProvisioningArtifactViews' => '

An array of objects with information about product views and provisioning artifacts.

', ], ], 'ProvisioningArtifacts' => [ 'base' => NULL, 'refs' => [ 'DescribeProductOutput$ProvisioningArtifacts' => '

Information about the provisioning artifacts for the specified product.

', 'DescribeProductViewOutput$ProvisioningArtifacts' => '

Information about the provisioning artifacts for the product.

', ], ], 'ProvisioningParameter' => [ 'base' => '

Information about a parameter used to provision a product.

', 'refs' => [ 'ProvisioningParameters$member' => NULL, ], ], 'ProvisioningParameters' => [ 'base' => NULL, 'refs' => [ 'ProvisionProductInput$ProvisioningParameters' => '

Parameters specified by the administrator that are required for provisioning the product.

', ], ], 'ProvisioningPreferences' => [ 'base' => '

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product type

One or more Amazon Web Services accounts that will have access to the provisioned product.

Applicable only to a CFN_STACKSET provisioned product type.

The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all accounts from the STACKSET constraint.

', 'refs' => [ 'ProvisionProductInput$ProvisioningPreferences' => '

An object that contains information about the provisioning preferences for a stack set.

', ], ], 'RecordDetail' => [ 'base' => '

Information about a request operation.

', 'refs' => [ 'DescribeRecordOutput$RecordDetail' => '

Information about the product.

', 'ExecuteProvisionedProductPlanOutput$RecordDetail' => '

Information about the result of provisioning the product.

', 'ExecuteProvisionedProductServiceActionOutput$RecordDetail' => '

An object containing detailed information about the result of provisioning the product.

', 'ImportAsProvisionedProductOutput$RecordDetail' => NULL, 'ProvisionProductOutput$RecordDetail' => '

Information about the result of provisioning the product.

', 'RecordDetails$member' => NULL, 'TerminateProvisionedProductOutput$RecordDetail' => '

Information about the result of this request.

', 'UpdateProvisionedProductOutput$RecordDetail' => '

Information about the result of the request.

', ], ], 'RecordDetails' => [ 'base' => NULL, 'refs' => [ 'ListRecordHistoryOutput$RecordDetails' => '

The records, in reverse chronological order.

', ], ], 'RecordError' => [ 'base' => '

The error code and description resulting from an operation.

', 'refs' => [ 'RecordErrors$member' => NULL, ], ], 'RecordErrors' => [ 'base' => NULL, 'refs' => [ 'RecordDetail$RecordErrors' => '

The errors that occurred.

', ], ], 'RecordOutput' => [ 'base' => '

The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

', 'refs' => [ 'RecordOutputs$member' => NULL, ], ], 'RecordOutputs' => [ 'base' => NULL, 'refs' => [ 'DescribeRecordOutput$RecordOutputs' => '

Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

', 'GetProvisionedProductOutputsOutput$Outputs' => '

Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

', 'NotifyProvisionProductEngineWorkflowResultInput$Outputs' => '

The output of the provisioning engine execution.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$Outputs' => '

The output of the update engine execution.

', ], ], 'RecordStatus' => [ 'base' => NULL, 'refs' => [ 'RecordDetail$Status' => '

The status of the provisioned product.

  • CREATED - The request was created but the operation has not started.

  • IN_PROGRESS - The requested operation is in progress.

  • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

  • SUCCEEDED - The requested operation has successfully completed.

  • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

', 'UpdateProvisionedProductPropertiesOutput$Status' => '

The status of the request.

', ], ], 'RecordTag' => [ 'base' => '

Information about a tag, which is a key-value pair.

', 'refs' => [ 'RecordTags$member' => NULL, ], ], 'RecordTagKey' => [ 'base' => NULL, 'refs' => [ 'RecordTag$Key' => '

The key for this tag.

', ], ], 'RecordTagValue' => [ 'base' => NULL, 'refs' => [ 'RecordTag$Value' => '

The value for this tag.

', ], ], 'RecordTags' => [ 'base' => NULL, 'refs' => [ 'RecordDetail$RecordTags' => '

One or more tags.

', ], ], 'RecordType' => [ 'base' => NULL, 'refs' => [ 'RecordDetail$RecordType' => '

The record type.

  • PROVISION_PRODUCT

  • UPDATE_PROVISIONED_PRODUCT

  • TERMINATE_PROVISIONED_PRODUCT

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'StackInstance$Region' => '

The name of the Amazon Web Services Region that the stack instance is associated with.

', 'StackSetRegions$member' => NULL, ], ], 'RejectPortfolioShareInput' => [ 'base' => NULL, 'refs' => [], ], 'RejectPortfolioShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'Replacement' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Replacement' => '

If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one.

', ], ], 'Repository' => [ 'base' => NULL, 'refs' => [ 'CodeStarParameters$Repository' => '

The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."

', ], ], 'RepositoryArtifactPath' => [ 'base' => NULL, 'refs' => [ 'CodeStarParameters$ArtifactPath' => '

The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."

', ], ], 'RepositoryBranch' => [ 'base' => NULL, 'refs' => [ 'CodeStarParameters$Branch' => '

The specific branch where the artifact resides.

', ], ], 'RequiresRecreation' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$RequiresRecreation' => '

If the attribute is Properties, indicates whether a change to this property causes the resource to be re-created.

', ], ], 'ResourceARN' => [ 'base' => NULL, 'refs' => [ 'PortfolioDetail$ARN' => '

The ARN assigned to the portfolio.

', 'ProductViewDetail$ProductARN' => '

The ARN of the product.

', ], ], 'ResourceAttribute' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$Attribute' => '

The attribute to be changed.

', 'Scope$member' => NULL, ], ], 'ResourceChange' => [ 'base' => '

Information about a resource change that will occur when a plan is executed.

', 'refs' => [ 'ResourceChanges$member' => NULL, ], ], 'ResourceChangeDetail' => [ 'base' => '

Information about a change to a resource attribute.

', 'refs' => [ 'ResourceChangeDetails$member' => NULL, ], ], 'ResourceChangeDetails' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Details' => '

Information about the resource changes.

', ], ], 'ResourceChanges' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisionedProductPlanOutput$ResourceChanges' => '

Information about the resource changes that will occur when the plan is executed.

', ], ], 'ResourceDetail' => [ 'base' => '

Information about a resource.

', 'refs' => [ 'ResourceDetails$member' => NULL, ], ], 'ResourceDetailARN' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$ARN' => '

The ARN of the resource.

', ], ], 'ResourceDetailCreatedTime' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$CreatedTime' => '

The creation time of the resource.

', ], ], 'ResourceDetailDescription' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$Description' => '

The description of the resource.

', ], ], 'ResourceDetailId' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$Id' => '

The identifier of the resource.

', ], ], 'ResourceDetailName' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$Name' => '

The name of the resource.

', ], ], 'ResourceDetails' => [ 'base' => NULL, 'refs' => [ 'ListResourcesForTagOptionOutput$ResourceDetails' => '

Information about the resources.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AssociateTagOptionWithResourceInput$ResourceId' => '

The resource identifier.

', 'DisassociateTagOptionFromResourceInput$ResourceId' => '

The resource identifier.

', ], ], 'ResourceInUseException' => [ 'base' => '

A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

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

The specified resource was not found.

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

Information about a change to a resource attribute.

', 'refs' => [ 'ResourceChangeDetail$Target' => '

Information about the resource attribute to be modified.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ListResourcesForTagOptionInput$ResourceType' => '

The resource type.

  • Portfolio

  • Product

', ], ], 'RetainPhysicalResources' => [ 'base' => NULL, 'refs' => [ 'TerminateProvisionedProductInput$RetainPhysicalResources' => '

When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes the Service Catalog provisioned product. However, it does not remove the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductDetail$LaunchRoleArn' => '

The ARN of the launch role associated with the provisioned product.

', 'RecordDetail$LaunchRoleArn' => '

The ARN of the launch role associated with the provisioned product.

', ], ], 'ScanProvisionedProductsInput' => [ 'base' => NULL, 'refs' => [], ], 'ScanProvisionedProductsOutput' => [ 'base' => NULL, 'refs' => [], ], 'Scope' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Scope' => '

The change scope.

', ], ], 'SearchFilterKey' => [ 'base' => NULL, 'refs' => [ 'ListRecordHistorySearchFilter$Key' => '

The filter key.

  • product - Filter results based on the specified product identifier.

  • provisionedproduct - Filter results based on the provisioned product identifier.

', ], ], 'SearchFilterValue' => [ 'base' => NULL, 'refs' => [ 'ListRecordHistorySearchFilter$Value' => '

The filter value.

', ], ], 'SearchProductsAsAdminInput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProductsAsAdminOutput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProductsInput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProductsOutput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProvisionedProductsInput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProvisionedProductsOutput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProvisionedProductsPageSize' => [ 'base' => NULL, 'refs' => [ 'SearchProvisionedProductsInput$PageSize' => '

The maximum number of items to return with this call.

', ], ], 'ServiceActionAssociation' => [ 'base' => '

A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

', 'refs' => [ 'ServiceActionAssociations$member' => NULL, ], ], 'ServiceActionAssociationErrorCode' => [ 'base' => NULL, 'refs' => [ 'FailedServiceActionAssociation$ErrorCode' => '

The error code. Valid values are listed below.

', ], ], 'ServiceActionAssociationErrorMessage' => [ 'base' => NULL, 'refs' => [ 'FailedServiceActionAssociation$ErrorMessage' => '

A text description of the error.

', ], ], 'ServiceActionAssociations' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateServiceActionWithProvisioningArtifactInput$ServiceActionAssociations' => '

One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

', 'BatchDisassociateServiceActionFromProvisioningArtifactInput$ServiceActionAssociations' => '

One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

', ], ], 'ServiceActionDefinitionKey' => [ 'base' => NULL, 'refs' => [ 'ServiceActionDefinitionMap$key' => NULL, ], ], 'ServiceActionDefinitionMap' => [ 'base' => NULL, 'refs' => [ 'CreateServiceActionInput$Definition' => '

The self-service action definition. Can be one of the following:

Name

The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

If you are using a shared SSM document, you must provide the ARN instead of the name.

Version

The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"

AssumeRole

The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

Parameters

The list of parameters in JSON format.

For example: [{\\"Name\\":\\"InstanceId\\",\\"Type\\":\\"TARGET\\"}] or [{\\"Name\\":\\"InstanceId\\",\\"Type\\":\\"TEXT_VALUE\\"}].

', 'ServiceActionDetail$Definition' => '

A map that defines the self-service action.

', 'UpdateServiceActionInput$Definition' => '

A map that defines the self-service action.

', ], ], 'ServiceActionDefinitionType' => [ 'base' => NULL, 'refs' => [ 'CreateServiceActionInput$DefinitionType' => '

The service action definition type. For example, SSM_AUTOMATION.

', 'ServiceActionSummary$DefinitionType' => '

The self-service action definition type. For example, SSM_AUTOMATION.

', ], ], 'ServiceActionDefinitionValue' => [ 'base' => NULL, 'refs' => [ 'ServiceActionDefinitionMap$value' => NULL, ], ], 'ServiceActionDescription' => [ 'base' => NULL, 'refs' => [ 'CreateServiceActionInput$Description' => '

The self-service action description.

', 'ServiceActionSummary$Description' => '

The self-service action description.

', 'UpdateServiceActionInput$Description' => '

The self-service action description.

', ], ], 'ServiceActionDetail' => [ 'base' => '

An object containing detailed information about the self-service action.

', 'refs' => [ 'CreateServiceActionOutput$ServiceActionDetail' => '

An object containing information about the self-service action.

', 'DescribeServiceActionOutput$ServiceActionDetail' => '

Detailed information about the self-service action.

', 'UpdateServiceActionOutput$ServiceActionDetail' => '

Detailed information about the self-service action.

', ], ], 'ServiceActionName' => [ 'base' => NULL, 'refs' => [ 'CreateServiceActionInput$Name' => '

The self-service action name.

', 'ServiceActionSummary$Name' => '

The self-service action name.

', 'UpdateServiceActionInput$Name' => '

The self-service action name.

', ], ], 'ServiceActionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListServiceActionsForProvisioningArtifactOutput$ServiceActionSummaries' => '

An object containing information about the self-service actions associated with the provisioning artifact.

', 'ListServiceActionsOutput$ServiceActionSummaries' => '

An object containing information about the service actions associated with the provisioning artifact.

', ], ], 'ServiceActionSummary' => [ 'base' => '

Detailed information about the self-service action.

', 'refs' => [ 'ServiceActionDetail$ServiceActionSummary' => '

Summary information about the self-service action.

', 'ServiceActionSummaries$member' => NULL, ], ], 'ShareDetails' => [ 'base' => '

Information about the portfolio share operation.

', 'refs' => [ 'DescribePortfolioShareStatusOutput$ShareDetails' => '

Information about the portfolio share operation.

', ], ], 'ShareError' => [ 'base' => '

Errors that occurred during the portfolio share operation.

', 'refs' => [ 'ShareErrors$member' => NULL, ], ], 'ShareErrors' => [ 'base' => NULL, 'refs' => [ 'ShareDetails$ShareErrors' => '

List of errors.

', ], ], 'ShareStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioShareStatusOutput$Status' => '

Status of the portfolio share operation.

', 'UpdatePortfolioShareOutput$Status' => '

The status of UpdatePortfolioShare operation. You can also obtain the operation status using DescribePortfolioShareStatus API.

', ], ], 'SortField' => [ 'base' => NULL, 'refs' => [ 'SearchProvisionedProductsInput$SortBy' => '

The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'SearchProductsAsAdminInput$SortOrder' => '

The sort order. If no value is specified, the results are not sorted.

', 'SearchProductsInput$SortOrder' => '

The sort order. If no value is specified, the results are not sorted.

', 'SearchProvisionedProductsInput$SortOrder' => '

The sort order. If no value is specified, the results are not sorted.

', ], ], 'SourceConnection' => [ 'base' => '

A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

', 'refs' => [ 'CreateProductInput$SourceConnection' => '

Specifies connection details for the created product and syncs the product to the connection source artifact. This automatically manages the product\'s artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.

  • Type

  • ConnectionParamters

', 'UpdateProductInput$SourceConnection' => '

Specifies connection details for the updated product and syncs the product to the connection source artifact. This automatically manages the product\'s artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.

  • Type

  • ConnectionParamters

', ], ], 'SourceConnectionDetail' => [ 'base' => '

Provides details about the configured SourceConnection.

', 'refs' => [ 'ProductViewDetail$SourceConnection' => '

A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

', ], ], 'SourceConnectionParameters' => [ 'base' => '

Provides connection details.

', 'refs' => [ 'SourceConnection$ConnectionParameters' => '

The connection details based on the connection Type.

', 'SourceConnectionDetail$ConnectionParameters' => '

The connection details based on the connection Type.

', ], ], 'SourceProvisioningArtifactProperties' => [ 'base' => NULL, 'refs' => [ 'CopyProductInput$SourceProvisioningArtifactIdentifiers' => '

The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

', ], ], 'SourceProvisioningArtifactPropertiesMap' => [ 'base' => NULL, 'refs' => [ 'SourceProvisioningArtifactProperties$member' => NULL, ], ], 'SourceRevision' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactDetail$SourceRevision' => '

Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

This field only exists for Repo-Synced products.

', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'SourceConnection$Type' => '

The only supported SourceConnection type is Codestar.

', 'SourceConnectionDetail$Type' => '

The only supported SourceConnection type is Codestar.

', ], ], 'StackInstance' => [ 'base' => '

An CloudFormation stack, in a specific account and Region, that\'s part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn\'t be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

', 'refs' => [ 'StackInstances$member' => NULL, ], ], 'StackInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'StackInstance$StackInstanceStatus' => '

The status of the stack instance, in terms of its synchronization with its associated stack set.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

  • OUTDATED: The stack isn\'t currently up to date with the stack set because either the associated stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

  • CURRENT: The stack is currently up to date with the stack set.

', ], ], 'StackInstances' => [ 'base' => NULL, 'refs' => [ 'ListStackInstancesForProvisionedProductOutput$StackInstances' => '

List of stack instances.

', ], ], 'StackSetAccounts' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactPreferences$StackSetAccounts' => '

One or more Amazon Web Services accounts where stack instances are deployed from the stack set. These accounts can be scoped in ProvisioningPreferences$StackSetAccounts and UpdateProvisioningPreferences$StackSetAccounts.

Applicable only to a CFN_STACKSET provisioned product type.

', 'ProvisioningPreferences$StackSetAccounts' => '

One or more Amazon Web Services accounts where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified accounts should be within the list of accounts from the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all acounts from the STACKSET constraint.

', 'UpdateProvisioningPreferences$StackSetAccounts' => '

One or more Amazon Web Services accounts that will have access to the provisioned product.

Applicable only to a CFN_STACKSET provisioned product type.

The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all accounts from the STACKSET constraint.

', ], ], 'StackSetFailureToleranceCount' => [ 'base' => NULL, 'refs' => [ 'ProvisioningPreferences$StackSetFailureToleranceCount' => '

The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn\'t attempt the operation in any subsequent Regions.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

The default value is 0 if no value is specified.

', 'UpdateProvisioningPreferences$StackSetFailureToleranceCount' => '

The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn\'t attempt the operation in any subsequent Regions.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

The default value is 0 if no value is specified.

', ], ], 'StackSetFailureTolerancePercentage' => [ 'base' => NULL, 'refs' => [ 'ProvisioningPreferences$StackSetFailureTolerancePercentage' => '

The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn\'t attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

', 'UpdateProvisioningPreferences$StackSetFailureTolerancePercentage' => '

The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn\'t attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

', ], ], 'StackSetMaxConcurrencyCount' => [ 'base' => NULL, 'refs' => [ 'ProvisioningPreferences$StackSetMaxConcurrencyCount' => '

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

', 'UpdateProvisioningPreferences$StackSetMaxConcurrencyCount' => '

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

', ], ], 'StackSetMaxConcurrencyPercentage' => [ 'base' => NULL, 'refs' => [ 'ProvisioningPreferences$StackSetMaxConcurrencyPercentage' => '

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as 1 instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

', 'UpdateProvisioningPreferences$StackSetMaxConcurrencyPercentage' => '

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as 1 instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

', ], ], 'StackSetOperationType' => [ 'base' => NULL, 'refs' => [ 'UpdateProvisioningPreferences$StackSetOperationType' => '

Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

Applicable only to a CFN_STACKSET provisioned product type.

CREATE

Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

UPDATE

Updates the stack set represented by the provisioned product and also its stack instances.

DELETE

Deletes a stack instance in the stack set represented by the provisioned product.

', ], ], 'StackSetRegions' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactPreferences$StackSetRegions' => '

One or more Amazon Web Services Regions where stack instances are deployed from the stack set. These Regions can be scoped in ProvisioningPreferences$StackSetRegions and UpdateProvisioningPreferences$StackSetRegions.

Applicable only to a CFN_STACKSET provisioned product type.

', 'ProvisioningPreferences$StackSetRegions' => '

One or more Amazon Web Services Regions where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all Regions from the STACKSET constraint.

', 'UpdateProvisioningPreferences$StackSetRegions' => '

One or more Amazon Web Services Regions where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all Regions from the STACKSET constraint.

', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'CreateConstraintOutput$Status' => '

The status of the current request.

', 'CreateProvisioningArtifactOutput$Status' => '

The status of the current request.

', 'DescribeConstraintOutput$Status' => '

The status of the current request.

', 'DescribeProvisioningArtifactOutput$Status' => '

The status of the current request.

', 'ProductViewDetail$Status' => '

The status of the product.

  • AVAILABLE - The product is ready for use.

  • CREATING - Product creation has started; the product is not ready for use.

  • FAILED - An action failed.

', 'UpdateConstraintOutput$Status' => '

The status of the current request.

', 'UpdateProvisioningArtifactOutput$Status' => '

The status of the current request.

', ], ], 'StatusDetail' => [ 'base' => NULL, 'refs' => [ 'DescribeCopyProductStatusOutput$StatusDetail' => '

The status message.

', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductPlanDetails$StatusMessage' => '

The status message.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AllowedValues$member' => NULL, 'ParameterConstraints$AllowedPattern' => '

A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.

', 'ParameterConstraints$ConstraintDescription' => '

A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:

Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.

', 'ParameterConstraints$MaxLength' => '

An integer value that determines the largest number of characters you want to allow for String types.

', 'ParameterConstraints$MinLength' => '

An integer value that determines the smallest number of characters you want to allow for String types.

', 'ParameterConstraints$MaxValue' => '

A numeric value that determines the largest numeric value you want to allow for Number types.

', 'ParameterConstraints$MinValue' => '

A numeric value that determines the smallest numeric value you want to allow for Number types.

', ], ], 'SuccessfulShares' => [ 'base' => NULL, 'refs' => [ 'ShareDetails$SuccessfulShares' => '

List of accounts for whom the operation succeeded.

', ], ], 'SupportDescription' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$SupportDescription' => '

The support information about the product.

', 'ProductViewSummary$SupportDescription' => '

The description of the support for this Product.

', 'UpdateProductInput$SupportDescription' => '

The updated support description for the product.

', ], ], 'SupportEmail' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$SupportEmail' => '

The contact email for product support.

', 'ProductViewSummary$SupportEmail' => '

The email contact information to obtain support for this Product.

', 'UpdateProductInput$SupportEmail' => '

The updated support email for the product.

', ], ], 'SupportUrl' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$SupportUrl' => '

The contact URL for product support.

^https?:\\/\\// / is the pattern used to validate SupportUrl.

', 'ProductViewSummary$SupportUrl' => '

The URL information to obtain support for this Product.

', 'UpdateProductInput$SupportUrl' => '

The updated support URL for the product.

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

Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.

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

The tag key.

', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UpdatePortfolioInput$RemoveTags' => '

The tags to remove.

', 'UpdateProductInput$RemoveTags' => '

The tags to remove from the product.

', ], ], 'TagOptionActive' => [ 'base' => NULL, 'refs' => [ 'ListTagOptionsFilters$Active' => '

The active state.

', 'TagOptionDetail$Active' => '

The TagOption active state.

', 'UpdateTagOptionInput$Active' => '

The updated active state.

', ], ], 'TagOptionDetail' => [ 'base' => '

Information about a TagOption.

', 'refs' => [ 'CreateTagOptionOutput$TagOptionDetail' => '

Information about the TagOption.

', 'DescribeTagOptionOutput$TagOptionDetail' => '

Information about the TagOption.

', 'TagOptionDetails$member' => NULL, 'UpdateTagOptionOutput$TagOptionDetail' => '

Information about the TagOption.

', ], ], 'TagOptionDetails' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioOutput$TagOptions' => '

Information about the TagOptions associated with the portfolio.

', 'DescribeProductAsAdminOutput$TagOptions' => '

Information about the TagOptions associated with the product.

', 'ListTagOptionsOutput$TagOptionDetails' => '

Information about the TagOptions.

', ], ], 'TagOptionId' => [ 'base' => NULL, 'refs' => [ 'AssociateTagOptionWithResourceInput$TagOptionId' => '

The TagOption identifier.

', 'DeleteTagOptionInput$Id' => '

The TagOption identifier.

', 'DescribeTagOptionInput$Id' => '

The TagOption identifier.

', 'DisassociateTagOptionFromResourceInput$TagOptionId' => '

The TagOption identifier.

', 'ListResourcesForTagOptionInput$TagOptionId' => '

The TagOption identifier.

', 'TagOptionDetail$Id' => '

The TagOption identifier.

', 'UpdateTagOptionInput$Id' => '

The TagOption identifier.

', ], ], 'TagOptionKey' => [ 'base' => NULL, 'refs' => [ 'CreateTagOptionInput$Key' => '

The TagOption key.

', 'ListTagOptionsFilters$Key' => '

The TagOption key.

', 'TagOptionDetail$Key' => '

The TagOption key.

', 'TagOptionSummary$Key' => '

The TagOption key.

', ], ], 'TagOptionNotMigratedException' => [ 'base' => '

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

', 'refs' => [], ], 'TagOptionSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningParametersOutput$TagOptions' => '

Information about the TagOptions associated with the resource.

', ], ], 'TagOptionSummary' => [ 'base' => '

Summary information about a TagOption.

', 'refs' => [ 'TagOptionSummaries$member' => NULL, ], ], 'TagOptionValue' => [ 'base' => NULL, 'refs' => [ 'CreateTagOptionInput$Value' => '

The TagOption value.

', 'ListTagOptionsFilters$Value' => '

The TagOption value.

', 'TagOptionDetail$Value' => '

The TagOption value.

', 'TagOptionValues$member' => NULL, 'UpdateTagOptionInput$Value' => '

The updated value.

', ], ], 'TagOptionValues' => [ 'base' => NULL, 'refs' => [ 'TagOptionSummary$Values' => '

The TagOption value.

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

The value for this key.

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioOutput$Tags' => '

Information about the tags associated with the portfolio.

', 'CreateProductOutput$Tags' => '

Information about the tags associated with the product.

', 'CreateProvisionedProductPlanInput$Tags' => '

One or more tags.

If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

', 'DescribePortfolioOutput$Tags' => '

Information about the tags associated with the portfolio.

', 'DescribeProductAsAdminOutput$Tags' => '

Information about the tags associated with the product.

', 'LaunchPathSummary$Tags' => '

The tags associated with this product path.

', 'ProvisionProductInput$Tags' => '

One or more tags.

', 'ProvisionedProductAttribute$Tags' => '

One or more tags.

', 'ProvisionedProductPlanDetails$Tags' => '

One or more tags.

', 'UpdatePortfolioOutput$Tags' => '

Information about the tags associated with the portfolio.

', 'UpdateProductOutput$Tags' => '

Information about the tags associated with the product.

', 'UpdateProvisionedProductInput$Tags' => '

One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

', ], ], 'TerminateProvisionedProductInput' => [ 'base' => NULL, 'refs' => [], ], 'TerminateProvisionedProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'TotalResultsCount' => [ 'base' => NULL, 'refs' => [ 'SearchProvisionedProductsOutput$TotalResultsCount' => '

The number of provisioned products found.

', ], ], 'UniqueTagKey' => [ 'base' => NULL, 'refs' => [ 'UniqueTagResourceIdentifier$Key' => '

A unique key that\'s attached to a resource.

', ], ], 'UniqueTagResourceIdentifier' => [ 'base' => '

The unique key-value pair for a tag that identifies provisioned product resources.

', 'refs' => [ 'EngineWorkflowResourceIdentifier$UniqueTag' => '

The unique key-value pair for a tag that identifies provisioned product resources.

', ], ], 'UniqueTagValue' => [ 'base' => NULL, 'refs' => [ 'UniqueTagResourceIdentifier$Value' => '

A unique value that\'s attached to a resource.

', ], ], 'UpdateConstraintInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConstraintOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePortfolioShareInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePortfolioShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProductInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisionedProductInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisionedProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisionedProductPropertiesInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisionedProductPropertiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisioningParameter' => [ 'base' => '

The parameter key-value pair used to update a provisioned product.

', 'refs' => [ 'UpdateProvisioningParameters$member' => NULL, ], ], 'UpdateProvisioningParameters' => [ 'base' => NULL, 'refs' => [ 'CreateProvisionedProductPlanInput$ProvisioningParameters' => '

Parameters specified by the administrator that are required for provisioning the product.

', 'ProvisionedProductPlanDetails$ProvisioningParameters' => '

Parameters specified by the administrator that are required for provisioning the product.

', 'UpdateProvisionedProductInput$ProvisioningParameters' => '

The new parameters.

', ], ], 'UpdateProvisioningPreferences' => [ 'base' => '

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.

', 'refs' => [ 'UpdateProvisionedProductInput$ProvisioningPreferences' => '

An object that contains information about the provisioning preferences for a stack set.

', ], ], 'UpdateServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTagOptionInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTagOptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatedTime' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductPlanDetails$UpdatedTime' => '

The UTC time stamp when the plan was last updated.

', 'RecordDetail$UpdatedTime' => '

The time when the record was last updated.

', ], ], 'UsageInstruction' => [ 'base' => '

Additional information provided by the administrator.

', 'refs' => [ 'UsageInstructions$member' => NULL, ], ], 'UsageInstructions' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningParametersOutput$UsageInstructions' => '

Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

', ], ], 'UsePreviousValue' => [ 'base' => NULL, 'refs' => [ 'UpdateProvisioningParameter$UsePreviousValue' => '

If set to true, Value is ignored and the previous parameter value is kept.

', ], ], 'UserArn' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$UserArn' => '

The Amazon Resource Name (ARN) of the user.

', ], ], 'UserArnSession' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$UserArnSession' => '

The ARN of the user in the session. This ARN might contain a session ID.

', ], ], 'Verbose' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningArtifactInput$Verbose' => '

Indicates whether a verbose level of detail is enabled.

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

Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in Service Catalog Concepts.

', 'operations' => [ 'AcceptPortfolioShare' => '

Accepts an offer to share the specified portfolio.

', 'AssociateBudgetWithResource' => '

Associates the specified budget with the specified resource.

', 'AssociatePrincipalWithPortfolio' => '

Associates the specified principal ARN with the specified portfolio.

If you share the portfolio with principal name sharing enabled, the PrincipalARN association is included in the share.

The PortfolioID, PrincipalARN, and PrincipalType parameters are required.

You can associate a maximum of 10 Principals with a portfolio using PrincipalType as IAM_PATTERN.

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

', 'AssociateProductWithPortfolio' => '

Associates the specified product with the specified portfolio.

A delegated admin is authorized to invoke this command.

', 'AssociateServiceActionWithProvisioningArtifact' => '

Associates a self-service action with a provisioning artifact.

', 'AssociateTagOptionWithResource' => '

Associate the specified TagOption with the specified portfolio or product.

', 'BatchAssociateServiceActionWithProvisioningArtifact' => '

Associates multiple self-service actions with provisioning artifacts.

', 'BatchDisassociateServiceActionFromProvisioningArtifact' => '

Disassociates a batch of self-service actions from the specified provisioning artifact.

', 'CopyProduct' => '

Copies the specified source product to the specified target product or a new product.

You can copy a product to the same account or another account. You can copy a product to the same Region or another Region. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare.

This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

', 'CreateConstraint' => '

Creates a constraint.

A delegated admin is authorized to invoke this command.

', 'CreatePortfolio' => '

Creates a portfolio.

A delegated admin is authorized to invoke this command.

', 'CreatePortfolioShare' => '

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

You can\'t share a shared resource, including portfolios that contain a shared product.

If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

', 'CreateProduct' => '

Creates a product.

A delegated admin is authorized to invoke this command.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

', 'CreateProvisionedProductPlan' => '

Creates a plan.

A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.

You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.

To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

', 'CreateProvisioningArtifact' => '

Creates a provisioning artifact (also known as a version) for the specified product.

You cannot create a provisioning artifact for a product that was shared with you.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

', 'CreateServiceAction' => '

Creates a self-service action.

', 'CreateTagOption' => '

Creates a TagOption.

', 'DeleteConstraint' => '

Deletes the specified constraint.

A delegated admin is authorized to invoke this command.

', 'DeletePortfolio' => '

Deletes the specified portfolio.

You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.

A delegated admin is authorized to invoke this command.

', 'DeletePortfolioShare' => '

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.

Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

', 'DeleteProduct' => '

Deletes the specified product.

You cannot delete a product if it was shared with you or is associated with a portfolio.

A delegated admin is authorized to invoke this command.

', 'DeleteProvisionedProductPlan' => '

Deletes the specified plan.

', 'DeleteProvisioningArtifact' => '

Deletes the specified provisioning artifact (also known as a version) for the specified product.

You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.

', 'DeleteServiceAction' => '

Deletes a self-service action.

', 'DeleteTagOption' => '

Deletes the specified TagOption.

You cannot delete a TagOption if it is associated with a product or portfolio.

', 'DescribeConstraint' => '

Gets information about the specified constraint.

', 'DescribeCopyProductStatus' => '

Gets the status of the specified copy product operation.

', 'DescribePortfolio' => '

Gets information about the specified portfolio.

A delegated admin is authorized to invoke this command.

', 'DescribePortfolioShareStatus' => '

Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.

', 'DescribePortfolioShares' => '

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.

The PortfolioId and Type parameters are both required.

', 'DescribeProduct' => '

Gets information about the specified product.

Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.

', 'DescribeProductAsAdmin' => '

Gets information about the specified product. This operation is run with administrator access.

', 'DescribeProductView' => '

Gets information about the specified product.

', 'DescribeProvisionedProduct' => '

Gets information about the specified provisioned product.

', 'DescribeProvisionedProductPlan' => '

Gets information about the resource changes for the specified plan.

', 'DescribeProvisioningArtifact' => '

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

', 'DescribeProvisioningParameters' => '

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

', 'DescribeRecord' => '

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product\'s history from when he was the owner.

', 'DescribeServiceAction' => '

Describes a self-service action.

', 'DescribeServiceActionExecutionParameters' => '

Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.

', 'DescribeTagOption' => '

Gets information about the specified TagOption.

', 'DisableAWSOrganizationsAccess' => '

Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.

You cannot call this API if there are active delegated administrators in the organization.

Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

If you share an Service Catalog portfolio in an organization within Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio.

', 'DisassociateBudgetFromResource' => '

Disassociates the specified budget from the specified resource.

', 'DisassociatePrincipalFromPortfolio' => '

Disassociates a previously associated principal ARN from a specified portfolio.

The PrincipalType and PrincipalARN must match the AssociatePrincipalWithPortfolio call request details. For example, to disassociate an association created with a PrincipalARN of PrincipalType IAM you must use the PrincipalType IAM when calling DisassociatePrincipalFromPortfolio.

For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.

For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.

If you disassociate a principal from a portfolio, with PrincipalType as IAM, the same principal will still have access to the portfolio if it matches one of the associated principals of type IAM_PATTERN. To fully remove access for a principal, verify all the associated Principals of type IAM_PATTERN, and then ensure you disassociate any IAM_PATTERN principals that match the principal whose access you are removing.

', 'DisassociateProductFromPortfolio' => '

Disassociates the specified product from the specified portfolio.

A delegated admin is authorized to invoke this command.

', 'DisassociateServiceActionFromProvisioningArtifact' => '

Disassociates the specified self-service action association from the specified provisioning artifact.

', 'DisassociateTagOptionFromResource' => '

Disassociates the specified TagOption from the specified resource.

', 'EnableAWSOrganizationsAccess' => '

Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.

When you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your behalf so that your shares stay in sync with any changes in your Organizations structure.

Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services is working to resolve this issue.

', 'ExecuteProvisionedProductPlan' => '

Provisions or modifies a product based on the resource changes for the specified plan.

', 'ExecuteProvisionedProductServiceAction' => '

Executes a self-service action against a provisioned product.

', 'GetAWSOrganizationsAccessStatus' => '

Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.

', 'GetProvisionedProductOutputs' => '

This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

', 'ImportAsProvisionedProduct' => '

Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.

Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks, are not supported.

The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and IMPORT_ROLLBACK_COMPLETE.

Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.

When you import an existing CloudFormation stack into a portfolio, Service Catalog does not apply the product\'s associated constraints during the import process. Service Catalog applies the constraints after you call UpdateProvisionedProduct for the provisioned product.

The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.

You can only import one provisioned product at a time. The product\'s CloudFormation stack must have the IMPORT_COMPLETE status before you import another.

', 'ListAcceptedPortfolioShares' => '

Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.

', 'ListBudgetsForResource' => '

Lists all the budgets associated to the specified resource.

', 'ListConstraintsForPortfolio' => '

Lists the constraints for the specified portfolio and product.

', 'ListLaunchPaths' => '

Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.

When provisioning a product that\'s been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.

', 'ListOrganizationPortfolioAccess' => '

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.

If a delegated admin is de-registered, they can no longer perform this operation.

', 'ListPortfolioAccess' => '

Lists the account IDs that have access to the specified portfolio.

A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

', 'ListPortfolios' => '

Lists all portfolios in the catalog.

', 'ListPortfoliosForProduct' => '

Lists all portfolios that the specified product is associated with.

', 'ListPrincipalsForPortfolio' => '

Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.

', 'ListProvisionedProductPlans' => '

Lists the plans for the specified provisioned product or all plans to which the user has access.

', 'ListProvisioningArtifacts' => '

Lists all provisioning artifacts (also known as versions) for the specified product.

', 'ListProvisioningArtifactsForServiceAction' => '

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

', 'ListRecordHistory' => '

Lists the specified requests or all performed requests.

', 'ListResourcesForTagOption' => '

Lists the resources associated with the specified TagOption.

', 'ListServiceActions' => '

Lists all self-service actions.

', 'ListServiceActionsForProvisioningArtifact' => '

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

', 'ListStackInstancesForProvisionedProduct' => '

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.

', 'ListTagOptions' => '

Lists the specified TagOptions or all TagOptions.

', 'NotifyProvisionProductEngineWorkflowResult' => '

Notifies the result of the provisioning engine execution.

', 'NotifyTerminateProvisionedProductEngineWorkflowResult' => '

Notifies the result of the terminate engine execution.

', 'NotifyUpdateProvisionedProductEngineWorkflowResult' => '

Notifies the result of the update engine execution.

', 'ProvisionProduct' => '

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product that\'s based on an CloudFormation template launches an CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.

If the request contains a tag key with an empty list of values, there\'s a tag conflict for that key. Don\'t include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

When provisioning a product that\'s been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.

', 'RejectPortfolioShare' => '

Rejects an offer to share the specified portfolio.

', 'ScanProvisionedProducts' => '

Lists the provisioned products that are available (not terminated).

To use additional filtering, see SearchProvisionedProducts.

', 'SearchProducts' => '

Gets information about the products to which the caller has access.

', 'SearchProductsAsAdmin' => '

Gets information about the products for the specified portfolio or all products.

', 'SearchProvisionedProducts' => '

Gets information about the provisioned products that meet the specified criteria.

', 'TerminateProvisionedProduct' => '

Terminates the specified provisioned product.

This operation does not delete any records associated with the provisioned product.

You can check the status of this request using DescribeRecord.

', 'UpdateConstraint' => '

Updates the specified constraint.

', 'UpdatePortfolio' => '

Updates the specified portfolio.

You cannot update a product that was shared with you.

', 'UpdatePortfolioShare' => '

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share.

The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be completed.

You must provide the accountId or organization node in the input, but not both.

If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.

This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

', 'UpdateProduct' => '

Updates the specified product.

', 'UpdateProvisionedProduct' => '

Requests updates to the configuration of the specified provisioned product.

If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.

You can check the status of this request using DescribeRecord.

', 'UpdateProvisionedProductProperties' => '

Requests updates to the properties of the specified provisioned product.

', 'UpdateProvisioningArtifact' => '

Updates the specified provisioning artifact (also known as a version) for the specified product.

You cannot update a provisioning artifact for a product that was shared with you.

', 'UpdateServiceAction' => '

Updates a self-service action.

', 'UpdateTagOption' => '

Updates the specified TagOption.

', ], 'shapes' => [ 'AcceptLanguage' => [ 'base' => NULL, 'refs' => [ 'AcceptPortfolioShareInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'AssociatePrincipalWithPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'AssociateProductWithPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'AssociateServiceActionWithProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'BatchAssociateServiceActionWithProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'BatchDisassociateServiceActionFromProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CopyProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreateConstraintInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreatePortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreatePortfolioShareInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreateProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreateProvisionedProductPlanInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreateProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'CreateServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeleteConstraintInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeletePortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeletePortfolioShareInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeleteProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeleteProvisionedProductPlanInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeleteProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DeleteServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeConstraintInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeCopyProductStatusInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribePortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProductAsAdminInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProductViewInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProvisionedProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProvisionedProductPlanInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeProvisioningParametersInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeRecordInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeServiceActionExecutionParametersInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DescribeServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DisassociatePrincipalFromPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DisassociateProductFromPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'DisassociateServiceActionFromProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ExecuteProvisionedProductPlanInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ExecuteProvisionedProductServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'GetProvisionedProductOutputsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ImportAsProvisionedProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListAcceptedPortfolioSharesInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListBudgetsForResourceInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListConstraintsForPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListLaunchPathsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListOrganizationPortfolioAccessInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListPortfolioAccessInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListPortfoliosForProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListPortfoliosInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListPrincipalsForPortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListProvisionedProductPlansInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListProvisioningArtifactsForServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListProvisioningArtifactsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListRecordHistoryInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListServiceActionsForProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListServiceActionsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ListStackInstancesForProvisionedProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ProvisionProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'RejectPortfolioShareInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'ScanProvisionedProductsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'SearchProductsAsAdminInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'SearchProductsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'SearchProvisionedProductsInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'TerminateProvisionedProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateConstraintInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdatePortfolioInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdatePortfolioShareInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateProvisionedProductInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateProvisionedProductPropertiesInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateProvisioningArtifactInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', 'UpdateServiceActionInput$AcceptLanguage' => '

The language code.

  • jp - Japanese

  • zh - Chinese

', ], ], 'AcceptPortfolioShareInput' => [ 'base' => NULL, 'refs' => [], ], 'AcceptPortfolioShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'AccessLevelFilter' => [ 'base' => '

The access level to use to filter results.

', 'refs' => [ 'ListProvisionedProductPlansInput$AccessLevelFilter' => '

The access level to use to obtain results. The default is User.

', 'ListRecordHistoryInput$AccessLevelFilter' => '

The access level to use to obtain results. The default is User.

', 'ScanProvisionedProductsInput$AccessLevelFilter' => '

The access level to use to obtain results. The default is User.

', 'SearchProvisionedProductsInput$AccessLevelFilter' => '

The access level to use to obtain results. The default is User.

', ], ], 'AccessLevelFilterKey' => [ 'base' => NULL, 'refs' => [ 'AccessLevelFilter$Key' => '

The access level.

  • Account - Filter results based on the account.

  • Role - Filter results based on the federated role of the specified user.

  • User - Filter results based on the specified user.

', ], ], 'AccessLevelFilterValue' => [ 'base' => NULL, 'refs' => [ 'AccessLevelFilter$Value' => '

The user to which the access level applies. The only supported value is self.

', ], ], 'AccessStatus' => [ 'base' => NULL, 'refs' => [ 'GetAWSOrganizationsAccessStatusOutput$AccessStatus' => '

The status of the portfolio share feature.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AccountIds$member' => NULL, 'ConstraintDetail$Owner' => '

The owner of the constraint.

', 'CreatePortfolioShareInput$AccountId' => '

The Amazon Web Services account ID. For example, 123456789012.

', 'DeletePortfolioShareInput$AccountId' => '

The Amazon Web Services account ID.

', 'Namespaces$member' => NULL, 'StackInstance$Account' => '

The name of the Amazon Web Services account that the stack instance is associated with.

', 'StackSetAccounts$member' => NULL, 'SuccessfulShares$member' => NULL, 'UpdatePortfolioShareInput$AccountId' => '

The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.

', ], ], 'AccountIds' => [ 'base' => NULL, 'refs' => [ 'ListPortfolioAccessOutput$AccountIds' => '

Information about the Amazon Web Services accounts with access to the portfolio.

', ], ], 'AddTags' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioInput$Tags' => '

One or more tags.

', 'CreateProductInput$Tags' => '

One or more tags.

', 'UpdatePortfolioInput$AddTags' => '

The tags to add.

', 'UpdateProductInput$AddTags' => '

The tags to add to the product.

', ], ], 'AllowedValues' => [ 'base' => NULL, 'refs' => [ 'ParameterConstraints$AllowedValues' => '

The values that the administrator has allowed for the parameter.

', ], ], 'ApproximateCount' => [ 'base' => NULL, 'refs' => [ 'ProductViewAggregationValue$ApproximateCount' => '

An approximate count of the products that match the value.

', ], ], 'AssociateBudgetWithResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateBudgetWithResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'AssociatePrincipalWithPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'AssociatePrincipalWithPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateProductWithPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateProductWithPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateServiceActionWithProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateServiceActionWithProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTagOptionWithResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTagOptionWithResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'AttributeValue' => [ 'base' => NULL, 'refs' => [ 'ProductViewAggregationValue$Value' => '

The value of the product view aggregation.

', ], ], 'BatchAssociateServiceActionWithProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchAssociateServiceActionWithProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateServiceActionFromProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateServiceActionFromProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioShareInput$ShareTagOptions' => '

Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

', 'CreatePortfolioShareInput$SharePrincipals' => '

This parameter is only supported for portfolios with an OrganizationalNode Type of ORGANIZATION or ORGANIZATIONAL_UNIT.

Enables or disables Principal sharing when creating the portfolio share. If you do not provide this flag, principal sharing is disabled.

When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in the recipient account before or after creating the share.

', 'DescribeProvisioningArtifactInput$IncludeProvisioningArtifactParameters' => '

Indicates if the API call response does or does not include additional details about the provisioning parameters.

', 'PortfolioShareDetail$Accepted' => '

Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.

', 'PortfolioShareDetail$ShareTagOptions' => '

Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

', 'PortfolioShareDetail$SharePrincipals' => '

Indicates if Principal sharing is enabled or disabled for the portfolio share.

', ], ], 'BudgetDetail' => [ 'base' => '

Information about a budget.

', 'refs' => [ 'Budgets$member' => NULL, ], ], 'BudgetName' => [ 'base' => NULL, 'refs' => [ 'AssociateBudgetWithResourceInput$BudgetName' => '

The name of the budget you want to associate.

', 'BudgetDetail$BudgetName' => '

Name of the associated budget.

', 'DisassociateBudgetFromResourceInput$BudgetName' => '

The name of the budget you want to disassociate.

', ], ], 'Budgets' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioOutput$Budgets' => '

Information about the associated budgets.

', 'DescribeProductAsAdminOutput$Budgets' => '

Information about the associated budgets.

', 'DescribeProductOutput$Budgets' => '

Information about the associated budgets.

', 'ListBudgetsForResourceOutput$Budgets' => '

Information about the associated budgets.

', ], ], 'CausingEntity' => [ 'base' => NULL, 'refs' => [ 'ResourceChangeDetail$CausingEntity' => '

The ID of the entity that caused the change.

', ], ], 'ChangeAction' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Action' => '

The change action.

', ], ], 'CloudWatchDashboard' => [ 'base' => '

Information about a CloudWatch dashboard.

', 'refs' => [ 'CloudWatchDashboards$member' => NULL, ], ], 'CloudWatchDashboardName' => [ 'base' => NULL, 'refs' => [ 'CloudWatchDashboard$Name' => '

The name of the CloudWatch dashboard.

', ], ], 'CloudWatchDashboards' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisionedProductOutput$CloudWatchDashboards' => '

Any CloudWatch dashboards that were created when provisioning the product.

', ], ], 'CodeStarConnectionArn' => [ 'base' => NULL, 'refs' => [ 'CodeStarParameters$ConnectionArn' => '

The CodeStar ARN, which is the connection between Service Catalog and the external repository.

', ], ], 'CodeStarParameters' => [ 'base' => '

The subtype containing details about the Codestar connection Type.

', 'refs' => [ 'SourceConnectionParameters$CodeStar' => '

Provides ConnectionType details.

', ], ], 'ConstraintDescription' => [ 'base' => NULL, 'refs' => [ 'ConstraintDetail$Description' => '

The description of the constraint.

', 'ConstraintSummary$Description' => '

The description of the constraint.

', 'CreateConstraintInput$Description' => '

The description of the constraint.

', 'UpdateConstraintInput$Description' => '

The updated description of the constraint.

', ], ], 'ConstraintDetail' => [ 'base' => '

Information about a constraint.

', 'refs' => [ 'ConstraintDetails$member' => NULL, 'CreateConstraintOutput$ConstraintDetail' => '

Information about the constraint.

', 'DescribeConstraintOutput$ConstraintDetail' => '

Information about the constraint.

', 'UpdateConstraintOutput$ConstraintDetail' => '

Information about the constraint.

', ], ], 'ConstraintDetails' => [ 'base' => NULL, 'refs' => [ 'ListConstraintsForPortfolioOutput$ConstraintDetails' => '

Information about the constraints.

', ], ], 'ConstraintParameters' => [ 'base' => NULL, 'refs' => [ 'CreateConstraintInput$Parameters' => '

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH

You are required to specify either the RoleArn or the LocalRoleName but can\'t use both.

Specify the RoleArn property as follows:

{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

Specify the LocalRoleName property as follows:

{"LocalRoleName": "SCBasicLaunchRole"}

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one LAUNCH constraint on a product and portfolio.

NOTIFICATION

Specify the NotificationArns property as follows:

{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

RESOURCE_UPDATE

Specify the TagUpdatesOnProvisionedProduct property as follows:

{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

STACKSET

Specify the Parameters property as follows:

{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one STACKSET constraint on a product and portfolio.

Products with a STACKSET constraint will launch an CloudFormation stack set.

TEMPLATE

Specify the Rules property. For more information, see Template Constraint Rules.

', 'CreateConstraintOutput$ConstraintParameters' => '

The constraint parameters.

', 'DescribeConstraintOutput$ConstraintParameters' => '

The constraint parameters.

', 'UpdateConstraintInput$Parameters' => '

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH

You are required to specify either the RoleArn or the LocalRoleName but can\'t use both.

Specify the RoleArn property as follows:

{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

Specify the LocalRoleName property as follows:

{"LocalRoleName": "SCBasicLaunchRole"}

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one LAUNCH constraint on a product and portfolio.

NOTIFICATION

Specify the NotificationArns property as follows:

{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

RESOURCE_UPDATE

Specify the TagUpdatesOnProvisionedProduct property as follows:

{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

STACKSET

Specify the Parameters property as follows:

{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one STACKSET constraint on a product and portfolio.

Products with a STACKSET constraint will launch an CloudFormation stack set.

TEMPLATE

Specify the Rules property. For more information, see Template Constraint Rules.

', 'UpdateConstraintOutput$ConstraintParameters' => '

The constraint parameters.

', ], ], 'ConstraintSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningParametersOutput$ConstraintSummaries' => '

Information about the constraints used to provision the product.

', 'LaunchPathSummary$ConstraintSummaries' => '

The constraints on the portfolio-product relationship.

', ], ], 'ConstraintSummary' => [ 'base' => '

Summary information about a constraint.

', 'refs' => [ 'ConstraintSummaries$member' => NULL, ], ], 'ConstraintType' => [ 'base' => NULL, 'refs' => [ 'ConstraintDetail$Type' => '

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • STACKSET

  • TEMPLATE

', 'ConstraintSummary$Type' => '

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • STACKSET

  • TEMPLATE

', 'CreateConstraintInput$Type' => '

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

', ], ], 'CopyOption' => [ 'base' => NULL, 'refs' => [ 'CopyOptions$member' => NULL, ], ], 'CopyOptions' => [ 'base' => NULL, 'refs' => [ 'CopyProductInput$CopyOptions' => '

The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

', ], ], 'CopyProductInput' => [ 'base' => NULL, 'refs' => [], ], 'CopyProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'CopyProductStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeCopyProductStatusOutput$CopyProductStatus' => '

The status of the copy product operation.

', ], ], 'CreateConstraintInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateConstraintOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePortfolioShareInput' => [ 'base' => NULL, 'refs' => [], ], 'CreatePortfolioShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProductInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisionedProductPlanInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisionedProductPlanOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateTagOptionInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateTagOptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatedTime' => [ 'base' => NULL, 'refs' => [ 'ProductViewDetail$CreatedTime' => '

The UTC time stamp of the creation time.

', 'ProvisionedProductAttribute$CreatedTime' => '

The UTC time stamp of the creation time.

', 'ProvisionedProductDetail$CreatedTime' => '

The UTC time stamp of the creation time.

', 'ProvisionedProductPlanDetails$CreatedTime' => '

The UTC time stamp of the creation time.

', 'RecordDetail$CreatedTime' => '

The UTC time stamp of the creation time.

', ], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'PortfolioDetail$CreatedTime' => '

The UTC time stamp of the creation time.

', 'ProvisioningArtifactDetail$CreatedTime' => '

The UTC time stamp of the creation time.

', ], ], 'DefaultValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactParameter$DefaultValue' => '

The default value.

', ], ], 'DeleteConstraintInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConstraintOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePortfolioShareInput' => [ 'base' => NULL, 'refs' => [], ], 'DeletePortfolioShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProductInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisionedProductPlanInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisionedProductPlanOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagOptionInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTagOptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConstraintInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConstraintOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCopyProductStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCopyProductStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioShareStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioShareStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioShareType' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioSharesInput$Type' => '

The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

1. ACCOUNT - Represents an external account to account share.

2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.

3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.

4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.

', 'PortfolioShareDetail$Type' => '

The type of the portfolio share.

', ], ], 'DescribePortfolioSharesInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePortfolioSharesOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductAsAdminInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductAsAdminOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductViewInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProductViewOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisionedProductInput' => [ 'base' => 'DescribeProvisionedProductAPI input structure. AcceptLanguage - [Optional] The language code for localization. Id - [Optional] The provisioned product identifier. Name - [Optional] Another provisioned product identifier. Customers must provide either Id or Name.', 'refs' => [], ], 'DescribeProvisionedProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisionedProductPlanInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisionedProductPlanOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningParametersInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeProvisioningParametersOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecordInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRecordOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServiceActionExecutionParametersInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServiceActionExecutionParametersOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTagOptionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTagOptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactParameter$Description' => '

The description of the parameter.

', 'RecordOutput$Description' => '

The description of the output.

', ], ], 'DisableAWSOrganizationsAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'DisableAWSOrganizationsAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisableTemplateValidation' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactProperties$DisableTemplateValidation' => '

If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.

Service Catalog does not support template validation for the TERRAFORM_OS product type.

', ], ], 'DisassociateBudgetFromResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateBudgetFromResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePrincipalFromPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePrincipalFromPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateProductFromPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateProductFromPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateServiceActionFromProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateServiceActionFromProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTagOptionFromResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTagOptionFromResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DuplicateResourceException' => [ 'base' => '

The specified resource is a duplicate.

', 'refs' => [], ], 'EnableAWSOrganizationsAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'EnableAWSOrganizationsAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'EngineWorkflowFailureReason' => [ 'base' => NULL, 'refs' => [ 'NotifyProvisionProductEngineWorkflowResultInput$FailureReason' => '

The reason why the provisioning engine execution failed.

', 'NotifyTerminateProvisionedProductEngineWorkflowResultInput$FailureReason' => '

The reason why the terminate engine execution failed.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$FailureReason' => '

The reason why the update engine execution failed.

', ], ], 'EngineWorkflowResourceIdentifier' => [ 'base' => '

The ID for the provisioned product resources that are part of a resource group.

', 'refs' => [ 'NotifyProvisionProductEngineWorkflowResultInput$ResourceIdentifier' => '

The ID for the provisioned product resources that are part of a resource group.

', ], ], 'EngineWorkflowStatus' => [ 'base' => NULL, 'refs' => [ 'NotifyProvisionProductEngineWorkflowResultInput$Status' => '

The status of the provisioning engine execution.

', 'NotifyTerminateProvisionedProductEngineWorkflowResultInput$Status' => '

The status of the terminate engine execution.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$Status' => '

The status of the update engine execution.

', ], ], 'EngineWorkflowToken' => [ 'base' => NULL, 'refs' => [ 'NotifyProvisionProductEngineWorkflowResultInput$WorkflowToken' => '

The encrypted contents of the provisioning engine execution payload that Service Catalog sends after the Terraform product provisioning workflow starts.

', 'NotifyTerminateProvisionedProductEngineWorkflowResultInput$WorkflowToken' => '

The encrypted contents of the terminate engine execution payload that Service Catalog sends after the Terraform product terminate workflow starts.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$WorkflowToken' => '

The encrypted contents of the update engine execution payload that Service Catalog sends after the Terraform product update workflow starts.

', ], ], 'Error' => [ 'base' => NULL, 'refs' => [ 'ShareError$Error' => '

Error type that happened when processing the operation.

', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'RecordError$Code' => '

The numeric value of the error.

', ], ], 'ErrorDescription' => [ 'base' => NULL, 'refs' => [ 'RecordError$Description' => '

The description of the error.

', ], ], 'EvaluationType' => [ 'base' => NULL, 'refs' => [ 'ResourceChangeDetail$Evaluation' => '

For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.

', ], ], 'ExecuteProvisionedProductPlanInput' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteProvisionedProductPlanOutput' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteProvisionedProductServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteProvisionedProductServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'ExecutionParameter' => [ 'base' => '

Details of an execution parameter value that is passed to a self-service action when executed on a provisioned product.

', 'refs' => [ 'ExecutionParameters$member' => NULL, ], ], 'ExecutionParameterKey' => [ 'base' => NULL, 'refs' => [ 'ExecutionParameter$Name' => '

The name of the execution parameter.

', 'ExecutionParameterMap$key' => NULL, ], ], 'ExecutionParameterMap' => [ 'base' => NULL, 'refs' => [ 'ExecuteProvisionedProductServiceActionInput$Parameters' => '

A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET, the provided value will override the default value generated by Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for any special parameters such as TARGET.

', ], ], 'ExecutionParameterType' => [ 'base' => NULL, 'refs' => [ 'ExecutionParameter$Type' => '

The execution parameter type.

', ], ], 'ExecutionParameterValue' => [ 'base' => NULL, 'refs' => [ 'ExecutionParameterValueList$member' => NULL, ], ], 'ExecutionParameterValueList' => [ 'base' => NULL, 'refs' => [ 'ExecutionParameter$DefaultValues' => '

The default values for the execution parameter.

', 'ExecutionParameterMap$value' => NULL, ], ], 'ExecutionParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeServiceActionExecutionParametersOutput$ServiceActionParameters' => '

The parameters of the self-service action.

', ], ], 'FailedServiceActionAssociation' => [ 'base' => '

An object containing information about the error, along with identifying information about the self-service action and its associations.

', 'refs' => [ 'FailedServiceActionAssociations$member' => NULL, ], ], 'FailedServiceActionAssociations' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateServiceActionWithProvisioningArtifactOutput$FailedServiceActionAssociations' => '

An object that contains a list of errors, along with information to help you identify the self-service action.

', 'BatchDisassociateServiceActionFromProvisioningArtifactOutput$FailedServiceActionAssociations' => '

An object that contains a list of errors, along with information to help you identify the self-service action.

', ], ], 'GetAWSOrganizationsAccessStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'GetAWSOrganizationsAccessStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetProvisionedProductOutputsInput' => [ 'base' => NULL, 'refs' => [], ], 'GetProvisionedProductOutputsOutput' => [ 'base' => NULL, 'refs' => [], ], 'HasDefaultPath' => [ 'base' => NULL, 'refs' => [ 'ProductViewSummary$HasDefaultPath' => '

Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

', ], ], 'Id' => [ 'base' => NULL, 'refs' => [ 'AcceptPortfolioShareInput$PortfolioId' => '

The portfolio identifier.

', 'AssociateBudgetWithResourceInput$ResourceId' => '

The resource identifier. Either a portfolio-id or a product-id.

', 'AssociatePrincipalWithPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'AssociateProductWithPortfolioInput$ProductId' => '

The product identifier.

', 'AssociateProductWithPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'AssociateProductWithPortfolioInput$SourcePortfolioId' => '

The identifier of the source portfolio.

', 'AssociateServiceActionWithProvisioningArtifactInput$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'AssociateServiceActionWithProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'AssociateServiceActionWithProvisioningArtifactInput$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'ConstraintDetail$ConstraintId' => '

The identifier of the constraint.

', 'ConstraintDetail$ProductId' => '

The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.

', 'ConstraintDetail$PortfolioId' => '

The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.

', 'CopyProductInput$TargetProductId' => '

The identifier of the target product. By default, a new product is created.

', 'CopyProductOutput$CopyProductToken' => '

The token to use to track the progress of the operation.

', 'CreateConstraintInput$PortfolioId' => '

The portfolio identifier.

', 'CreateConstraintInput$ProductId' => '

The product identifier.

', 'CreatePortfolioShareInput$PortfolioId' => '

The portfolio identifier.

', 'CreatePortfolioShareOutput$PortfolioShareToken' => '

The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.

', 'CreateProvisionedProductPlanInput$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

', 'CreateProvisionedProductPlanInput$ProductId' => '

The product identifier.

', 'CreateProvisionedProductPlanInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'CreateProvisionedProductPlanOutput$PlanId' => '

The plan identifier.

', 'CreateProvisionedProductPlanOutput$ProvisionProductId' => '

The product identifier.

', 'CreateProvisionedProductPlanOutput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'CreateProvisioningArtifactInput$ProductId' => '

The product identifier.

', 'DeleteConstraintInput$Id' => '

The identifier of the constraint.

', 'DeletePortfolioInput$Id' => '

The portfolio identifier.

', 'DeletePortfolioShareInput$PortfolioId' => '

The portfolio identifier.

', 'DeletePortfolioShareOutput$PortfolioShareToken' => '

The portfolio share unique identifier. This will only be returned if delete is made to an organization node.

', 'DeleteProductInput$Id' => '

The product identifier.

', 'DeleteProvisionedProductPlanInput$PlanId' => '

The plan identifier.

', 'DeleteProvisioningArtifactInput$ProductId' => '

The product identifier.

', 'DeleteProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'DeleteServiceActionInput$Id' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'DescribeConstraintInput$Id' => '

The identifier of the constraint.

', 'DescribeCopyProductStatusInput$CopyProductToken' => '

The token for the copy product operation. This token is returned by CopyProduct.

', 'DescribeCopyProductStatusOutput$TargetProductId' => '

The identifier of the copied product.

', 'DescribePortfolioInput$Id' => '

The portfolio identifier.

', 'DescribePortfolioShareStatusInput$PortfolioShareToken' => '

The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

', 'DescribePortfolioShareStatusOutput$PortfolioShareToken' => '

The token for the portfolio share operation. For example, share-6v24abcdefghi.

', 'DescribePortfolioShareStatusOutput$PortfolioId' => '

The portfolio identifier.

', 'DescribePortfolioSharesInput$PortfolioId' => '

The unique identifier of the portfolio for which shares will be retrieved.

', 'DescribeProductAsAdminInput$Id' => '

The product identifier.

', 'DescribeProductAsAdminInput$SourcePortfolioId' => '

The unique identifier of the shared portfolio that the specified product is associated with.

You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned.

', 'DescribeProductInput$Id' => '

The product identifier.

', 'DescribeProductViewInput$Id' => '

The product view identifier.

', 'DescribeProvisionedProductInput$Id' => '

The provisioned product identifier. You must provide the name or ID, but not both.

If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

', 'DescribeProvisionedProductPlanInput$PlanId' => '

The plan identifier.

', 'DescribeProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'DescribeProvisioningArtifactInput$ProductId' => '

The product identifier.

', 'DescribeProvisioningParametersInput$ProductId' => '

The product identifier. You must provide the product name or ID, but not both.

', 'DescribeProvisioningParametersInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. You must provide the name or ID, but not both.

', 'DescribeProvisioningParametersInput$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

', 'DescribeRecordInput$Id' => '

The record identifier of the provisioned product. This identifier is returned by the request operation.

', 'DescribeServiceActionExecutionParametersInput$ProvisionedProductId' => '

The identifier of the provisioned product.

', 'DescribeServiceActionExecutionParametersInput$ServiceActionId' => '

The self-service action identifier.

', 'DescribeServiceActionInput$Id' => '

The self-service action identifier.

', 'DisassociateBudgetFromResourceInput$ResourceId' => '

The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.

', 'DisassociatePrincipalFromPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'DisassociateProductFromPortfolioInput$ProductId' => '

The product identifier.

', 'DisassociateProductFromPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'DisassociateServiceActionFromProvisioningArtifactInput$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'DisassociateServiceActionFromProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'DisassociateServiceActionFromProvisioningArtifactInput$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'ExecuteProvisionedProductPlanInput$PlanId' => '

The plan identifier.

', 'ExecuteProvisionedProductServiceActionInput$ProvisionedProductId' => '

The identifier of the provisioned product.

', 'ExecuteProvisionedProductServiceActionInput$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'FailedServiceActionAssociation$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'FailedServiceActionAssociation$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'FailedServiceActionAssociation$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'GetProvisionedProductOutputsInput$ProvisionedProductId' => '

The identifier of the provisioned product that you want the outputs from.

', 'ImportAsProvisionedProductInput$ProductId' => '

The product identifier.

', 'ImportAsProvisionedProductInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'LastSync$LastSuccessfulSyncProvisioningArtifactId' => '

The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.

', 'LaunchPath$Id' => '

The identifier of the launch path.

', 'LaunchPathSummary$Id' => '

The identifier of the product path.

', 'ListBudgetsForResourceInput$ResourceId' => '

The resource identifier.

', 'ListConstraintsForPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'ListConstraintsForPortfolioInput$ProductId' => '

The product identifier.

', 'ListLaunchPathsInput$ProductId' => '

The product identifier.

', 'ListOrganizationPortfolioAccessInput$PortfolioId' => '

The portfolio identifier. For example, port-2abcdext3y5fk.

', 'ListPortfolioAccessInput$PortfolioId' => '

The portfolio identifier.

', 'ListPortfolioAccessInput$OrganizationParentId' => '

The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

', 'ListPortfoliosForProductInput$ProductId' => '

The product identifier.

', 'ListPrincipalsForPortfolioInput$PortfolioId' => '

The portfolio identifier.

', 'ListProvisionedProductPlansInput$ProvisionProductId' => '

The product identifier.

', 'ListProvisioningArtifactsForServiceActionInput$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'ListProvisioningArtifactsInput$ProductId' => '

The product identifier.

', 'ListServiceActionsForProvisioningArtifactInput$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'ListServiceActionsForProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'ListStackInstancesForProvisionedProductInput$ProvisionedProductId' => '

The identifier of the provisioned product.

', 'NotifyProvisionProductEngineWorkflowResultInput$RecordId' => '

The identifier of the record.

', 'NotifyTerminateProvisionedProductEngineWorkflowResultInput$RecordId' => '

The identifier of the record.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$RecordId' => '

The identifier of the record.

', 'PortfolioDetail$Id' => '

The portfolio identifier.

', 'PortfolioShareDetail$PrincipalId' => '

The identifier of the recipient entity that received the portfolio share. The recipient entity can be one of the following:

1. An external account.

2. An organziation member account.

3. An organzational unit (OU).

4. The organization itself. (This shares with every account in the organization).

', 'ProductViewSummary$Id' => '

The product view identifier.

', 'ProductViewSummary$ProductId' => '

The product identifier.

', 'ProvisionProductInput$ProductId' => '

The product identifier. You must provide the name or ID, but not both.

', 'ProvisionProductInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. You must provide the name or ID, but not both.

', 'ProvisionProductInput$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

', 'ProvisionedProductAttribute$Id' => '

The identifier of the provisioned product.

', 'ProvisionedProductAttribute$LastRecordId' => '

The record identifier of the last request performed on this provisioned product.

', 'ProvisionedProductAttribute$LastProvisioningRecordId' => '

The record identifier of the last request performed on this provisioned product of the following types:

  • ProvisionProduct

  • UpdateProvisionedProduct

  • ExecuteProvisionedProductPlan

  • TerminateProvisionedProduct

', 'ProvisionedProductAttribute$LastSuccessfulProvisioningRecordId' => '

The record identifier of the last successful request performed on this provisioned product of the following types:

  • ProvisionProduct

  • UpdateProvisionedProduct

  • ExecuteProvisionedProductPlan

  • TerminateProvisionedProduct

', 'ProvisionedProductAttribute$ProductId' => '

The product identifier.

', 'ProvisionedProductAttribute$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'ProvisionedProductDetail$LastProvisioningRecordId' => '

The record identifier of the last request performed on this provisioned product of the following types:

  • ProvisionProduct

  • UpdateProvisionedProduct

  • ExecuteProvisionedProductPlan

  • TerminateProvisionedProduct

', 'ProvisionedProductDetail$LastSuccessfulProvisioningRecordId' => '

The record identifier of the last successful request performed on this provisioned product of the following types:

  • ProvisionProduct

  • UpdateProvisionedProduct

  • ExecuteProvisionedProductPlan

  • TerminateProvisionedProduct

', 'ProvisionedProductDetail$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'ProvisionedProductDetail$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'ProvisionedProductPlanDetails$PathId' => '

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

', 'ProvisionedProductPlanDetails$ProductId' => '

The product identifier.

', 'ProvisionedProductPlanDetails$PlanId' => '

The plan identifier.

', 'ProvisionedProductPlanDetails$ProvisionProductId' => '

The product identifier.

', 'ProvisionedProductPlanDetails$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'ProvisionedProductPlanSummary$PlanId' => '

The plan identifier.

', 'ProvisionedProductPlanSummary$ProvisionProductId' => '

The product identifier.

', 'ProvisionedProductPlanSummary$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'ProvisioningArtifact$Id' => '

The identifier of the provisioning artifact.

', 'ProvisioningArtifactDetail$Id' => '

The identifier of the provisioning artifact.

', 'ProvisioningArtifactSummary$Id' => '

The identifier of the provisioning artifact.

', 'RecordDetail$RecordId' => '

The identifier of the record.

', 'RecordDetail$ProvisionedProductId' => '

The identifier of the provisioned product.

', 'RecordDetail$ProductId' => '

The product identifier.

', 'RecordDetail$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'RecordDetail$PathId' => '

The path identifier.

', 'RejectPortfolioShareInput$PortfolioId' => '

The portfolio identifier.

', 'SearchProductsAsAdminInput$PortfolioId' => '

The portfolio identifier.

', 'ServiceActionAssociation$ServiceActionId' => '

The self-service action identifier. For example, act-fs7abcd89wxyz.

', 'ServiceActionAssociation$ProductId' => '

The product identifier. For example, prod-abcdzk7xy33qa.

', 'ServiceActionAssociation$ProvisioningArtifactId' => '

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

', 'ServiceActionSummary$Id' => '

The self-service action identifier.

', 'TerminateProvisionedProductInput$ProvisionedProductId' => '

The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

', 'UpdateConstraintInput$Id' => '

The identifier of the constraint.

', 'UpdatePortfolioInput$Id' => '

The portfolio identifier.

', 'UpdatePortfolioShareInput$PortfolioId' => '

The unique identifier of the portfolio for which the share will be updated.

', 'UpdatePortfolioShareOutput$PortfolioShareToken' => '

The token that tracks the status of the UpdatePortfolioShare operation for external account to account or organizational type sharing.

', 'UpdateProductInput$Id' => '

The product identifier.

', 'UpdateProvisionedProductInput$ProvisionedProductId' => '

The identifier of the provisioned product. You must provide the name or ID, but not both.

', 'UpdateProvisionedProductInput$ProductId' => '

The identifier of the product. You must provide the name or ID, but not both.

', 'UpdateProvisionedProductInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'UpdateProvisionedProductInput$PathId' => '

The path identifier. This value is optional if the product has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.

', 'UpdateProvisionedProductPropertiesInput$ProvisionedProductId' => '

The identifier of the provisioned product.

', 'UpdateProvisionedProductPropertiesOutput$ProvisionedProductId' => '

The provisioned product identifier.

', 'UpdateProvisionedProductPropertiesOutput$RecordId' => '

The identifier of the record.

', 'UpdateProvisioningArtifactInput$ProductId' => '

The product identifier.

', 'UpdateProvisioningArtifactInput$ProvisioningArtifactId' => '

The identifier of the provisioning artifact.

', 'UpdateServiceActionInput$Id' => '

The self-service action identifier.

', ], ], 'IdempotencyToken' => [ 'base' => NULL, 'refs' => [ 'AssociateServiceActionWithProvisioningArtifactInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request.

', 'CopyProductInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreateConstraintInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreatePortfolioInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreateProductInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreateProvisionedProductPlanInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreateProvisioningArtifactInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'CreateServiceActionInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'DeleteServiceActionInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request.

', 'DisassociateServiceActionFromProvisioningArtifactInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request.

', 'ExecuteProvisionedProductPlanInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'ExecuteProvisionedProductServiceActionInput$ExecuteToken' => '

An idempotency token that uniquely identifies the execute request.

', 'ImportAsProvisionedProductInput$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'NotifyProvisionProductEngineWorkflowResultInput$IdempotencyToken' => '

The idempotency token that identifies the provisioning engine execution.

', 'NotifyTerminateProvisionedProductEngineWorkflowResultInput$IdempotencyToken' => '

The idempotency token that identifies the terminate engine execution.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$IdempotencyToken' => '

The idempotency token that identifies the update engine execution.

', 'ProvisionProductInput$ProvisionToken' => '

An idempotency token that uniquely identifies the provisioning request.

', 'ProvisionedProductAttribute$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'ProvisionedProductDetail$IdempotencyToken' => '

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

', 'TerminateProvisionedProductInput$TerminateToken' => '

An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

', 'UpdateProvisionedProductInput$UpdateToken' => '

The idempotency token that uniquely identifies the provisioning update request.

', 'UpdateProvisionedProductPropertiesInput$IdempotencyToken' => '

The idempotency token that uniquely identifies the provisioning product update request.

', ], ], 'IgnoreErrors' => [ 'base' => NULL, 'refs' => [ 'DeleteProvisionedProductPlanInput$IgnoreErrors' => '

If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

', 'TerminateProvisionedProductInput$IgnoreErrors' => '

If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

', ], ], 'ImportAsProvisionedProductInput' => [ 'base' => NULL, 'refs' => [], ], 'ImportAsProvisionedProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'InstructionType' => [ 'base' => NULL, 'refs' => [ 'UsageInstruction$Type' => '

The usage instruction type for the value.

', ], ], 'InstructionValue' => [ 'base' => NULL, 'refs' => [ 'UsageInstruction$Value' => '

The usage instruction value for this type.

', ], ], 'InvalidParametersException' => [ 'base' => '

One or more parameters provided to the operation are not valid.

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

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

', 'refs' => [], ], 'LastRequestId' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductDetail$LastRecordId' => '

The record identifier of the last request performed on this provisioned product.

', ], ], 'LastSuccessfulSyncTime' => [ 'base' => NULL, 'refs' => [ 'LastSync$LastSuccessfulSyncTime' => '

The time of the latest successful sync from the source repo artifact to the Service Catalog product.

', ], ], 'LastSync' => [ 'base' => '

Provides details about the product\'s connection sync and contains the following sub-fields.

  • LastSyncTime

  • LastSyncStatus

  • LastSyncStatusMessage

  • LastSuccessfulSyncTime

  • LastSuccessfulSyncProvisioningArtifactID

', 'refs' => [ 'SourceConnectionDetail$LastSync' => '

Provides details about the product\'s connection sync and contains the following sub-fields.

  • LastSyncTime

  • LastSyncStatus

  • LastSyncStatusMessage

  • LastSuccessfulSyncTime

  • LastSuccessfulSyncProvisioningArtifactID

', ], ], 'LastSyncStatus' => [ 'base' => NULL, 'refs' => [ 'LastSync$LastSyncStatus' => '

The current status of the sync. Responses include SUCCEEDED or FAILED.

', ], ], 'LastSyncStatusMessage' => [ 'base' => NULL, 'refs' => [ 'LastSync$LastSyncStatusMessage' => '

The sync\'s status message.

', ], ], 'LastSyncTime' => [ 'base' => NULL, 'refs' => [ 'LastSync$LastSyncTime' => '

The time of the last attempted sync from the repository to the Service Catalog product.

', ], ], 'LaunchPath' => [ 'base' => '

A launch path object.

', 'refs' => [ 'LaunchPaths$member' => NULL, ], ], 'LaunchPathSummaries' => [ 'base' => NULL, 'refs' => [ 'ListLaunchPathsOutput$LaunchPathSummaries' => '

Information about the launch path.

', ], ], 'LaunchPathSummary' => [ 'base' => '

Summary information about a product path for a user.

', 'refs' => [ 'LaunchPathSummaries$member' => NULL, ], ], 'LaunchPaths' => [ 'base' => NULL, 'refs' => [ 'DescribeProductOutput$LaunchPaths' => '

Information about the associated launch paths.

', ], ], 'LimitExceededException' => [ 'base' => '

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

', 'refs' => [], ], 'ListAcceptedPortfolioSharesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListAcceptedPortfolioSharesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBudgetsForResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBudgetsForResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListConstraintsForPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'ListConstraintsForPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListLaunchPathsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListLaunchPathsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationPortfolioAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationPortfolioAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfolioAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfolioAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfoliosForProductInput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfoliosForProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfoliosInput' => [ 'base' => NULL, 'refs' => [], ], 'ListPortfoliosOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPrincipalsForPortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'ListPrincipalsForPortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisionedProductPlansInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisionedProductPlansOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningArtifactsForServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningArtifactsForServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningArtifactsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProvisioningArtifactsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListRecordHistoryInput' => [ 'base' => NULL, 'refs' => [], ], 'ListRecordHistoryOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListRecordHistorySearchFilter' => [ 'base' => '

The search filter to use when listing history records.

', 'refs' => [ 'ListRecordHistoryInput$SearchFilter' => '

The search filter to scope the results.

', ], ], 'ListResourcesForTagOptionInput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcesForTagOptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListServiceActionsForProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'ListServiceActionsForProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListServiceActionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListServiceActionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackInstancesForProvisionedProductInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackInstancesForProvisionedProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagOptionsFilters' => [ 'base' => '

Filters to use when listing TagOptions.

', 'refs' => [ 'ListTagOptionsInput$Filters' => '

The search filters. If no search filters are specified, the output includes all TagOptions.

', ], ], 'ListTagOptionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagOptionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'LogicalResourceId' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$LogicalResourceId' => '

The ID of the resource, as defined in the CloudFormation template.

', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ShareError$Message' => '

Information about the error.

', ], ], 'Namespaces' => [ 'base' => NULL, 'refs' => [ 'ShareError$Accounts' => '

List of accounts impacted by the error.

', ], ], 'NoEcho' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactParameter$IsNoEcho' => '

If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.

', ], ], 'NotificationArn' => [ 'base' => NULL, 'refs' => [ 'NotificationArns$member' => NULL, ], ], 'NotificationArns' => [ 'base' => NULL, 'refs' => [ 'CreateProvisionedProductPlanInput$NotificationArns' => '

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

', 'ProvisionProductInput$NotificationArns' => '

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

', 'ProvisionedProductPlanDetails$NotificationArns' => '

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

', ], ], 'NotifyProvisionProductEngineWorkflowResultInput' => [ 'base' => NULL, 'refs' => [], ], 'NotifyProvisionProductEngineWorkflowResultOutput' => [ 'base' => NULL, 'refs' => [], ], 'NotifyTerminateProvisionedProductEngineWorkflowResultInput' => [ 'base' => NULL, 'refs' => [], ], 'NotifyTerminateProvisionedProductEngineWorkflowResultOutput' => [ 'base' => NULL, 'refs' => [], ], 'NotifyUpdateProvisionedProductEngineWorkflowResultInput' => [ 'base' => NULL, 'refs' => [], ], 'NotifyUpdateProvisionedProductEngineWorkflowResultOutput' => [ 'base' => NULL, 'refs' => [], ], 'NullableBoolean' => [ 'base' => NULL, 'refs' => [ 'UpdatePortfolioShareInput$ShareTagOptions' => '

Enables or disables TagOptions sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.

', 'UpdatePortfolioShareInput$SharePrincipals' => '

A flag to enables or disables Principals sharing in the portfolio. If this field is not provided, the current state of the Principals sharing on the portfolio share will not be modified.

', ], ], 'OperationNotSupportedException' => [ 'base' => '

The operation is not supported.

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

Information about the organization node.

', 'refs' => [ 'CreatePortfolioShareInput$OrganizationNode' => '

The organization node to whom you are going to share. When you pass OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services accounts that are associated to the OrganizationNode. The output returns a PortfolioShareToken, which enables the administrator to monitor the status of the PortfolioShare creation process.

', 'DeletePortfolioShareInput$OrganizationNode' => '

The organization node to whom you are going to stop sharing.

', 'OrganizationNodes$member' => NULL, 'UpdatePortfolioShareInput$OrganizationNode' => NULL, ], ], 'OrganizationNodeType' => [ 'base' => NULL, 'refs' => [ 'ListOrganizationPortfolioAccessInput$OrganizationNodeType' => '

The organization node type that will be returned in the output.

  • ORGANIZATION - Organization that has access to the portfolio.

  • ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.

  • ACCOUNT - Account that has access to the portfolio within your organization.

', 'OrganizationNode$Type' => '

The organization node type.

', ], ], 'OrganizationNodeValue' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioShareStatusOutput$OrganizationNodeValue' => '

Organization node identifier. It can be either account id, organizational unit id or organization id.

', 'OrganizationNode$Value' => '

The identifier of the organization node.

', ], ], 'OrganizationNodes' => [ 'base' => NULL, 'refs' => [ 'ListOrganizationPortfolioAccessOutput$OrganizationNodes' => '

Displays information about the organization nodes.

', ], ], 'OutputDescription' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactOutput$Description' => '

Description of the provisioning artifact output key.

', ], ], 'OutputKey' => [ 'base' => NULL, 'refs' => [ 'OutputKeys$member' => NULL, 'RecordOutput$OutputKey' => '

The output key.

', ], ], 'OutputKeys' => [ 'base' => NULL, 'refs' => [ 'GetProvisionedProductOutputsInput$OutputKeys' => '

The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product.

', ], ], 'OutputValue' => [ 'base' => NULL, 'refs' => [ 'RecordOutput$OutputValue' => '

The output value.

', ], ], 'Owner' => [ 'base' => NULL, 'refs' => [ 'TagOptionDetail$Owner' => '

The Amazon Web Services account Id of the owner account that created the TagOption.

', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisionedProductPlanInput$PageSize' => '

The maximum number of items to return with this call.

', 'DescribeRecordInput$PageSize' => '

The maximum number of items to return with this call.

', 'GetProvisionedProductOutputsInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListBudgetsForResourceInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListConstraintsForPortfolioInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListLaunchPathsInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListOrganizationPortfolioAccessInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListPrincipalsForPortfolioInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListProvisionedProductPlansInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListProvisioningArtifactsForServiceActionInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListRecordHistoryInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListResourcesForTagOptionInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListServiceActionsForProvisioningArtifactInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListServiceActionsInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListStackInstancesForProvisionedProductInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListTagOptionsInput$PageSize' => '

The maximum number of items to return with this call.

', 'ScanProvisionedProductsInput$PageSize' => '

The maximum number of items to return with this call.

', 'SearchProductsAsAdminInput$PageSize' => '

The maximum number of items to return with this call.

', ], ], 'PageSizeMax100' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioSharesInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListAcceptedPortfolioSharesInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListPortfolioAccessInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListPortfoliosForProductInput$PageSize' => '

The maximum number of items to return with this call.

', 'ListPortfoliosInput$PageSize' => '

The maximum number of items to return with this call.

', 'SearchProductsInput$PageSize' => '

The maximum number of items to return with this call.

', ], ], 'PageToken' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioSharesInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'DescribePortfolioSharesOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'DescribeProvisionedProductPlanInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'DescribeProvisionedProductPlanOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'DescribeRecordInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'DescribeRecordOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'GetProvisionedProductOutputsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'GetProvisionedProductOutputsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListAcceptedPortfolioSharesInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListAcceptedPortfolioSharesOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListBudgetsForResourceInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListBudgetsForResourceOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListConstraintsForPortfolioInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListConstraintsForPortfolioOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListLaunchPathsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListLaunchPathsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListOrganizationPortfolioAccessInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListOrganizationPortfolioAccessOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListPortfolioAccessInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListPortfolioAccessOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListPortfoliosForProductInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListPortfoliosForProductOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListPortfoliosInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListPortfoliosOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListPrincipalsForPortfolioInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListPrincipalsForPortfolioOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListProvisionedProductPlansInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListProvisionedProductPlansOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListProvisioningArtifactsForServiceActionInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListProvisioningArtifactsForServiceActionOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListProvisioningArtifactsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListRecordHistoryInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListRecordHistoryOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListResourcesForTagOptionInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListResourcesForTagOptionOutput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListServiceActionsForProvisioningArtifactInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListServiceActionsForProvisioningArtifactOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListServiceActionsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListServiceActionsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListStackInstancesForProvisionedProductInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListStackInstancesForProvisionedProductOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'ListTagOptionsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ListTagOptionsOutput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ScanProvisionedProductsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'ScanProvisionedProductsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'SearchProductsAsAdminInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'SearchProductsAsAdminOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'SearchProductsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'SearchProductsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', 'SearchProvisionedProductsInput$PageToken' => '

The page token for the next set of results. To retrieve the first set of results, use null.

', 'SearchProvisionedProductsOutput$NextPageToken' => '

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

', ], ], 'ParameterConstraints' => [ 'base' => '

The constraints that the administrator has put on the parameter.

', 'refs' => [ 'ProvisioningArtifactParameter$ParameterConstraints' => '

Constraints that the administrator has put on a parameter.

', ], ], 'ParameterKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactParameter$ParameterKey' => '

The parameter key.

', 'ProvisioningParameter$Key' => '

The parameter key.

', 'UpdateProvisioningParameter$Key' => '

The parameter key.

', ], ], 'ParameterType' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactParameter$ParameterType' => '

The parameter type.

', ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningParameter$Value' => '

The parameter value.

', 'UpdateProvisioningParameter$Value' => '

The parameter value.

', ], ], 'PhysicalId' => [ 'base' => NULL, 'refs' => [ 'ImportAsProvisionedProductInput$PhysicalId' => '

The unique identifier of the resource to be imported. It only currently supports CloudFormation stack IDs.

', 'ProvisionedProductAttribute$PhysicalId' => '

The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.

', ], ], 'PhysicalResourceId' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$PhysicalResourceId' => '

The ID of the resource, if it was already created.

', ], ], 'PlanResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$ResourceType' => '

The type of resource.

', ], ], 'PortfolioDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioInput$Description' => '

The description of the portfolio.

', 'PortfolioDetail$Description' => '

The description of the portfolio.

', 'UpdatePortfolioInput$Description' => '

The updated description of the portfolio.

', ], ], 'PortfolioDetail' => [ 'base' => '

Information about a portfolio.

', 'refs' => [ 'CreatePortfolioOutput$PortfolioDetail' => '

Information about the portfolio.

', 'DescribePortfolioOutput$PortfolioDetail' => '

Information about the portfolio.

', 'PortfolioDetails$member' => NULL, 'UpdatePortfolioOutput$PortfolioDetail' => '

Information about the portfolio.

', ], ], 'PortfolioDetails' => [ 'base' => NULL, 'refs' => [ 'ListAcceptedPortfolioSharesOutput$PortfolioDetails' => '

Information about the portfolios.

', 'ListPortfoliosForProductOutput$PortfolioDetails' => '

Information about the portfolios.

', 'ListPortfoliosOutput$PortfolioDetails' => '

Information about the portfolios.

', ], ], 'PortfolioDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioInput$DisplayName' => '

The name to use for display purposes.

', 'DescribeProvisioningParametersInput$PathName' => '

The name of the path. You must provide the name or ID, but not both.

', 'PortfolioDetail$DisplayName' => '

The name to use for display purposes.

', 'ProvisionProductInput$PathName' => '

The name of the path. You must provide the name or ID, but not both.

', 'UpdatePortfolioInput$DisplayName' => '

The name to use for display purposes.

', 'UpdateProvisionedProductInput$PathName' => '

The name of the path. You must provide the name or ID, but not both.

', ], ], 'PortfolioName' => [ 'base' => NULL, 'refs' => [ 'LaunchPath$Name' => '

The name of the launch path.

', 'LaunchPathSummary$Name' => '

The name of the portfolio that contains the product.

', ], ], 'PortfolioShareDetail' => [ 'base' => '

Information about the portfolio share.

', 'refs' => [ 'PortfolioShareDetails$member' => NULL, ], ], 'PortfolioShareDetails' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioSharesOutput$PortfolioShareDetails' => '

Summaries about each of the portfolio shares.

', ], ], 'PortfolioShareType' => [ 'base' => NULL, 'refs' => [ 'AcceptPortfolioShareInput$PortfolioShareType' => '

The type of shared portfolios to accept. The default is to accept imported portfolios.

  • AWS_ORGANIZATIONS - Accept portfolios shared by the management account of your organization.

  • IMPORTED - Accept imported portfolios.

  • AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

For example, aws servicecatalog accept-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS

', 'ListAcceptedPortfolioSharesInput$PortfolioShareType' => '

The type of shared portfolios to list. The default is to list imported portfolios.

  • AWS_ORGANIZATIONS - List portfolios accepted and shared via organizational sharing by the management account or delegated administrator of your organization.

  • AWS_SERVICECATALOG - Deprecated type.

  • IMPORTED - List imported portfolios that have been accepted and shared through account-to-account sharing.

', 'RejectPortfolioShareInput$PortfolioShareType' => '

The type of shared portfolios to reject. The default is to reject imported portfolios.

  • AWS_ORGANIZATIONS - Reject portfolios shared by the management account of your organization.

  • IMPORTED - Reject imported portfolios.

  • AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

For example, aws servicecatalog reject-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS

', ], ], 'Principal' => [ 'base' => '

Information about a principal.

', 'refs' => [ 'Principals$member' => NULL, ], ], 'PrincipalARN' => [ 'base' => NULL, 'refs' => [ 'AssociatePrincipalWithPortfolioInput$PrincipalARN' => '

The ARN of the principal (user, role, or group). If the PrincipalType is IAM, the supported value is a fully defined IAM Amazon Resource Name (ARN). If the PrincipalType is IAM_PATTERN, the supported value is an IAM ARN without an AccountID in the following format:

arn:partition:iam:::resource-type/resource-id

The ARN resource-id can be either:

  • A fully formed resource-id. For example, arn:aws:iam:::role/resource-name or arn:aws:iam:::role/resource-path/resource-name

  • A wildcard ARN. The wildcard ARN accepts IAM_PATTERN values with a "*" or "?" in the resource-id segment of the ARN. For example arn:partition:service:::resource-type/resource-path/resource-name. The new symbols are exclusive to the resource-path and resource-name and cannot replace the resource-type or other ARN values.

    The ARN path and principal name allow unlimited wildcard characters.

Examples of an acceptable wildcard ARN:

  • arn:aws:iam:::role/ResourceName_*

  • arn:aws:iam:::role/*/ResourceName_?

Examples of an unacceptable wildcard ARN:

  • arn:aws:iam:::*/ResourceName

You can associate multiple IAM_PATTERNs even if the account has no principal with that name.

The "?" wildcard character matches zero or one of any character. This is similar to ".?" in regular regex context. The "*" wildcard character matches any number of any characters. This is similar to ".*" in regular regex context.

In the IAM Principal ARN format (arn:partition:iam:::resource-type/resource-path/resource-name), valid resource-type values include user/, group/, or role/. The "?" and "*" characters are allowed only after the resource-type in the resource-id segment. You can use special characters anywhere within the resource-id.

The "*" character also matches the "/" character, allowing paths to be formed within the resource-id. For example, arn:aws:iam:::role/*/ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and arn:aws:iam:::role/pathA/ResourceName_1.

', 'DisassociatePrincipalFromPortfolioInput$PrincipalARN' => '

The ARN of the principal (user, role, or group). This field allows an ARN with no accountID with or without wildcard characters if PrincipalType is IAM_PATTERN.

', 'Principal$PrincipalARN' => '

The ARN of the principal (user, role, or group). This field allows for an ARN with no accountID, with or without wildcard characters if the PrincipalType is an IAM_PATTERN.

For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.

', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'AssociatePrincipalWithPortfolioInput$PrincipalType' => '

The principal type. The supported value is IAM if you use a fully defined Amazon Resource Name (ARN), or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

', 'DisassociatePrincipalFromPortfolioInput$PrincipalType' => '

The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you specify an IAM ARN with no AccountId, with or without wildcard characters.

', 'Principal$PrincipalType' => '

The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

', ], ], 'Principals' => [ 'base' => NULL, 'refs' => [ 'ListPrincipalsForPortfolioOutput$Principals' => '

The PrincipalARNs and corresponding PrincipalTypes associated with the portfolio.

', ], ], 'ProductArn' => [ 'base' => NULL, 'refs' => [ 'CopyProductInput$SourceProductArn' => '

The Amazon Resource Name (ARN) of the source product.

', ], ], 'ProductSource' => [ 'base' => NULL, 'refs' => [ 'SearchProductsAsAdminInput$ProductSource' => '

Access level of the source of the product.

', ], ], 'ProductType' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$ProductType' => '

The type of product.

', 'ProductViewSummary$Type' => '

The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by Amazon Web Services Marketplace.

', ], ], 'ProductViewAggregationType' => [ 'base' => NULL, 'refs' => [ 'ProductViewAggregations$key' => NULL, ], ], 'ProductViewAggregationValue' => [ 'base' => '

A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.

', 'refs' => [ 'ProductViewAggregationValues$member' => NULL, ], ], 'ProductViewAggregationValues' => [ 'base' => NULL, 'refs' => [ 'ProductViewAggregations$value' => NULL, ], ], 'ProductViewAggregations' => [ 'base' => NULL, 'refs' => [ 'SearchProductsOutput$ProductViewAggregations' => '

The product view aggregations.

', ], ], 'ProductViewDetail' => [ 'base' => '

Information about a product view.

', 'refs' => [ 'CreateProductOutput$ProductViewDetail' => '

Information about the product view.

', 'DescribeProductAsAdminOutput$ProductViewDetail' => '

Information about the product view.

', 'ProductViewDetails$member' => NULL, 'UpdateProductOutput$ProductViewDetail' => '

Information about the product view.

', ], ], 'ProductViewDetails' => [ 'base' => NULL, 'refs' => [ 'SearchProductsAsAdminOutput$ProductViewDetails' => '

Information about the product views.

', ], ], 'ProductViewDistributor' => [ 'base' => NULL, 'refs' => [ 'ProductViewSummary$Distributor' => '

The distributor of the product. Contact the product administrator for the significance of this value.

', ], ], 'ProductViewFilterBy' => [ 'base' => NULL, 'refs' => [ 'ProductViewFilters$key' => NULL, ], ], 'ProductViewFilterValue' => [ 'base' => NULL, 'refs' => [ 'ProductViewFilterValues$member' => NULL, ], ], 'ProductViewFilterValues' => [ 'base' => NULL, 'refs' => [ 'ProductViewFilters$value' => NULL, ], ], 'ProductViewFilters' => [ 'base' => NULL, 'refs' => [ 'SearchProductsAsAdminInput$Filters' => '

The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

', 'SearchProductsInput$Filters' => '

The search filters. If no search filters are specified, the output includes all products to which the caller has access.

', ], ], 'ProductViewName' => [ 'base' => NULL, 'refs' => [ 'CopyProductInput$TargetProductName' => '

A name for the target product. The default is the name of the source product.

', 'CreateProductInput$Name' => '

The name of the product.

', 'DescribeProductAsAdminInput$Name' => '

The product name.

', 'DescribeProductInput$Name' => '

The product name.

', 'DescribeProvisioningArtifactInput$ProductName' => '

The product name.

', 'DescribeProvisioningParametersInput$ProductName' => '

The name of the product. You must provide the name or ID, but not both.

', 'ProductViewSummary$Name' => '

The name of the product.

', 'ProvisionProductInput$ProductName' => '

The name of the product. You must provide the name or ID, but not both.

', 'ProvisionedProductAttribute$ProductName' => '

The name of the product.

', 'UpdateProductInput$Name' => '

The updated product name.

', 'UpdateProvisionedProductInput$ProductName' => '

The name of the product. You must provide the name or ID, but not both.

', ], ], 'ProductViewOwner' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$Owner' => '

The owner of the product.

', 'CreateProductInput$Distributor' => '

The distributor of the product.

', 'ProductViewSummary$Owner' => '

The owner of the product. Contact the product administrator for the significance of this value.

', 'UpdateProductInput$Owner' => '

The updated owner of the product.

', 'UpdateProductInput$Distributor' => '

The updated distributor of the product.

', ], ], 'ProductViewShortDescription' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$Description' => '

The description of the product.

', 'ProductViewSummary$ShortDescription' => '

Short description of the product.

', 'UpdateProductInput$Description' => '

The updated description of the product.

', ], ], 'ProductViewSortBy' => [ 'base' => NULL, 'refs' => [ 'SearchProductsAsAdminInput$SortBy' => '

The sort field. If no value is specified, the results are not sorted.

', 'SearchProductsInput$SortBy' => '

The sort field. If no value is specified, the results are not sorted.

', ], ], 'ProductViewSummaries' => [ 'base' => NULL, 'refs' => [ 'SearchProductsOutput$ProductViewSummaries' => '

Information about the product views.

', ], ], 'ProductViewSummary' => [ 'base' => '

Summary information about a product view.

', 'refs' => [ 'DescribeProductOutput$ProductViewSummary' => '

Summary information about the product view.

', 'DescribeProductViewOutput$ProductViewSummary' => '

Summary information about the product.

', 'ProductViewDetail$ProductViewSummary' => '

Summary information about the product view.

', 'ProductViewSummaries$member' => NULL, 'ProvisioningArtifactView$ProductViewSummary' => '

Summary information about a product view.

', ], ], 'PropertyKey' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductProperties$key' => NULL, ], ], 'PropertyName' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$Name' => '

If the attribute is Properties, the value is the name of the property. Otherwise, the value is null.

', ], ], 'PropertyValue' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductProperties$value' => NULL, ], ], 'ProviderName' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioInput$ProviderName' => '

The name of the portfolio provider.

', 'PortfolioDetail$ProviderName' => '

The name of the portfolio provider.

', 'UpdatePortfolioInput$ProviderName' => '

The updated name of the portfolio provider.

', ], ], 'ProvisionProductInput' => [ 'base' => NULL, 'refs' => [], ], 'ProvisionProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'ProvisionedProductAttribute' => [ 'base' => '

Information about a provisioned product.

', 'refs' => [ 'ProvisionedProductAttributes$member' => NULL, ], ], 'ProvisionedProductAttributes' => [ 'base' => NULL, 'refs' => [ 'SearchProvisionedProductsOutput$ProvisionedProducts' => '

Information about the provisioned products.

', ], ], 'ProvisionedProductDetail' => [ 'base' => '

Information about a provisioned product.

', 'refs' => [ 'DescribeProvisionedProductOutput$ProvisionedProductDetail' => '

Information about the provisioned product.

', 'ProvisionedProductDetails$member' => NULL, ], ], 'ProvisionedProductDetails' => [ 'base' => NULL, 'refs' => [ 'ScanProvisionedProductsOutput$ProvisionedProducts' => '

Information about the provisioned products.

', ], ], 'ProvisionedProductFilters' => [ 'base' => NULL, 'refs' => [ 'SearchProvisionedProductsInput$Filters' => '

The search filters.

When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifactId, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

Example: "SearchQuery":["status:AVAILABLE"]

', ], ], 'ProvisionedProductId' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductDetail$Id' => '

The identifier of the provisioned product.

', ], ], 'ProvisionedProductName' => [ 'base' => NULL, 'refs' => [ 'CreateProvisionedProductPlanInput$ProvisionedProductName' => '

A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

', 'CreateProvisionedProductPlanOutput$ProvisionedProductName' => '

The user-friendly name of the provisioned product.

', 'DescribeProvisionedProductInput$Name' => '

The name of the provisioned product. You must provide the name or ID, but not both.

If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

', 'GetProvisionedProductOutputsInput$ProvisionedProductName' => '

The name of the provisioned product that you want the outputs from.

', 'ImportAsProvisionedProductInput$ProvisionedProductName' => '

The user-friendly name of the provisioned product. The value must be unique for the Amazon Web Services account. The name cannot be updated after the product is provisioned.

', 'ProvisionProductInput$ProvisionedProductName' => '

A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

', 'ProvisionedProductPlanDetails$ProvisionProductName' => '

The user-friendly name of the provisioned product.

', 'ProvisionedProductPlanSummary$ProvisionProductName' => '

The user-friendly name of the provisioned product.

', 'RecordDetail$ProvisionedProductName' => '

The user-friendly name of the provisioned product.

', ], ], 'ProvisionedProductNameOrArn' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$Name' => '

The user-friendly name of the provisioned product.

', 'ProvisionedProductAttribute$Arn' => '

The ARN of the provisioned product.

', 'ProvisionedProductDetail$Name' => '

The user-friendly name of the provisioned product.

', 'ProvisionedProductDetail$Arn' => '

The ARN of the provisioned product.

', 'TerminateProvisionedProductInput$ProvisionedProductName' => '

The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

', 'UpdateProvisionedProductInput$ProvisionedProductName' => '

The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

', ], ], 'ProvisionedProductPlanDetails' => [ 'base' => '

Information about a plan.

', 'refs' => [ 'DescribeProvisionedProductPlanOutput$ProvisionedProductPlanDetails' => '

Information about the plan.

', ], ], 'ProvisionedProductPlanName' => [ 'base' => NULL, 'refs' => [ 'CreateProvisionedProductPlanInput$PlanName' => '

The name of the plan.

', 'CreateProvisionedProductPlanOutput$PlanName' => '

The name of the plan.

', 'ProvisionedProductPlanDetails$PlanName' => '

The name of the plan.

', 'ProvisionedProductPlanSummary$PlanName' => '

The name of the plan.

', ], ], 'ProvisionedProductPlanStatus' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductPlanDetails$Status' => '

The status.

', ], ], 'ProvisionedProductPlanSummary' => [ 'base' => '

Summary information about a plan.

', 'refs' => [ 'ProvisionedProductPlans$member' => NULL, ], ], 'ProvisionedProductPlanType' => [ 'base' => NULL, 'refs' => [ 'CreateProvisionedProductPlanInput$PlanType' => '

The plan type.

', 'ProvisionedProductPlanDetails$PlanType' => '

The plan type.

', 'ProvisionedProductPlanSummary$PlanType' => '

The plan type.

', ], ], 'ProvisionedProductPlans' => [ 'base' => NULL, 'refs' => [ 'ListProvisionedProductPlansOutput$ProvisionedProductPlans' => '

Information about the plans.

', ], ], 'ProvisionedProductProperties' => [ 'base' => NULL, 'refs' => [ 'UpdateProvisionedProductPropertiesInput$ProvisionedProductProperties' => '

A map that contains the provisioned product properties to be updated.

The LAUNCH_ROLE key accepts role ARNs. This key allows an administrator to call UpdateProvisionedProductProperties to update the launch role that is associated with a provisioned product. This role is used when an end user calls a provisioning operation such as UpdateProvisionedProduct, TerminateProvisionedProduct, or ExecuteProvisionedProductServiceAction. Only a role ARN is valid. A user ARN is invalid.

The OWNER key accepts user ARNs, IAM role ARNs, and STS assumed-role ARNs. The owner is the user that has permission to see, update, terminate, and execute service actions in the provisioned product.

The administrator can change the owner of a provisioned product to another IAM or STS entity within the same account. Both end user owners and administrators can see ownership history of the provisioned product using the ListRecordHistory API. The new owner can describe all past records for the provisioned product using the DescribeRecord API. The previous owner can no longer use DescribeRecord, but can still see the product\'s history from when he was an owner using ListRecordHistory.

If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or Service Catalog console such as update, terminate, and execute service actions. If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through API or the Service Catalog console on that provisioned product.

', 'UpdateProvisionedProductPropertiesOutput$ProvisionedProductProperties' => '

A map that contains the properties updated.

', ], ], 'ProvisionedProductStatus' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$Status' => '

The current status of the provisioned product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

', 'ProvisionedProductDetail$Status' => '

The current status of the provisioned product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

', ], ], 'ProvisionedProductStatusMessage' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$StatusMessage' => '

The current status message of the provisioned product.

', 'ProvisionedProductDetail$StatusMessage' => '

The current status message of the provisioned product.

', ], ], 'ProvisionedProductType' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$Type' => '

The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

', 'ProvisionedProductDetail$Type' => '

The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

', 'RecordDetail$ProvisionedProductType' => '

The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

', ], ], 'ProvisionedProductViewFilterBy' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductFilters$key' => NULL, ], ], 'ProvisionedProductViewFilterValue' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductViewFilterValues$member' => NULL, ], ], 'ProvisionedProductViewFilterValues' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductFilters$value' => NULL, ], ], 'ProvisioningArtifact' => [ 'base' => '

Information about a provisioning artifact. A provisioning artifact is also known as a product version.

', 'refs' => [ 'ProvisioningArtifactView$ProvisioningArtifact' => '

Information about a provisioning artifact. A provisioning artifact is also known as a product version.

', 'ProvisioningArtifacts$member' => NULL, ], ], 'ProvisioningArtifactActive' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactDetail$Active' => '

Indicates whether the product version is active.

', 'UpdateProvisioningArtifactInput$Active' => '

Indicates whether the product version is active.

Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

', ], ], 'ProvisioningArtifactCreatedTime' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifact$CreatedTime' => '

The UTC time stamp of the creation time.

', 'ProvisioningArtifactSummary$CreatedTime' => '

The UTC time stamp of the creation time.

', ], ], 'ProvisioningArtifactDescription' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifact$Description' => '

The description of the provisioning artifact.

', 'ProvisioningArtifactProperties$Description' => '

The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

', 'ProvisioningArtifactSummary$Description' => '

The description of the provisioning artifact.

', 'UpdateProvisioningArtifactInput$Description' => '

The updated description of the provisioning artifact.

', ], ], 'ProvisioningArtifactDetail' => [ 'base' => '

Information about a provisioning artifact (also known as a version) for a product.

', 'refs' => [ 'CreateProductOutput$ProvisioningArtifactDetail' => '

Information about the provisioning artifact.

', 'CreateProvisioningArtifactOutput$ProvisioningArtifactDetail' => '

Information about the provisioning artifact.

', 'DescribeProvisioningArtifactOutput$ProvisioningArtifactDetail' => '

Information about the provisioning artifact.

', 'ProvisioningArtifactDetails$member' => NULL, 'UpdateProvisioningArtifactOutput$ProvisioningArtifactDetail' => '

Information about the provisioning artifact.

', ], ], 'ProvisioningArtifactDetails' => [ 'base' => NULL, 'refs' => [ 'ListProvisioningArtifactsOutput$ProvisioningArtifactDetails' => '

Information about the provisioning artifacts.

', ], ], 'ProvisioningArtifactGuidance' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifact$Guidance' => '

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

', 'ProvisioningArtifactDetail$Guidance' => '

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

', 'UpdateProvisioningArtifactInput$Guidance' => '

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

The DEFAULT value indicates that the product version is active.

The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

', ], ], 'ProvisioningArtifactInfo' => [ 'base' => NULL, 'refs' => [ 'CreateProvisioningArtifactOutput$Info' => '

Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ].

Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

LoadTemplateFromURL

Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

ImportFromPhysicalId

Use the physical id of the resource that contains the template; currently supports CloudFormation stack ARN.

', 'DescribeProvisioningArtifactOutput$Info' => '

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

', 'ProvisioningArtifactProperties$Info' => '

Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL in JSON format as follows:

"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

', 'ProvisioningArtifactSummary$ProvisioningArtifactMetadata' => '

The metadata for the provisioning artifact. This is used with Amazon Web Services Marketplace products.

', 'UpdateProvisioningArtifactOutput$Info' => '

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

', ], ], 'ProvisioningArtifactInfoKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactInfo$key' => NULL, ], ], 'ProvisioningArtifactInfoValue' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactInfo$value' => NULL, ], ], 'ProvisioningArtifactName' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningArtifactInput$ProvisioningArtifactName' => '

The provisioning artifact name.

', 'DescribeProvisioningParametersInput$ProvisioningArtifactName' => '

The name of the provisioning artifact. You must provide the name or ID, but not both.

', 'ProvisionProductInput$ProvisioningArtifactName' => '

The name of the provisioning artifact. You must provide the name or ID, but not both.

', 'ProvisionedProductAttribute$ProvisioningArtifactName' => '

The name of the provisioning artifact.

', 'ProvisioningArtifact$Name' => '

The name of the provisioning artifact.

', 'ProvisioningArtifactDetail$Name' => '

The name of the provisioning artifact.

', 'ProvisioningArtifactDetail$Description' => '

The description of the provisioning artifact.

', 'ProvisioningArtifactProperties$Name' => '

The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.

', 'ProvisioningArtifactSummary$Name' => '

The name of the provisioning artifact.

', 'UpdateProvisionedProductInput$ProvisioningArtifactName' => '

The name of the provisioning artifact. You must provide the name or ID, but not both.

', 'UpdateProvisioningArtifactInput$Name' => '

The updated name of the provisioning artifact.

', ], ], 'ProvisioningArtifactOutput' => [ 'base' => '

Provisioning artifact output.

', 'refs' => [ 'ProvisioningArtifactOutputs$member' => NULL, ], ], 'ProvisioningArtifactOutputKey' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactOutput$Key' => '

The provisioning artifact output key.

', ], ], 'ProvisioningArtifactOutputs' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningParametersOutput$ProvisioningArtifactOutputs' => '

The output of the provisioning artifact.

', 'DescribeProvisioningParametersOutput$ProvisioningArtifactOutputKeys' => '

A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

', ], ], 'ProvisioningArtifactParameter' => [ 'base' => '

Information about a parameter used to provision a product.

', 'refs' => [ 'ProvisioningArtifactParameters$member' => NULL, ], ], 'ProvisioningArtifactParameters' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningArtifactOutput$ProvisioningArtifactParameters' => '

Information about the parameters used to provision the product.

', 'DescribeProvisioningParametersOutput$ProvisioningArtifactParameters' => '

Information about the parameters used to provision the product.

', ], ], 'ProvisioningArtifactPreferences' => [ 'base' => '

The user-defined preferences that will be applied during product provisioning, unless overridden by ProvisioningPreferences or UpdateProvisioningPreferences.

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options in the CloudFormation User Guide.

', 'refs' => [ 'DescribeProvisioningParametersOutput$ProvisioningArtifactPreferences' => '

An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

', ], ], 'ProvisioningArtifactProperties' => [ 'base' => '

Information about a provisioning artifact (also known as a version) for a product.

', 'refs' => [ 'CreateProductInput$ProvisioningArtifactParameters' => '

The configuration of the provisioning artifact.

', 'CreateProvisioningArtifactInput$Parameters' => '

The configuration for the provisioning artifact.

', ], ], 'ProvisioningArtifactPropertyName' => [ 'base' => NULL, 'refs' => [ 'SourceProvisioningArtifactPropertiesMap$key' => NULL, ], ], 'ProvisioningArtifactPropertyValue' => [ 'base' => NULL, 'refs' => [ 'SourceProvisioningArtifactPropertiesMap$value' => NULL, ], ], 'ProvisioningArtifactSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeProductAsAdminOutput$ProvisioningArtifactSummaries' => '

Information about the provisioning artifacts (also known as versions) for the specified product.

', ], ], 'ProvisioningArtifactSummary' => [ 'base' => '

Summary information about a provisioning artifact (also known as a version) for a product.

', 'refs' => [ 'ProvisioningArtifactSummaries$member' => NULL, ], ], 'ProvisioningArtifactType' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactDetail$Type' => '

The type of provisioning artifact.

  • CLOUD_FORMATION_TEMPLATE - CloudFormation template

  • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

  • TERRAFORM_CLOUD - Terraform Cloud configuration file

  • EXTERNAL - External configuration file

', 'ProvisioningArtifactProperties$Type' => '

The type of provisioning artifact.

  • CLOUD_FORMATION_TEMPLATE - CloudFormation template

  • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

  • TERRAFORM_CLOUD - Terraform Cloud configuration file

  • EXTERNAL - External configuration file

', ], ], 'ProvisioningArtifactView' => [ 'base' => '

An object that contains summary information about a product view and a provisioning artifact.

', 'refs' => [ 'ProvisioningArtifactViews$member' => NULL, ], ], 'ProvisioningArtifactViews' => [ 'base' => NULL, 'refs' => [ 'ListProvisioningArtifactsForServiceActionOutput$ProvisioningArtifactViews' => '

An array of objects with information about product views and provisioning artifacts.

', ], ], 'ProvisioningArtifacts' => [ 'base' => NULL, 'refs' => [ 'DescribeProductOutput$ProvisioningArtifacts' => '

Information about the provisioning artifacts for the specified product.

', 'DescribeProductViewOutput$ProvisioningArtifacts' => '

Information about the provisioning artifacts for the product.

', ], ], 'ProvisioningParameter' => [ 'base' => '

Information about a parameter used to provision a product.

', 'refs' => [ 'ProvisioningParameters$member' => NULL, ], ], 'ProvisioningParameters' => [ 'base' => NULL, 'refs' => [ 'ProvisionProductInput$ProvisioningParameters' => '

Parameters specified by the administrator that are required for provisioning the product.

', ], ], 'ProvisioningPreferences' => [ 'base' => '

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product type

One or more Amazon Web Services accounts that will have access to the provisioned product.

Applicable only to a CFN_STACKSET provisioned product type.

The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all accounts from the STACKSET constraint.

', 'refs' => [ 'ProvisionProductInput$ProvisioningPreferences' => '

An object that contains information about the provisioning preferences for a stack set.

', ], ], 'RecordDetail' => [ 'base' => '

Information about a request operation.

', 'refs' => [ 'DescribeRecordOutput$RecordDetail' => '

Information about the product.

', 'ExecuteProvisionedProductPlanOutput$RecordDetail' => '

Information about the result of provisioning the product.

', 'ExecuteProvisionedProductServiceActionOutput$RecordDetail' => '

An object containing detailed information about the result of provisioning the product.

', 'ImportAsProvisionedProductOutput$RecordDetail' => NULL, 'ProvisionProductOutput$RecordDetail' => '

Information about the result of provisioning the product.

', 'RecordDetails$member' => NULL, 'TerminateProvisionedProductOutput$RecordDetail' => '

Information about the result of this request.

', 'UpdateProvisionedProductOutput$RecordDetail' => '

Information about the result of the request.

', ], ], 'RecordDetails' => [ 'base' => NULL, 'refs' => [ 'ListRecordHistoryOutput$RecordDetails' => '

The records, in reverse chronological order.

', ], ], 'RecordError' => [ 'base' => '

The error code and description resulting from an operation.

', 'refs' => [ 'RecordErrors$member' => NULL, ], ], 'RecordErrors' => [ 'base' => NULL, 'refs' => [ 'RecordDetail$RecordErrors' => '

The errors that occurred.

', ], ], 'RecordOutput' => [ 'base' => '

The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

', 'refs' => [ 'RecordOutputs$member' => NULL, ], ], 'RecordOutputs' => [ 'base' => NULL, 'refs' => [ 'DescribeRecordOutput$RecordOutputs' => '

Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

', 'GetProvisionedProductOutputsOutput$Outputs' => '

Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

', 'NotifyProvisionProductEngineWorkflowResultInput$Outputs' => '

The output of the provisioning engine execution.

', 'NotifyUpdateProvisionedProductEngineWorkflowResultInput$Outputs' => '

The output of the update engine execution.

', ], ], 'RecordStatus' => [ 'base' => NULL, 'refs' => [ 'RecordDetail$Status' => '

The status of the provisioned product.

  • CREATED - The request was created but the operation has not started.

  • IN_PROGRESS - The requested operation is in progress.

  • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

  • SUCCEEDED - The requested operation has successfully completed.

  • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

', 'UpdateProvisionedProductPropertiesOutput$Status' => '

The status of the request.

', ], ], 'RecordTag' => [ 'base' => '

Information about a tag, which is a key-value pair.

', 'refs' => [ 'RecordTags$member' => NULL, ], ], 'RecordTagKey' => [ 'base' => NULL, 'refs' => [ 'RecordTag$Key' => '

The key for this tag.

', ], ], 'RecordTagValue' => [ 'base' => NULL, 'refs' => [ 'RecordTag$Value' => '

The value for this tag.

', ], ], 'RecordTags' => [ 'base' => NULL, 'refs' => [ 'RecordDetail$RecordTags' => '

One or more tags.

', ], ], 'RecordType' => [ 'base' => NULL, 'refs' => [ 'RecordDetail$RecordType' => '

The record type.

  • PROVISION_PRODUCT

  • UPDATE_PROVISIONED_PRODUCT

  • TERMINATE_PROVISIONED_PRODUCT

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'StackInstance$Region' => '

The name of the Amazon Web Services Region that the stack instance is associated with.

', 'StackSetRegions$member' => NULL, ], ], 'RejectPortfolioShareInput' => [ 'base' => NULL, 'refs' => [], ], 'RejectPortfolioShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'Replacement' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Replacement' => '

If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one.

', ], ], 'Repository' => [ 'base' => NULL, 'refs' => [ 'CodeStarParameters$Repository' => '

The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."

', ], ], 'RepositoryArtifactPath' => [ 'base' => NULL, 'refs' => [ 'CodeStarParameters$ArtifactPath' => '

The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."

', ], ], 'RepositoryBranch' => [ 'base' => NULL, 'refs' => [ 'CodeStarParameters$Branch' => '

The specific branch where the artifact resides.

', ], ], 'RequiresRecreation' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$RequiresRecreation' => '

If the attribute is Properties, indicates whether a change to this property causes the resource to be re-created.

', ], ], 'ResourceARN' => [ 'base' => NULL, 'refs' => [ 'PortfolioDetail$ARN' => '

The ARN assigned to the portfolio.

', 'ProductViewDetail$ProductARN' => '

The ARN of the product.

', ], ], 'ResourceAttribute' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$Attribute' => '

The attribute to be changed.

', 'Scope$member' => NULL, ], ], 'ResourceChange' => [ 'base' => '

Information about a resource change that will occur when a plan is executed.

', 'refs' => [ 'ResourceChanges$member' => NULL, ], ], 'ResourceChangeDetail' => [ 'base' => '

Information about a change to a resource attribute.

', 'refs' => [ 'ResourceChangeDetails$member' => NULL, ], ], 'ResourceChangeDetails' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Details' => '

Information about the resource changes.

', ], ], 'ResourceChanges' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisionedProductPlanOutput$ResourceChanges' => '

Information about the resource changes that will occur when the plan is executed.

', ], ], 'ResourceDetail' => [ 'base' => '

Information about a resource.

', 'refs' => [ 'ResourceDetails$member' => NULL, ], ], 'ResourceDetailARN' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$ARN' => '

The ARN of the resource.

', ], ], 'ResourceDetailCreatedTime' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$CreatedTime' => '

The creation time of the resource.

', ], ], 'ResourceDetailDescription' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$Description' => '

The description of the resource.

', ], ], 'ResourceDetailId' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$Id' => '

The identifier of the resource.

', ], ], 'ResourceDetailName' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$Name' => '

The name of the resource.

', ], ], 'ResourceDetails' => [ 'base' => NULL, 'refs' => [ 'ListResourcesForTagOptionOutput$ResourceDetails' => '

Information about the resources.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AssociateTagOptionWithResourceInput$ResourceId' => '

The resource identifier.

', 'DisassociateTagOptionFromResourceInput$ResourceId' => '

The resource identifier.

', ], ], 'ResourceInUseException' => [ 'base' => '

A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

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

The specified resource was not found.

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

Information about a change to a resource attribute.

', 'refs' => [ 'ResourceChangeDetail$Target' => '

Information about the resource attribute to be modified.

', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ListResourcesForTagOptionInput$ResourceType' => '

The resource type.

  • Portfolio

  • Product

', ], ], 'RetainPhysicalResources' => [ 'base' => NULL, 'refs' => [ 'TerminateProvisionedProductInput$RetainPhysicalResources' => '

When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes the Service Catalog provisioned product. However, it does not remove the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductDetail$LaunchRoleArn' => '

The ARN of the launch role associated with the provisioned product.

', 'RecordDetail$LaunchRoleArn' => '

The ARN of the launch role associated with the provisioned product.

', ], ], 'ScanProvisionedProductsInput' => [ 'base' => NULL, 'refs' => [], ], 'ScanProvisionedProductsOutput' => [ 'base' => NULL, 'refs' => [], ], 'Scope' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Scope' => '

The change scope.

', ], ], 'SearchFilterKey' => [ 'base' => NULL, 'refs' => [ 'ListRecordHistorySearchFilter$Key' => '

The filter key.

  • product - Filter results based on the specified product identifier.

  • provisionedproduct - Filter results based on the provisioned product identifier.

', ], ], 'SearchFilterValue' => [ 'base' => NULL, 'refs' => [ 'ListRecordHistorySearchFilter$Value' => '

The filter value.

', ], ], 'SearchProductsAsAdminInput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProductsAsAdminOutput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProductsInput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProductsOutput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProvisionedProductsInput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProvisionedProductsOutput' => [ 'base' => NULL, 'refs' => [], ], 'SearchProvisionedProductsPageSize' => [ 'base' => NULL, 'refs' => [ 'SearchProvisionedProductsInput$PageSize' => '

The maximum number of items to return with this call.

', ], ], 'ServiceActionAssociation' => [ 'base' => '

A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

', 'refs' => [ 'ServiceActionAssociations$member' => NULL, ], ], 'ServiceActionAssociationErrorCode' => [ 'base' => NULL, 'refs' => [ 'FailedServiceActionAssociation$ErrorCode' => '

The error code. Valid values are listed below.

', ], ], 'ServiceActionAssociationErrorMessage' => [ 'base' => NULL, 'refs' => [ 'FailedServiceActionAssociation$ErrorMessage' => '

A text description of the error.

', ], ], 'ServiceActionAssociations' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateServiceActionWithProvisioningArtifactInput$ServiceActionAssociations' => '

One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

', 'BatchDisassociateServiceActionFromProvisioningArtifactInput$ServiceActionAssociations' => '

One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

', ], ], 'ServiceActionDefinitionKey' => [ 'base' => NULL, 'refs' => [ 'ServiceActionDefinitionMap$key' => NULL, ], ], 'ServiceActionDefinitionMap' => [ 'base' => NULL, 'refs' => [ 'CreateServiceActionInput$Definition' => '

The self-service action definition. Can be one of the following:

Name

The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

If you are using a shared SSM document, you must provide the ARN instead of the name.

Version

The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"

AssumeRole

The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

Parameters

The list of parameters in JSON format.

For example: [{\\"Name\\":\\"InstanceId\\",\\"Type\\":\\"TARGET\\"}] or [{\\"Name\\":\\"InstanceId\\",\\"Type\\":\\"TEXT_VALUE\\"}].

', 'ServiceActionDetail$Definition' => '

A map that defines the self-service action.

', 'UpdateServiceActionInput$Definition' => '

A map that defines the self-service action.

', ], ], 'ServiceActionDefinitionType' => [ 'base' => NULL, 'refs' => [ 'CreateServiceActionInput$DefinitionType' => '

The service action definition type. For example, SSM_AUTOMATION.

', 'ServiceActionSummary$DefinitionType' => '

The self-service action definition type. For example, SSM_AUTOMATION.

', ], ], 'ServiceActionDefinitionValue' => [ 'base' => NULL, 'refs' => [ 'ServiceActionDefinitionMap$value' => NULL, ], ], 'ServiceActionDescription' => [ 'base' => NULL, 'refs' => [ 'CreateServiceActionInput$Description' => '

The self-service action description.

', 'ServiceActionSummary$Description' => '

The self-service action description.

', 'UpdateServiceActionInput$Description' => '

The self-service action description.

', ], ], 'ServiceActionDetail' => [ 'base' => '

An object containing detailed information about the self-service action.

', 'refs' => [ 'CreateServiceActionOutput$ServiceActionDetail' => '

An object containing information about the self-service action.

', 'DescribeServiceActionOutput$ServiceActionDetail' => '

Detailed information about the self-service action.

', 'UpdateServiceActionOutput$ServiceActionDetail' => '

Detailed information about the self-service action.

', ], ], 'ServiceActionName' => [ 'base' => NULL, 'refs' => [ 'CreateServiceActionInput$Name' => '

The self-service action name.

', 'ServiceActionSummary$Name' => '

The self-service action name.

', 'UpdateServiceActionInput$Name' => '

The self-service action name.

', ], ], 'ServiceActionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListServiceActionsForProvisioningArtifactOutput$ServiceActionSummaries' => '

An object containing information about the self-service actions associated with the provisioning artifact.

', 'ListServiceActionsOutput$ServiceActionSummaries' => '

An object containing information about the service actions associated with the provisioning artifact.

', ], ], 'ServiceActionSummary' => [ 'base' => '

Detailed information about the self-service action.

', 'refs' => [ 'ServiceActionDetail$ServiceActionSummary' => '

Summary information about the self-service action.

', 'ServiceActionSummaries$member' => NULL, ], ], 'ShareDetails' => [ 'base' => '

Information about the portfolio share operation.

', 'refs' => [ 'DescribePortfolioShareStatusOutput$ShareDetails' => '

Information about the portfolio share operation.

', ], ], 'ShareError' => [ 'base' => '

Errors that occurred during the portfolio share operation.

', 'refs' => [ 'ShareErrors$member' => NULL, ], ], 'ShareErrors' => [ 'base' => NULL, 'refs' => [ 'ShareDetails$ShareErrors' => '

List of errors.

', ], ], 'ShareStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioShareStatusOutput$Status' => '

Status of the portfolio share operation.

', 'UpdatePortfolioShareOutput$Status' => '

The status of UpdatePortfolioShare operation. You can also obtain the operation status using DescribePortfolioShareStatus API.

', ], ], 'SortField' => [ 'base' => NULL, 'refs' => [ 'SearchProvisionedProductsInput$SortBy' => '

The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'SearchProductsAsAdminInput$SortOrder' => '

The sort order. If no value is specified, the results are not sorted.

', 'SearchProductsInput$SortOrder' => '

The sort order. If no value is specified, the results are not sorted.

', 'SearchProvisionedProductsInput$SortOrder' => '

The sort order. If no value is specified, the results are not sorted.

', ], ], 'SourceConnection' => [ 'base' => '

A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

', 'refs' => [ 'CreateProductInput$SourceConnection' => '

Specifies connection details for the created product and syncs the product to the connection source artifact. This automatically manages the product\'s artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.

  • Type

  • ConnectionParamters

', 'UpdateProductInput$SourceConnection' => '

Specifies connection details for the updated product and syncs the product to the connection source artifact. This automatically manages the product\'s artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.

  • Type

  • ConnectionParamters

', ], ], 'SourceConnectionDetail' => [ 'base' => '

Provides details about the configured SourceConnection.

', 'refs' => [ 'ProductViewDetail$SourceConnection' => '

A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

', ], ], 'SourceConnectionParameters' => [ 'base' => '

Provides connection details.

', 'refs' => [ 'SourceConnection$ConnectionParameters' => '

The connection details based on the connection Type.

', 'SourceConnectionDetail$ConnectionParameters' => '

The connection details based on the connection Type.

', ], ], 'SourceProvisioningArtifactProperties' => [ 'base' => NULL, 'refs' => [ 'CopyProductInput$SourceProvisioningArtifactIdentifiers' => '

The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

', ], ], 'SourceProvisioningArtifactPropertiesMap' => [ 'base' => NULL, 'refs' => [ 'SourceProvisioningArtifactProperties$member' => NULL, ], ], 'SourceRevision' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactDetail$SourceRevision' => '

Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

This field only exists for Repo-Synced products.

', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'SourceConnection$Type' => '

The only supported SourceConnection type is Codestar.

', 'SourceConnectionDetail$Type' => '

The only supported SourceConnection type is Codestar.

', ], ], 'StackInstance' => [ 'base' => '

An CloudFormation stack, in a specific account and Region, that\'s part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn\'t be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

', 'refs' => [ 'StackInstances$member' => NULL, ], ], 'StackInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'StackInstance$StackInstanceStatus' => '

The status of the stack instance, in terms of its synchronization with its associated stack set.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

  • OUTDATED: The stack isn\'t currently up to date with the stack set because either the associated stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

  • CURRENT: The stack is currently up to date with the stack set.

', ], ], 'StackInstances' => [ 'base' => NULL, 'refs' => [ 'ListStackInstancesForProvisionedProductOutput$StackInstances' => '

List of stack instances.

', ], ], 'StackSetAccounts' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactPreferences$StackSetAccounts' => '

One or more Amazon Web Services accounts where stack instances are deployed from the stack set. These accounts can be scoped in ProvisioningPreferences$StackSetAccounts and UpdateProvisioningPreferences$StackSetAccounts.

Applicable only to a CFN_STACKSET provisioned product type.

', 'ProvisioningPreferences$StackSetAccounts' => '

One or more Amazon Web Services accounts where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified accounts should be within the list of accounts from the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all acounts from the STACKSET constraint.

', 'UpdateProvisioningPreferences$StackSetAccounts' => '

One or more Amazon Web Services accounts that will have access to the provisioned product.

Applicable only to a CFN_STACKSET provisioned product type.

The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all accounts from the STACKSET constraint.

', ], ], 'StackSetFailureToleranceCount' => [ 'base' => NULL, 'refs' => [ 'ProvisioningPreferences$StackSetFailureToleranceCount' => '

The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn\'t attempt the operation in any subsequent Regions.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

The default value is 0 if no value is specified.

', 'UpdateProvisioningPreferences$StackSetFailureToleranceCount' => '

The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn\'t attempt the operation in any subsequent Regions.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

The default value is 0 if no value is specified.

', ], ], 'StackSetFailureTolerancePercentage' => [ 'base' => NULL, 'refs' => [ 'ProvisioningPreferences$StackSetFailureTolerancePercentage' => '

The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn\'t attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

', 'UpdateProvisioningPreferences$StackSetFailureTolerancePercentage' => '

The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn\'t attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

', ], ], 'StackSetMaxConcurrencyCount' => [ 'base' => NULL, 'refs' => [ 'ProvisioningPreferences$StackSetMaxConcurrencyCount' => '

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

', 'UpdateProvisioningPreferences$StackSetMaxConcurrencyCount' => '

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

', ], ], 'StackSetMaxConcurrencyPercentage' => [ 'base' => NULL, 'refs' => [ 'ProvisioningPreferences$StackSetMaxConcurrencyPercentage' => '

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as 1 instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

', 'UpdateProvisioningPreferences$StackSetMaxConcurrencyPercentage' => '

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as 1 instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

', ], ], 'StackSetOperationType' => [ 'base' => NULL, 'refs' => [ 'UpdateProvisioningPreferences$StackSetOperationType' => '

Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

Applicable only to a CFN_STACKSET provisioned product type.

CREATE

Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

UPDATE

Updates the stack set represented by the provisioned product and also its stack instances.

DELETE

Deletes a stack instance in the stack set represented by the provisioned product.

', ], ], 'StackSetRegions' => [ 'base' => NULL, 'refs' => [ 'ProvisioningArtifactPreferences$StackSetRegions' => '

One or more Amazon Web Services Regions where stack instances are deployed from the stack set. These Regions can be scoped in ProvisioningPreferences$StackSetRegions and UpdateProvisioningPreferences$StackSetRegions.

Applicable only to a CFN_STACKSET provisioned product type.

', 'ProvisioningPreferences$StackSetRegions' => '

One or more Amazon Web Services Regions where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all Regions from the STACKSET constraint.

', 'UpdateProvisioningPreferences$StackSetRegions' => '

One or more Amazon Web Services Regions where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all Regions from the STACKSET constraint.

', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'CreateConstraintOutput$Status' => '

The status of the current request.

', 'CreateProvisioningArtifactOutput$Status' => '

The status of the current request.

', 'DescribeConstraintOutput$Status' => '

The status of the current request.

', 'DescribeProvisioningArtifactOutput$Status' => '

The status of the current request.

', 'ProductViewDetail$Status' => '

The status of the product.

  • AVAILABLE - The product is ready for use.

  • CREATING - Product creation has started; the product is not ready for use.

  • FAILED - An action failed.

', 'UpdateConstraintOutput$Status' => '

The status of the current request.

', 'UpdateProvisioningArtifactOutput$Status' => '

The status of the current request.

', ], ], 'StatusDetail' => [ 'base' => NULL, 'refs' => [ 'DescribeCopyProductStatusOutput$StatusDetail' => '

The status message.

', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductPlanDetails$StatusMessage' => '

The status message.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AllowedValues$member' => NULL, 'ParameterConstraints$AllowedPattern' => '

A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.

', 'ParameterConstraints$ConstraintDescription' => '

A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:

Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.

', 'ParameterConstraints$MaxLength' => '

An integer value that determines the largest number of characters you want to allow for String types.

', 'ParameterConstraints$MinLength' => '

An integer value that determines the smallest number of characters you want to allow for String types.

', 'ParameterConstraints$MaxValue' => '

A numeric value that determines the largest numeric value you want to allow for Number types.

', 'ParameterConstraints$MinValue' => '

A numeric value that determines the smallest numeric value you want to allow for Number types.

', ], ], 'SuccessfulShares' => [ 'base' => NULL, 'refs' => [ 'ShareDetails$SuccessfulShares' => '

List of accounts for whom the operation succeeded.

', ], ], 'SupportDescription' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$SupportDescription' => '

The support information about the product.

', 'ProductViewSummary$SupportDescription' => '

The description of the support for this Product.

', 'UpdateProductInput$SupportDescription' => '

The updated support description for the product.

', ], ], 'SupportEmail' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$SupportEmail' => '

The contact email for product support.

', 'ProductViewSummary$SupportEmail' => '

The email contact information to obtain support for this Product.

', 'UpdateProductInput$SupportEmail' => '

The updated support email for the product.

', ], ], 'SupportUrl' => [ 'base' => NULL, 'refs' => [ 'CreateProductInput$SupportUrl' => '

The contact URL for product support.

^https?:\\/\\// / is the pattern used to validate SupportUrl.

', 'ProductViewSummary$SupportUrl' => '

The URL information to obtain support for this Product.

', 'UpdateProductInput$SupportUrl' => '

The updated support URL for the product.

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

Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.

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

The tag key.

', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UpdatePortfolioInput$RemoveTags' => '

The tags to remove.

', 'UpdateProductInput$RemoveTags' => '

The tags to remove from the product.

', ], ], 'TagOptionActive' => [ 'base' => NULL, 'refs' => [ 'ListTagOptionsFilters$Active' => '

The active state.

', 'TagOptionDetail$Active' => '

The TagOption active state.

', 'UpdateTagOptionInput$Active' => '

The updated active state.

', ], ], 'TagOptionDetail' => [ 'base' => '

Information about a TagOption.

', 'refs' => [ 'CreateTagOptionOutput$TagOptionDetail' => '

Information about the TagOption.

', 'DescribeTagOptionOutput$TagOptionDetail' => '

Information about the TagOption.

', 'TagOptionDetails$member' => NULL, 'UpdateTagOptionOutput$TagOptionDetail' => '

Information about the TagOption.

', ], ], 'TagOptionDetails' => [ 'base' => NULL, 'refs' => [ 'DescribePortfolioOutput$TagOptions' => '

Information about the TagOptions associated with the portfolio.

', 'DescribeProductAsAdminOutput$TagOptions' => '

Information about the TagOptions associated with the product.

', 'ListTagOptionsOutput$TagOptionDetails' => '

Information about the TagOptions.

', ], ], 'TagOptionId' => [ 'base' => NULL, 'refs' => [ 'AssociateTagOptionWithResourceInput$TagOptionId' => '

The TagOption identifier.

', 'DeleteTagOptionInput$Id' => '

The TagOption identifier.

', 'DescribeTagOptionInput$Id' => '

The TagOption identifier.

', 'DisassociateTagOptionFromResourceInput$TagOptionId' => '

The TagOption identifier.

', 'ListResourcesForTagOptionInput$TagOptionId' => '

The TagOption identifier.

', 'TagOptionDetail$Id' => '

The TagOption identifier.

', 'UpdateTagOptionInput$Id' => '

The TagOption identifier.

', ], ], 'TagOptionKey' => [ 'base' => NULL, 'refs' => [ 'CreateTagOptionInput$Key' => '

The TagOption key.

', 'ListTagOptionsFilters$Key' => '

The TagOption key.

', 'TagOptionDetail$Key' => '

The TagOption key.

', 'TagOptionSummary$Key' => '

The TagOption key.

', ], ], 'TagOptionNotMigratedException' => [ 'base' => '

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.

', 'refs' => [], ], 'TagOptionSummaries' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningParametersOutput$TagOptions' => '

Information about the TagOptions associated with the resource.

', ], ], 'TagOptionSummary' => [ 'base' => '

Summary information about a TagOption.

', 'refs' => [ 'TagOptionSummaries$member' => NULL, ], ], 'TagOptionValue' => [ 'base' => NULL, 'refs' => [ 'CreateTagOptionInput$Value' => '

The TagOption value.

', 'ListTagOptionsFilters$Value' => '

The TagOption value.

', 'TagOptionDetail$Value' => '

The TagOption value.

', 'TagOptionValues$member' => NULL, 'UpdateTagOptionInput$Value' => '

The updated value.

', ], ], 'TagOptionValues' => [ 'base' => NULL, 'refs' => [ 'TagOptionSummary$Values' => '

The TagOption value.

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

The value for this key.

', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreatePortfolioOutput$Tags' => '

Information about the tags associated with the portfolio.

', 'CreateProductOutput$Tags' => '

Information about the tags associated with the product.

', 'CreateProvisionedProductPlanInput$Tags' => '

One or more tags.

If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

', 'DescribePortfolioOutput$Tags' => '

Information about the tags associated with the portfolio.

', 'DescribeProductAsAdminOutput$Tags' => '

Information about the tags associated with the product.

', 'LaunchPathSummary$Tags' => '

The tags associated with this product path.

', 'ProvisionProductInput$Tags' => '

One or more tags.

', 'ProvisionedProductAttribute$Tags' => '

One or more tags.

', 'ProvisionedProductPlanDetails$Tags' => '

One or more tags.

', 'UpdatePortfolioOutput$Tags' => '

Information about the tags associated with the portfolio.

', 'UpdateProductOutput$Tags' => '

Information about the tags associated with the product.

', 'UpdateProvisionedProductInput$Tags' => '

One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

', ], ], 'TerminateProvisionedProductInput' => [ 'base' => NULL, 'refs' => [], ], 'TerminateProvisionedProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'TotalResultsCount' => [ 'base' => NULL, 'refs' => [ 'SearchProvisionedProductsOutput$TotalResultsCount' => '

The number of provisioned products found.

', ], ], 'UniqueTagKey' => [ 'base' => NULL, 'refs' => [ 'UniqueTagResourceIdentifier$Key' => '

A unique key that\'s attached to a resource.

', ], ], 'UniqueTagResourceIdentifier' => [ 'base' => '

The unique key-value pair for a tag that identifies provisioned product resources.

', 'refs' => [ 'EngineWorkflowResourceIdentifier$UniqueTag' => '

The unique key-value pair for a tag that identifies provisioned product resources.

', ], ], 'UniqueTagValue' => [ 'base' => NULL, 'refs' => [ 'UniqueTagResourceIdentifier$Value' => '

A unique value that\'s attached to a resource.

', ], ], 'UpdateConstraintInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConstraintOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePortfolioInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePortfolioOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePortfolioShareInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePortfolioShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProductInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisionedProductInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisionedProductOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisionedProductPropertiesInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisionedProductPropertiesOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisioningArtifactInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisioningArtifactOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProvisioningParameter' => [ 'base' => '

The parameter key-value pair used to update a provisioned product.

', 'refs' => [ 'UpdateProvisioningParameters$member' => NULL, ], ], 'UpdateProvisioningParameters' => [ 'base' => NULL, 'refs' => [ 'CreateProvisionedProductPlanInput$ProvisioningParameters' => '

Parameters specified by the administrator that are required for provisioning the product.

', 'ProvisionedProductPlanDetails$ProvisioningParameters' => '

Parameters specified by the administrator that are required for provisioning the product.

', 'UpdateProvisionedProductInput$ProvisioningParameters' => '

The new parameters.

', ], ], 'UpdateProvisioningPreferences' => [ 'base' => '

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.

', 'refs' => [ 'UpdateProvisionedProductInput$ProvisioningPreferences' => '

An object that contains information about the provisioning preferences for a stack set.

', ], ], 'UpdateServiceActionInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateServiceActionOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTagOptionInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTagOptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatedTime' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductPlanDetails$UpdatedTime' => '

The UTC time stamp when the plan was last updated.

', 'RecordDetail$UpdatedTime' => '

The time when the record was last updated.

', ], ], 'UsageInstruction' => [ 'base' => '

Additional information provided by the administrator.

', 'refs' => [ 'UsageInstructions$member' => NULL, ], ], 'UsageInstructions' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningParametersOutput$UsageInstructions' => '

Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

', ], ], 'UsePreviousValue' => [ 'base' => NULL, 'refs' => [ 'UpdateProvisioningParameter$UsePreviousValue' => '

If set to true, Value is ignored and the previous parameter value is kept.

', ], ], 'UserArn' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$UserArn' => '

The Amazon Resource Name (ARN) of the user.

', ], ], 'UserArnSession' => [ 'base' => NULL, 'refs' => [ 'ProvisionedProductAttribute$UserArnSession' => '

The ARN of the user in the session. This ARN might contain a session ID.

', ], ], 'Verbose' => [ 'base' => NULL, 'refs' => [ 'DescribeProvisioningArtifactInput$Verbose' => '

Indicates whether a verbose level of detail is enabled.

', ], ], ],]; From 9b0b2daf46d5e6a4600575917cea0764e4dbb6b5 Mon Sep 17 00:00:00 2001 From: AwsSdkPhpAutomation Date: Thu, 4 Jan 2024 19:43:02 +0000 Subject: [PATCH 2/2] 3.295.6 release --- CHANGELOG.md | 2 +- src/Sdk.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 030b32e2a2..f16664ca29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # CHANGELOG -## next release +## 3.295.6 - 2024-01-04 * `Aws\DocDB` - Adding PerformanceInsightsEnabled and PerformanceInsightsKMSKeyId fields to DescribeDBInstances Response. * `Aws\SageMaker` - Adding support for provisioned throughput mode for SageMaker Feature Groups diff --git a/src/Sdk.php b/src/Sdk.php index c7601cd12e..c8b5d40bc3 100644 --- a/src/Sdk.php +++ b/src/Sdk.php @@ -757,7 +757,7 @@ */ class Sdk { - const VERSION = '3.295.5'; + const VERSION = '3.295.6'; /** @var array Arguments for creating clients */ private $args;